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

Database class

包:

@azure/cosmos

用于读取或删除现有数据库的操作。

请参阅 用于 创建新数据库和读取/查询所有数据库的数据库;使用 client.databases。

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

构造函数

Database(CosmosClient, string, ClientContext)

返回新的 数据库实例 。 注意：目的是通过 client.database(id)从 CosmosClient 获取此对象，而不是自行实例化它。

属性

client
containers	用于创建新容器，或查询/读取所有容器。 用于 .database(id) 按 ID 读取、替换或删除特定的现有 数据库 。 示例 创建新容器 const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	返回资源的引用 URL。 用于在“权限”中链接。
users	用于创建新用户，或查询/读取所有用户。 用于 .user(id) 按 ID 读取、替换或删除特定的现有 用户 。

方法

container(string)	用于按 ID 读取、替换或删除特定的现有 数据库 。 使用 .containers 创建新容器，或查询/读取所有容器。 示例 删除容器 await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	删除给定的数据库。
read(RequestOptions)	读取给定数据库的定义。
readOffer(RequestOptions)	获取数据库上的产品/服务。 如果不存在，则返回未定义的 OfferResponse。
user(string)	用于按 ID 读取、替换或删除特定的现有 用户 。 用于 .users 创建新用户，或查询/读取所有用户。

构造函数详细信息

Database(CosmosClient, string, ClientContext)

返回新的 数据库实例 。

注意：目的是通过 client.database(id)从 CosmosClient 获取此对象，而不是自行实例化它。

new Database(client: CosmosClient, id: string, clientContext: ClientContext)

参数

client

CosmosClient

id

string

clientContext

ClientContext

属性详细信息

client

client: CosmosClient

属性值

CosmosClient

containers

用于创建新容器，或查询/读取所有容器。

用于 .database(id) 按 ID 读取、替换或删除特定的现有 数据库 。

示例

创建新容器

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});

containers: Containers

属性值

Containers

id

id: string

属性值

string

url

返回资源的引用 URL。 用于在“权限”中链接。

string url

属性值

string

users

用于创建新用户，或查询/读取所有用户。

用于 .user(id) 按 ID 读取、替换或删除特定的现有 用户 。

users: Users

属性值

Users

方法详细信息

container(string)

用于按 ID 读取、替换或删除特定的现有 数据库 。

使用 .containers 创建新容器，或查询/读取所有容器。

示例

删除容器

await client.database("<db id>").container("<container id>").delete();

function container(id: string): Container

参数

id

string

返回

Container

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>

user(string)

用于按 ID 读取、替换或删除特定的现有 用户 。

用于 .users 创建新用户，或查询/读取所有用户。

function user(id: string): User

参数

id

string

返回

User