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