快速入门:使用 Azure Cosmos DB Gremlin API 帐户生成 .NET Framework 或 Core 应用程序

适用于: Gremlin API

Azure Cosmos DB 是世纪互联提供的多区域分布式多模型数据库服务。 可快速创建和查询文档、键/值和图形数据库,所有这些都受益于 Azure Cosmos DB 核心的多区域分布和水平缩放功能。

本快速入门演示如何使用 Azure 门户创建 Azure Cosmos DB Gremlin API 帐户、数据库和图(容器)。 然后使用开源驱动程序 Gremlin.Net 生成并运行控制台应用。

先决条件

如果尚未安装 Visual Studio 2019,可以下载并使用 免费Visual Studio 2019 Community Edition。 在安装 Visual Studio 的过程中,请确保启用“Azure 开发”。

如果没有 Azure 试用版订阅,请在开始前创建一个试用版订阅

创建数据库帐户

  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-gremlindotnet-getting-started.git
    
  4. 然后打开 Visual Studio,再打开解决方案文件。

  5. 在项目中还原 NuGet 包。 这应该包括 Gremlin.Net 驱动程序和 Newtonsoft.Json 包。

  6. 也可使用 Nuget 包管理器或 NuGet 命令行实用程序手动安装 Gremlin.Net@v3.4.6 驱动程序:

    nuget install Gremlin.NET -Version 3.4.6
    

备注

Gremlin API 当前仅支持最高 v3.4.6 的 Gremlin.Net。 如果安装最新版本,则在使用该服务时会收到错误。

查看代码

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

