Aracılığıyla paylaş

Containers class

Paket:
@azure/cosmos

Yeni kapsayıcılar oluşturma ve tüm kapsayıcıları okuma/sorgulama işlemleri

Mevcut kapsayıcıyı okumak, değiştirmek veya silmek için bkz. kapsayıcı ; .container(id)kullanın.

Not: Tüm bu işlemler sabit bir bütçeye göre çağrı yapar. Sisteminizi, bu çağrıların uygulamanızla birlikte alt satır olarak ölçeklendirilmesi için tasarlamanız gerekir. Örneğin, kapsayıcının mevcut olduğundan emin olmak için her containers.readAll() çağrısından önce item.read() çağırmayın; uygulama başlatılırken bunu bir kez yapın.

Özellikler

database

Yöntemler

create(ContainerRequest, RequestOptions)

Bir kapsayıcı oluşturur.

Kapsayıcı, öğeler için adlandırılmış bir mantıksal kapsayıcıdır.

Bir veritabanı sıfır veya daha fazla adlandırılmış kapsayıcı içerebilir ve her kapsayıcı sıfır veya daha fazla JSON öğesinden oluşur.

Şema içermeyen bir kapsayıcıdaki öğelerin aynı yapıyı veya alanları paylaşması gerekmez.

Kapsayıcılar uygulama kaynakları olduğundan, ana anahtar veya kaynak anahtarları kullanılarak yetkilendirilebilirler.

Örnek

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)

Kapsayıcının var olup olmadığını denetler ve yoksa oluşturur. Bu, bodyiçindeki kimliği temel alan bir okuma işlemi yapar ve bulunamazsa oluşturma işlemi yapar. Çıktının varsayılan olmayan özellikler (dizin oluşturma ilkesi vb.) için geçirilen gövdeyle eşleşdiğini onaylamanız gerekir.

Kapsayıcı, öğeler için adlandırılmış bir mantıksal kapsayıcıdır.

Bir veritabanı sıfır veya daha fazla adlandırılmış kapsayıcı içerebilir ve her kapsayıcı sıfır veya daha fazla JSON öğesinden oluşur.

Şema içermeyen bir kapsayıcıdaki öğelerin aynı yapıyı veya alanları paylaşması gerekmez.

Kapsayıcılar uygulama kaynakları olduğundan, ana anahtar veya kaynak anahtarları kullanılarak yetkilendirilebilirler.

Örnek

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)

Tüm kapsayıcıları sorgular.

Örnek

Diziye tüm kapsayıcıları okuyun.

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)

Tüm kapsayıcıları sorgular.

Örnek

Diziye tüm kapsayıcıları okuyun.

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)

Tüm kapsayıcıları okuyun.

Örnek

Diziye tüm kapsayıcıları okuyun.

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

Özellik Ayrıntıları

database 

database: Database

Özellik Değeri

Database

Yöntem Ayrıntıları

create(ContainerRequest, RequestOptions)

Bir kapsayıcı oluşturur.

Kapsayıcı, öğeler için adlandırılmış bir mantıksal kapsayıcıdır.

Bir veritabanı sıfır veya daha fazla adlandırılmış kapsayıcı içerebilir ve her kapsayıcı sıfır veya daha fazla JSON öğesinden oluşur.

Şema içermeyen bir kapsayıcıdaki öğelerin aynı yapıyı veya alanları paylaşması gerekmez.

Kapsayıcılar uygulama kaynakları olduğundan, ana anahtar veya kaynak anahtarları kullanılarak yetkilendirilebilirler.

Örnek

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>

Parametreler

body
ContainerRequest

Kapsayıcının gövdesini temsil eder.

options
RequestOptions

Yanıt sayfası boyutu, devamlılık belirteçleri vb. gibi seçenekleri ayarlamak için kullanın.

Döndürülenler

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Kapsayıcının var olup olmadığını denetler ve yoksa oluşturur. Bu, bodyiçindeki kimliği temel alan bir okuma işlemi yapar ve bulunamazsa oluşturma işlemi yapar. Çıktının varsayılan olmayan özellikler (dizin oluşturma ilkesi vb.) için geçirilen gövdeyle eşleşdiğini onaylamanız gerekir.

Kapsayıcı, öğeler için adlandırılmış bir mantıksal kapsayıcıdır.

Bir veritabanı sıfır veya daha fazla adlandırılmış kapsayıcı içerebilir ve her kapsayıcı sıfır veya daha fazla JSON öğesinden oluşur.

Şema içermeyen bir kapsayıcıdaki öğelerin aynı yapıyı veya alanları paylaşması gerekmez.

Kapsayıcılar uygulama kaynakları olduğundan, ana anahtar veya kaynak anahtarları kullanılarak yetkilendirilebilirler.

Örnek

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>

Parametreler

body
ContainerRequest

Kapsayıcının gövdesini temsil eder.

options
RequestOptions

Yanıt sayfası boyutu, devamlılık belirteçleri vb. gibi seçenekleri ayarlamak için kullanın.

Döndürülenler

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Tüm kapsayıcıları sorgular.

Örnek

Diziye tüm kapsayıcıları okuyun.

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>

Parametreler

query
SqlQuerySpec

İşlem için sorgu yapılandırması. Sorgu yapılandırma hakkında daha fazla bilgi için bkz. SqlQuerySpec.

options
FeedOptions

Yanıt sayfası boyutu, devamlılık belirteçleri vb. gibi seçenekleri ayarlamak için kullanın.

Döndürülenler

QueryIterator<any>

QueryIterator Bir dizideki belirli kapsayıcıları döndürmenize veya bunları birer birer yinelemenize olanak tanır.

query<T>(SqlQuerySpec, FeedOptions)

Tüm kapsayıcıları sorgular.

Örnek

Diziye tüm kapsayıcıları okuyun.

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>

Parametreler

query
SqlQuerySpec

İşlem için sorgu yapılandırması. Sorgu yapılandırma hakkında daha fazla bilgi için bkz. SqlQuerySpec.

options
FeedOptions

Yanıt sayfası boyutu, devamlılık belirteçleri vb. gibi seçenekleri ayarlamak için kullanın.

Döndürülenler

QueryIterator<T>

QueryIterator Bir dizideki belirli kapsayıcıları döndürmenize veya bunları birer birer yinelemenize olanak tanır.

readAll(FeedOptions)

Tüm kapsayıcıları okuyun.

Örnek

Diziye tüm kapsayıcıları okuyun.

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>

Parametreler

options
FeedOptions

Yanıt sayfası boyutu, devamlılık belirteçleri vb. gibi seçenekleri ayarlamak için kullanın.

Döndürülenler

QueryIterator<ContainerDefinition & Resource>

QueryIterator Bir dizideki tüm kapsayıcıları döndürmenize veya bunları birer birer yinelemenize olanak tanır.