Azure Cosmos DB Python 示例

  • 作者
    • Edward Chen

对 Azure Cosmos DB 资源执行 CRUD 操作和其他常见操作的示例解决方案包含在 azure-documentdb-python GitHub 存储库中。 本文提供：

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

先决条件

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

可以使用 URI 为 https://localhost:8081 的 Azure Cosmos DB 模拟器。 对请求进行身份验证中提供了主密钥。

还需要 Python SDK。

Note

每个示例都是独立的，自行对自身进行设置并在完成后自行进行清理。 示例问题将多次调用 document_client.CreateCollection。 每次调用完成后，你的订阅将按使用一小时计费。 有关 Azure Cosmos DB 计费的详细信息，请参阅 Azure Cosmos DB 定价。

数据库示例

DatabaseManagement 项目的 Program.py 文件演示了如何执行以下任务：

任务 API 参考
创建数据库 document_client.CreateDatabase
按 ID 读取数据库 document_client.ReadDatabase
列出帐户的数据库 document_client.ReadDatabases
删除数据库 document_client.DeleteDatabase

集合示例

CollectionManagement 项目的 Program.py 文件演示了如何执行以下任务：

任务 API 参考
创建集合 document_client.CreateCollection
读取数据库中所有集合的列表 document_client.ReadCollections
按 ID 获取集合 document_client.ReadCollection
更改集合的吞吐量 document_client.ReplaceOffer
删除集合 document_client.DeleteCollection

文档示例

DocumentManagement 项目的 Program.py 文件演示了如何执行以下任务：

任务 API 参考
创建文档 document_client.CreateDocument
创建文档的集合 document_client.CreateDocuments
按 ID 读取文档 document_client.ReadDocument
读取集合中的所有文档 document_client.ReadDocuments

索引示例

IndexManagement 项目的 Program.py 文件演示了如何执行以下任务：

任务 API 参考
使用手动（而非自动）索引 IndexingPolicy.Automatic
从索引中排除指定的文档路径 IndexingPolicy.ExcludedPaths
从索引中排除文档 documents.IndexingDirective.Exclude
设置索引模式 documents.IndexingMode
对字符串使用范围索引 IndexingPolicy.IncludedPaths
执行索引转换 document_client.ReplaceCollection

查询示例

示例项目还演示了如何执行以下查询任务：

任务 API 参考
查询数据库帐户 document_client.QueryDatabases
查询文档 document_client.QueryDocuments
对哈希索引路径强制执行范围扫描操作 http_constants.HttpHeaders.EnableScanInQuery