快速入门:使用 Azure Cosmos DB SQL API 帐户生成 Python 应用程序

适用于: SQL API

在本快速入门中,你将通过 Azure 门户创建和管理 Azure Cosmos DB SQL API 帐户,并通过 Visual Studio Code 使用从 GitHub 克隆的 Python 应用来添加数据。 Azure Cosmos DB 是一种多模型数据库服务,可让你通过多区域分布和水平缩放功能快速创建和查询文档、表、键/值和图数据库。

先决条件

创建数据库帐户

  1. 在 Azure 门户菜单或主页中,选择“创建资源” 。

  2. 在“新建”页面中搜索“Azure Cosmos DB”,然后选择它。

  3. 在“Azure Cosmos DB”页上,选择“创建”。

  4. 在“创建 Azure Cosmos DB 帐户”页中,输入新 Azure Cosmos 帐户的基本设置。

    设置 说明
    订阅 订阅名称 选择要用于此 Azure Cosmos 帐户的 Azure 订阅。
    资源组 资源组名称 选择一个资源组,或者选择“新建”,然后输入新资源组的唯一名称。
    帐户名 唯一的名称 输入标识此 Azure Cosmos 帐户的名称。 由于 documents.azure.cn 将追加到所提供的名称以创建 URI,因此,请使用唯一的名称。

    名称只能包含小写字母、数字和连字符 (-)。 它的长度必须介于 3 到 31 个字符之间。
    API 要创建的帐户的类型 选择“Core (SQL)”,以便使用 SQL 语法创建文档数据库并进行查询。

    API 确定要创建的帐户的类型。 Azure Cosmos DB 提供五种 API:适用于文档数据的 Core (SQL) 和 MongoDB、适用于图形数据的 Gremlin、Azure 表和 Cassandra。 目前,你必须为每种 API 创建单独的帐户。

    详细了解 SQL API
    位置 离用户最近的区域 选择用于托管 Azure Cosmos DB 帐户的地理位置。 使用离用户最近的位置,使他们能够以最快的速度访问数据。
    容量模式 预配吞吐量或无服务器 选择“预配吞吐量”以在预配吞吐量模式下创建帐户。 选择“无服务器”以在无服务器模式下创建帐户。
    应用 Azure Cosmos DB 免费层折扣 “应用”或“不应用” 使用 Azure Cosmos DB 免费层,你将在帐户中获得每秒前 1000 RU 的免费吞吐量和 25 GB 的免费存储。 了解免费层的详细信息。

    备注

    每个 Azure 订阅最多可以有一个免费层 Azure Cosmos DB 帐户,并且你必须在创建帐户时选择加入使用。 如果看不到用于应用免费层折扣的选项,这意味着订阅中的另一个帐户已启用免费层。

    Azure Cosmos DB 的“新建帐户”页面

  5. 在“全局分发”选项卡中,配置以下详细信息。 对于本快速入门,可以保留默认值:

    设置 说明
    异地冗余 禁用 通过将你的区域与另一区域进行配对来启用或禁用帐户的全局分发。 稍后可以将更多区域添加到帐户。
    多区域写入 禁用 借助多区域写入功能,可以利用全球数据库和容器的预配吞吐量。

    备注

    如果选择“无服务器”作为“容量模式”,则以下选项不可用 :

    • 应用免费层折扣
    • 异地冗余
    • 多区域写入
  6. (可选)可以在以下选项卡中配置其他详细信息:

    • 网络 - 配置从虚拟网络进行访问

    • 备份策略 -配置定期备份策略。

    • 加密 - 使用服务管理的密钥或客户管理的密钥

    • 标记 - 标记是名称/值对。通过将相同的标记应用到多个资源和资源组,可以对资源进行分类并查看合并的账单。

  7. 选择“查看 + 创建”。

  8. 检查帐户设置,然后选择“创建”。 创建帐户需要几分钟时间。 等待门户页显示“你的部署已完成”消息。

    Azure 门户“通知”窗格

  9. 选择“转到资源”,转到 Azure Cosmos DB 帐户页。

    Azure Cosmos DB 帐户页面

