SearchClient.DeleteDocuments Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| DeleteDocuments(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken) |
Exclua documentos do índice como um lote, considerando apenas suas chaves. |
| DeleteDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken) |
Exclua documentos do índice como um lote. |
DeleteDocuments(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)
- Origem:
- SearchClient.cs
- Origem:
- SearchClient.cs
Exclua documentos do índice como um lote, considerando apenas suas chaves.
public virtual Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult> DeleteDocuments (string keyName, System.Collections.Generic.IEnumerable<string> keyValues, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDocuments : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>
override this.DeleteDocuments : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>Public Overridable Function DeleteDocuments (keyName As String, keyValues As IEnumerable(Of String), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IndexDocumentsResult)Parâmetros
- keyName
- String
O nome do campo de chave que identifica exclusivamente documentos no índice.
- keyValues
- IEnumerable<String>
As chaves dos documentos a serem excluídos.
- options
- IndexDocumentsOptions
Opções que permitem especificar o comportamento de indexação de documentos.
- cancellationToken
- CancellationToken
Opcional CancellationToken para propagar notificações de que a operação deve ser cancelada.
Retornos
Resposta que contém o status de operações para todas as ações no lote de ações.
Exceções
Gerado quando uma falha é retornada pelo Serviço de Pesquisa.
Comentários
Por padrão, uma exceção só será gerada se toda a solicitação falhar. Falhas individuais são descritas na Results coleção. Você pode definir ThrowOnAnyError se quiser que exceções ocorram em uma falha parcial.
Aplica-se a
DeleteDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)
- Origem:
- SearchClient.cs
- Origem:
- SearchClient.cs
Exclua documentos do índice como um lote.
public virtual Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult> DeleteDocuments<T> (System.Collections.Generic.IEnumerable<T> documents, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDocuments : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>
override this.DeleteDocuments : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>Public Overridable Function DeleteDocuments(Of T) (documents As IEnumerable(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IndexDocumentsResult)Parâmetros de tipo
- T
O tipo .NET que mapeia para o esquema de índice. Instâncias desse tipo podem ser recuperadas como documentos do índice.
Parâmetros
- documents
- IEnumerable<T>
Os documentos a serem excluídos.
- options
- IndexDocumentsOptions
Opções que permitem especificar o comportamento de indexação de documentos.
- cancellationToken
- CancellationToken
Opcional CancellationToken para propagar notificações de que a operação deve ser cancelada.
Retornos
Resposta que contém o status de operações para todas as ações no lote de ações.
Exceções
Gerado quando uma falha é retornada pelo Serviço de Pesquisa.
Comentários
As sobrecargas genéricas dos métodos DeleteDocuments e DeleteDocumentsAsync dão suporte ao mapeamento de tipos de campo de pesquisa para tipos .NET por meio do parâmetro de tipo T. Consulte GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) para obter mais detalhes sobre o mapeamento de tipo.
Por padrão, uma exceção só será gerada se toda a solicitação falhar. Falhas individuais são descritas na Results coleção. Você pode definir ThrowOnAnyError se quiser que exceções ocorram em uma falha parcial.
Aplica-se a
Azure SDK for .NET