导入Neo4j数据

本文以一个示例说明如何使用Exchange将存储在Neo4j的数据导入Nebula Graph。

实现方法

Exchange使用Neo4j Driver 4.0.1实现对Neo4j数据的读取。执行批量导出之前,用户需要在配置文件中写入针对标签(label)和关系类型(Relationship Type)自动执行的Cypher语句,以及Spark分区数,提高数据导出性能。

Exchange读取Neo4j数据时需要完成以下工作:

  1. Exchange中的Reader会将配置文件中exec部分的CypherRETURN语句后面的语句替换为COUNT(*),并执行这个语句,从而获取数据总量,再根据Spark分区数量计算每个分区的起始偏移量和大小。

  2. (可选)如果用户配置了check_point_path目录,Reader会读取目录中的文件。如果处于续传状态,Reader会计算每个Spark分区应该有的偏移量和大小。

  3. 在每个Spark分区里,Exchange中的Reader会在Cypher语句后面添加不同的SKIPLIMIT语句,调用Neo4j Driver并行执行,将数据分布到不同的Spark分区中。

  4. Reader最后将返回的数据处理成DataFrame。

至此,Exchange即完成了对Neo4j数据的导出。之后,数据被并行写入Nebula Graph数据库中。

整个过程如下图所示。

Nebula Graph® Exchange 从 Neo4j 数据库中导出数据再并行导入 Nebula Graph 数据库中

数据集

本文以basketballplayer数据集为例。

环境配置

本文示例在MacOS下完成,以下是相关的环境配置信息:

  • 硬件规格:

    • CPU:Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz

    • CPU 内核数:14

    • 内存:251 GB

  • Spark:单机版,2.4.6 pre-build for Hadoop 2.7

  • Neo4j:3.5.20 Community Edition

  • Nebula Graph:2.6.0。使用Docker Compose部署

前提条件

开始导入数据之前,用户需要确认以下信息:

  • 已经安装部署Nebula Graph并获取如下信息:

    • Graph服务和Meta服务的的IP地址和端口。

    • 拥有Nebula Graph写权限的用户名和密码。

  • 已经编译Exchange。详情请参见编译Exchange。本示例中使用Exchange 2.6.0。

  • 已经安装Spark。

  • 了解Nebula Graph中创建Schema的信息,包括Tag和Edge type的名称、属性等。

操作步骤

步骤 1:在Nebula Graph中创建Schema

分析数据,按以下步骤在Nebula Graph中创建Schema:

  1. 确认Schema要素。Nebula Graph中的Schema要素如下表所示。

    要素名称属性
    Tagplayername string, age int
    Tagteamname string
    Edge Typefollowdegree int
    Edge Typeservestart_year int, end_year int
  2. 使用Nebula Console创建一个图空间basketballplayer,并创建一个Schema,如下所示。

    1. ## 创建图空间
    2. nebula> CREATE SPACE basketballplayer \
    3. (partition_num = 10, \
    4. replica_factor = 1, \
    5. vid_type = FIXED_STRING(30));
    6. ## 选择图空间basketballplayer
    7. nebula> USE basketballplayer;
    8. ## 创建Tag player
    9. nebula> CREATE TAG player(name string, age int);
    10. ## 创建Tag team
    11. nebula> CREATE TAG team(name string);
    12. ## 创建Edge type follow
    13. nebula> CREATE EDGE follow(degree int);
    14. ## 创建Edge type serve
    15. nebula> CREATE EDGE serve(start_year int, end_year int);

更多信息,请参见快速开始

步骤 2:配置源数据

为了提高Neo4j数据的导出速度,在Neo4j数据库中为相应属性创建索引。详细信息,参考Neo4j用户手册

步骤 3:修改配置文件

