Containers class
新しいコンテナーを作成し、すべてのコンテナーの読み取り/クエリを実行するための操作
既存 のコンテナー の読み取り、置換、または削除については、「コンテナー」を参照してください。を使用します .container(id)。
注: これらの操作はすべて、固定予算に対して呼び出しを行います。
これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるように、システムを設計する必要があります。
たとえば、コンテナーが存在することを確認するために、1 回item.read()の呼び出しの前に を呼び出containers.readAll()さないでください。これは、アプリケーションの起動時に 1 回行います。
コンストラクター
| Containers(Database, Client |
プロパティ
| database |
メソッド
| create(Container |
コンテナーを作成します。 コンテナーは、項目の名前付き論理コンテナーです。 データベースには 0 個以上の名前付きコンテナーを含め、各コンテナーは 0 個以上の JSON 項目で構成されます。 スキーマフリーのコンテナー内の項目は、同じ構造またはフィールドを共有する必要はありません。 コンテナーはアプリケーション リソースであるため、マスター キーまたはリソース キーを使用して承認できます。 |
| create |
コンテナーが存在するかどうかを確認し、存在しない場合は作成します。
これにより、 の コンテナーは、項目の名前付き論理コンテナーです。 データベースには 0 個以上の名前付きコンテナーを含め、各コンテナーは 0 個以上の JSON 項目で構成されます。 スキーマフリーのコンテナー内の項目は、同じ構造またはフィールドを共有する必要はありません。 コンテナーはアプリケーション リソースであるため、マスター キーまたはリソース キーを使用して承認できます。 |
| query(Sql |
すべてのコンテナーに対してクエリを実行します。 例 すべてのコンテナーを配列に読み取る。
* |
| query<T>(Sql |
すべてのコンテナーに対してクエリを実行します。 例 すべてのコンテナーを配列に読み取る。
* |
| read |
すべてのコンテナーを読み取る。 例 すべてのコンテナーを配列に読み取る。
* |
コンストラクターの詳細
Containers(Database, ClientContext)
new Containers(database: Database, clientContext: ClientContext)パラメーター
- database
- Database
- clientContext
-
ClientContext
プロパティの詳細
database
メソッドの詳細
create(ContainerRequest, RequestOptions)
コンテナーを作成します。
コンテナーは、項目の名前付き論理コンテナーです。
データベースには 0 個以上の名前付きコンテナーを含め、各コンテナーは 0 個以上の JSON 項目で構成されます。
スキーマフリーのコンテナー内の項目は、同じ構造またはフィールドを共有する必要はありません。
コンテナーはアプリケーション リソースであるため、マスター キーまたはリソース キーを使用して承認できます。
function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>パラメーター
- body
- ContainerRequest
コンテナーの本文を表します。
- options
- RequestOptions
応答ページ サイズ、継続トークンなどのオプションを設定するために使用します。
戻り値
Promise<ContainerResponse>
createIfNotExists(ContainerRequest, RequestOptions)
コンテナーが存在するかどうかを確認し、存在しない場合は作成します。
これにより、 の bodyID に基づいて読み取り操作が行われます。見つからない場合は作成操作です。
既定以外のプロパティ (インデックス作成ポリシーなど) に渡した本文と出力が一致することを確認する必要があります。
コンテナーは、項目の名前付き論理コンテナーです。
データベースには 0 個以上の名前付きコンテナーを含め、各コンテナーは 0 個以上の JSON 項目で構成されます。
スキーマフリーのコンテナー内の項目は、同じ構造またはフィールドを共有する必要はありません。
コンテナーはアプリケーション リソースであるため、マスター キーまたはリソース キーを使用して承認できます。
function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>パラメーター
- body
- ContainerRequest
コンテナーの本文を表します。
- options
- RequestOptions
応答ページ サイズ、継続トークンなどのオプションを設定するために使用します。
戻り値
Promise<ContainerResponse>
query(SqlQuerySpec, FeedOptions)
すべてのコンテナーに対してクエリを実行します。
例
すべてのコンテナーを配列に読み取る。
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>パラメーター
- query
- SqlQuerySpec
操作のクエリ構成。 クエリを構成する方法の詳細については、「 SqlQuerySpec 」を参照してください。
- options
- FeedOptions
応答ページ サイズ、継続トークンなどのオプションを設定するために使用します。
戻り値
QueryIterator<any>
QueryIterator 配列内の特定のコンテナーを返したり、一度に 1 つずつ反復処理したりできます。 *
query<T>(SqlQuerySpec, FeedOptions)
すべてのコンテナーに対してクエリを実行します。
例
すべてのコンテナーを配列に読み取る。
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>パラメーター
- query
- SqlQuerySpec
操作のクエリ構成。 クエリを構成する方法の詳細については、「 SqlQuerySpec 」を参照してください。
- options
- FeedOptions
応答ページ サイズ、継続トークンなどのオプションを設定するために使用します。
戻り値
QueryIterator 配列内の特定のコンテナーを返したり、一度に 1 つずつ反復処理したりできます。 *
readAll(FeedOptions)
すべてのコンテナーを読み取る。
例
すべてのコンテナーを配列に読み取る。
* typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>パラメーター
- options
- FeedOptions
応答ページ サイズ、継続トークンなどのオプションを設定するために使用します。
戻り値
QueryIterator 配列内のすべてのコンテナーを返したり、一度に 1 つずつ反復処理したりできます。 *