以下代码片段全部摘自 Program.cs 文件。

  • 跟踪上面创建的帐户设置连接参数:

    private static string Host => Environment.GetEnvironmentVariable("Host") ?? throw new ArgumentException("Missing env var: Host");
    private static string PrimaryKey => Environment.GetEnvironmentVariable("PrimaryKey") ?? throw new ArgumentException("Missing env var: PrimaryKey");
    private static string Database => Environment.GetEnvironmentVariable("DatabaseName") ?? throw new ArgumentException("Missing env var: DatabaseName");
    private static string Container => Environment.GetEnvironmentVariable("ContainerName") ?? throw new ArgumentException("Missing env var: ContainerName");
    
    private static bool EnableSSL
    {
       get
       {
           if (Environment.GetEnvironmentVariable("EnableSSL") == null)
           {
               return true;
           }
    
           if (!bool.TryParse(Environment.GetEnvironmentVariable("EnableSSL"), out bool value))
           {
               throw new ArgumentException("Invalid env var: EnableSSL is not a boolean");
           }
    
           return value;
       }
    }
    
    private static int Port
    {
       get
       {
           if (Environment.GetEnvironmentVariable("Port") == null)
           {
               return 443;
           }
    
           if (!int.TryParse(Environment.GetEnvironmentVariable("Port"), out int port))
           {
               throw new ArgumentException("Invalid env var: Port is not an integer");
           }
    
           return port;
       } 
    }
    
    
  • 要执行的 Gremlin 命令列在字典中:

    private static Dictionary<string, string> gremlinQueries = new Dictionary<string, string>
    {
       { "Cleanup",        "g.V().drop()" },
       { "AddVertex 1",    "g.addV('person').property('id', 'thomas').property('firstName', 'Thomas').property('age', 44).property('pk', 'pk')" },
       { "AddVertex 2",    "g.addV('person').property('id', 'mary').property('firstName', 'Mary').property('lastName', 'Andersen').property('age', 39).property('pk', 'pk')" },
       { "AddVertex 3",    "g.addV('person').property('id', 'ben').property('firstName', 'Ben').property('lastName', 'Miller').property('pk', 'pk')" },
       { "AddVertex 4",    "g.addV('person').property('id', 'robin').property('firstName', 'Robin').property('lastName', 'Wakefield').property('pk', 'pk')" },
       { "AddEdge 1",      "g.V('thomas').addE('knows').to(g.V('mary'))" },
       { "AddEdge 2",      "g.V('thomas').addE('knows').to(g.V('ben'))" },
       { "AddEdge 3",      "g.V('ben').addE('knows').to(g.V('robin'))" },
       { "UpdateVertex",   "g.V('thomas').property('age', 44)" },
       { "CountVertices",  "g.V().count()" },
       { "Filter Range",   "g.V().hasLabel('person').has('age', gt(40))" },
       { "Project",        "g.V().hasLabel('person').values('firstName')" },
       { "Sort",           "g.V().hasLabel('person').order().by('firstName', decr)" },
       { "Traverse",       "g.V('thomas').out('knows').hasLabel('person')" },
       { "Traverse 2x",    "g.V('thomas').out('knows').hasLabel('person').out('knows').hasLabel('person')" },
       { "Loop",           "g.V('thomas').repeat(out()).until(has('id', 'robin')).path()" },
       { "DropEdge",       "g.V('thomas').outE('knows').where(inV().has('id', 'mary')).drop()" },
       { "CountEdges",     "g.E().count()" },
       { "DropVertex",     "g.V('thomas').drop()" },
    };
    
    
  • 使用上面提供的参数创建新的 GremlinServerGremlinClient 连接对象:

    string containerLink = "/dbs/" + Database + "/colls/" + Container;
    Console.WriteLine($"Connecting to: host: {Host}, port: {Port}, container: {containerLink}, ssl: {EnableSSL}");
    var gremlinServer = new GremlinServer(Host, Port, enableSsl: EnableSSL, 
                                           username: containerLink, 
                                           password: PrimaryKey);
    
    ConnectionPoolSettings connectionPoolSettings = new ConnectionPoolSettings()
    {
       MaxInProcessPerConnection = 10,
       PoolSize = 30, 
       ReconnectionAttempts= 3,
       ReconnectionBaseDelay = TimeSpan.FromMilliseconds(500)
    };
    
    var webSocketConfiguration =
       new Action<ClientWebSocketOptions>(options =>
       {
           options.KeepAliveInterval = TimeSpan.FromSeconds(10);
       });
    
    using (var gremlinClient = new GremlinClient(
       gremlinServer, 
       new GraphSON2Reader(), 
       new GraphSON2Writer(), 
       GremlinClient.GraphSON2MimeType, 
       connectionPoolSettings, 
       webSocketConfiguration))
    {
    
    
  • 通过将 GremlinClient 对象与异步任务配合使用来执行每一个 Gremlin 查询。 可以从上一步中定义的字典读取 Gremlin 查询,并执行它们。 稍后使用 Newtonsoft.Json 包中的 JsonSerializer 类,获取结果并读取已格式化为字典的值:

    foreach (var query in gremlinQueries)
    {
       Console.WriteLine(String.Format("Running this query: {0}: {1}", query.Key, query.Value));
    
       // Create async task to execute the Gremlin query.
       var resultSet = SubmitRequest(gremlinClient, query).Result;
       if (resultSet.Count > 0)
       {
           Console.WriteLine("\tResult:");
           foreach (var result in resultSet)
           {
               // The vertex results are formed as Dictionaries with a nested dictionary for their properties
               string output = JsonConvert.SerializeObject(result);
               Console.WriteLine($"\t{output}");
           }
           Console.WriteLine();
       }
    
       // Print the status attributes for the result set.
       // This includes the following:
       //  x-ms-status-code            : This is the sub-status code which is specific to Cosmos DB.
       //  x-ms-total-request-charge   : The total request units charged for processing a request.
       //  x-ms-total-server-time-ms   : The total time executing processing the request on the server.
       PrintStatusAttributes(resultSet.StatusAttributes);
       Console.WriteLine();
    }
    
    

更新连接字符串

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

  1. Azure 门户中,导航到你的图形数据库帐户。 在“概述”选项卡中,可以看到两个终结点:

    .NET SDK URI - 使用 Microsoft.Azure.Graphs 库连接到图形帐户时将使用此值。

    Gremlin 终结点 - 使用 Gremlin.Net 库连接到图形帐户时将使用此值。

    复制终结点

    若要运行此示例,请复制 Gremlin 终结点 值,删除末尾的端口号,也就是说,URI 将变为 https://<your cosmos db account name>.gremlin.cosmos.azure.cn。 终结点值应类似于 testgraphacct.gremlin.cosmos.azure.cn

  2. 接下来,从 Azure 门户中导航到“密钥”选项卡并复制“主密钥”值。

  3. 复制帐户的 URI 和主键以后,请将其保存到运行应用程序的本地计算机的新环境变量中。 若要设置环境变量,请打开命令提示符窗口,并运行以下命令。 确保替换 <Your_Azure_Cosmos_account_URI> 和 <Your_Azure_Cosmos_account_PRIMARY_KEY> 值。

    setx Host "<your Azure Cosmos account name>.gremlin.cosmos.azure.cn"
    setx PrimaryKey "<Your_Azure_Cosmos_account_PRIMARY_KEY>"
    
  4. 打开 Program.cs 文件,将 "database" 和 "container" 变量更新为在上面创建的数据库和容器的名称(也是图形名称)。

    private static string database = "your-database-name"; private static string container = "your-container-or-graph-name";

  5. 保存 Program.cs 文件。

现已使用与 Azure Cosmos DB 进行通信所需的所有信息更新应用。

运行控制台应用

单击 Ctrl+F5 运行应用程序。 应用程序会在控制台中列显 Gremlin 查询命令和结果。

控制台窗口会显示所添加到图形的顶点及边缘。 完成脚本后,按 ENTER 关闭控制台窗口。

使用数据资源管理器浏览

现在可以返回到 Azure 门户中的数据资源管理器,浏览和查询新的图形数据。

  1. 在数据资源管理器中,新数据库会显示在“图形”窗格中。 展开数据库和容器节点,然后单击“图形”。

  2. 单击“应用筛选器”按钮,使用默认查询来查看图形中的所有顶点。 示例应用生成的数据会显示在“图形”窗格中。

    可以放大和缩小图形,可以扩展图形显示空间,可以添加其他顶点,还可以在显示图面移动顶点。

    在 Azure 门户的数据资源管理器中查看图形

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