SearchClient.DeleteDocuments メソッド

定義

名前空間:

Azure.Search.Documents

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

オーバーロード

DeleteDocuments(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)	キーのみが指定されたバッチとして、インデックスからドキュメントを削除します。
DeleteDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)	インデックスからドキュメントをバッチとして削除します。

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

ソース:

SearchClient.cs

キーのみが指定されたバッチとして、インデックスからドキュメントを削除します。

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)

パラメーター

keyName

String

インデックス内のドキュメントを一意に識別するキー フィールドの名前。

keyValues

IEnumerable<String>

削除するドキュメントのキー。

options

IndexDocumentsOptions

ドキュメントのインデックス作成動作を指定できるオプション。

cancellationToken

CancellationToken

操作を取り消す必要があることを示す通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Response<IndexDocumentsResult>

アクションのバッチ内のすべてのアクションの操作の状態を含む応答。

例外

RequestFailedException

Search Service によってエラーが返されたときにスローされます。

注釈

既定では、要求全体が失敗した場合にのみ例外がスローされます。 個々のエラーについては、コレクションで Results 説明します。 部分的な障害時に例外をスローするかどうかを設定 ThrowOnAnyError できます。

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

ソース:

SearchClient.cs

インデックスからドキュメントをバッチとして削除します。

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)

型パラメーター

T

インデックス スキーマにマップされる .NET 型。 この型のインスタンスは、インデックスからドキュメントとして取得できます。

パラメーター

documents

IEnumerable<T>

削除するドキュメント。

options

IndexDocumentsOptions

ドキュメントのインデックス作成動作を指定できるオプション。

cancellationToken

CancellationToken

操作を取り消す必要があることを示す通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Response<IndexDocumentsResult>

アクションのバッチ内のすべてのアクションの操作の状態を含む応答。

例外

RequestFailedException

Search Service によってエラーが返されたときにスローされます。

注釈

DeleteDocuments メソッドと DeleteDocumentsAsync メソッドのジェネリック オーバーロードでは、型パラメーター T を使用した .NET 型への検索フィールド型のマッピングがサポートされています。型マッピングの詳細については、以下を参照してください GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) 。

既定では、要求全体が失敗した場合にのみ例外がスローされます。 個々のエラーについては、コレクションで Results 説明します。 部分的な障害時に例外をスローするかどうかを設定 ThrowOnAnyError できます。