你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Databases class
用于创建新数据库和读取/查询所有数据库的操作
有关读取或删除现有数据库，请参阅 数据库 ;使用 client.database(id)。
注意：所有这些操作都会根据固定预算进行调用。
应设计系统，使这些调用与应用程序一起按子线性缩放。
例如，不要在每次item.read()调用之前调用databases.readAll()，以确保数据库存在;在应用程序启动时执行此操作一次。
属性
| client |
方法
| create(Database |
发送创建数据库的请求。 数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。 每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。 |
| create |
检查数据库是否存在，如果不存在，请创建它。
这将基于 中的 数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。 每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。 |
| query(string | Sql |
查询所有数据库。 示例 读取数组中的所有数据库。
* |
| query<T>(string | Sql |
查询所有数据库。 示例 读取数组中的所有数据库。
* |
| read |
读取所有数据库。 示例 读取数组中的所有数据库。
* |
属性详细信息
client
方法详细信息
create(DatabaseRequest, RequestOptions)
发送创建数据库的请求。
数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。
每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。
function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>参数
- body
- DatabaseRequest
表示要创建的数据库的 DatabaseDefinition。
- options
- RequestOptions
用于设置响应页大小、延续标记等选项。
返回
Promise<DatabaseResponse>
createIfNotExists(DatabaseRequest, RequestOptions)
检查数据库是否存在，如果不存在，请创建它。
这将基于 中的 bodyID 执行读取操作，如果找不到，则创建操作。
数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。
每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。
function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>参数
- body
- DatabaseRequest
表示要创建的数据库的 DatabaseDefinition。
- options
- RequestOptions
请求的其他选项
返回
Promise<DatabaseResponse>
query(string | SqlQuerySpec, FeedOptions)
查询所有数据库。
示例
读取数组中的所有数据库。
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: 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)
查询所有数据库。
示例
读取数组中的所有数据库。
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>参数
- query
-
string | SqlQuerySpec
操作的查询配置。 有关如何配置查询的详细信息，请参阅 SqlQuerySpec 。
- options
- FeedOptions
用于设置响应页大小、延续标记等选项。
返回
QueryIterator 允许返回数组中的所有数据库，或一次循环访问一个数据库。 *
readAll(FeedOptions)
读取所有数据库。
示例
读取数组中的所有数据库。
* typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>参数
- options
- FeedOptions
用于设置响应页大小、延续标记等选项。
返回
QueryIterator 允许返回数组中的所有数据库，或一次循环访问一个数据库。 *