Items class

  • リファレンス
パッケージ:
@azure/cosmos

新しいアイテムを作成し、すべてのアイテムの読み取り/クエリを実行するための操作

既存のコンテナーの読み取り、置換、または削除については、「 項目 」を参照してください。を使用します .item(id)。

プロパティ

container

メソッド

batch(OperationInput[], PartitionKey, RequestOptions)

アイテムに対してトランザクション バッチ操作を実行します。

Batch は、操作の実行内容に基づいて型指定された Operations の配列を受け取ります。 Batch はトランザクションであり、失敗した場合は、すべての操作をロールバックします。 選択肢は、Create、Upsert、Read、Replace、Delete です。

使用例:

// partitionKey is required as a second argument to batch, but defaults to the default partition key
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.batch(operations)
bulk(OperationInput[], BulkOptions, RequestOptions)

アイテムに対して一括操作を実行します。

一括では、操作の実行内容に基づいて型指定された Operations の配列を受け取ります。 選択肢は、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)
changeFeed(ChangeFeedOptions)

変更のページを反復処理する を ChangeFeedIterator 作成する
changeFeed(PartitionKey, ChangeFeedOptions)

変更のページを反復処理する を ChangeFeedIterator 作成する

例

変更フィードの先頭から読み取ります。

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
changeFeed<T>(ChangeFeedOptions)

変更のページを反復処理する を ChangeFeedIterator 作成する
changeFeed<T>(PartitionKey, ChangeFeedOptions)

変更のページを反復処理する を ChangeFeedIterator 作成する
create<T>(T, RequestOptions)

項目を作成します。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

変更のページを反復処理する反復子を返します。 返される反復子を使用して、1 つのパーティション キー、フィード範囲、またはコンテナー全体の変更をフェッチできます。
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();
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();
readAll(FeedOptions)

すべてのアイテムを読み取ります。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

例

すべての項目を配列に読み取ります。

const {body: containerList} = await items.readAll().fetchAll();
readAll<T>(FeedOptions)

すべてのアイテムを読み取ります。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

例

すべての項目を配列に読み取ります。

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

変更のページを反復処理する を ChangeFeedIterator 作成する
readChangeFeed(PartitionKey, ChangeFeedOptions)

変更のページを反復処理する を ChangeFeedIterator 作成する

例

変更フィードの先頭から読み取ります。

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

変更のページを反復処理する を ChangeFeedIterator 作成する
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

変更のページを反復処理する を ChangeFeedIterator 作成する
upsert(unknown, RequestOptions)

アイテムをアップサートします。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。
upsert<T>(T, RequestOptions)

アイテムをアップサートします。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

プロパティの詳細

container 

container: Container

プロパティ値

Container

メソッドの詳細

batch(OperationInput[], PartitionKey, RequestOptions)

アイテムに対してトランザクション バッチ操作を実行します。

Batch は、操作の実行内容に基づいて型指定された Operations の配列を受け取ります。 Batch はトランザクションであり、失敗した場合は、すべての操作をロールバックします。 選択肢は、Create、Upsert、Read、Replace、Delete です。

使用例:

// partitionKey is required as a second argument to batch, but defaults to the default partition key
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.batch(operations)

function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>

パラメーター

operations

OperationInput[]

操作の一覧。 制限 100

partitionKey
PartitionKey
options
RequestOptions

要求の変更に使用されます

戻り値

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

アイテムに対して一括操作を実行します。

一括では、操作の実行内容に基づいて型指定された Operations の配列を受け取ります。 選択肢は、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

OperationInput[]

操作の一覧。 制限 100

bulkOptions
BulkOptions

一括動作を変更するオプションの options オブジェクト。 { continueOnError: true } を渡して、失敗した場合に操作の実行を続行します。 (既定値は false) ** 注: 4.0 リリースでは、既定値は 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

戻り値

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

変更のページを反復処理する を ChangeFeedIterator 作成する

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

パラメーター

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

戻り値

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

項目を作成します。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

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

パラメーター

body

T

アイテムの本文を表します。 任意の数のユーザー定義プロパティを含めることができます。

options
RequestOptions

要求の変更に使用されます (パーティション キーの指定など)。

戻り値

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

変更のページを反復処理する反復子を返します。 返される反復子を使用して、1 つのパーティション キー、フィード範囲、またはコンテナー全体の変更をフェッチできます。

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

パラメーター

changeFeedIteratorOptions
ChangeFeedIteratorOptions

戻り値

ChangeFeedPullModelIterator<T>

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

要求の変更に使用されます (パーティション キーの指定など)。

戻り値

QueryIterator<T>

readAll(FeedOptions)

すべてのアイテムを読み取ります。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

例

すべての項目を配列に読み取ります。

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

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

パラメーター

options
FeedOptions

要求の変更に使用されます (パーティション キーの指定など)。

戻り値

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

すべてのアイテムを読み取ります。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

例

すべての項目を配列に読み取ります。

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

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

パラメーター

options
FeedOptions

要求の変更に使用されます (パーティション キーの指定など)。

戻り値

QueryIterator<T>

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

戻り値

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

警告

この API は非推奨になりました。

Use changeFeed instead.

変更のページを反復処理する を ChangeFeedIterator 作成する

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

パラメーター

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

戻り値

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

アイテムをアップサートします。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

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

パラメーター

body

unknown

アイテムの本文を表します。 任意の数のユーザー定義プロパティを含めることができます。

options
RequestOptions

要求の変更に使用されます (パーティション キーの指定など)。

戻り値

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

アイテムをアップサートします。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

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

パラメーター

body

T

アイテムの本文を表します。 任意の数のユーザー定義プロパティを含めることができます。

options
RequestOptions

要求の変更に使用されます (パーティション キーの指定など)。

戻り値

Promise<ItemResponse<T>>