次の方法で共有


Database class

既存のデータベースを読み取りまたは削除するための操作。

新しいデータベースを作成し、すべてのデータベースの読み取り/クエリを実行する方法については、「データベースの」を参照してください。client.databasesを使用します。

注: これらすべての操作は、固定予算に対して呼び出しを行います。 これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるようにシステムを設計する必要があります。 たとえば、1 回の item.read() 呼び出しの前に database.read() を呼び出して、データベースが存在することを確認しないでください。これは、アプリケーションの起動時に 1 回行います。

コンストラクター

Database(CosmosClient, string, ClientContext)

新しい Database インスタンスを返します。

注: このオブジェクトは、CosmosClient から client.database(id)経由で取得し、自分でインスタンス化しないようにすることです。

プロパティ

client
containers

新しいコンテナーの作成、またはすべてのコンテナーのクエリ/読み取りに使用されます。

.database(id) を使用して、既存の特定の Database を ID で読み取り、置換、または削除します。

新しいコンテナーを作成する

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

リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。

users

新しいユーザーの作成、またはすべてのユーザーのクエリ/読み取りに使用されます。

.user(id) を使用して、既存の特定の ユーザー を ID で読み取り、置換、または削除します。

メソッド

container(string)

既存の特定の Database を ID で読み取り、置換、または削除するために使用されます。

.containers 新しいコンテナーの作成、またはすべてのコンテナーのクエリ/読み取りを使用します。

コンテナーを削除する

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

指定されたデータベースを削除します。

read(RequestOptions)

指定されたデータベースの定義を読み取ります。

readOffer(RequestOptions)

データベースのオファーを取得します。 存在しない場合は、未定義の OfferResponse を返します。

user(string)

既存の特定の ユーザー を ID で読み取り、置換、または削除するために使用されます。

.users を使用して、新しいユーザーを作成したり、すべてのユーザーのクエリや読み取りを行ったりします。

コンストラクターの詳細

Database(CosmosClient, string, ClientContext)

新しい Database インスタンスを返します。

注: このオブジェクトは、CosmosClient から client.database(id)経由で取得し、自分でインスタンス化しないようにすることです。

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

パラメーター

client
CosmosClient
id

string

clientContext

ClientContext

プロパティの詳細

client

client: CosmosClient

プロパティ値

containers

新しいコンテナーの作成、またはすべてのコンテナーのクエリ/読み取りに使用されます。

.database(id) を使用して、既存の特定の Database を ID で読み取り、置換、または削除します。

新しいコンテナーを作成する

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

プロパティ値

id

id: string

プロパティ値

string

url

リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。

string url

プロパティ値

string

users

新しいユーザーの作成、またはすべてのユーザーのクエリ/読み取りに使用されます。

.user(id) を使用して、既存の特定の ユーザー を ID で読み取り、置換、または削除します。

users: Users

プロパティ値

メソッドの詳細

container(string)

既存の特定の Database を ID で読み取り、置換、または削除するために使用されます。

.containers 新しいコンテナーの作成、またはすべてのコンテナーのクエリ/読み取りを使用します。

コンテナーを削除する

await client.database("<db id>").container("<container id>").delete();
function container(id: string): Container

パラメーター

id

string

戻り値

delete(RequestOptions)

指定されたデータベースを削除します。

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

パラメーター

options
RequestOptions

戻り値

Promise<DatabaseResponse>

read(RequestOptions)

指定されたデータベースの定義を読み取ります。

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

パラメーター

options
RequestOptions

戻り値

Promise<DatabaseResponse>

readOffer(RequestOptions)

データベースのオファーを取得します。 存在しない場合は、未定義の OfferResponse を返します。

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

パラメーター

options
RequestOptions

戻り値

Promise<OfferResponse>

user(string)

既存の特定の ユーザー を ID で読み取り、置換、または削除するために使用されます。

.users を使用して、新しいユーザーを作成したり、すべてのユーザーのクエリや読み取りを行ったりします。

function user(id: string): User

パラメーター

id

string

戻り値