Sdílet prostřednictvím

Containers class

Balíček:
@azure/cosmos

Operace pro vytváření nových kontejnerů a čtení /dotazování všech kontejnerů

Informace o čtení, nahrazení nebo odstranění existujícího kontejneru najdete v kontejneru. použít .container(id).

Poznámka: Všechny tyto operace vyžadují pevné rozpočty. Systém byste měli navrhnout tak, aby tato volání škálovat podlineárně s vaší aplikací. Například nevolejte containers.readAll() před každým voláním item.read(), aby se zajistilo, že kontejner existuje; proveďte to jednou při spuštění aplikace.

Vlastnosti

database

Metody

create(ContainerRequest, RequestOptions)

Vytvoří kontejner.

Kontejner je pojmenovaný logický kontejner pro položky.

Databáze může obsahovat nula nebo více pojmenovaných kontejnerů a každý kontejner se skládá z nuly nebo více položek JSON.

Bez schématu nemusí položky v kontejneru sdílet stejnou strukturu nebo pole.

Vzhledem k tomu, že kontejnery jsou prostředky aplikace, je možné je autorizovat pomocí hlavního klíče nebo klíčů prostředků.

příklad 

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)

Zkontroluje, jestli kontejner existuje, a pokud ne, vytvoří ho. Tím se provede operace čtení na základě ID v body, a pokud se nenajde, operace vytvoření. Měli byste potvrdit, že výstup odpovídá textu, který jste předali pro jiné než výchozí vlastnosti (tj. zásady indexování/atd.).

Kontejner je pojmenovaný logický kontejner pro položky.

Databáze může obsahovat nula nebo více pojmenovaných kontejnerů a každý kontejner se skládá z nuly nebo více položek JSON.

Bez schématu nemusí položky v kontejneru sdílet stejnou strukturu nebo pole.

Vzhledem k tomu, že kontejnery jsou prostředky aplikace, je možné je autorizovat pomocí hlavního klíče nebo klíčů prostředků.

příklad 

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)

Dotazuje se na všechny kontejnery.

příklad

Čtení všech kontejnerů do pole

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)

Dotazuje se na všechny kontejnery.

příklad

Čtení všech kontejnerů do pole

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)

Čtení všech kontejnerů

příklad

Čtení všech kontejnerů do pole

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

Podrobnosti vlastnosti

database 

database: Database

Hodnota vlastnosti

Database

Podrobnosti metody

create(ContainerRequest, RequestOptions)

Vytvoří kontejner.

Kontejner je pojmenovaný logický kontejner pro položky.

Databáze může obsahovat nula nebo více pojmenovaných kontejnerů a každý kontejner se skládá z nuly nebo více položek JSON.

Bez schématu nemusí položky v kontejneru sdílet stejnou strukturu nebo pole.

Vzhledem k tomu, že kontejnery jsou prostředky aplikace, je možné je autorizovat pomocí hlavního klíče nebo klíčů prostředků.

příklad 

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>

Parametry

body
ContainerRequest

Představuje tělo kontejneru.

options
RequestOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Zkontroluje, jestli kontejner existuje, a pokud ne, vytvoří ho. Tím se provede operace čtení na základě ID v body, a pokud se nenajde, operace vytvoření. Měli byste potvrdit, že výstup odpovídá textu, který jste předali pro jiné než výchozí vlastnosti (tj. zásady indexování/atd.).

Kontejner je pojmenovaný logický kontejner pro položky.

Databáze může obsahovat nula nebo více pojmenovaných kontejnerů a každý kontejner se skládá z nuly nebo více položek JSON.

Bez schématu nemusí položky v kontejneru sdílet stejnou strukturu nebo pole.

Vzhledem k tomu, že kontejnery jsou prostředky aplikace, je možné je autorizovat pomocí hlavního klíče nebo klíčů prostředků.

příklad 

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>

Parametry

body
ContainerRequest

Představuje tělo kontejneru.

options
RequestOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Dotazuje se na všechny kontejnery.

příklad

Čtení všech kontejnerů do pole

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>

Parametry

query
SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

QueryIterator<any>

QueryIterator Umožňuje vracet konkrétní kontejnery v poli nebo je postupně iterovat.

query<T>(SqlQuerySpec, FeedOptions)

Dotazuje se na všechny kontejnery.

příklad

Čtení všech kontejnerů do pole

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>

Parametry

query
SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

QueryIterator<T>

QueryIterator Umožňuje vracet konkrétní kontejnery v poli nebo je postupně iterovat.

readAll(FeedOptions)

Čtení všech kontejnerů

příklad

Čtení všech kontejnerů do pole

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>

Parametry

options
FeedOptions

Slouží k nastavení možností, jako je velikost stránky odpovědi, tokeny pokračování atd.

Návraty

QueryIterator<ContainerDefinition & Resource>

QueryIterator Umožňuje vrátit všechny kontejnery v poli nebo je postupně iterovat.