Bagikan melalui

Containers class

Paket:
@azure/cosmos

Operasi untuk membuat kontainer baru, dan membaca/mengkueri semua kontainer

Lihat Kontainer untuk membaca, mengganti, atau menghapus kontainer yang ada; gunakan .container(id).

Catatan: semua operasi ini melakukan panggilan terhadap anggaran tetap. Anda harus merancang sistem Anda sih sehingga panggilan ini menskalakan secara sublinear dengan aplikasi Anda. Misalnya, jangan memanggil containers.readAll() sebelum setiap panggilan item.read(), untuk memastikan kontainer ada; lakukan ini setelah aplikasi dimulai.

Properti

database

Metode

create(ContainerRequest, RequestOptions)

Membuat kontainer.

Kontainer adalah kontainer logis bernama untuk item.

Database mungkin berisi nol atau lebih kontainer bernama dan setiap kontainer terdiri dari nol atau lebih item JSON.

Bebas skema, item dalam kontainer tidak perlu berbagi struktur atau bidang yang sama.

Karena kontainer adalah sumber daya aplikasi, kontainer dapat diotorisasi menggunakan kunci master atau kunci sumber daya.

Contoh

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)

Memeriksa apakah Kontainer ada, dan, jika tidak, membuatnya. Ini akan membuat operasi baca berdasarkan id di body, maka jika tidak ditemukan, operasi buat. Anda harus mengonfirmasi bahwa output cocok dengan isi yang Anda lewati untuk properti non-default (yaitu kebijakan pengindeksan/dll.)

Kontainer adalah kontainer logis bernama untuk item.

Database mungkin berisi nol atau lebih kontainer bernama dan setiap kontainer terdiri dari nol atau lebih item JSON.

Bebas skema, item dalam kontainer tidak perlu berbagi struktur atau bidang yang sama.

Karena kontainer adalah sumber daya aplikasi, kontainer dapat diotorisasi menggunakan kunci master atau kunci sumber daya.

Contoh

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)

Mengkueri semua kontainer.

Contoh

Baca semua kontainer untuk array.

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)

Mengkueri semua kontainer.

Contoh

Baca semua kontainer untuk array.

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)

Membaca semua kontainer.

Contoh

Baca semua kontainer untuk array.

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

Detail Properti

database 

database: Database

Nilai Properti

Database

Detail Metode

create(ContainerRequest, RequestOptions)

Membuat kontainer.

Kontainer adalah kontainer logis bernama untuk item.

Database mungkin berisi nol atau lebih kontainer bernama dan setiap kontainer terdiri dari nol atau lebih item JSON.

Bebas skema, item dalam kontainer tidak perlu berbagi struktur atau bidang yang sama.

Karena kontainer adalah sumber daya aplikasi, kontainer dapat diotorisasi menggunakan kunci master atau kunci sumber daya.

Contoh

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>

Parameter

body
ContainerRequest

Mewakili isi kontainer.

options
RequestOptions

Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.

Mengembalikan

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Memeriksa apakah Kontainer ada, dan, jika tidak, membuatnya. Ini akan membuat operasi baca berdasarkan id di body, maka jika tidak ditemukan, operasi buat. Anda harus mengonfirmasi bahwa output cocok dengan isi yang Anda lewati untuk properti non-default (yaitu kebijakan pengindeksan/dll.)

Kontainer adalah kontainer logis bernama untuk item.

Database mungkin berisi nol atau lebih kontainer bernama dan setiap kontainer terdiri dari nol atau lebih item JSON.

Bebas skema, item dalam kontainer tidak perlu berbagi struktur atau bidang yang sama.

Karena kontainer adalah sumber daya aplikasi, kontainer dapat diotorisasi menggunakan kunci master atau kunci sumber daya.

Contoh

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>

Parameter

body
ContainerRequest

Mewakili isi kontainer.

options
RequestOptions

Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.

Mengembalikan

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Mengkueri semua kontainer.

Contoh

Baca semua kontainer untuk array.

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>

Parameter

query
SqlQuerySpec

Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara mengonfigurasi kueri.

options
FeedOptions

Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.

Mengembalikan

QueryIterator<any>

QueryIterator Memungkinkan Anda mengembalikan kontainer tertentu dalam array atau mengulanginya satu per satu.

query<T>(SqlQuerySpec, FeedOptions)

Mengkueri semua kontainer.

Contoh

Baca semua kontainer untuk array.

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>

Parameter

query
SqlQuerySpec

Konfigurasi kueri untuk operasi. Lihat SqlQuerySpec untuk informasi selengkapnya tentang cara mengonfigurasi kueri.

options
FeedOptions

Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.

Mengembalikan

QueryIterator<T>

QueryIterator Memungkinkan Anda mengembalikan kontainer tertentu dalam array atau mengulanginya satu per satu.

readAll(FeedOptions)

Membaca semua kontainer.

Contoh

Baca semua kontainer untuk array.

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>

Parameter

options
FeedOptions

Gunakan untuk mengatur opsi seperti ukuran halaman respons, token kelanjutan, dll.

Mengembalikan

QueryIterator<ContainerDefinition & Resource>

QueryIterator Memungkinkan Anda mengembalikan semua kontainer dalam array atau melakukan iterasi satu per satu.