你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Container class
用于按 ID 读取、替换或删除特定现有容器的操作。
请参阅 用于创建新容器 和读取/查询所有容器的容器;使用 .containers。
注意：所有这些操作都会根据固定预算进行调用。
应设计系统，使这些调用与应用程序一起按子线性缩放。
例如，不要在每次item.read()调用之前调用container(id).read()，以确保容器存在;在应用程序启动时执行此操作一次。
属性
| conflicts | 读取和查询给定容器的冲突的操作。 若要读取或删除特定冲突，请使用 |
| database | |
| id | |
| items | 创建新项和读取/查询所有项的操作 若要读取、替换或删除现有项，请使用 示例 创建新项 |
| scripts | 存储过程、触发器和用户定义的函数的所有操作 |
| url | 返回资源的引用 URL。 用于在权限中链接。 |
方法
| conflict(string, Partition |
用于按 ID 读取、替换或删除特定的现有 冲突 。 用于 |
| delete(Request |
删除容器 |
| delete |
删除所提供分区键值所属容器的所有文档 |
| get |
|
| get |
首先通过查看缓存来获取分区键定义，否则通过读取集合来获取分区键定义。 |
| get |
|
| item(string, Partition |
用于按 ID 读取、替换或删除特定的现有 项 。 用于 示例 替换项 |
| read(Request |
读取容器的定义 |
| read |
获取容器上的产品/服务。 如果不存在，则返回未定义的 OfferResponse。 |
| read |
|
| replace(Container |
替换容器的定义 |
属性详细信息
conflicts
database
id
id: string属性值
string
items
创建新项和读取/查询所有项的操作
若要读取、替换或删除现有项，请使用 .item(id)。
示例
创建新项
const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
Items items属性值
scripts
url
返回资源的引用 URL。 用于在权限中链接。
string url属性值
string
方法详细信息
conflict(string, PartitionKey)
用于按 ID 读取、替换或删除特定的现有 冲突 。
用于 .conflicts 创建新冲突，或查询/读取所有冲突。
function conflict(id: string, partitionKey?: PartitionKey): Conflict参数
- id
-
string
冲突的 ID。
- partitionKey
- PartitionKey
返回
delete(RequestOptions)
删除容器
function delete(options?: RequestOptions): Promise<ContainerResponse>参数
- options
- RequestOptions
返回
Promise<ContainerResponse>
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)
删除所提供分区键值所属容器的所有文档
function deleteAllItemsForPartitionKey(partitionKey: PartitionKey, options?: RequestOptions): Promise<ContainerResponse>参数
- partitionKey
- PartitionKey
要删除的项的分区键值
- options
- RequestOptions
返回
Promise<ContainerResponse>
getFeedRanges()
function getFeedRanges(): Promise<readonly FeedRange[]>返回
Promise<readonly FeedRange[]>
可以提取更改源的所有源范围。
getPartitionKeyDefinition()
警告
现已弃用此 API。
This method has been renamed to readPartitionKeyDefinition.
首先通过查看缓存来获取分区键定义，否则通过读取集合来获取分区键定义。
function getPartitionKeyDefinition(): Promise<ResourceResponse<PartitionKeyDefinition>>返回
Promise<ResourceResponse<PartitionKeyDefinition>>
getQueryPlan(string | SqlQuerySpec)
function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>参数
- query
-
string | SqlQuerySpec
返回
Promise<Response_2<PartitionedQueryExecutionInfo>>
item(string, PartitionKey)
用于按 ID 读取、替换或删除特定的现有 项 。
用于 .items 创建新项或查询/读取所有项。
示例
替换项 const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
function item(id: string, partitionKeyValue?: PartitionKey): Item参数
- id
-
string
项的 ID。
- partitionKeyValue
- PartitionKey
Item 分区键的值
返回
read(RequestOptions)
读取容器的定义
function read(options?: RequestOptions): Promise<ContainerResponse>参数
- options
- RequestOptions
返回
Promise<ContainerResponse>
readOffer(RequestOptions)
获取容器上的产品/服务。 如果不存在，则返回未定义的 OfferResponse。
function readOffer(options?: RequestOptions): Promise<OfferResponse>参数
- options
- RequestOptions
返回
Promise<OfferResponse>
readPartitionKeyRanges(FeedOptions)
function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>参数
- feedOptions
- FeedOptions
返回
QueryIterator<PartitionKeyRange>
replace(ContainerDefinition, RequestOptions)
替换容器的定义
function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>参数
- body
- ContainerDefinition
- options
- RequestOptions
返回
Promise<ContainerResponse>