› 推特 ›阿里云技术文档›正文

NodeJs_SDK参考_图数据库GDB

admin 阿里云技术文档 2020-02-11 191 0
阿里云服务器优惠

NodeJs

本文介绍如何基于Node.js编程环境连接和操作图数据库GDB，这也是以常驻服务形式操作图数据库GDB的常用形式。

注意

  • 进行以下操作时请确保图数据库GDB实例与您运行环境网络联通。
  • 确保运行环境已经安装有Node.js，且版本不低于8.11

环境准备

  • 安装Node.js，版本8.11或更高版本，Linux环境可以直接安装二进制包

  • 安装gremlin-javascript程序包

    1. npm install gremlin
  • 获取图数据库GDB连接参数

在’实例管理’->’基本信息’页面，可以查看实例内网地址和内网端口，如果开通外网访问实例，也可以使用外网地址和外网端口

注意 确保运行环境在实例白名单配置的可访问范围内

  1. # 内网环境
  2. endpoint = "${gdbID}.graphdb.rds.aliyuncs.com:8182"
  4. # 外网环境
  5. endpoint = "${gdbID}pub.graphdb.rds.aliyuncs.com:3734"

在’实例管理’->’账号管理’页面，可以查询实例账号信息，如果忘记密码，请’重置密码’

  1. cusername="${username}"
  2. password="${password}"

示例代码

  • 新建一个demo目录，并添加测试文件
  1. mkdir gdb_demo
  2. cd gdb_demo
  3. touch demo.js
  • 编写测试代码，将下面your-endpoint替换为您的GDB实例内网环境或外网环境的endpoint，your-username和your-password也替换为您的GDB账号信息
  1. "use strict";
  3. const gremlin = require('gremlin');
  4. const authenticator = new gremlin.driver.auth.PlainTextSaslAuthenticator('your-username', 'your-password');
  5. const client = new gremlin.driver.Client(
  6.     'ws://your-endpoint/gremlin',
  7.     {authenticator}
  8. );
  10. function countVertices()
  11. {
  12.     console.log('Running Vertex Count');
  13.     return client.submit("g.V().count()", { })
  14.         .then((result) => {
  15.             console.log("Vertex Count Result: %s\n", JSON.stringify(result));
  16.         });
  17. }
  19. function addVertex1()
  20. {
  21.     console.log('Running Add Vertex 1');
  22.     return client.submit("g.addV(GDB___label).property(id, GDB___id).property(GDB___pk, GDB___pv)",{
  23.         GDB___id: "gdb_vertex_test_id_1",
  24.         GDB___label: "gdb_vertex_test_label",
  25.         GDB___pk: "name",
  26.         GDB___pv: "Jack"
  27.     }).then(data => {
  28.         console.log("Add Vertex 1 Result: %s\n", JSON.stringify(data));
  29.     });
  30. }
  32. function addVertex2()
  33. {
  34.     console.log('Running Add Vertex 2');
  35.     return client.submit("g.addV(GDB___label).property(id, GDB___id).property(GDB___pk, GDB___pv)",{
  36.         GDB___id: "gdb_vertex_test_id_2",
  37.         GDB___label: "gdb_vertex_test_label",
  38.         GDB___pk: "name",
  39.         GDB___pv: "Lucy"
  40.     }).then(data => {
  41.         console.log("Add Vertex 2 Result: %s\n", JSON.stringify(data));
  42.     });
  43. }
  45. function addEdge()
  46. {
  47.     console.log('Running Add Edge');
  48.     return client.submit("g.addE(GDB___label).from(V(GDB___from)).to(V(GDB___to)).property(id, GDB___id).property(GDB___pk, GDB___pv)",{
  49.         GDB___id: "gdb_edge_test_id",
  50.         GDB___label: "gdb_edge_test_label",
  51.         GDB___from: "gdb_vertex_test_id_1",
  52.         GDB___to: "gdb_vertex_test_id_2",
  53.         GDB___pk: "relation",
  54.         GDB___pv: "lover"
  55.     }).then(data => {
  56.         console.log("Add Edge Result: %s\n", JSON.stringify(data));
  57.     });
  58. }
  60. function dropVertices()
  61. {
  62.     console.log('Running Drop');
  63.     return client.submit('g.V().drop()', { })
  64.         .then((result) => {
  65.             console.log("Drop Result: %s\n", JSON.stringify(result));
  66.         });
  67. }
  69. client.open()
  70.     .then(countVertices)
  71.     .then(addVertex1)
  72.     .then(addVertex2)
  73.     .then(addEdge)
  74.     .then(dropVertices)
  75.     .catch((error) => {
  76.         console.error("Error running query...");
  77.         console.error(error);
  78.     }).then((res) => {
  79.         client.close()
  80.         console.log("Finished, Press any key to exit")
  81.         process.stdin.resume();
  82.         process.stdin.on('data', process.exit.bind(process, 0));
  83.     }).catch((err) => {
  84.         console.error("Fatal error:", err);
  85.     });

上述代码使用图数据库GDB连接参数新建访问client，然后查询点数量，再添加两个点和一个边，接着删除所有点，最后等待用户键入退出

