快速入门:在 Azure Cosmos DB 中使用 Python 和 Azure 门户创建图形数据库

适用于: Gremlin API

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

先决条件

备注

本快速入门需要 2017 年 12 月 20 日之后创建的图形数据库帐户。 迁移至正式发布版后,现有帐户将支持 Python。

创建数据库帐户

在创建图形数据库之前,需通过 Azure Cosmos DB 创建 Gremlin (Graph) 数据库帐户。

  1. 在新浏览器窗口中,登录到 Azure 门户

  2. 在左侧菜单中,选择“创建资源” 。

    在 Azure 门户中创建资源

  3. 在“新建”页上,选择“数据库” > “Azure Cosmos DB”。

    Azure 门户“数据库”窗格

    提示

    如果在列表中没有看到“Azure Cosmos DB”,只需在页面顶部的搜索框中键入它,然后按 Enter 键即可。

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

    设置 说明
    订阅 你的订阅 选择要用于此 Azure Cosmos DB 帐户的 Azure 订阅。
    资源组 新建

    然后,输入与帐户名称相同的名称。
    选择“新建”。 然后输入帐户的新资源组名称。 为简单起见,请使用与 Azure Cosmos DB 帐户名称相同的名称。
    帐户名 输入唯一的名称 输入标识此 Azure Cosmos DB 帐户的唯一名称。 帐户 URI 将是追加到唯一帐户名称的“gremlin.cosmos.azure.cn” 。

    帐户名称只能使用小写字母、数字及连字符 (-),必须为 3 到 31 个字符长。
    API Gremlin(图形) API 确定要创建的帐户的类型。 Azure Cosmos DB 提供五种 API:Core(SQL)(适用于文档数据库)、Gremlin(适用于图数据库)、MongoDB(适用于文档数据库)、Azure 表和 Cassandra。 必须为每种 API 创建单独的帐户。

    选择“Gremlin (图)”,因为本快速入门将创建使用 Gremlin API 的表 。

    详细了解 Gremlin API
    位置 选择离用户最近的区域 选择用于托管 Azure Cosmos DB 帐户的地理位置。 使用离用户最近的位置,使他们能够以最快的速度访问数据。
    容量模式 预配吞吐量或无服务器 选择“预配吞吐量”以在预配吞吐量模式下创建帐户。 选择“无服务器”以在无服务器模式下创建帐户。

    选择“查看 + 创建” 。 可以跳过“网络” 和“标记” 部分。

    Azure Cosmos DB 的“新建帐户”页

  5. 创建帐户需要几分钟时间。 等待门户中显示“祝贺你! 已创建 Azure Cosmos DB 帐户”页。

    “Azure Cosmos DB 帐户已创建”页

添加图形

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

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

    此时,最右侧显示“添加图形” 区域,可能需要向右滚动才能看到。

    Azure 门户“数据资源管理器”中的“添加图形”页

  2. 在“添加图形” 页上,输入新图形的设置。

    设置 建议的值 说明
    数据库 ID sample-database 输入“sample-database” 作为新数据库的名称。 数据库名称的长度必须为 1 到 255 个字符,不能包含 / \ # ? 或尾随空格。
    吞吐量 400 RU 将吞吐量更改为每秒 400 个请求单位 (RU/s)。 如果想要减少延迟,以后可以增加吞吐量。
    图形 ID sample-graph 输入“sample-graph” 作为新集合的名称。 图形名称与数据库 ID 的字符要求相同。
    分区键 /pk 所有 Cosmos DB 帐户都需要一个分区键才能进行水平缩放。 在图形数据分区一文中了解如何选择适当的分区键。
  3. 填写表单后,请选择“确定” 。

克隆示例应用程序

现在,让我们转到如何使用代码上来。 从 GitHub 克隆 Gremlin API 应用,设置连接字符串,并运行应用。 会看到以编程方式处理数据是多么容易。

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

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

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

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

查看代码

此步骤是可选的。 如果有意了解如何使用代码创建数据库资源,可以查看以下代码片段。 这些代码片段全部摘自 C:\git-samples\azure-cosmos-db-graph-python-getting-started\ 文件夹中的 connect.py 文件。 否则,可以直接跳转到更新连接字符串

  • Gremlin client 在 connect.py 中的第 155 行进行初始化。 请确保将 <YOUR_DATABASE><YOUR_CONTAINER_OR_GRAPH> 替换为帐户的数据库名称和图名称的值:

    ...
    client = client.Client('wss://<YOUR_ENDPOINT>.gremlin.cosmos.azure.cn:443/','g', 
        username="/dbs/<YOUR_DATABASE>/colls/<YOUR_CONTAINER_OR_GRAPH>", 
        password="<YOUR_PASSWORD>")
    ...
    
  • connect.py 文件的开头声明了一系列 Gremlin 步骤。 然后它们将通过 client.submitAsync() 方法执行:

    client.submitAsync(_gremlin_cleanup_graph)
    

更新连接信息

