Aracılığıyla paylaş

Database class

  • Başvuru
Paket:
@azure/cosmos

Mevcut veritabanını okuma veya silme işlemleri.

Yeni veritabanları oluşturmak ve tüm veritabanlarını okumak/sorgulamak için bkz. Veritabanları; client.databaseskullanı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, veritabanının mevcut olduğundan emin olmak için her item.read() çağrısından önce database.read() çağırmayın; uygulama başlatılırken bunu bir kez yapın.

Oluşturucular

Database(CosmosClient, string, ClientContext)

Yeni bir Veritabanı örneği döndürür.

Not: Amaç, bu nesneyi kendiniz örneklemek değil, client.database(id)aracılığıyla CosmosClient almaktır.

Özellikler

client
containers

Yeni kapsayıcılar oluşturmak veya tüm kapsayıcıları sorgulamak/okumak için kullanılır.

Belirli bir Veritabanı kimliğe göre okumak, değiştirmek veya silmek için .database(id) kullanın.

Örnek

Yeni kapsayıcı oluşturma

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url

Kaynağa bir başvuru URL'si döndürür. İzinler'de bağlantı için kullanılır.
users

Yeni kullanıcılar oluşturmak veya tüm kullanıcıları sorgulamak/okumak için kullanılır.

Kimliğine göre kullanıcı belirli bir okumak, değiştirmek veya silmek için .user(id) kullanın.

Yöntemler

container(string)

Kimliğe göre belirli bir Veritabanını okumak, değiştirmek veya silmek için kullanılır.

Yeni kapsayıcılar oluşturmak veya tüm kapsayıcıları sorgulamak/okumak .containers kullanın.

Örnek

Kapsayıcıyı silme

await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)

Verilen Veritabanını silin.
read(RequestOptions)

Verilen Veritabanının tanımını okuyun.
readOffer(RequestOptions)

Veritabanında teklif alır. Yoksa, tanımlanmamış bir OfferResponse döndürür.
user(string)

Kimliğe göre kullanıcı belirli bir okumak, değiştirmek veya silmek için kullanılır.

Yeni kullanıcılar oluşturmak veya tüm kullanıcıları sorgulamak/okumak için .users kullanın.

Oluşturucu Ayrıntıları

Database(CosmosClient, string, ClientContext)

Yeni bir Veritabanı örneği döndürür.

Not: Amaç, bu nesneyi kendiniz örneklemek değil, client.database(id)aracılığıyla CosmosClient almaktır.

new Database(client: CosmosClient, id: string, clientContext: ClientContext)

Parametreler

client
CosmosClient
id

string

clientContext

ClientContext

Özellik Ayrıntıları

client 

client: CosmosClient

Özellik Değeri

CosmosClient

containers

Yeni kapsayıcılar oluşturmak veya tüm kapsayıcıları sorgulamak/okumak için kullanılır.

Belirli bir Veritabanı kimliğe göre okumak, değiştirmek veya silmek için .database(id) kullanın.

Örnek

Yeni kapsayıcı oluşturma

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});

containers: Containers

Özellik Değeri

Containers

id 

id: string

Özellik Değeri

string

url

Kaynağa bir başvuru URL'si döndürür. İzinler'de bağlantı için kullanılır.

string url

Özellik Değeri

string

users

Yeni kullanıcılar oluşturmak veya tüm kullanıcıları sorgulamak/okumak için kullanılır.

Kimliğine göre kullanıcı belirli bir okumak, değiştirmek veya silmek için .user(id) kullanın.

users: Users

Özellik Değeri

Users

Yöntem Ayrıntıları

container(string)

Kimliğe göre belirli bir Veritabanını okumak, değiştirmek veya silmek için kullanılır.

Yeni kapsayıcılar oluşturmak veya tüm kapsayıcıları sorgulamak/okumak .containers kullanın.

Örnek

Kapsayıcıyı silme

await client.database("<db id>").container("<container id>").delete();

function container(id: string): Container

Parametreler

id

string

Döndürülenler

Container

delete(RequestOptions)

Verilen Veritabanını silin.

function delete(options?: RequestOptions): Promise<DatabaseResponse>

Parametreler

options
RequestOptions

Döndürülenler

Promise<DatabaseResponse>

read(RequestOptions)

Verilen Veritabanının tanımını okuyun.

function read(options?: RequestOptions): Promise<DatabaseResponse>

Parametreler

options
RequestOptions

Döndürülenler

Promise<DatabaseResponse>

readOffer(RequestOptions)

Veritabanında teklif alır. Yoksa, tanımlanmamış bir OfferResponse döndürür.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Parametreler

options
RequestOptions

Döndürülenler

Promise<OfferResponse>

user(string)

Kimliğe göre kullanıcı belirli bir okumak, değiştirmek veya silmek için kullanılır.

Yeni kullanıcılar oluşturmak veya tüm kullanıcıları sorgulamak/okumak için .users kullanın.

function user(id: string): User

Parametreler

id

string

Döndürülenler

User