Items class

container: Container

属性值

对项执行事务批处理作。

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[]>>

参数

返回

对项执行批量作。

大容量采用基于作执行的作类型的作数组。 选项包括：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>

参数

返回

创建一个 ChangeFeedIterator 来循环访问更改页面

function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

参数

返回

创建一个 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>

参数

返回

创建一个 ChangeFeedIterator 来循环访问更改页面

function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

参数

返回

创建一个 ChangeFeedIterator 来循环访问更改页面

function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

参数

返回

创建项。

SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性，并且由逻辑来强制实施。

JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。

function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

参数

返回

返回迭代器以循环访问更改页。 返回的迭代器可用于提取单个分区键、源范围或整个容器的更改。

function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>

参数

返回

查询所有项。

示例

将所有项读取到数组。

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>

参数

返回

查询所有项。

示例

将所有项读取到数组。

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>

参数

返回

读取所有项。

JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。

示例

将所有项读取到数组。

const {body: containerList} = await items.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

参数

返回

读取所有项。

SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性，并且由逻辑来强制实施。

JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。

示例

将所有项读取到数组。

const {body: containerList} = await items.readAll().fetchAll();

function readAll<T>(options?: FeedOptions): QueryIterator<T>

参数

返回

创建一个 ChangeFeedIterator 来循环访问更改页面

function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

参数

返回

创建一个 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>

参数

返回

创建一个 ChangeFeedIterator 来循环访问更改页面

function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

参数

返回

创建一个 ChangeFeedIterator 来循环访问更改页面

function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

参数

返回

向上插入项。

JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。

function upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>

参数

返回

向上插入项。

SDK 不一定强制实施任何提供的类型 T。 可能会获取或多或少的属性，并且由逻辑来强制实施。

JSON 项没有设置架构。 它们可能包含任意数量的自定义属性。

function upsert<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

参数

返回