你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CosmosDatabase.GetUserQueryIterator 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
重载
| GetUserQueryIterator<T>(QueryDefinition, String, QueryRequestOptions, CancellationToken) |
此方法使用 SQL 语句为数据库下的用户创建查询。 它返回 FeedIterator。 有关使用参数化值准备 SQL 语句的详细信息，请参阅 QueryDefinition 重载。 |
| GetUserQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken) |
此方法使用 SQL 语句为数据库下的用户创建查询。 它返回 FeedIterator。 有关使用参数化值准备 SQL 语句的详细信息，请参阅 QueryDefinition 重载。 |
GetUserQueryIterator<T>(QueryDefinition, String, QueryRequestOptions, CancellationToken)
此方法使用 SQL 语句为数据库下的用户创建查询。 它返回 FeedIterator。 有关使用参数化值准备 SQL 语句的详细信息，请参阅 QueryDefinition 重载。
public abstract Azure.AsyncPageable<T> GetUserQueryIterator<T> (Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetUserQueryIterator : Azure.Cosmos.QueryDefinition * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<'T>Public MustOverride Function GetUserQueryIterator(Of T) (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of T)类型参数
- T
参数
- queryDefinition
- QueryDefinition
cosmos SQL 查询定义。
- continuationToken
- String
(可选) Azure Cosmos DB 服务中的延续令牌。
- requestOptions
- QueryRequestOptions
(可选) 用户查询请求的选项 QueryRequestOptions
- cancellationToken
- CancellationToken
(表示请求取消的可选) CancellationToken 。
返回
用于浏览用户的迭代器
示例
这将为使用 queryDefinition 作为输入的用户创建类型源迭代器。
string queryText = "SELECT * FROM c where c.id like @testId";
QueryDefinition queryDefinition = new QueryDefinition(queryText);
queryDefinition.WithParameter("@testId", "testUserId");
await foreach(UserProperties properties in this.cosmosDatabase.GetUserQueryIterator<UserProperties>(queryDefinition))
{
Console.WriteLine(properties.Id);
}
适用于
GetUserQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)
此方法使用 SQL 语句为数据库下的用户创建查询。 它返回 FeedIterator。 有关使用参数化值准备 SQL 语句的详细信息，请参阅 QueryDefinition 重载。
public abstract Azure.AsyncPageable<T> GetUserQueryIterator<T> (string queryText = default, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetUserQueryIterator : string * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<'T>Public MustOverride Function GetUserQueryIterator(Of T) (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of T)类型参数
- T
参数
- queryText
- String
cosmos SQL 查询文本。
- continuationToken
- String
(可选) Azure Cosmos DB 服务中的延续令牌。
- requestOptions
- QueryRequestOptions
(可选) 用户查询请求的选项 QueryRequestOptions
- cancellationToken
- CancellationToken
(表示请求取消的可选) CancellationToken 。
返回
用于浏览用户的迭代器
示例
- 这将为使用 queryText 作为输入的用户创建类型源迭代器，
string queryText = "SELECT * FROM c where c.id like '%testId%'";
await foreach (UserProperties properties in this.cosmosDatabase.GetUserQueryIterator<UserProperties>(queryText))
{
}
- 这将为不带 queryText 的用户创建类型源迭代器，检索所有用户。
await foreach (UserProperties properties in this.cosmosDatabase.GetUserQueryIterator<ContainerProperties>())
{
}
