通过

用于 JS 的 Azure Cosmos DB for NoSQL SDK 示例

  • 项目

适用范围： NoSQL

JavaScript SDK for Azure Cosmos DB GitHub 存储库中包含可对 Azure Cosmos DB 资源执行 CRUD 操作和其他常见操作的示例解决方案。 本文将提供：

  • 指向每个 Node.js 示例项目文件中任务的链接。
  • 指向相关的 API 参考内容的链接。

先决条件

如果没有 Azure 订阅，可在开始前创建一个试用帐户。

可以创建一个 Azure Cosmos DB 免费层帐户，你将在帐户中获得前 1000 RU/s 的免费吞吐量和 25 GB 的免费存储。 还可以使用 URI 为 https://localhost:8081 的 Azure Cosmos DB 模拟器。 有关在模拟器中使用的密钥，请参阅对请求进行身份验证。

也需 JavaScript SDK。

注意

每个示例都是独立的，自行对自身进行设置并在完成后自行进行清理。 因此，这些示例对 Containers.create 发出多个调用。 每次执行完此操作，均会按照正在创建的容器的性能层，向订阅收取使用 1 小时的费用。

数据库示例

DatabaseManagement 文件演示如何对数据库执行 CRUD 操作。 若要在运行以下示例之前了解 Azure Cosmos DB 数据库，请参阅使用数据库、容器和项概念性文章。

任务 API 参考
创建数据库（如果不存在） Databases.createIfNotExists
列出帐户的数据库 Databases.readAll
按 ID 读取数据库 Database.read
删除数据库 Database.delete

容器示例

ContainerManagement 文件演示如何对容器执行 CRUD 操作。 若要在运行以下示例之前了解 Azure Cosmos DB 集合，请参阅使用数据库、容器和项概念性文章。

任务 API 参考
创建容器（如果不存在） Containers.createIfNotExists
列出帐户的容器 Containers.readAll
读取容器定义 Container.read
删除容器 Container.delete

项示例

ItemManagement 文件演示如何对项执行 CRUD 操作。 若要在运行以下示例之前了解 Azure Cosmos DB 文档，请参阅使用数据库、容器和项概念性文章。

任务 API 参考
创建项 Items.create
读取容器中的所有项 Items.readAll
按 ID 读取项 Item.read
仅当项更改时读取项 Item.read - RequestOptions.accessCondition
查询文档 Items.query
替换项 Item.replace
使用条件 ETag 检查替换项 Item.replace - RequestOptions.accessCondition
删除项 Item.delete

索引示例

IndexManagement 文件演示如何管理索引。 若要在运行以下示例之前了解 Azure Cosmos DB 中的索引，请参阅索引策略、索引类型和索引路径概念文章。

任务 API 参考
手动为特定项编制索引 RequestOptions.indexingDirective: 'include'
手动从索引中排除特定项 RequestOptions.indexingDirective: 'exclude'
从索引中排除路径 IndexingPolicy.ExcludedPath
在字符串路径上创建范围索引 IndexKind.Range、IndexingPolicy、Items.query
使用默认 indexPolicy 创建容器，然后对其进行联机更新 Containers.create

服务器端编程示例

index.ts 文件将演示如何执行以下任务。 若要在运行以下示例之前了解 Azure Cosmos DB 中的服务器端编程，请参阅存储过程、触发器和用户定义函数概念性文章。

任务 API 参考
创建存储过程 StoredProcedures.create
执行存储过程 StoredProcedure.execute
使用存储过程进行批量更新 StoredProcedure.execute

有关服务器端编程的详细信息，请参阅 Azure Cosmos DB 服务器端编程：存储过程、数据库触发器和 UDF。

Microsoft Entra 身份验证示例

EntraAuth.ts 文件展示了如何执行以下任务。

任务 API 参考
Create credential object from @azure/identity API
使用密钥 aadCredentials 将凭据传递给客户端对象 API
使用 aad 凭据执行 cosmos 客户端 API

其他示例

以下特选示例演示了常见方案。

任务 API 参考
更改查询吞吐量 API
获取查询吞吐量 API
使用 SasTokens 授予对 Cosmos DB 资源的范围访问权限 API

后续步骤

正在尝试为迁移到 Azure Cosmos DB 进行容量计划？ 可以使用有关现有数据库群集的信息进行容量规划。