Database class
既存のデータベースを読み取りまたは削除するための操作。
新しいデータベースを作成し、すべてのデータベースの読み取り/クエリを実行する方法については、「データベースの」を参照してください。client.databasesを使用します。
注: これらすべての操作は、固定予算に対して呼び出しを行います。
これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるようにシステムを設計する必要があります。
たとえば、1 回の item.read() 呼び出しの前に database.read() を呼び出して、データベースが存在することを確認しないでください。これは、アプリケーションの起動時に 1 回行います。
コンストラクター
| Database(Cosmos |
新しい Database インスタンスを返します。 注: このオブジェクトは、CosmosClient から |
プロパティ
| client | |
| containers | 新しいコンテナーの作成、またはすべてのコンテナーのクエリ/読み取りに使用されます。
例 新しいコンテナーを作成する |
| id | |
| url | リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。 |
| users | 新しいユーザーの作成、またはすべてのユーザーのクエリ/読み取りに使用されます。
|
メソッド
| container(string) | 既存の特定の Database を ID で読み取り、置換、または削除するために使用されます。
例 コンテナーを削除する |
| delete(Request |
指定されたデータベースを削除します。 |
| read(Request |
指定されたデータベースの定義を読み取ります。 |
| read |
データベースのオファーを取得します。 存在しない場合は、未定義の OfferResponse を返します。 |
| user(string) | 既存の特定の ユーザー を ID で読み取り、置換、または削除するために使用されます。
|
コンストラクターの詳細
Database(CosmosClient, string, ClientContext)
新しい Database インスタンスを返します。
注: このオブジェクトは、CosmosClient から client.database(id)経由で取得し、自分でインスタンス化しないようにすることです。
new Database(client: CosmosClient, id: string, clientContext: ClientContext)パラメーター
- client
- CosmosClient
- id
-
string
- clientContext
-
ClientContext
プロパティの詳細
client
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>