编译Exchange后,复制target/classes/application.conf文件设置数据源相关的配置。在本示例中,复制的文件名为neo4j_application.conf。各个配置项的详细说明请参见配置说明

  1. {
  2. # Spark相关配置
  3. spark: {
  4. app: {
  5. name: Nebula Exchange 2.6.0
  6. }
  7. driver: {
  8. cores: 1
  9. maxResultSize: 1G
  10. }
  11. executor: {
  12. memory:1G
  13. }
  14. cores:{
  15. max: 16
  16. }
  17. }
  18. # Nebula Graph相关配置
  19. nebula: {
  20. address:{
  21. graph:["127.0.0.1:9669"]
  22. meta:["127.0.0.1:9559"]
  23. }
  24. user: root
  25. pswd: nebula
  26. space: basketballplayer
  27. connection {
  28. timeout: 3000
  29. retry: 3
  30. }
  31. execution {
  32. retry: 3
  33. }
  34. error: {
  35. max: 32
  36. output: /tmp/errors
  37. }
  38. rate: {
  39. limit: 1024
  40. timeout: 1000
  41. }
  42. }
  43. # 处理点
  44. tags: [
  45. # 设置Tag player相关信息。
  46. {
  47. name: player
  48. type: {
  49. source: neo4j
  50. sink: client
  51. }
  52. server: "bolt://192.168.*.*:7687"
  53. user: neo4j
  54. password:neo4j
  55. database:neo4j
  56. exec: "match (n:player) return n.id as id, n.age as age, n.name as name"
  57. fields: [age,name]
  58. nebula.fields: [age,name]
  59. vertex: {
  60. field:id
  61. }
  62. partition: 10
  63. batch: 1000
  64. check_point_path: /tmp/test
  65. }
  66. # 设置Tag team相关信息。
  67. {
  68. name: team
  69. type: {
  70. source: neo4j
  71. sink: client
  72. }
  73. server: "bolt://192.168.*.*:7687"
  74. user: neo4j
  75. password:neo4j
  76. database:neo4j
  77. exec: "match (n:team) return n.id as id,n.name as name"
  78. fields: [name]
  79. nebula.fields: [name]
  80. vertex: {
  81. field:id
  82. }
  83. partition: 10
  84. batch: 1000
  85. check_point_path: /tmp/test
  86. }
  87. ]
  88. # 处理边数据
  89. edges: [
  90. # 设置Edge type follow相关信息
  91. {
  92. name: follow
  93. type: {
  94. source: neo4j
  95. sink: client
  96. }
  97. server: "bolt://192.168.*.*:7687"
  98. user: neo4j
  99. password:neo4j
  100. database:neo4j
  101. exec: "match (a:player)-[r:follow]->(b:player) return a.id as src, b.id as dst, r.degree as degree order by id(r)"
  102. fields: [degree]
  103. nebula.fields: [degree]
  104. source: {
  105. field: src
  106. }
  107. target: {
  108. field: dst
  109. }
  110. #ranking: rank
  111. partition: 10
  112. batch: 1000
  113. check_point_path: /tmp/test
  114. }
  115. # 设置Edge type serve相关信息
  116. {
  117. name: serve
  118. type: {
  119. source: neo4j
  120. sink: client
  121. }
  122. server: "bolt://192.168.*.*:7687"
  123. user: neo4j
  124. password:neo4j
  125. database:neo4j
  126. exec: "match (a:player)-[r:serve]->(b:team) return a.id as src, b.id as dst, r.start_year as start_year, r.end_year as end_year order by id(r)"
  127. fields: [start_year,end_year]
  128. nebula.fields: [start_year,end_year]
  129. source: {
  130. field: src
  131. }
  132. target: {
  133. field: dst
  134. }
  135. #ranking: rank
  136. partition: 10
  137. batch: 1000
  138. check_point_path: /tmp/test
  139. }
  140. ]
  141. }

exec配置说明

在配置tags.exec或者edges.exec参数时,需要填写Cypher查询语句。为了保证每次查询结果排序一致,并且为了防止在导入时丢失数据,强烈建议在Cypher查询语句中加入ORDER BY子句,同时,为了提高数据导入效率,最好选取有索引的属性作为排序的属性。如果没有索引,用户也可以观察默认的排序,选择合适的属性用于排序,以提高效率。如果默认的排序找不到规律,用户可以根据点或关系的ID进行排序,并且将partition设置为一个尽量小的值,减轻Neo4j的排序压力。

说明:使用ORDER BY子句会延长数据导入的时间。

另外,Exchange需要在不同Spark分区执行不同SKIPLIMIT的Cypher语句,所以在tags.execedges.exec对应的Cypher语句中不能含有SKIPLIMIT子句。

tags.vertex或edges.vertex配置说明

Nebula Graph在创建点和边时会将ID作为唯一主键,如果主键已存在则会覆盖该主键中的数据。所以,假如将某个Neo4j属性值作为Nebula Graph的ID,而这个属性值在Neo4j中是有重复的,就会导致重复ID,它们对应的数据有且只有一条会存入Nebula Graph中,其它的则会被覆盖掉。由于数据导入过程是并发地往Nebula Graph中写数据,最终保存的数据并不能保证是Neo4j中最新的数据。

check_point_path配置说明

如果启用了断点续传功能,为避免数据丢失,在断点和续传之间,数据库不应该改变状态,例如不能添加数据或删除数据,同时,不能更改partition数量配置。

步骤 4:向Nebula Graph导入数据

运行如下命令将文件数据导入到Nebula Graph中。关于参数的说明,请参见导入命令参数

  1. ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange <nebula-exchange-2.6.0.jar_path> -c <neo4j_application.conf_path>

Note

JAR包有两种获取方式:自行编译或者从maven仓库下载。

示例:

  1. ${SPARK_HOME}/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange /root/nebula-exchange/nebula-exchange/target/nebula-exchange-2.6.0.jar -c /root/nebula-exchange/nebula-exchange/target/classes/neo4j_application.conf

用户可以在返回信息中搜索batchSuccess.<tag_name/edge_name>,确认成功的数量。例如batchSuccess.follow: 300

步骤 5:(可选)验证数据

用户可以在Nebula Graph客户端(例如Nebula Graph Studio)中执行查询语句,确认数据是否已导入。例如:

  1. GO FROM "player100" OVER follow;

用户也可以使用命令SHOW STATS查看统计数据。

步骤 6:(如有)在Nebula Graph中重建索引

导入数据后,用户可以在Nebula Graph中重新创建并重建索引。详情请参见索引介绍


最后更新: October 18, 2021