添加容器

现在可以在 Azure 门户中使用数据资源管理器工具来创建数据库和容器。

  1. 选择“数据资源管理器” > “新建容器”。

    “添加容器”区域显示在最右侧,可能需要向右滚动才能看到它。

    Azure 门户 >“数据资源管理器”>“添加集合”窗格

  2. 在“添加容器”页中,输入新容器的设置。

    设置 建议的值 说明
    数据库 ID ToDoList 输入 Tasks 作为新数据库的名称。 数据库名称必须包含 1 到 255 个字符,不能包含 /, \\, #, ? 或尾随空格。 选中“跨容器共享吞吐量”选项,这样就可以在数据库中的所有容器之间共享在该数据库上预配的吞吐量。 此选项还有助于节省成本。
    数据库吞吐量 可以预配“自动缩放”或“手动”吞吐量 。 “手动”吞吐量使你可以自行缩放 RU/秒,而自动缩放吞吐量使系统可以根据使用情况缩放 RU/秒。 对于此示例,请选择“手动”。

    将吞吐量保留为每秒 400 个请求单位 (RU/s)。 如果希望减少延迟,可以稍后通过使用容量计算器估算所需的 RU/秒来纵向扩展吞吐量。

    注意:在无服务器帐户中创建新容器时,此设置不可用。
    容器 ID Items 输入 Items 作为新容器的名称。 容器 ID 与数据库名称的字符要求相同。
    分区键 /category 本文中所述的示例使用 /category 作为分区键。

    请勿为此示例添加“唯一键”或启用“分析存储” 。 使用唯一键可将数据完整性层添加到数据库,因为它能确保每个分区键的一个或多个值的唯一性。 有关详细信息,请参阅 Azure Cosmos DB 中的唯一键分析存储用于针对操作数据启用大规模分析,而不会对事务工作负载产生任何影响。

    选择“确定” 。 数据资源管理器将显示新的数据库和容器。

添加示例数据

现在可以使用数据资源管理器将数据添加到新容器。

  1. 在“数据资源管理器”中展开“Tasks”数据库,然后展开“Items”容器。 依次选择“项”、“新建项”。

    在 Azure 门户的数据资源管理器中创建新文档

  2. 现在,将文档添加到具有以下结构的容器。

    {
        "id": "1",
        "category": "personal",
        "name": "groceries",
        "description": "Pick up apples and strawberries.",
        "isComplete": false
    }
    
  3. 将 json 添加到“文档”选项卡以后,即可选择“保存”。

    通过复制添加 JSON 数据,然后在 Azure 门户上的数据资源管理器中选择“保存”

  4. 再创建并保存一个文档,在其中插入 id 属性的唯一值,并将其他属性更改为适当值。 新文档可以具有所需的任何结构,因为 Azure Cosmos DB 不对数据施加任何架构。

查询数据

可以在数据资源管理器中使用查询来检索和筛选数据。

  1. 在数据资源管理器的“项”选项卡顶部,查看默认查询 SELECT * FROM c。 此查询检索并显示容器中按 ID 排序的所有文档。

    数据资源管理器中的默认查询是“SELECT * FROM c”

  2. 若要更改查询,请选择“编辑筛选器”,将默认查询替换为 ORDER BY c._ts DESC,然后选择“应用筛选器”。

    添加“ORDER BY c._ts DESC”并单击“应用筛选器”,更改默认查询

    此修改后的查询根据文档的时间戳按降序显示文档,所以现在最先列出的是第二个文档。

    将查询更改为 ORDER BY c._ts DESC,然后单击“应用筛选器”

如果熟悉 SQL 语法,可以在查询谓词框中输入任何受支持的 SQL 查询。 还可以使用数据资源管理器创建存储过程、UDF 和触发器以执行服务器端业务逻辑。

