你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SearchClient.DeleteDocuments 方法

参考

定义

命名空间:: Azure.Search.Documents

程序集:: Azure.Search.Documents.dll

包:: Azure.Search.Documents v11.6.0

包:: Azure.Search.Documents v11.7.0-beta.3

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

重载

DeleteDocuments(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)	将文档作为批从索引中删除，仅给定文档的键。
DeleteDocuments<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)	以批处理的形式从索引中删除文档。

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

Source:: SearchClient.cs

Source:: 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

搜索服务返回失败时引发。

注解

默认情况下，仅当整个请求失败时才会引发异常。集合中 Results 介绍了各个故障。可以设置 ThrowOnAnyError 是否希望在部分失败时引发异常。

适用于

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

Source:: SearchClient.cs

Source:: 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