你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Containers class
用于创建新容器和读取/查询所有容器的操作
有关读取、替换或删除现有 容器 ，请参阅容器;使用 .container(id)。
注意：所有这些操作都针对固定预算进行调用。
应设计系统，使这些调用与应用程序一起以子线性方式缩放。
例如，不要在每次item.read()调用之前调用 containers.readAll() ，以确保容器存在;在应用程序启动时执行此操作一次。
构造函数
| Containers(Database, Client |
属性
| database |
方法
| create(Container |
创建容器。 容器是项的命名逻辑容器。 数据库可能包含零个或多个命名容器，每个容器由零个或多个 JSON 项组成。 由于没有架构，容器中的项不需要共享相同的结构或字段。 由于容器是应用程序资源，因此可以使用主密钥或资源密钥对容器进行授权。 |
| create |
检查容器是否存在，如果不存在，则创建它。
这将基于 中的 容器是项的命名逻辑容器。 数据库可能包含零个或多个命名容器，每个容器由零个或多个 JSON 项组成。 由于没有架构，容器中的项不需要共享相同的结构或字段。 由于容器是应用程序资源，因此可以使用主密钥或资源密钥对容器进行授权。 |
| query(Sql |
查询所有容器。 示例 将所有容器读到数组中。
* |
| query<T>(Sql |
查询所有容器。 示例 将所有容器读到数组中。
* |
| read |
读取所有容器。 示例 将所有容器读到数组中。
* |
构造函数详细信息
Containers(Database, ClientContext)
new Containers(database: Database, clientContext: ClientContext)参数
- database
- Database
- clientContext
-
ClientContext
属性详细信息
database
方法详细信息
create(ContainerRequest, RequestOptions)
创建容器。
容器是项的命名逻辑容器。
数据库可能包含零个或多个命名容器，每个容器由零个或多个 JSON 项组成。
由于没有架构，容器中的项不需要共享相同的结构或字段。
由于容器是应用程序资源，因此可以使用主密钥或资源密钥对容器进行授权。
function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>参数
- body
- ContainerRequest
表示容器的主体。
- options
- RequestOptions
用于设置响应页大小、继续标记等选项。
返回
Promise<ContainerResponse>
createIfNotExists(ContainerRequest, RequestOptions)
检查容器是否存在，如果不存在，则创建它。
这将基于 中的 bodyID 进行读取操作，如果找不到，则创建操作。
应确认输出与传入的非默认属性的正文匹配， (即索引策略/等)
容器是项的命名逻辑容器。
数据库可能包含零个或多个命名容器，每个容器由零个或多个 JSON 项组成。
由于没有架构，容器中的项不需要共享相同的结构或字段。
由于容器是应用程序资源，因此可以使用主密钥或资源密钥对容器进行授权。
function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>参数
- body
- ContainerRequest
表示容器的主体。
- options
- RequestOptions
用于设置响应页大小、继续标记等选项。
返回
Promise<ContainerResponse>
query(SqlQuerySpec, FeedOptions)
查询所有容器。
示例
将所有容器读到数组中。
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>参数
- query
- SqlQuerySpec
操作的查询配置。 有关如何配置查询的详细信息，请参阅 SqlQuerySpec 。
- options
- FeedOptions
用于设置响应页大小、继续标记等选项。
返回
QueryIterator<any>
QueryIterator 允许返回数组中的特定容器，或一次循环访问一个容器。 *
query<T>(SqlQuerySpec, FeedOptions)
查询所有容器。
示例
将所有容器读到数组中。
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>参数
- query
- SqlQuerySpec
操作的查询配置。 有关如何配置查询的详细信息，请参阅 SqlQuerySpec 。
- options
- FeedOptions
用于设置响应页大小、继续标记等选项。
返回
QueryIterator 允许返回数组中的特定容器，或一次循环访问一个容器。 *
readAll(FeedOptions)
读取所有容器。
示例
将所有容器读到数组中。
* typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>参数
- options
- FeedOptions
用于设置响应页大小、继续标记等选项。
返回
QueryIterator 允许返回数组中的所有容器，或一次循环访问一个容器。 *