Udostępnij za pomocą

Containers class

Pakiet:
@azure/cosmos

Operacje tworzenia nowych kontenerów i odczytywania/wykonywania zapytań dotyczących wszystkich kontenerów

Zobacz Container, aby uzyskać informacje na temat odczytywania, zastępowania lub usuwania istniejącego kontenera; użyj .container(id).

Uwaga: wszystkie te operacje tworzą wywołania względem stałego budżetu. Należy zaprojektować system tak, aby te wywołania były skalowane podlinearnie z aplikacją. Na przykład nie należy wywoływać containers.readAll() przed każdym wywołaniem item.read(), aby upewnić się, że kontener istnieje; zrób to raz podczas uruchamiania aplikacji.

Właściwości

database

Metody

create(ContainerRequest, RequestOptions)

Tworzy kontener.

Kontener jest nazwanym kontenerem logicznym dla elementów.

Baza danych może zawierać zero lub więcej nazwanych kontenerów, a każdy kontener składa się z co najmniej zera elementów JSON.

Bez schematu elementy w kontenerze nie muszą współdzielić tej samej struktury ani pól.

Ponieważ kontenery są zasobami aplikacji, można je autoryzować przy użyciu klucza głównego lub kluczy zasobów.

Przykład

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)

Sprawdza, czy kontener istnieje, a jeśli nie, tworzy go. Spowoduje to wykonanie operacji odczytu na podstawie identyfikatora w body, a jeśli nie zostanie znaleziona, operacja tworzenia. Należy potwierdzić, że dane wyjściowe są zgodne z treścią przekazaną dla właściwości innych niż domyślne (np. zasady indeksowania/itp.)

Kontener jest nazwanym kontenerem logicznym dla elementów.

Baza danych może zawierać zero lub więcej nazwanych kontenerów, a każdy kontener składa się z co najmniej zera elementów JSON.

Bez schematu elementy w kontenerze nie muszą współdzielić tej samej struktury ani pól.

Ponieważ kontenery są zasobami aplikacji, można je autoryzować przy użyciu klucza głównego lub kluczy zasobów.

Przykład

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)

Wykonuje zapytania dotyczące wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy.

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)

Wykonuje zapytania dotyczące wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy.

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)

Odczytywanie wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy.

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

Szczegóły właściwości

database 

database: Database

Wartość właściwości

Database

Szczegóły metody

create(ContainerRequest, RequestOptions)

Tworzy kontener.

Kontener jest nazwanym kontenerem logicznym dla elementów.

Baza danych może zawierać zero lub więcej nazwanych kontenerów, a każdy kontener składa się z co najmniej zera elementów JSON.

Bez schematu elementy w kontenerze nie muszą współdzielić tej samej struktury ani pól.

Ponieważ kontenery są zasobami aplikacji, można je autoryzować przy użyciu klucza głównego lub kluczy zasobów.

Przykład

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

Reprezentuje treść kontenera.

options
RequestOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Sprawdza, czy kontener istnieje, a jeśli nie, tworzy go. Spowoduje to wykonanie operacji odczytu na podstawie identyfikatora w body, a jeśli nie zostanie znaleziona, operacja tworzenia. Należy potwierdzić, że dane wyjściowe są zgodne z treścią przekazaną dla właściwości innych niż domyślne (np. zasady indeksowania/itp.)

Kontener jest nazwanym kontenerem logicznym dla elementów.

Baza danych może zawierać zero lub więcej nazwanych kontenerów, a każdy kontener składa się z co najmniej zera elementów JSON.

Bez schematu elementy w kontenerze nie muszą współdzielić tej samej struktury ani pól.

Ponieważ kontenery są zasobami aplikacji, można je autoryzować przy użyciu klucza głównego lub kluczy zasobów.

Przykład

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

Reprezentuje treść kontenera.

options
RequestOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Wykonuje zapytania dotyczące wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy.

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

Wykonywanie zapytań o konfigurację operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec.

options
FeedOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<any>

QueryIterator Umożliwia zwracanie określonych kontenerów w tablicy lub iterowanie ich pojedynczo.

query<T>(SqlQuerySpec, FeedOptions)

Wykonuje zapytania dotyczące wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy.

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

Wykonywanie zapytań o konfigurację operacji. Aby uzyskać więcej informacji na temat konfigurowania zapytania, zobacz SqlQuerySpec.

options
FeedOptions

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<T>

QueryIterator Umożliwia zwracanie określonych kontenerów w tablicy lub iterowanie ich pojedynczo.

readAll(FeedOptions)

Odczytywanie wszystkich kontenerów.

Przykład

Odczytywanie wszystkich kontenerów do tablicy.

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

Służy do ustawiania opcji, takich jak rozmiar strony odpowiedzi, tokeny kontynuacji itp.

Zwraca

QueryIterator<ContainerDefinition & Resource>

QueryIterator Umożliwia zwrócenie wszystkich kontenerów w tablicy lub iterowanie ich pojedynczo.