现在,返回到 Azure 门户,获取连接信息,并将信息复制到应用程序中。 借助这些设置,应用程序可以与托管的数据库进行通信。

  1. Azure 门户中,在你的 Azure Cosmos DB 帐户中,选择“密钥”。

    复制 URI 值的第一部分。

    在 Azure 门户的“密钥”页中,查看并复制访问密钥

  2. 打开 connect.py 文件,将 URI 值粘贴至第 155 行的 <YOUR_ENDPOINT> 位置:

    client = client.Client('wss://<YOUR_ENDPOINT>.gremlin.cosmos.azure.cn:443/','g', 
        username="/dbs/<YOUR_DATABASE>/colls/<YOUR_COLLECTION_OR_GRAPH>", 
        password="<YOUR_PASSWORD>")
    

    客户端对象的 URI 部分应类似于以下代码:

    client = client.Client('wss://test.gremlin.cosmos.azure.cn:443/','g', 
        username="/dbs/<YOUR_DATABASE>/colls/<YOUR_COLLECTION_OR_GRAPH>", 
        password="<YOUR_PASSWORD>")
    
  3. 更改 client 对象的第二个参数以替换 <YOUR_DATABASE><YOUR_COLLECTION_OR_GRAPH> 字符串。 如果使用建议的值,该参数应类似于以下代码:

    username="/dbs/sample-database/colls/sample-graph"

    整个 client 对象现在应类似于以下代码:

    client = client.Client('wss://test.gremlin.cosmos.azure.cn:443/','g', 
        username="/dbs/sample-database/colls/sample-graph", 
        password="<YOUR_PASSWORD>")
    
  4. 在“密钥”页上,使用“复制”按钮复制主密钥,并将它粘贴到 password=<YOUR_PASSWORD> 参数中的 <YOUR_PASSWORD> 位置。

    整个 client 对象定义现在应类似以下代码:

    client = client.Client('wss://test.gremlin.cosmos.azure.cn:443/','g', 
        username="/dbs/sample-database/colls/sample-graph", 
        password="asdb13Fadsf14FASc22Ggkr662ifxz2Mg==")
    
  5. 保存 connect.py 文件。

运行控制台应用

  1. 在 git 终端窗口中,使用 cd 命令转到 azure-cosmos-db-graph-python-getting-started 文件夹。

    cd "./git-samples\azure-cosmos-db-graph-python-getting-started"
    
  2. 在 git 终端窗口中,使用以下命令安装所需 Python 包。

    pip install -r requirements.txt
    
  3. 在 git 终端窗口中,使用以下命令启动 Python 应用程序。

    python connect.py
    

    终端窗口会显示添加到图形的顶点和边缘。

    如果遇到超时错误,请在更新你的连接信息中检查是否正确更新了连接信息,并尝试再次运行上一个命令。

    一旦程序停止运行,按 Enter,然后在 Internet 浏览器中立即切换回 Azure 门户。

查看并添加示例数据

插入顶点和边后,现在可以返回数据资源管理器,查看添加到图中的顶点,并添加其他数据点。

  1. 在 Azure 门户中,在你的 Azure Cosmos DB 帐户中,选择“数据资源管理器”,展开“sample-graph”,再依次选择“图形”和“应用筛选器”。

    屏幕截图显示了从 API 中选择了提供“应用筛选器”选项的“图形”。

  2. 在“结果”列表中,请注意,图中添加了三个新用户。 可以通过拖放操作来移动顶点,也可以通过滚动鼠标滚轮进行缩放,并能用双箭头放大图形。

    在 Azure 门户数据资源管理器的图形中的新顶点

  3. 接下来,添加几个新用户。 选择“新建顶点”按钮,向图形中添加数据。

    屏幕截图显示了可以在其中输入值的“新建顶点”窗格。

  4. 输入标签“人员”。

  5. 选择“添加属性”,以添加下列每个属性。 注意,可以在图形中为每个人创建唯一属性。 仅 id 键是必需的。

    key 说明
    pk /pk
    id ashley 顶点的唯一标识符。 如果未指定 id,将为你生成一个。
    gender
    tech Java

    备注

    在本快速入门中创建未分区的集合。 但是,如果在创建集合过程中通过指定分区键创建了分区的集合,则需在每个新顶点中包括该分区键作为键。

  6. 选择“确定”。 可能需要展开屏幕才能在屏幕底部看到“确定”。

  7. 再次选择“新建顶点”,添加其他新用户。

  8. 输入标签“人员”。

  9. 选择“添加属性”,以添加下列每个属性:

    key 说明
    pk /pk
    id rakesh 顶点的唯一标识符。 如果未指定 id,将为你生成一个。
    gender
    school MIT
  10. 选择“确定”。

  11. 选择“应用筛选器”按钮(使用默认 g.V() 筛选器),显示图中的所有值。 所有用户此时会显示在“结果”列表中。

    添加更多数据时,可以使用筛选器来限制结果。 默认情况下,数据资源管理器使用 g.V() 检索图形中的所有顶点。 可以更改为其他图形查询(如 g.V().count()),以 JSON 格式返回图形中所有 顶点的计数。 如果更改了筛选器,请将筛选器更改回 g.V(),并选择“应用筛选器”,再次显示所有结果。

  12. 现在可以连接 rakesh 与 ashley。 确保在“结果”列表中选中“ashley”,然后选择右下侧“目标”旁边的编辑按钮。 可能需要扩大窗口才能看到“属性”区域。

    更改图形中某个顶点的目标

  13. 在“目标”框中键入“rakesh”,在“Edge 标签”框中键入“认识”,再选中复选框。

    通过数据资源管理器在 ashley 和 rakesh 之间添加连接

  14. 现在,从结果列表中选择“rakesh”即可看到 ashley 和 rakesh 已连接。

    在数据资源管理器中连接的两个顶点

这就完成了本教程的资源创建部分。 可以继续向图形添加顶点、修改现有顶点,也可以更改查询。 现在,回顾一下 Azure Cosmos DB 提供的指标,然后清理资源。

在 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 帐户,使用数据资源管理器创建图形,以及运行 Python 应用来向图形添加数据。 现可使用 Gremlin 构建更复杂的查询,实现功能强大的图形遍历逻辑。