快速入门：适用于 Python 的 Azure Cosmos DB for NoSQL 库

项目
09/14/2024

适用范围： NoSQL

开始使用适用于 Python 的 Azure Cosmos DB for NoSQL 客户端库来查询容器中的数据，并对各个项执行常见操作。请按照以下步骤使用 Azure Developer CLI 将最小解决方案部署到环境。

API 参考文档 | 库源代码 | 包 (PyPI) | Azure Developer CLI

先决条件

具有活动订阅的 Azure 帐户。创建帐户。
GitHub 帐户

一个 Azure 帐户和一个有效的订阅。创建帐户。
Azure 开发人员 CLI
Docker Desktop

设置

将此项目的开发容器部署到环境中。然后，使用 Azure Developer CLI (azd) 创建 Azure Cosmos DB for NoSQL 帐户并部署容器化示例应用程序。示例应用程序使用客户端库来管理、创建、读取和查询示例数据。

重要

GitHub 帐户包括使用免费的存储和核心小时数的权利。有关详细信息，请参阅包含的 GitHub 帐户存储和核心小时数。

在项目的根目录中打开终端。
使用 azd auth login 向 Azure Developer CLI 进行身份验证。按照该工具指定的步骤，使用首选 Azure 凭据向 CLI 进行身份验证。
```
azd auth login
```
使用 azd init 来初始化项目。
```
azd init --template cosmos-db-nosql-python-quickstart
```
注意

本快速入门使用 azure-samples/cosmos-db-nosql-python-quickstart 模板 GitHub 存储库。 Azure Developer CLI 会自动将此项目克隆到计算机（如果其中尚不存在该项目）。
在初始化期间，配置唯一的环境名称。

提示

环境名称也将用作目标资源组名称。对于本快速入门，请考虑使用 msdocs-cosmos-db。
使用 azd up 部署 Azure Cosmos DB 帐户。 Bicep 模板还部署示例 Web 应用程序。
```
azd up
```
在预配过程中，选择订阅和所需位置。等待预配过程完成。此过程可能需要大约 5 分钟。

预配 Azure 资源后，输出中将包含指向正在运行的 Web 应用程序的 URL。

Deploying services (azd deploy)

  (✓) Done: Deploying service web
- Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>

SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.

使用控制台中的 URL 在浏览器中导航到 Web 应用程序。观察正在运行的应用的输出。

安装客户端库

客户端库可通过 Python 包索引作为 azure-cosmos 库可用。

打开终端并导航到 /src 文件夹。
```
cd ./src
```
使用 pip install 安装 azure-cosmos 包（如果尚未安装）。
```
pip install azure-cosmos
```
另请安装 azure-identity 包（如果尚未安装）。
```
pip install azure-identity
```
打开并查看 src/requirements.txt 文件以验证 azure-cosmos 和 azure-identity 条目是否同时存在。

对象模型

名称	描述
`CosmosClient`	此类是主要客户端类，用于管理帐户范围的元数据或数据库。
`DatabaseProxy`	此类表示帐户内的数据库。
`ContainerProxy`	此类主要用于对容器或容器中存储的项执行读取、更新和删除操作。
`PartitionKey`	此类表示逻辑分区键。许多常见操作和查询都需要此类。

模板中的示例代码使用名为 cosmicworks 的数据库和名为 products 的容器。 products 容器包含每个产品的名称、类别、数量、唯一标识符和销售标志等详细信息。该容器使用 /category 属性作为逻辑分区键。

验证客户端

对大多数 Azure 服务的应用程序请求必须获得授权。使用 DefaultAzureCredential 类型作为在应用程序和 Azure Cosmos DB for NoSQL 之间实现无密码连接的首选方式。 DefaultAzureCredential 支持多种身份验证方法，并确定应在运行时使用哪种方法。

重要

还可以直接使用密码、连接字符串或其他凭据授权对 Azure 服务的请求。但是，应谨慎使用此方法。开发人员必须尽量避免在不安全的位置公开这些机密。任何可获得密码或密钥的人员都可向数据库服务进行身份验证。 DefaultAzureCredential 提供比帐户密钥更好的管理和安全优势，可以在不冒存储密钥的风险的情况下实现无密码身份验证。