数据资源管理器可以通过 Azure 门户轻松访问 API 中提供的所有内置编程数据访问功能。 也可通过门户缩放吞吐量、获取密钥和连接字符串,以及查看 Azure Cosmos DB 帐户的指标和 SLA。

克隆示例应用程序

现在,让我们从 GitHub 中克隆一个 SQL API 应用,设置连接字符串,然后运行该应用。 本快速入门使用 Python SDK 版本 4。

  1. 打开命令提示符,新建一个名为“git-samples”的文件夹,然后关闭命令提示符。

    md "git-samples"
    

    如果使用的是 bash 提示符,则应当改用以下命令:

    mkdir "git-samples"
    
  2. 打开诸如 git bash 之类的 git 终端窗口,并使用 cd 命令更改为要安装示例应用的新文件夹。

    cd "git-samples"
    
  3. 运行下列命令,克隆示例存储库。 此命令在计算机上创建示例应用程序的副本。

    git clone https://github.com/Azure-Samples/azure-cosmos-db-python-getting-started.git
    

更新连接字符串

现在返回到 Azure 门户,获取连接字符串信息,并将其复制到应用。

  1. Azure 门户中,在你的 Azure Cosmos DB 帐户中,选择左侧导航栏中的“密钥”。 使用屏幕右侧的复制按钮将 URI主密钥 复制到下一步的 cosmos_get_started.py 文件中。

    在 Azure 门户的“密钥”设置中获取访问密钥和 URI

  2. 在 Visual Studio Code 中,打开 \git-samples\azure-cosmos-db-python-getting-started 中的 cosmos_get_started.py 文件。

  3. 从门户中复制你的 URI 值(使用复制按钮),并在 cosmos_get_started.py 中将其设为 endpoint 变量的值。

    endpoint = 'https://FILLME.documents.azure.cn',

  4. 然后从门户复制“主密钥”值,并在 cosmos_get_started.py 中将其设为 key 的值。 现已使用与 Azure Cosmos DB 进行通信所需的所有信息更新应用。

    key = 'FILLME'

  5. 保存 cosmos_get_started.py 文件。

查看代码

此步骤是可选的。 了解在代码中创建的数据库资源,或者跳转到更新连接字符串

以下代码片段全部摘自 cosmos_get_started.py 文件。

  • 对 CosmosClient 进行初始化。 请务必根据更新连接字符串部分中所述更新“endpoint”和“key”值。

    client = CosmosClient(endpoint, key)
    
  • 将创建一个新数据库。

    database_name = 'AzureSampleFamilyDatabase'
    database = client.create_database_if_not_exists(id=database_name)
    
  • 将创建一个预配吞吐量为 400 RU/秒的新容器。 选择 lastName 作为分区键,这可以按属性进行筛选并执行有效的查询。

    container_name = 'FamilyContainer'
    container = database.create_container_if_not_exists(
        id=container_name, 
        partition_key=PartitionKey(path="/lastName"),
        offer_throughput=400
    )
    
  • 向容器中添加一些项。 容器是项(JSON 文档)的集合,这些项可以采用不同的架构。 帮助器方法 get_[name]_family_item 返回 Azure Cosmos DB 中作为 JSON 文档存储的家族表示形式。

    for family_item in family_items_to_create:
        container.create_item(body=family_item)
    
  • 使用 read_item 方法执行点读取(键值查找)。 我们将输出每个操作的 RU 费用

    for family in family_items_to_create:
        item_response = container.read_item(item=family['id'], partition_key=family['lastName'])
        request_charge = container.client_connection.last_response_headers['x-ms-request-charge']
        print('Read item with id {0}. Operation consumed {1} request units'.format(item_response['id'], (request_charge)))
    
  • 使用 SQL 查询语法执行查询。 由于我们在 WHERE 子句中使用 lastName 的分区键值,因此 Azure Cosmos DB 会有效地将此查询路由到相关分区,从而提高性能。

    query = "SELECT * FROM c WHERE c.lastName IN ('Wakefield', 'Andersen')"
    
    items = list(container.query_items(
        query=query,
        enable_cross_partition_query=True
    ))
    
    request_charge = container.client_connection.last_response_headers['x-ms-request-charge']
    
    print('Query returned {0} items. Operation consumed {1} request units'.format(len(items), request_charge))
    

