SearchClient.DeleteDocuments Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Überlädt
| DeleteDocuments(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken) |
Löschen Sie Dokumente aus dem Index als Batch, der nur ihre Schlüssel erhält. |
| DeleteDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken) |
Löschen Sie Dokumente aus dem Index als Batch. |
DeleteDocuments(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)
- Quelle:
- SearchClient.cs
- Quelle:
- SearchClient.cs
Löschen Sie Dokumente aus dem Index als Batch, der nur ihre Schlüssel erhält.
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)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
Antwort mit der status von Vorgängen für alle Aktionen im Aktionsbatch.
Ausnahmen
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.
Gilt für:
DeleteDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)
- Quelle:
- SearchClient.cs
- Quelle:
- SearchClient.cs
Löschen Sie Dokumente aus dem Index als Batch.
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)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
Antwort mit der status von Vorgängen für alle Aktionen im Aktionsbatch.
Ausnahmen
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.
Gilt für:
Azure SDK for .NET