SearchClient.DeleteDocumentsAsync Methode

Definition

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Paket:

Azure.Search.Documents v11.5.1

Überlädt

DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)	Löschen Sie Dokumente aus dem Index als Batch, der nur ihre Schlüssel erhält.
DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)	Löschen Sie Dokumente aus dem Index als Batch.

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

Quelle:

SearchClient.cs

Löschen Sie Dokumente aus dem Index als Batch, der nur ihre Schlüssel erhält.

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

Parameter

keyName

String

Der Name des Schlüsselfelds, das Dokumente im Index eindeutig identifiziert.

keyValues

IEnumerable<String>

Die Schlüssel der zu löschenden Dokumente.

options

IndexDocumentsOptions

Optionen, mit denen das Dokumentindizierungsverhalten angegeben werden kann.

cancellationToken

CancellationToken

Optional CancellationToken zur Weitergabe von Benachrichtigungen, dass der Vorgang abgebrochen werden soll.

Gibt zurück

Task<Response<IndexDocumentsResult>>

Antwort mit der status von Vorgängen für alle Aktionen im Aktionsbatch.

Ausnahmen

RequestFailedException

Wird ausgelöst, wenn ein Fehler vom Suchdienst zurückgegeben wird.

Hinweise

Standardmäßig wird eine Ausnahme nur ausgelöst, wenn die gesamte Anforderung fehlschlägt. Einzelne Fehler werden in der Results Auflistung beschrieben. Sie können festlegen ThrowOnAnyError , ob Ausnahmen bei teilweisen Fehlern ausgelöst werden sollen.

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

Quelle:

SearchClient.cs

Löschen Sie Dokumente aus dem Index als Batch.

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

Typparameter

T

Der .NET-Typ, der dem Indexschema zugeordnet ist. Instanzen dieses Typs können als Dokumente aus dem Index abgerufen werden.

Parameter

documents

IEnumerable<T>

Die zu löschenden Dokumente.

options

IndexDocumentsOptions

Optionen, mit denen das Dokumentindizierungsverhalten angegeben werden kann.

cancellationToken

CancellationToken

Optional CancellationToken zur Weitergabe von Benachrichtigungen, dass der Vorgang abgebrochen werden soll.

Gibt zurück

Task<Response<IndexDocumentsResult>>

Antwort mit der status von Vorgängen für alle Aktionen im Aktionsbatch.

Ausnahmen

RequestFailedException

Wird ausgelöst, wenn ein Fehler vom Suchdienst zurückgegeben wird.

Hinweise

Die generischen Überladungen der DeleteDocuments- und DeleteDocumentsAsync-Methoden unterstützen die Zuordnung von Suchfeldtypen zu .NET-Typen über den Typparameter T. Weitere Informationen zur Typzuordnung finden Sie GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) unter .

Standardmäßig wird eine Ausnahme nur ausgelöst, wenn die gesamte Anforderung fehlschlägt. Einzelne Fehler werden in der Results Auflistung beschrieben. Sie können festlegen ThrowOnAnyError , ob Ausnahmen bei teilweisen Fehlern ausgelöst werden sollen.