SearchClient.DeleteDocumentsAsync Método

Definição

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Pacote:

Azure.Search.Documents v11.5.1

Sobrecargas

DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)	Exclua documentos do índice como um lote, considerando apenas suas chaves.
DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)	Exclua documentos do índice como um lote.

DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)

Origem:

SearchClient.cs

Exclua documentos do índice como um lote, considerando apenas suas chaves.

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

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

Task<Response<IndexDocumentsResult>>

Resposta que contém o status de operações para todas as ações no lote de ações.

Exceções

RequestFailedException

Gerada 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 deseja que exceções lançadas em falha parcial.

DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)

Origem:

SearchClient.cs

Exclua documentos do índice como um 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

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

Task<Response<IndexDocumentsResult>>

Resposta que contém o status de operações para todas as ações no lote de ações.

Exceções

RequestFailedException

Gerada 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 deseja que exceções lançadas em falha parcial.