Class Items

Readonlycontainer

batch

• batch(operations, partitionKey?, options?): Promise<Response<OperationResponse[]>>

• Execute transactional batch operations on items.

  Batch takes an array of Operations which are typed based on what the operation does. Batch is transactional and will rollback all operations if one fails. The choices are: Create, Upsert, Read, Replace, and Delete

  Usage example:

  // 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")
  Copy

  Parameters

  • operations: OperationInput[]

    List of operations. Limit 100
  • OptionalpartitionKey: PartitionKey
  • Optionaloptions: RequestOptions

    Used for modifying the request

  Returns Promise<Response<OperationResponse[]>>

bulk

• bulk(operations, bulkOptions?, options?): Promise<BulkOperationResponse>

• Execute bulk operations on items.

  Bulk takes an array of Operations which are typed based on what the operation does. The choices are: Create, Upsert, Read, Replace, and Delete

  Usage example:

  // 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)
  Copy

  Parameters

  • operations: OperationInput[]

    List of operations. Limit 100
  • OptionalbulkOptions: BulkOptions

    Optional options object to modify bulk behavior. Pass { continueOnError: false } to stop executing operations when one fails. (Defaults to true)
  • Optionaloptions: RequestOptions

    Used for modifying the request.

  Returns Promise<BulkOperationResponse>

changeFeed

• changeFeed(partitionKey, changeFeedOptions?): ChangeFeedIterator<any>

• Create a ChangeFeedIterator to iterate over pages of changes

  Parameters

  • partitionKey: PartitionKey
  • OptionalchangeFeedOptions: ChangeFeedOptions

  Returns ChangeFeedIterator<any>

  Example: Read from the beginning of the change feed.

  const iterator = items.readChangeFeed({ startFromBeginning: true });
  const firstPage = await iterator.fetchNext();
  const firstPageResults = firstPage.result
  const secondPage = await iterator.fetchNext();
  Copy

• changeFeed(changeFeedOptions?): ChangeFeedIterator<any>

• Create a ChangeFeedIterator to iterate over pages of changes

  Parameters

  • OptionalchangeFeedOptions: ChangeFeedOptions

  Returns ChangeFeedIterator<any>
• changeFeed<T>(partitionKey, changeFeedOptions?): ChangeFeedIterator<T>

• Create a ChangeFeedIterator to iterate over pages of changes

  Type Parameters

  • T

  Parameters

  • partitionKey: PartitionKey
  • OptionalchangeFeedOptions: ChangeFeedOptions

  Returns ChangeFeedIterator<T>
• changeFeed<T>(changeFeedOptions?): ChangeFeedIterator<T>

• Create a ChangeFeedIterator to iterate over pages of changes

  Type Parameters

  • T

  Parameters

  • OptionalchangeFeedOptions: ChangeFeedOptions

  Returns ChangeFeedIterator<T>

create

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

• Create an item.

  Any provided type, T, is not necessarily enforced by the SDK. You may get more or less properties and it's up to your logic to enforce it.

  There is no set schema for JSON items. They may contain any number of custom properties.

  Type Parameters

  • T extends ItemDefinition = any

  Parameters

  • body: T

    Represents the body of the item. Can contain any number of user defined properties.
  • options: RequestOptions = {}

    Used for modifying the request (for instance, specifying the partition key).

  Returns Promise<ItemResponse<T>>

getChangeFeedIterator

• getChangeFeedIterator<T>(changeFeedIteratorOptions?): ChangeFeedPullModelIterator<T>

• Returns an iterator to iterate over pages of changes. The iterator returned can be used to fetch changes for a single partition key, feed range or an entire container.

  Type Parameters

  • T

  Parameters

  • OptionalchangeFeedIteratorOptions: ChangeFeedIteratorOptions

  Returns ChangeFeedPullModelIterator<T>

query

• query(query, options?): QueryIterator<any>

• Queries all items.

  Parameters

  • query: string | SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

    Used for modifying the request (for instance, specifying the partition key).

  Returns QueryIterator<any>

  Example: Read all items to array.

  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();
  Copy

