你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Items class
用于创建新项和读取/查询所有项的作
请参阅 项,了解如何读取、替换或删除现有容器;使用 .item(id)
。
属性
container |
方法
batch(Operation |
对项执行事务批处理作。 Batch 采用基于作执行的作类型的作数组。 Batch 是事务性的,如果一个作失败,则会回滚所有作。 选项包括:Create、Upsert、Read、Replace 和 Delete 用法示例:
|
bulk(Operation |
对项执行批量作。 大容量采用基于作执行的作类型的作数组。 选项包括:Create、Upsert、Read、Replace 和 Delete 用法示例:
|
change |
创建一个 |
change |
创建一个 示例 从更改源的开头读取。
|
change |
创建一个 |
change |
创建一个 |
create<T>(T, Request |
创建项。 SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性,并且由逻辑来强制实施。 JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。 |
get |
返回迭代器以循环访问更改页。 返回的迭代器可用于提取单个分区键、源范围或整个容器的更改。 |
query(string | Sql |
查询所有项。 示例 将所有项读取到数组。
|
query<T>(string | Sql |
查询所有项。 示例 将所有项读取到数组。
|
read |
读取所有项。 JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。 示例 将所有项读取到数组。
|
read |
读取所有项。 SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性,并且由逻辑来强制实施。 JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。 示例 将所有项读取到数组。
|
read |
创建一个 |
read |
创建一个 示例 从更改源的开头读取。
|
read |
创建一个 |
read |
创建一个 |
upsert(unknown, Request |
向上插入项。 JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。 |
upsert<T>(T, Request |
向上插入项。 SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性,并且由逻辑来强制实施。 JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。 |
属性详细信息
container
方法详细信息
batch(OperationInput[], PartitionKey, RequestOptions)
对项执行事务批处理作。
Batch 采用基于作执行的作类型的作数组。 Batch 是事务性的,如果一个作失败,则会回滚所有作。 选项包括:Create、Upsert、Read、Replace 和 Delete
用法示例:
// The partitionKey is a required second argument. If it’s undefined, it defaults to the expected partition key format.
const operations: OperationInput[] = [
{
operationType: "Create",
resourceBody: { id: "doc1", name: "sample", key: "A" }
},
{
operationType: "Upsert",
resourceBody: { id: "doc2", name: "other", key: "A" }
}
]
await database.container.items.batch(operations, "A")
function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>
参数
- operations
作列表。 限制 100
- partitionKey
- PartitionKey
- options
- RequestOptions
用于修改请求
返回
Promise<Response_2<OperationResponse[]>>
bulk(OperationInput[], BulkOptions, RequestOptions)
对项执行批量作。
大容量采用基于作执行的作类型的作数组。 选项包括:Create、Upsert、Read、Replace 和 Delete
用法示例:
// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
{
operationType: "Create",
resourceBody: { id: "doc1", name: "sample", key: "A" }
},
{
operationType: "Upsert",
partitionKey: 'A',
resourceBody: { id: "doc2", name: "other", key: "A" }
}
]
await database.container.items.bulk(operations)
function bulk(operations: OperationInput[], bulkOptions?: BulkOptions, options?: RequestOptions): Promise<BulkOperationResponse>
参数
- operations
作列表。 限制 100
- bulkOptions
- BulkOptions
用于修改批量行为的可选选项对象。 传递 { continueOnError:false } 以在失败时停止执行作。 (默认值为 true)
- options
- RequestOptions
用于修改请求。
返回
Promise<BulkOperationResponse>
changeFeed(ChangeFeedOptions)
创建一个 ChangeFeedIterator
来循环访问更改页面
function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>
参数
- changeFeedOptions
- ChangeFeedOptions
返回
ChangeFeedIterator<any>
changeFeed(PartitionKey, ChangeFeedOptions)
创建一个 ChangeFeedIterator
来循环访问更改页面
示例
从更改源的开头读取。
const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
function changeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>
参数
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
返回
ChangeFeedIterator<any>
changeFeed<T>(ChangeFeedOptions)
创建一个 ChangeFeedIterator
来循环访问更改页面
function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
参数
- changeFeedOptions
- ChangeFeedOptions
返回
changeFeed<T>(PartitionKey, ChangeFeedOptions)
创建一个 ChangeFeedIterator
来循环访问更改页面
function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
参数
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
返回
create<T>(T, RequestOptions)
创建项。
SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性,并且由逻辑来强制实施。
JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。
function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>
参数
- body
-
T
表示项的正文。 可以包含任意数量的用户定义的属性。
- options
- RequestOptions
用于修改请求(例如,指定分区键)。
返回
Promise<ItemResponse<T>>
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)
返回迭代器以循环访问更改页。 返回的迭代器可用于提取单个分区键、源范围或整个容器的更改。
function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>
参数
- changeFeedIteratorOptions
- ChangeFeedIteratorOptions
返回
query(string | SqlQuerySpec, FeedOptions)
查询所有项。
示例
将所有项读取到数组。
const querySpec: SqlQuerySpec = {
query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
parameters: [
{name: "@lastName", value: "Hendricks"}
]
};
const {result: items} = await items.query(querySpec).fetchAll();
function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
参数
- query
-
string | SqlQuerySpec
作的查询配置。 有关如何配置查询的详细信息,请参阅 SqlQuerySpec。
- options
- FeedOptions
用于修改请求(例如,指定分区键)。
返回
QueryIterator<any>
query<T>(string | SqlQuerySpec, FeedOptions)
查询所有项。
示例
将所有项读取到数组。
const querySpec: SqlQuerySpec = {
query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
parameters: [
{name: "@lastName", value: "Hendricks"}
]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();
function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>
参数
- query
-
string | SqlQuerySpec
作的查询配置。 有关如何配置查询的详细信息,请参阅 SqlQuerySpec。
- options
- FeedOptions
用于修改请求(例如,指定分区键)。
返回
readAll(FeedOptions)
读取所有项。
JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。
示例
将所有项读取到数组。
const {body: containerList} = await items.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>
参数
- options
- FeedOptions
用于修改请求(例如,指定分区键)。
返回
readAll<T>(FeedOptions)
读取所有项。
SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性,并且由逻辑来强制实施。
JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。
示例
将所有项读取到数组。
const {body: containerList} = await items.readAll().fetchAll();
function readAll<T>(options?: FeedOptions): QueryIterator<T>
参数
- options
- FeedOptions
用于修改请求(例如,指定分区键)。
返回
readChangeFeed(ChangeFeedOptions)
警告
现已弃用此 API。
Use changeFeed
instead.
创建一个 ChangeFeedIterator
来循环访问更改页面
function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>
参数
- changeFeedOptions
- ChangeFeedOptions
返回
ChangeFeedIterator<any>
readChangeFeed(PartitionKey, ChangeFeedOptions)
警告
现已弃用此 API。
Use changeFeed
instead.
创建一个 ChangeFeedIterator
来循环访问更改页面
示例
从更改源的开头读取。
const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
function readChangeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>
参数
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
返回
ChangeFeedIterator<any>
readChangeFeed<T>(ChangeFeedOptions)
警告
现已弃用此 API。
Use changeFeed
instead.
创建一个 ChangeFeedIterator
来循环访问更改页面
function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
参数
- changeFeedOptions
- ChangeFeedOptions
返回
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)
警告
现已弃用此 API。
Use changeFeed
instead.
创建一个 ChangeFeedIterator
来循环访问更改页面
function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>
参数
- partitionKey
- PartitionKey
- changeFeedOptions
- ChangeFeedOptions
返回
upsert(unknown, RequestOptions)
向上插入项。
JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。
function upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>
参数
- body
-
unknown
表示项的正文。 可以包含任意数量的用户定义的属性。
- options
- RequestOptions
用于修改请求(例如,指定分区键)。
返回
Promise<ItemResponse<ItemDefinition>>
upsert<T>(T, RequestOptions)
向上插入项。
SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性,并且由逻辑来强制实施。
JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。
function upsert<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>
参数
- body
-
T
表示项的正文。 可以包含任意数量的用户定义的属性。
- options
- RequestOptions
用于修改请求(例如,指定分区键)。
返回
Promise<ItemResponse<T>>