快速入门:使用 Azure Cosmos DB Gremlin API 帐户生成 Node.js 应用程序

适用于: Gremlin API

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

先决条件

创建数据库帐户

  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”的文件夹,然后关闭命令提示符。

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

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

    git clone https://github.com/Azure-Samples/azure-cosmos-db-graph-nodejs-getting-started.git
    
  4. 在 Visual Studio 中打开解决方案文件。

查看代码

此步骤是可选的。 如果有意了解如何使用代码创建数据库资源,可以查看以下代码片段。 否则,可以直接跳转到更新连接字符串

以下代码片段全部摘自 app.js 文件。

此控制台应用使用开源 Gremlin Node.js 驱动程序。

  • 将创建 Gremlin 客户端。

    const authenticator = new Gremlin.driver.auth.PlainTextSaslAuthenticator(
        `/dbs/${config.database}/colls/${config.collection}`, 
        config.primaryKey
    )
    
    const client = new Gremlin.driver.Client(
        config.endpoint, 
        { 
            authenticator,
            traversalsource : "g",
            rejectUnauthorized : true,
            mimeType : "application/vnd.gremlin-v2.0+json"
        }
    );
    
    

    配置均位于 config.js 中,可以在 以下部分中编辑该文件。

  • 将定义一系列函数以执行不同 Gremlin 操作。 以下是其中一个函数:

    function addVertex1()
    {
        console.log('Running Add Vertex1'); 
        return client.submit("g.addV(label).property('id', id).property('firstName', firstName).property('age', age).property('userid', userid).property('pk', 'pk')", {
                label:"person",
                id:"thomas",
                firstName:"Thomas",
                age:44, userid: 1
            }).then(function (result) {
                    console.log("Result: %s\n", JSON.stringify(result));
            });
    }
    
  • 每个函数均通过 Gremlin 查询字符串参数执行 client.execute 方法。 下面是演示如何执行 g.V().count() 的示例:

    function countVertices()
    {
        console.log('Running Count');
        return client.submit("g.V().count()", { }).then(function (result) {
            console.log("Result: %s\n", JSON.stringify(result));
        });
    }
    
  • 然后在文件末尾,调用所有方法。 这将依次执行它们:

    client.open()
    .then(dropGraph)
    .then(addVertex1)
    .then(addVertex2)
    .then(addEdge)
    .then(countVertices)
    .catch((err) => {
        console.error("Error running query...");
        console.error(err)
    }).then((res) => {
        client.close();
        finish();
    }).catch((err) => 
        console.error("Fatal error:", err)
    );
    

更新连接字符串

  1. 打开 config.js 文件。

  2. config.js 中,使用 Azure 门户中你的 Cosmos DB 帐户的“概述”页面中的“Gremlin 终结点”值填写 config.endpoint 密钥。

    config.endpoint = "https://<your_Gremlin_account_name>.gremlin.cosmos.azure.cn:443/";

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

  3. config.js 中,使用 Azure 门户中你的 Cosmos DB 帐户的“密钥”页面中的“主密钥”值填写 config.primaryKey 值。

    config.primaryKey = "PRIMARYKEY";

    Azure 门户“密钥”边栏选项卡

  4. 输入数据库名称和图形(容器)名称作为 config.database 和 config.collection 的值。

下面的示例展示了完成的 config.js 文件应该是什么样子的:

var config = {}

// Note that this must include the protocol (HTTPS:// for .NET SDK URI or wss:// for Gremlin Endpoint) and the port number
config.endpoint = "https://testgraphacct.gremlin.cosmos.azure.cn:443/"; 
config.primaryKey = "Pams6e7LEUS7LJ2Qk0fjZf3eGo65JdMWHmyn65i52w8ozPX2oxY3iP0yu05t9v1WymAHNcMwPIqNAEv3XDFsEg==";
config.database = "graphdb"
config.collection = "Persons"

module.exports = config;

运行控制台应用

  1. 打开一个终端窗口,切换到(通过 cd 命令)项目中包括的 package.json 文件的安装目录。

  2. 运行 npm install,安装所需的 npm 模块,包括 gremlin

  3. 在终端中运行 node app.js,启动 node 应用程序。

使用数据资源管理器浏览

现在可以返回到 Azure 门户中的数据资源管理器,查看、查询、修改以及使用新的图形数据。

在数据资源管理器中,新数据库会显示在“图形”窗格中。 展开数据库(后跟容器),然后选择“图形”。

选择“应用筛选器”时,由示例应用生成的数据会显示在“图形”选项卡的下一窗格中。

尝试使用 .has('firstName', 'Thomas') 来完成 g.V(),对筛选器进行测试。 请注意,值区分大小写。

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