Dela via

Containers class

Paket:
@azure/cosmos

Åtgärder för att skapa nya containrar och läsa/köra frågor mot alla containrar

Se Container för att läsa, ersätta eller ta bort en befintlig container. använd .container(id).

Obs! Alla dessa åtgärder anropar en fast budget. Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program. Anropa till exempel inte containers.readAll() innan varje enskilt item.read() anrop för att säkerställa att containern finns. gör detta en gång när programmet startas.

Egenskaper

database

Metoder

create(ContainerRequest, RequestOptions)

Skapar en container.

En container är en namngiven logisk container för objekt.

En databas kan innehålla noll eller fler namngivna containrar och varje container består av noll eller fler JSON-objekt.

Eftersom objekten i en container är schemafria behöver de inte dela samma struktur eller fält.

Eftersom containrar är programresurser kan de auktoriseras med antingen huvudnyckeln eller resursnycklarna.

Exempel

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)

Kontrollerar om det finns en container och skapar den om den inte gör det. Detta gör en läsåtgärd baserat på ID:t i body, och om det inte hittas, en skapandeåtgärd. Du bör bekräfta att utdata matchar brödtexten som du skickade för icke-standardegenskaper (dvs. indexeringsprincip/etc.)

En container är en namngiven logisk container för objekt.

En databas kan innehålla noll eller fler namngivna containrar och varje container består av noll eller fler JSON-objekt.

Eftersom objekten i en container är schemafria behöver de inte dela samma struktur eller fält.

Eftersom containrar är programresurser kan de auktoriseras med antingen huvudnyckeln eller resursnycklarna.

Exempel

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)

Kör frågor mot alla containrar.

Exempel

Läs alla containrar till matrisen.

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)

Kör frågor mot alla containrar.

Exempel

Läs alla containrar till matrisen.

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)

Läs alla containrar.

Exempel

Läs alla containrar till matrisen.

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

Egenskapsinformation

database 

database: Database

Egenskapsvärde

Database

Metodinformation

create(ContainerRequest, RequestOptions)

Skapar en container.

En container är en namngiven logisk container för objekt.

En databas kan innehålla noll eller fler namngivna containrar och varje container består av noll eller fler JSON-objekt.

Eftersom objekten i en container är schemafria behöver de inte dela samma struktur eller fält.

Eftersom containrar är programresurser kan de auktoriseras med antingen huvudnyckeln eller resursnycklarna.

Exempel

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>

Parametrar

body
ContainerRequest

Representerar innehållet i containern.

options
RequestOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Kontrollerar om det finns en container och skapar den om den inte gör det. Detta gör en läsåtgärd baserat på ID:t i body, och om det inte hittas, en skapandeåtgärd. Du bör bekräfta att utdata matchar brödtexten som du skickade för icke-standardegenskaper (dvs. indexeringsprincip/etc.)

En container är en namngiven logisk container för objekt.

En databas kan innehålla noll eller fler namngivna containrar och varje container består av noll eller fler JSON-objekt.

Eftersom objekten i en container är schemafria behöver de inte dela samma struktur eller fält.

Eftersom containrar är programresurser kan de auktoriseras med antingen huvudnyckeln eller resursnycklarna.

Exempel

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>

Parametrar

body
ContainerRequest

Representerar innehållet i containern.

options
RequestOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Kör frågor mot alla containrar.

Exempel

Läs alla containrar till matrisen.

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>

Parametrar

query
SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec.

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator<any>

QueryIterator Gör att du kan returnera specifika containrar i en matris eller iterera över dem en i taget.

query<T>(SqlQuerySpec, FeedOptions)

Kör frågor mot alla containrar.

Exempel

Läs alla containrar till matrisen.

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>

Parametrar

query
SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec.

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator<T>

QueryIterator Gör att du kan returnera specifika containrar i en matris eller iterera över dem en i taget.

readAll(FeedOptions)

Läs alla containrar.

Exempel

Läs alla containrar till matrisen.

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>

Parametrar

options
FeedOptions

Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.

Returer

QueryIterator<ContainerDefinition & Resource>

QueryIterator Gör att du kan returnera alla containrar i en matris eller iterera över dem en i taget.