Containers class

套件:

@azure/cosmos

建立新容器和讀取/查詢所有容器的作業

如需讀取、取代或刪除現有容器，請參閱 容器;使用 .container(id)。

注意：所有這些作業都會針對固定預算進行呼叫。 您應該設計您的系統，讓這些呼叫以子線性方式調整您的應用程式。 例如，在每次呼叫 containers.readAll() 之前，請勿呼叫 item.read()，以確保容器存在;在應用程式啟動時執行此動作。

屬性

database

方法

create(ContainerRequest, RequestOptions)	建立容器。 容器是專案的具名邏輯容器。 資料庫可能包含零個或多個具名容器，而且每個容器都包含零個或多個 JSON 專案。 無架構，容器中的專案不需要共用相同的結構或欄位。 由於容器是應用程式資源，因此可以使用主要密鑰或資源金鑰來獲得授權。 範例 import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const container = client.database("<database id>").containers.create({ id: "<name here>", });
createIfNotExists(ContainerRequest, RequestOptions)	檢查容器是否存在，如果容器不存在，則會建立它。 這會根據 body中的標識符進行讀取作業，如果找不到，則會建立作業。 您應該確認輸出符合您針對非預設屬性傳入的主體（例如編制索引原則/等等） 容器是專案的具名邏輯容器。 資料庫可能包含零個或多個具名容器，而且每個容器都包含零個或多個 JSON 專案。 無架構，容器中的專案不需要共用相同的結構或欄位。 由於容器是應用程式資源，因此可以使用主要密鑰或資源金鑰來獲得授權。 範例 import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" });
query(SqlQuerySpec, FeedOptions)	查詢所有容器。 範例 讀取所有容器至陣列。 import { CosmosClient, SqlQuerySpec } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const querySpec: SqlQuerySpec = { query: `SELECT * FROM root r WHERE r.id = @container`, parameters: [{ name: "@container", value: "Todo" }], }; const { resources: containerList } = await client .database("<db id>") .containers.query(querySpec) .fetchAll();
query<T>(SqlQuerySpec, FeedOptions)	查詢所有容器。 範例 讀取所有容器至陣列。 import { CosmosClient, SqlQuerySpec } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const querySpec: SqlQuerySpec = { query: `SELECT * FROM root r WHERE r.id = @container`, parameters: [{ name: "@container", value: "Todo" }], }; const { resources: containerList } = await client .database("<db id>") .containers.query(querySpec) .fetchAll();
readAll(FeedOptions)	讀取所有容器。 範例 讀取所有容器至陣列。 import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { resources: containerList } = await client .database("<db id>") .containers.readAll() .fetchAll();

屬性詳細資料

database

database: Database

屬性值

Database

方法詳細資料

create(ContainerRequest, RequestOptions)

建立容器。

容器是專案的具名邏輯容器。

資料庫可能包含零個或多個具名容器，而且每個容器都包含零個或多個 JSON 專案。

無架構，容器中的專案不需要共用相同的結構或欄位。

由於容器是應用程式資源，因此可以使用主要密鑰或資源金鑰來獲得授權。

範例

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const container = client.database("<database id>").containers.create({
  id: "<name here>",
});

function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

參數

body

ContainerRequest

表示容器的主體。

options

RequestOptions

使用 來設定回應頁面大小、接續令牌等選項。

傳回

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

檢查容器是否存在，如果容器不存在，則會建立它。 這會根據 body中的標識符進行讀取作業，如果找不到，則會建立作業。 您應該確認輸出符合您針對非預設屬性傳入的主體（例如編制索引原則/等等）

容器是專案的具名邏輯容器。

資料庫可能包含零個或多個具名容器，而且每個容器都包含零個或多個 JSON 專案。

無架構，容器中的專案不需要共用相同的結構或欄位。

由於容器是應用程式資源，因此可以使用主要密鑰或資源金鑰來獲得授權。

範例

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

參數

body

ContainerRequest

表示容器的主體。

options

RequestOptions

使用 來設定回應頁面大小、接續令牌等選項。

傳回

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

查詢所有容器。

範例

讀取所有容器至陣列。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @container`,
  parameters: [{ name: "@container", value: "Todo" }],
};
const { resources: 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 可讓您傳回陣列中的特定容器，或逐一逐一查看它們。

query<T>(SqlQuerySpec, FeedOptions)

查詢所有容器。

範例

讀取所有容器至陣列。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @container`,
  parameters: [{ name: "@container", value: "Todo" }],
};
const { resources: 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<T>

QueryIterator 可讓您傳回陣列中的特定容器，或逐一逐一查看它們。

readAll(FeedOptions)

讀取所有容器。

範例

讀取所有容器至陣列。

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { resources: containerList } = await client
  .database("<db id>")
  .containers.readAll()
  .fetchAll();

function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>

參數

options

FeedOptions

使用 來設定回應頁面大小、接續令牌等選項。

傳回

QueryIterator<ContainerDefinition & Resource>

QueryIterator 可讓您傳回陣列中的所有容器，或逐一逐一查看它們。