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

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,
   },
});

构造函数

CosmosClient(CosmosClientOptions)

创建新的 CosmosClient 对象。 有关可以使用的选项的更多详细信息,请参阅 CosmosClientOptions

CosmosClient(string)

从连接字符串创建新的 CosmosClient 对象。 可在 Azure 门户中找到数据库连接字符串

属性

databases

用于创建新数据库或查询/读取所有数据库。

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

示例

新建数据库

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers

用于查询 & 读取所有产品/服务。

使用 .offer(id) 读取或替换现有产品/服务。

方法

database(string)

用于通过 ID 读取、更新或删除现有数据库或访问属于该数据库的容器。

这不会进行网络调用。 使用 .read 在获取 Database 对象后获取有关 数据库 的信息。

示例

从现有数据库创建新容器

const container = client.database("<database id>").containers.create("<container id>");

示例

删除现有数据库

await client.database("<id here>").delete();
dispose()

清除后台终结点刷新程序。 在另一个进程中销毁 CosmosClient 时,请使用 client.dispose () 。

getDatabaseAccount(RequestOptions)

获取有关当前 DatabaseAccount (的信息,包括支持的区域等 )

getReadEndpoint()

获取当前使用的读取终结点。 可用于故障排除目的。

如果使用的是特定于位置的终结点,URL 可能包含区域后缀 (例如“-eastus”) 。

getReadEndpoints()

获取当前使用的读取终结点。 可用于故障排除目的。

如果使用的是特定于位置的终结点,URL 可能包含区域后缀 (例如“-eastus”) 。

getWriteEndpoint()

获取当前使用的写入终结点 URL。 可用于故障排除目的。

如果使用的是特定于位置的终结点,URL 可能包含区域后缀 (例如“-eastus”) 。

getWriteEndpoints()

获取已知的写入终结点。 可用于故障排除目的。

如果我们使用特定于位置的终结点,URL 可能包含区域后缀 (例如“-eastus”) 。

offer(string)

用于读取或按 ID 更新现有产品/服务。

构造函数详细信息

CosmosClient(CosmosClientOptions)

创建新的 CosmosClient 对象。 有关可以使用的选项的更多详细信息,请参阅 CosmosClientOptions

new CosmosClient(options: CosmosClientOptions)

参数

options
CosmosClientOptions

选项包;至少需要配置终结点和身份验证

CosmosClient(string)

从连接字符串创建新的 CosmosClient 对象。 可在 Azure 门户中找到数据库连接字符串

new CosmosClient(connectionString: string)

参数

connectionString

string

属性详细信息

databases

用于创建新数据库或查询/读取所有数据库。

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

示例

新建数据库

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
databases: Databases

属性值

offers

用于查询 & 读取所有产品/服务。

使用 .offer(id) 读取或替换现有产品/服务。

offers: Offers

属性值

方法详细信息

database(string)

用于通过 ID 读取、更新或删除现有数据库或访问属于该数据库的容器。

这不会进行网络调用。 使用 .read 在获取 Database 对象后获取有关 数据库 的信息。

示例

从现有数据库创建新容器

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

返回

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。

返回