CosmosClient class
Azure Cosmos DB データベース アカウントのクライアント側の論理表現を提供します。 このクライアントは、Azure Cosmos DB データベース サービスで要求を構成して実行するために使用されます。
例
クライアントをインスタンス化し、新しいデータベースを作成する
const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});
例
カスタム接続ポリシーを使用してクライアントをインスタンス化する
const client = new CosmosClient({
endpoint: "<URL HERE>",
key: "<KEY HERE>",
connectionPolicy: {
requestTimeout: 10000,
},
});
コンストラクター
| Cosmos |
新しい CosmosClient オブジェクトを作成します。 使用できるオプションの詳細については、「 CosmosClientOptions 」を参照してください。 |
| Cosmos |
接続文字列から新しい CosmosClient オブジェクトを作成します。 データベース 接続文字列は、Azure Portal で確認できます |
プロパティ
| databases | 新しいデータベースの作成、またはすべてのデータベースのクエリ/読み取りに使用されます。 ID で特定の既存のデータベースを読み取り、置換、または削除するには、 を使用 例 新しいデータベースの作成 |
| offers | すべてのオファーの読み取り & クエリに使用されます。 を使用して |
メソッド
| database(string) | ID によって既存のデータベースを読み取り、更新、または削除したり、そのデータベースに属するコンテナーにアクセスしたりするために使用されます。 これにより、ネットワーク呼び出しは行われません。
Database オブジェクトを取得した後、データベースに関する情報を取得するには、 を使用 例 既存のデータベースから新しいコンテナーを作成する 例 既存のデータベースを削除する |
| dispose() | バックグラウンド エンドポイントリフレッシャーをクリアします。 別のプロセス内で CosmosClient を破棄する場合は、client.dispose() を使用します。 |
| get |
現在の DatabaseAccount (サポートされているリージョンなど) に関する情報を取得する |
| get |
現在使用されている読み取りエンドポイントを取得します。 トラブルシューティングの目的で役立ちます。 場所固有のエンドポイントを使用している場合、URL にはリージョン サフィックス ("-eastus" など) が含まれる場合があります。 |
| get |
現在使用されている読み取りエンドポイントを取得します。 トラブルシューティングの目的で役立ちます。 場所固有のエンドポイントを使用している場合、URL にはリージョン サフィックス ("-eastus" など) が含まれる場合があります。 |
| get |
現在使用されている書き込みエンドポイント URL を取得します。 トラブルシューティングの目的で役立ちます。 場所固有のエンドポイントを使用している場合、URL にはリージョン サフィックス ("-eastus" など) が含まれる場合があります。 |
| get |
既知の書き込みエンドポイントを取得します。 トラブルシューティングの目的で役立ちます。 場所固有のエンドポイントを使用している場合、URL にはリージョン サフィックス (例: "-eastus") が含まれる場合があります。 |
| offer(string) | ID による既存のオファーの読み取りまたは更新に使用されます。 |
コンストラクターの詳細
CosmosClient(CosmosClientOptions)
新しい CosmosClient オブジェクトを作成します。 使用できるオプションの詳細については、「 CosmosClientOptions 」を参照してください。
new CosmosClient(options: CosmosClientOptions)パラメーター
- options
- CosmosClientOptions
オプションの袋;少なくともエンドポイントと認証を構成する必要がある
CosmosClient(string)
接続文字列から新しい CosmosClient オブジェクトを作成します。 データベース 接続文字列は、Azure Portal で確認できます
new CosmosClient(connectionString: string)パラメーター
- connectionString
-
string
プロパティの詳細
databases
新しいデータベースの作成、またはすべてのデータベースのクエリ/読み取りに使用されます。
ID で特定の既存のデータベースを読み取り、置換、または削除するには、 を使用 .database(id) します。
例
新しいデータベースの作成
const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
databases: Databasesプロパティ値
offers
すべてのオファーの読み取り & クエリに使用されます。
を使用して .offer(id) 、既存のオファーの読み取り、または置き換えを行います。
offers: Offersプロパティ値
メソッドの詳細
database(string)
ID によって既存のデータベースを読み取り、更新、または削除したり、そのデータベースに属するコンテナーにアクセスしたりするために使用されます。
これにより、ネットワーク呼び出しは行われません。
Database オブジェクトを取得した後、データベースに関する情報を取得するには、 を使用.readします。
例
既存のデータベースから新しいコンテナーを作成する
const container = client.database("<database id>").containers.create("<container id>");
例
既存のデータベースを削除する
await client.database("<id here>").delete();
function database(id: string): Databaseパラメーター
- id
-
string
データベースの ID。
戻り値
dispose()
バックグラウンド エンドポイントリフレッシャーをクリアします。 別のプロセス内で CosmosClient を破棄する場合は、client.dispose() を使用します。
function dispose()
getDatabaseAccount(RequestOptions)
現在の DatabaseAccount (サポートされているリージョンなど) に関する情報を取得する
function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>パラメーター
- options
- RequestOptions
戻り値
Promise<ResourceResponse<DatabaseAccount>>
getReadEndpoint()
現在使用されている読み取りエンドポイントを取得します。 トラブルシューティングの目的で役立ちます。
場所固有のエンドポイントを使用している場合、URL にはリージョン サフィックス ("-eastus" など) が含まれる場合があります。
function getReadEndpoint(): Promise<string>戻り値
Promise<string>
getReadEndpoints()
現在使用されている読み取りエンドポイントを取得します。 トラブルシューティングの目的で役立ちます。
場所固有のエンドポイントを使用している場合、URL にはリージョン サフィックス ("-eastus" など) が含まれる場合があります。
function getReadEndpoints(): Promise<readonly string[]>戻り値
Promise<readonly string[]>
getWriteEndpoint()
現在使用されている書き込みエンドポイント URL を取得します。 トラブルシューティングの目的で役立ちます。
場所固有のエンドポイントを使用している場合、URL にはリージョン サフィックス ("-eastus" など) が含まれる場合があります。
function getWriteEndpoint(): Promise<string>戻り値
Promise<string>
getWriteEndpoints()
既知の書き込みエンドポイントを取得します。 トラブルシューティングの目的で役立ちます。
場所固有のエンドポイントを使用している場合、URL にはリージョン サフィックス (例: "-eastus") が含まれる場合があります。
function getWriteEndpoints(): Promise<readonly string[]>戻り値
Promise<readonly string[]>
offer(string)
ID による既存のオファーの読み取りまたは更新に使用されます。
function offer(id: string): Offerパラメーター
- id
-
string
オファーの ID。