• query<T>(query, options?): QueryIterator<T>

• Queries all items.

  Type Parameters

  • T

  Parameters

  • query: string | SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

    Used for modifying the request (for instance, specifying the partition key).

  Returns QueryIterator<T>

  Example: Read all items to array.

  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();
  Copy

readAll

• readAll(options?): QueryIterator<ItemDefinition>

• Read all items.

  There is no set schema for JSON items. They may contain any number of custom properties.

  Parameters

  • Optionaloptions: FeedOptions

    Used for modifying the request (for instance, specifying the partition key).

  Returns QueryIterator<ItemDefinition>

  Example: Read all items to array.

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

• readAll<T>(options?): QueryIterator<T>

• Read all items.

  Any provided type, T, is not necessarily enforced by the SDK. You may get more or less properties and it's up to your logic to enforce it.

  There is no set schema for JSON items. They may contain any number of custom properties.

  Type Parameters

  • T extends ItemDefinition

  Parameters

  • Optionaloptions: FeedOptions

    Used for modifying the request (for instance, specifying the partition key).

  Returns QueryIterator<T>

  Example: Read all items to array.

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

readChangeFeed

• readChangeFeed(partitionKey, changeFeedOptions?): ChangeFeedIterator<any>

• Create a ChangeFeedIterator to iterate over pages of changes

  Parameters

  • partitionKey: PartitionKey
  • OptionalchangeFeedOptions: ChangeFeedOptions

  Returns ChangeFeedIterator<any>

  Deprecated

  Use changeFeed instead.

  Example: Read from the beginning of the change feed.

  const iterator = items.readChangeFeed({ startFromBeginning: true });
  const firstPage = await iterator.fetchNext();
  const firstPageResults = firstPage.result
  const secondPage = await iterator.fetchNext();
  Copy

• readChangeFeed(changeFeedOptions?): ChangeFeedIterator<any>

• Create a ChangeFeedIterator to iterate over pages of changes

  Parameters

  • OptionalchangeFeedOptions: ChangeFeedOptions

  Returns ChangeFeedIterator<any>

  Deprecated

  Use changeFeed instead.

• readChangeFeed<T>(partitionKey, changeFeedOptions?): ChangeFeedIterator<T>

• Create a ChangeFeedIterator to iterate over pages of changes

  Type Parameters

  • T

  Parameters

  • partitionKey: PartitionKey
  • OptionalchangeFeedOptions: ChangeFeedOptions

  Returns ChangeFeedIterator<T>

  Deprecated

  Use changeFeed instead.

• readChangeFeed<T>(changeFeedOptions?): ChangeFeedIterator<T>

• Create a ChangeFeedIterator to iterate over pages of changes

  Type Parameters

  • T

  Parameters

  • OptionalchangeFeedOptions: ChangeFeedOptions

  Returns ChangeFeedIterator<T>

  Deprecated

  Use changeFeed instead.

upsert

• upsert(body, options?): Promise<ItemResponse<ItemDefinition>>

• Upsert an item.

  There is no set schema for JSON items. They may contain any number of custom properties.

  Parameters

  • body: unknown

    Represents the body of the item. Can contain any number of user defined properties.
  • Optionaloptions: RequestOptions

    Used for modifying the request (for instance, specifying the partition key).

  Returns Promise<ItemResponse<ItemDefinition>>
• upsert<T>(body, options?): Promise<ItemResponse<T>>

• Upsert an item.

  Any provided type, T, is not necessarily enforced by the SDK. You may get more or less properties and it's up to your logic to enforce it.

  There is no set schema for JSON items. They may contain any number of custom properties.

  Type Parameters

  • T extends ItemDefinition

  Parameters

  • body: T

    Represents the body of the item. Can contain any number of user defined properties.
  • Optionaloptions: RequestOptions

    Used for modifying the request (for instance, specifying the partition key).

  Returns Promise<ItemResponse<T>>