Databases class

client: CosmosClient

プロパティ値

データベースを作成するための要求を送信します。

データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、複数の独立した名前付きデータベースをサポートでき、データベースはデータの論理コンテナーです。

各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

例

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { resource: databaseDefinition, database } = await client.databases.create({
  id: "<name here>",
});

function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

パラメーター

戻り値

データベースが存在するかどうかを確認し、存在しない場合は作成します。 これにより、body内の ID に基づいて読み取り操作が行われます。見つからない場合は作成操作です。

データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、複数の独立した名前付きデータベースをサポートでき、データベースはデータの論理コンテナーです。

各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

例

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

パラメーター

戻り値

すべてのデータベースに対してクエリを実行します。

例

すべてのデータベースを配列に読み取る。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @database`,
  parameters: [{ name: "@database", value: "Todo" }],
};
const { resources: databaseList } = await client.databases.query(querySpec).fetchAll();

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

パラメーター

戻り値

QueryIterator 配列内のすべてのデータベースを返したり、一度に 1 つずつ反復処理したりできます。

すべてのデータベースに対してクエリを実行します。

例

すべてのデータベースを配列に読み取る。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @database`,
  parameters: [{ name: "@database", value: "Todo" }],
};
const { resources: databaseList } = await client.databases.query(querySpec).fetchAll();

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

パラメーター

戻り値

QueryIterator 配列内のすべてのデータベースを返したり、一度に 1 つずつ反復処理したりできます。

すべてのデータベースを読み取ります。

例

すべてのデータベースを配列に読み取る。

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { resources: databaseList } = await client.databases.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>

パラメーター

戻り値

QueryIterator 配列内のすべてのデータベースを返したり、一度に 1 つずつ反復処理したりできます。