SearchClient.DeleteDocumentsAsync Méthode

Définition

Espace de noms:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Paquet:

Azure.Search.Documents v11.5.1

Surcharges

DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)	Supprimez des documents de l’index en tant que lot en fonction de leurs clés uniquement.
DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)	Supprimez des documents de l’index sous forme de lot.

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

Source:

SearchClient.cs

Supprimez des documents de l’index en tant que lot en fonction de leurs clés uniquement.

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))

Paramètres

keyName

String

Nom du champ de clé qui identifie de façon unique les documents dans l’index.

keyValues

IEnumerable<String>

Clés des documents à supprimer.

options

IndexDocumentsOptions

Options qui permettent de spécifier le comportement d’indexation des documents.

cancellationToken

CancellationToken

Facultatif CancellationToken pour propager des notifications indiquant que l’opération doit être annulée.

Retours

Task<Response<IndexDocumentsResult>>

Réponse contenant le status d’opérations pour toutes les actions du lot d’actions.

Exceptions

RequestFailedException

Levée lorsqu’un échec est retourné par le service de recherche.

Remarques

Par défaut, une exception n’est levée qu’en cas d’échec de la requête entière. Les défaillances individuelles sont décrites dans la Results collection. Vous pouvez définir ThrowOnAnyError si vous souhaitez que des exceptions soient levées en cas d’échec partiel.

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

Source:

SearchClient.cs

Supprimez des documents de l’index sous forme de lot.

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))

Paramètres de type

T

Type .NET mappé au schéma d’index. Les instances de ce type peuvent être récupérées en tant que documents à partir de l’index.

Paramètres

documents

IEnumerable<T>

Documents à supprimer.

options

IndexDocumentsOptions

Options qui permettent de spécifier le comportement d’indexation des documents.

cancellationToken

CancellationToken

Facultatif CancellationToken pour propager des notifications indiquant que l’opération doit être annulée.

Retours

Task<Response<IndexDocumentsResult>>

Réponse contenant le status d’opérations pour toutes les actions du lot d’actions.

Exceptions

RequestFailedException

Levée lorsqu’un échec est retourné par le service de recherche.

Remarques

Les surcharges génériques des méthodes DeleteDocuments et DeleteDocumentsAsync prennent en charge le mappage des types de champs de recherche aux types .NET via le paramètre de type T. Pour plus d’informations sur le mappage de type, consultez GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) .

Par défaut, une exception n’est levée qu’en cas d’échec de la requête entière. Les défaillances individuelles sont décrites dans la Results collection. Vous pouvez définir ThrowOnAnyError si vous souhaitez que des exceptions soient levées en cas d’échec partiel.