运行应用

  1. 在 Visual Studio Code 中,选择“视图” > “命令面板”。

  2. 在提示符处,输入 Python:Select Interpreter,然后选择要使用的 Python 的版本。

    Visual Studio Code 中的页脚将更新以指示所选的解释器。

  3. 选择“视图” > “集成终端”以打开 Visual Studio Code 集成终端。

  4. 在集成的终端窗口中,确保位于 azure-cosmos-db-python-getting-started 文件夹中。 如果没有位于该文件夹中,请运行以下命令来切换到示例文件夹。

    cd "\git-samples\azure-cosmos-db-python-getting-started"`
    
  5. 运行以下命令来安装 azure-cosmos 程序包。

    pip install --pre azure-cosmos
    

    如果尝试安装 azure-cosmos 时收到有关访问被拒绝的错误,则需要以管理员身份运行 VS Code

  6. 运行以下命令来运行示例并将新文档存储在 Azure Cosmos DB 中。

    python cosmos_get_started.py
    
  7. 若要确认是否已创建并保存新项,请在 Azure 门户中选择“数据资源管理器” > “AzureSampleFamilyDatabase” > “项”。 查看创建的项。 例如,下面是 Andersen 家族的示例 JSON 文档:

    {
        "id": "Andersen-1569479288379",
        "lastName": "Andersen",
        "district": "WA5",
        "parents": [
            {
                "familyName": null,
                "firstName": "Thomas"
            },
            {
                "familyName": null,
                "firstName": "Mary Kay"
            }
        ],
        "children": null,
        "address": {
            "state": "WA",
            "county": "King",
            "city": "Seattle"
        },
        "registered": true,
        "_rid": "8K5qAIYtZXeBhB4AAAAAAA==",
        "_self": "dbs/8K5qAA==/colls/8K5qAIYtZXc=/docs/8K5qAIYtZXeBhB4AAAAAAA==/",
        "_etag": "\"a3004d78-0000-0800-0000-5d8c5a780000\"",
        "_attachments": "attachments/",
        "_ts": 1569479288
    }
    

在 Azure 门户中查看 SLA

Azure 门户监视 Cosmos DB 帐户吞吐量、存储、可用性、延迟和一致性。 与 Azure Cosmos DB 服务级别协议 (SLA) 关联的指标的图表显示与实际性能相比的 SLA 值。 此套指标使得监视 SLA 十分透明。

若要查看指标和 SLA,请执行以下操作:

  1. 在 Cosmos DB 帐户的导航菜单中选择“指标” 。

  2. 选择一个选项卡,如“延迟” ,然后选择右侧的时间范围。 比较图表上的“实际” 和“SLA” 线。

    Azure Cosmos DB 指标套件

  3. 查看其他选项卡上的指标。

清理资源

执行完应用和 Azure Cosmos DB 帐户的操作以后,可以删除所创建的 Azure 资源,以免产生更多费用。 若要删除资源,请执行以下操作:

  1. 在 Azure 门户的“搜索”栏中,搜索并选择“资源组” 。

  2. 从列表中选择为本快速入门创建的资源组。

    选择要删除的资源组

  3. 在资源组“概览”页上,选择“删除资源组” 。

    删除资源组

  4. 在下一窗口中输入要删除的资源组的名称,然后选择“删除” 。

后续步骤

在本快速入门中,你已了解了如何创建 Azure Cosmos DB 帐户,使用数据资源管理器创建容器,以及在 Visual Studio Code 中运行 Python 应用。 现在可以将其他数据导入 Azure Cosmos DB 帐户了。