注意 使用script方式交互时，最好将DSL中可变参数模版化，对性能提升有显著帮助

  • 复制上述代码到demo.js，运行测试程序
  1. # 安装gremlin依赖到测试工程目录
  2. npm install gremlin
  3. # 运行测试程序
  4. node demo.js
  • 连接新创建的图数据库GDB实例，以下是测试程序的输出
  1. Running Vertex Count
  2. Vertex Count Result: {"_items":[0],"attributes":{},"length":1}
  4. Running Add Vertex 1
  5. Add Vertex 1 Result: {"_items":[{"id":"gdb_vertex_test_id_1","label":"gdb_vertex_test_label","properties":{"name":[{"id":"gdb_vertex_test_id_1","label":"name","value":"Jack","key":"name"}]}}],"attributes":{},"length":1}
  7. Running Add Vertex 2
  8. Add Vertex 2 Result: {"_items":[{"id":"gdb_vertex_test_id_2","label":"gdb_vertex_test_label","properties":{"name":[{"id":"gdb_vertex_test_id_2","label":"name","value":"Lucy","key":"name"}]}}],"attributes":{},"length":1}
  10. Running Add Edge
  11. Add Edge Result: {"_items":[{"id":"gdb_edge_test_id","label":"gdb_edge_test_label","outV":"gdb_vertex_test_id_1","inV":"gdb_vertex_test_id_2","properties":{"relation":"lover"}}],"attributes":{},"length":1}
  13. Running Drop
  14. Drop Result: {"_items":[],"attributes":{},"length":0}
  16. Finished, Press any key to exit

使用bytecode方式访问图数据库GDB

除上述script方式与图数据库GDB交互外，您也可以使用bytecode方式与GDB交互，以下直接给出与上一节相同功能的代码，您可以直接用相同方法运行查看执行结果。

同样您也需要替换图数据库GDB实例对连接参数到下面代码中。

  1. "use strict";
  3. const gremlin = require('gremlin');
  4. const DriverRemoteConnection = gremlin.driver.DriverRemoteConnection;
  5. const Graph = gremlin.structure.Graph;
  6. const __ = gremlin.process.statics;
  7. const t = gremlin.process.t;
  9. const authenticator = new gremlin.driver.auth.PlainTextSaslAuthenticator('your-username', 'your-password');
  11. const graph = new Graph();
  12. const g = graph.traversal().withRemote(
  13.     new DriverRemoteConnection(
  14.         'ws://your-endpoint/gremlin',
  15.         {authenticator}
  16.     ));
  18. function vertexCount()
  19. {
  20.     console.log('Running Vertex Count');
  21.     return g.V().count().next().
  22.         then(data => {
  23.             console.log("Vertex Count Result: %s", JSON.stringify(data));
  24.         });
  25. }
  27. function addVertex1()
  28. {
  29.     console.log('Running Add Vertex 1');
  30.     return g.addV('gdb_vertex_test_label')
  31.         .property(t.id, 'gdb_vertex_test_id_1')
  32.         .property('name','Jack').toList()
  33.         .then(data => {
  34.             console.log("Add Vertex 1 Result: %s", JSON.stringify(data));
  35.         });
  36. }
  38. function addVertex2()
  39. {
  40.     console.log('Running Add Vertex 2');
  41.     return g.addV('gdb_vertex_test_label')
  42.         .property(t.id, 'gdb_vertex_test_id_2')
  43.         .property('name','Lucy').toList()
  44.         .then(data => {
  45.             console.log("Add Vertex 2 Result: %s", JSON.stringify(data));
  46.         });
  47. }
  49. function addEdge()
  50. {
  51.     console.log('Running Add Edge');
  52.     return g.addE('gdb_edge_test_label')
  53.         .from_(__.V('gdb_vertex_test_id_1'))
  54.         .to(__.V('gdb_vertex_test_id_2'))
  55.         .property(t.id, 'gdb_edge_test_id')
  56.         .property('relation','lover').toList()
  57.         .then(data => {
  58.             console.log("Add Edge Result: %s", JSON.stringify(data));
  59.         });
  60. }
  62. function dropVertex()
  63. {
  64.     console.log('Running Drop');
  65.     return g.V().drop().iterate();
  66. }
  68. function finish()
  69. {
  70.     console.log("Finished, Press any key to exit")
  71.     process.stdin.resume();
  72.     process.stdin.on('data', process.exit.bind(process, 0));
  73. }
  75. async function allTasks()
  76. {
  77.   await vertexCount();
  78.   await addVertex1();
  79.   await addVertex2();
  80.   await addEdge();
  81.   await dropVertex();
  82.   await finish();
  83. }
  85. allTasks();

以上示例使用顺序串行的方式依次完成点数量查询，添加两个点和一个边，再删除所有数据，最后等待用户键入退出。示例只是演示script和bytecode完成相同功能的代码片段，同时也推荐您在异步事件中嵌入GDB的操作代码。

注意使用bytecode方式需要在DSL末尾添加一个终结符，这样DSL前面的操作才会提交到GDB服务端执行。

最佳实践

  • GDB支持script和bytecode两种方式访问，但更推荐使用script方式
  • 使用script方式访问GDB时，最好将DSL中可变参数模版化，可以获得较好的性能
版权声明

本文仅代表作者观点，不代表本站立场。
本文系作者授权发表，未经许可，不得转载。

评论

-----