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

SearchClient.DeleteDocumentsAsync 方法

定义

重载

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

将文档作为批从索引中删除,只提供它们的键。

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

以批处理的形式从索引中删除文档。

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

Source:
SearchClient.cs
Source:
SearchClient.cs

将文档作为批从索引中删除,只提供它们的键。

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

参数

keyName
String

唯一标识索引中文档的键字段的名称。

keyValues
IEnumerable<String>

要删除的文档的键。

options
IndexDocumentsOptions

允许指定文档索引行为的选项。

cancellationToken
CancellationToken

可选 CancellationToken ,用于传播应取消操作的通知。

返回

包含操作批处理中所有操作的操作状态的响应。

例外

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

注解

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

适用于

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

Source:
SearchClient.cs
Source:
SearchClient.cs

以批处理的形式从索引中删除文档。

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

类型参数

T

映射到索引架构的 .NET 类型。 可以从索引中以文档的形式检索此类型的实例。

参数

documents
IEnumerable<T>

要删除的文档。

options
IndexDocumentsOptions

允许指定文档索引行为的选项。

cancellationToken
CancellationToken

可选 CancellationToken ,用于传播应取消操作的通知。

返回

包含操作批处理中所有操作的操作状态的响应。

例外

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

注解

DeleteDocuments 和 DeleteDocumentsAsync 方法的泛型重载支持通过类型参数 T 将搜索字段类型映射到 .NET 类型。有关类型映射的更多详细信息,请参阅 GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken)

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

适用于