此示例创建一个 CosmosClient 类型的新实例并使用 DefaultAzureCredential 实例进行身份验证。

# <imports>
from azure.cosmos import CosmosClient
from azure.identity import DefaultAzureCredential

# </imports>

import json


def getLastRequestCharge(c):
    return c.client_connection.last_response_headers["x-ms-request-charge"]


def runDemo(endpoint, writeOutput):
    # <create_client>
    credential = DefaultAzureCredential()
    client = CosmosClient(url=endpoint, credential=credential)
    # </create_client>

    # <get_database>
    database = client.get_database_client("cosmicworks")
    # </get_database>

    writeOutput(f"Get database:\t{database.id}")

    # <get_container>
    container = database.get_container_client("products")
    # </get_container>
    writeOutput(f"Get container:\t{container.id}")

    # <create_item>
    new_item = {
        "id": "70b63682-b93a-4c77-aad2-65501347265f",
        "category": "gear-surf-surfboards",
        "name": "Yamba Surfboard",
        "quantity": 12,
        "sale": False,
    }
    created_item = container.upsert_item(new_item)
    # </create_item>
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput("Request charge:\t" f"{getLastRequestCharge(container)}")

    new_item = {
        "id": "25a68543-b90c-439d-8332-7ef41e06a0e0",
        "category": "gear-surf-surfboards",
        "name": "Kiama Classic Surfboard",
        "quantity": 4,
        "sale": True,
    }
    created_item = container.upsert_item(new_item)
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <read_item>
    existing_item = container.read_item(
        item="70b63682-b93a-4c77-aad2-65501347265f",
        partition_key="gear-surf-surfboards",
    )
    # </read_item>
    writeOutput(f"Read item id:\t{existing_item['id']}")
    writeOutput(f"Read item:\t{existing_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <query_items>
    queryText = "SELECT * FROM products p WHERE p.category = @category"
    results = container.query_items(
        query=queryText,
        parameters=[
            dict(
                name="@category",
                value="gear-surf-surfboards",
            )
        ],
        enable_cross_partition_query=False,
    )
    # </query_items>
    # <parse_results>
    items = [item for item in results]
    output = json.dumps(items, indent=True)
    # </parse_results>
    writeOutput("Found items:")
    writeOutput(output, isCode=True)

获取数据库

使用 client.get_database_client 检索名为 cosmicworks 的现有数据库。

# <imports>
from azure.cosmos import CosmosClient
from azure.identity import DefaultAzureCredential

# </imports>

import json


def getLastRequestCharge(c):
    return c.client_connection.last_response_headers["x-ms-request-charge"]


def runDemo(endpoint, writeOutput):
    # <create_client>
    credential = DefaultAzureCredential()
    client = CosmosClient(url=endpoint, credential=credential)
    # </create_client>

    # <get_database>
    database = client.get_database_client("cosmicworks")
    # </get_database>

    writeOutput(f"Get database:\t{database.id}")

    # <get_container>
    container = database.get_container_client("products")
    # </get_container>
    writeOutput(f"Get container:\t{container.id}")

    # <create_item>
    new_item = {
        "id": "70b63682-b93a-4c77-aad2-65501347265f",
        "category": "gear-surf-surfboards",
        "name": "Yamba Surfboard",
        "quantity": 12,
        "sale": False,
    }
    created_item = container.upsert_item(new_item)
    # </create_item>
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput("Request charge:\t" f"{getLastRequestCharge(container)}")

    new_item = {
        "id": "25a68543-b90c-439d-8332-7ef41e06a0e0",
        "category": "gear-surf-surfboards",
        "name": "Kiama Classic Surfboard",
        "quantity": 4,
        "sale": True,
    }
    created_item = container.upsert_item(new_item)
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <read_item>
    existing_item = container.read_item(
        item="70b63682-b93a-4c77-aad2-65501347265f",
        partition_key="gear-surf-surfboards",
    )
    # </read_item>
    writeOutput(f"Read item id:\t{existing_item['id']}")
    writeOutput(f"Read item:\t{existing_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <query_items>
    queryText = "SELECT * FROM products p WHERE p.category = @category"
    results = container.query_items(
        query=queryText,
        parameters=[
            dict(
                name="@category",
                value="gear-surf-surfboards",
            )
        ],
        enable_cross_partition_query=False,
    )
    # </query_items>
    # <parse_results>
    items = [item for item in results]
    output = json.dumps(items, indent=True)
    # </parse_results>
    writeOutput("Found items:")
    writeOutput(output, isCode=True)

获取容器

使用 database.get_container_client 检索现有的 products 容器。

# <imports>
from azure.cosmos import CosmosClient
from azure.identity import DefaultAzureCredential

# </imports>

import json


def getLastRequestCharge(c):
    return c.client_connection.last_response_headers["x-ms-request-charge"]


def runDemo(endpoint, writeOutput):
    # <create_client>
    credential = DefaultAzureCredential()
    client = CosmosClient(url=endpoint, credential=credential)
    # </create_client>

    # <get_database>
    database = client.get_database_client("cosmicworks")
    # </get_database>

    writeOutput(f"Get database:\t{database.id}")

    # <get_container>
    container = database.get_container_client("products")
    # </get_container>
    writeOutput(f"Get container:\t{container.id}")

    # <create_item>
    new_item = {
        "id": "70b63682-b93a-4c77-aad2-65501347265f",
        "category": "gear-surf-surfboards",
        "name": "Yamba Surfboard",
        "quantity": 12,
        "sale": False,
    }
    created_item = container.upsert_item(new_item)
    # </create_item>
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput("Request charge:\t" f"{getLastRequestCharge(container)}")

    new_item = {
        "id": "25a68543-b90c-439d-8332-7ef41e06a0e0",
        "category": "gear-surf-surfboards",
        "name": "Kiama Classic Surfboard",
        "quantity": 4,
        "sale": True,
    }
    created_item = container.upsert_item(new_item)
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <read_item>
    existing_item = container.read_item(
        item="70b63682-b93a-4c77-aad2-65501347265f",
        partition_key="gear-surf-surfboards",
    )
    # </read_item>
    writeOutput(f"Read item id:\t{existing_item['id']}")
    writeOutput(f"Read item:\t{existing_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <query_items>
    queryText = "SELECT * FROM products p WHERE p.category = @category"
    results = container.query_items(
        query=queryText,
        parameters=[
            dict(
                name="@category",
                value="gear-surf-surfboards",
            )
        ],
        enable_cross_partition_query=False,
    )
    # </query_items>
    # <parse_results>
    items = [item for item in results]
    output = json.dumps(items, indent=True)
    # </parse_results>
    writeOutput("Found items:")
    writeOutput(output, isCode=True)

创建项

使用要序列化为 JSON 的所有成员生成一个新对象。在此示例中，该类型具有唯一标识符以及用于类别、名称、数量、价格和销售的字段。使用 container.upsert_item 在容器中创建某个项。此方法会“更新插入”该项，有效地替换该项（如果该项已存在）。

# <imports>
from azure.cosmos import CosmosClient
from azure.identity import DefaultAzureCredential

# </imports>

import json


def getLastRequestCharge(c):
    return c.client_connection.last_response_headers["x-ms-request-charge"]


def runDemo(endpoint, writeOutput):
    # <create_client>
    credential = DefaultAzureCredential()
    client = CosmosClient(url=endpoint, credential=credential)
    # </create_client>

    # <get_database>
    database = client.get_database_client("cosmicworks")
    # </get_database>

    writeOutput(f"Get database:\t{database.id}")

    # <get_container>
    container = database.get_container_client("products")
    # </get_container>
    writeOutput(f"Get container:\t{container.id}")

    # <create_item>
    new_item = {
        "id": "70b63682-b93a-4c77-aad2-65501347265f",
        "category": "gear-surf-surfboards",
        "name": "Yamba Surfboard",
        "quantity": 12,
        "sale": False,
    }
    created_item = container.upsert_item(new_item)
    # </create_item>
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput("Request charge:\t" f"{getLastRequestCharge(container)}")

    new_item = {
        "id": "25a68543-b90c-439d-8332-7ef41e06a0e0",
        "category": "gear-surf-surfboards",
        "name": "Kiama Classic Surfboard",
        "quantity": 4,
        "sale": True,
    }
    created_item = container.upsert_item(new_item)
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <read_item>
    existing_item = container.read_item(
        item="70b63682-b93a-4c77-aad2-65501347265f",
        partition_key="gear-surf-surfboards",
    )
    # </read_item>
    writeOutput(f"Read item id:\t{existing_item['id']}")
    writeOutput(f"Read item:\t{existing_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <query_items>
    queryText = "SELECT * FROM products p WHERE p.category = @category"
    results = container.query_items(
        query=queryText,
        parameters=[
            dict(
                name="@category",
                value="gear-surf-surfboards",
            )
        ],
        enable_cross_partition_query=False,
    )
    # </query_items>
    # <parse_results>
    items = [item for item in results]
    output = json.dumps(items, indent=True)
    # </parse_results>
    writeOutput("Found items:")
    writeOutput(output, isCode=True)

读取项

同时使用唯一标识符 (id) 和分区键字段来执行点读取操作。使用 container.read_item 以有效检索特定项。

# <imports>
from azure.cosmos import CosmosClient
from azure.identity import DefaultAzureCredential

# </imports>

import json


def getLastRequestCharge(c):
    return c.client_connection.last_response_headers["x-ms-request-charge"]


def runDemo(endpoint, writeOutput):
    # <create_client>
    credential = DefaultAzureCredential()
    client = CosmosClient(url=endpoint, credential=credential)
    # </create_client>

    # <get_database>
    database = client.get_database_client("cosmicworks")
    # </get_database>

    writeOutput(f"Get database:\t{database.id}")

    # <get_container>
    container = database.get_container_client("products")
    # </get_container>
    writeOutput(f"Get container:\t{container.id}")

    # <create_item>
    new_item = {
        "id": "70b63682-b93a-4c77-aad2-65501347265f",
        "category": "gear-surf-surfboards",
        "name": "Yamba Surfboard",
        "quantity": 12,
        "sale": False,
    }
    created_item = container.upsert_item(new_item)
    # </create_item>
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput("Request charge:\t" f"{getLastRequestCharge(container)}")

    new_item = {
        "id": "25a68543-b90c-439d-8332-7ef41e06a0e0",
        "category": "gear-surf-surfboards",
        "name": "Kiama Classic Surfboard",
        "quantity": 4,
        "sale": True,
    }
    created_item = container.upsert_item(new_item)
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <read_item>
    existing_item = container.read_item(
        item="70b63682-b93a-4c77-aad2-65501347265f",
        partition_key="gear-surf-surfboards",
    )
    # </read_item>
    writeOutput(f"Read item id:\t{existing_item['id']}")
    writeOutput(f"Read item:\t{existing_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <query_items>
    queryText = "SELECT * FROM products p WHERE p.category = @category"
    results = container.query_items(
        query=queryText,
        parameters=[
            dict(
                name="@category",
                value="gear-surf-surfboards",
            )
        ],
        enable_cross_partition_query=False,
    )
    # </query_items>
    # <parse_results>
    items = [item for item in results]
    output = json.dumps(items, indent=True)
    # </parse_results>
    writeOutput("Found items:")
    writeOutput(output, isCode=True)

查询项

使用 container.GetItemQueryIterator 对容器中的多个项执行查询。使用此参数化查询查找指定类别中的所有项：

SELECT * FROM products p WHERE p.category = @category

# <imports>
from azure.cosmos import CosmosClient
from azure.identity import DefaultAzureCredential

# </imports>

import json


def getLastRequestCharge(c):
    return c.client_connection.last_response_headers["x-ms-request-charge"]


def runDemo(endpoint, writeOutput):
    # <create_client>
    credential = DefaultAzureCredential()
    client = CosmosClient(url=endpoint, credential=credential)
    # </create_client>

    # <get_database>
    database = client.get_database_client("cosmicworks")
    # </get_database>

    writeOutput(f"Get database:\t{database.id}")

    # <get_container>
    container = database.get_container_client("products")
    # </get_container>
    writeOutput(f"Get container:\t{container.id}")

    # <create_item>
    new_item = {
        "id": "70b63682-b93a-4c77-aad2-65501347265f",
        "category": "gear-surf-surfboards",
        "name": "Yamba Surfboard",
        "quantity": 12,
        "sale": False,
    }
    created_item = container.upsert_item(new_item)
    # </create_item>
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput("Request charge:\t" f"{getLastRequestCharge(container)}")

    new_item = {
        "id": "25a68543-b90c-439d-8332-7ef41e06a0e0",
        "category": "gear-surf-surfboards",
        "name": "Kiama Classic Surfboard",
        "quantity": 4,
        "sale": True,
    }
    created_item = container.upsert_item(new_item)
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <read_item>
    existing_item = container.read_item(
        item="70b63682-b93a-4c77-aad2-65501347265f",
        partition_key="gear-surf-surfboards",
    )
    # </read_item>
    writeOutput(f"Read item id:\t{existing_item['id']}")
    writeOutput(f"Read item:\t{existing_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <query_items>
    queryText = "SELECT * FROM products p WHERE p.category = @category"
    results = container.query_items(
        query=queryText,
        parameters=[
            dict(
                name="@category",
                value="gear-surf-surfboards",
            )
        ],
        enable_cross_partition_query=False,
    )
    # </query_items>
    # <parse_results>
    items = [item for item in results]
    output = json.dumps(items, indent=True)
    # </parse_results>
    writeOutput("Found items:")
    writeOutput(output, isCode=True)

循环访问查询的结果。

# <imports>
from azure.cosmos import CosmosClient
from azure.identity import DefaultAzureCredential

# </imports>

import json


def getLastRequestCharge(c):
    return c.client_connection.last_response_headers["x-ms-request-charge"]


def runDemo(endpoint, writeOutput):
    # <create_client>
    credential = DefaultAzureCredential()
    client = CosmosClient(url=endpoint, credential=credential)
    # </create_client>

    # <get_database>
    database = client.get_database_client("cosmicworks")
    # </get_database>

    writeOutput(f"Get database:\t{database.id}")

    # <get_container>
    container = database.get_container_client("products")
    # </get_container>
    writeOutput(f"Get container:\t{container.id}")

    # <create_item>
    new_item = {
        "id": "70b63682-b93a-4c77-aad2-65501347265f",
        "category": "gear-surf-surfboards",
        "name": "Yamba Surfboard",
        "quantity": 12,
        "sale": False,
    }
    created_item = container.upsert_item(new_item)
    # </create_item>
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput("Request charge:\t" f"{getLastRequestCharge(container)}")

    new_item = {
        "id": "25a68543-b90c-439d-8332-7ef41e06a0e0",
        "category": "gear-surf-surfboards",
        "name": "Kiama Classic Surfboard",
        "quantity": 4,
        "sale": True,
    }
    created_item = container.upsert_item(new_item)
    writeOutput(f"Upserted item:\t{created_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <read_item>
    existing_item = container.read_item(
        item="70b63682-b93a-4c77-aad2-65501347265f",
        partition_key="gear-surf-surfboards",
    )
    # </read_item>
    writeOutput(f"Read item id:\t{existing_item['id']}")
    writeOutput(f"Read item:\t{existing_item}")
    writeOutput(f"Request charge:\t{getLastRequestCharge(container)}")

    # <query_items>
    queryText = "SELECT * FROM products p WHERE p.category = @category"
    results = container.query_items(
        query=queryText,
        parameters=[
            dict(
                name="@category",
                value="gear-surf-surfboards",
            )
        ],
        enable_cross_partition_query=False,
    )
    # </query_items>
    # <parse_results>
    items = [item for item in results]
    output = json.dumps(items, indent=True)
    # </parse_results>
    writeOutput("Found items:")
    writeOutput(output, isCode=True)

下一步

PyPI 包

通过