SearchClient.DeleteDocumentsAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken) |
Elimine documentos del índice como un lote dado solo sus claves. |
| DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken) |
Elimine documentos del índice como un lote. |
DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)
- Source:
- SearchClient.cs
- Source:
- SearchClient.cs
Elimine documentos del índice como un lote dado solo sus claves.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> DeleteDocumentsAsync (string keyName, System.Collections.Generic.IEnumerable<string> keyValues, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDocumentsAsync : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.DeleteDocumentsAsync : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>Public Overridable Function DeleteDocumentsAsync (keyName As String, keyValues As IEnumerable(Of String), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))Parámetros
- keyName
- String
Nombre del campo de clave que identifica de forma única los documentos del índice.
- keyValues
- IEnumerable<String>
Claves de los documentos que se van a eliminar.
- options
- IndexDocumentsOptions
Opciones que permiten especificar el comportamiento de indexación de documentos.
- cancellationToken
- CancellationToken
Opcional CancellationToken para propagar notificaciones que se deben cancelar en la operación.
Devoluciones
Respuesta que contiene el estado de las operaciones de todas las acciones del lote de acciones.
Excepciones
Se produce cuando el servicio de búsqueda devuelve un error.
Comentarios
De forma predeterminada, solo se producirá una excepción si se produce un error en toda la solicitud. Los errores individuales se describen en la Results colección. Puede establecer ThrowOnAnyError si desea que se produzcan excepciones en caso de error parcial.
Se aplica a
DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)
- Source:
- SearchClient.cs
- Source:
- SearchClient.cs
Elimine documentos del índice como un lote.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> DeleteDocumentsAsync<T> (System.Collections.Generic.IEnumerable<T> documents, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDocumentsAsync : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.DeleteDocumentsAsync : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>Public Overridable Function DeleteDocumentsAsync(Of T) (documents As IEnumerable(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))Parámetros de tipo
- T
Tipo de .NET que se asigna al esquema de índice. Las instancias de este tipo se pueden recuperar como documentos del índice.
Parámetros
- documents
- IEnumerable<T>
Documentos que se van a eliminar.
- options
- IndexDocumentsOptions
Opciones que permiten especificar el comportamiento de indexación de documentos.
- cancellationToken
- CancellationToken
Opcional CancellationToken para propagar notificaciones que se deben cancelar en la operación.
Devoluciones
Respuesta que contiene el estado de las operaciones de todas las acciones del lote de acciones.
Excepciones
Se produce cuando el servicio de búsqueda devuelve un error.
Comentarios
Las sobrecargas genéricas de los métodos DeleteDocuments y DeleteDocumentsAsync admiten la asignación de tipos de campo de búsqueda a tipos de .NET a través del parámetro de tipo T. Consulte GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) para obtener más información sobre la asignación de tipos.
De forma predeterminada, solo se producirá una excepción si se produce un error en toda la solicitud. Los errores individuales se describen en la Results colección. Puede establecer ThrowOnAnyError si desea que se produzcan excepciones en caso de error parcial.
Se aplica a
Azure SDK for .NET