通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Databases class

  • 参考
包:
@azure/cosmos

用于创建新数据库和读取/查询所有数据库的作

请参阅 数据库 来读取或删除现有数据库;使用 client.database(id)。

注意：所有这些作都针对固定预算进行调用。 应设计系统，以便这些调用与应用程序进行子线性缩放。 例如，在每次调用 databases.readAll() 之前不要调用 item.read()，以确保数据库存在;在应用程序启动时执行此作。

属性

client

方法

create(DatabaseRequest, RequestOptions)

发送创建数据库的请求。

数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。

每个数据库都包含一个或多个容器，每个容器又包含一个或多个文档。 由于数据库是管理资源，因此需要服务主密钥才能使用用户 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>",
});
createIfNotExists(DatabaseRequest, RequestOptions)

检查数据库是否存在，如果不存在，请创建它。 这将基于 body中的 ID 进行读取作，如果未找到，则创建作。

数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。

每个数据库都包含一个或多个容器，每个容器又包含一个或多个文档。 由于数据库是管理资源，因此需要服务主密钥才能使用用户 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" });
query(string | SqlQuerySpec, FeedOptions)

查询所有数据库。

示例

读取所有数据库以数组。

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();
query<T>(string | SqlQuerySpec, FeedOptions)

查询所有数据库。

示例

读取所有数据库以数组。

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();
readAll(FeedOptions)

读取所有数据库。

示例

读取所有数据库以数组。

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();

属性详细信息

client 

client: CosmosClient

属性值

CosmosClient

方法详细信息

create(DatabaseRequest, RequestOptions)

发送创建数据库的请求。

数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。

每个数据库都包含一个或多个容器，每个容器又包含一个或多个文档。 由于数据库是管理资源，因此需要服务主密钥才能使用用户 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
DatabaseRequest

DatabaseDefinition，表示要创建的 数据库。

options
RequestOptions

用于设置响应页大小、继续标记等选项。

返回

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

检查数据库是否存在，如果不存在，请创建它。 这将基于 body中的 ID 进行读取作，如果未找到，则创建作。

数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。

每个数据库都包含一个或多个容器，每个容器又包含一个或多个文档。 由于数据库是管理资源，因此需要服务主密钥才能使用用户 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>

参数

body
DatabaseRequest

DatabaseDefinition，表示要创建的 数据库。

options
RequestOptions

请求的其他选项

返回

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

查询所有数据库。

示例

读取所有数据库以数组。

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>

参数

query

string | SqlQuerySpec

作的查询配置。 有关如何配置查询的详细信息，请参阅 SqlQuerySpec。

options
FeedOptions

用于设置响应页大小、继续标记等选项。

返回

QueryIterator<any>

QueryIterator 允许返回数组中的所有数据库或逐个循环访问它们。

query<T>(string | SqlQuerySpec, FeedOptions)

查询所有数据库。

示例

读取所有数据库以数组。

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>

参数

query

string | SqlQuerySpec

作的查询配置。 有关如何配置查询的详细信息，请参阅 SqlQuerySpec。

options
FeedOptions

用于设置响应页大小、继续标记等选项。

返回

QueryIterator<T>

QueryIterator 允许返回数组中的所有数据库或逐个循环访问它们。

readAll(FeedOptions)

读取所有数据库。

示例

读取所有数据库以数组。

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>

参数

options
FeedOptions

用于设置响应页大小、继续标记等选项。

返回

QueryIterator<DatabaseDefinition & Resource>

QueryIterator 允许返回数组中的所有数据库或逐个循环访问它们。