Dump Tool

Dump Tool 是一个单机离线数据导出工具，可以用于导出或统计指定条件的数据。

如何获得

Dump Tool 源码位于 nebula/src/tools/db_dump 下，用户可以执行 make db_dump 命令来编译生成该工具。在使用本工具前，你可以使用 Nebula Graph CLI 的 SHOW HOSTS 命令查看分区的分布。使用 vertex_id % partition_num 来计算点对应的 key 位于哪个分区。

注意： Dump Tool 位于 rpm 包中，目录是 nebula/bin/。该工具通过直接打开 RocksDB 转储数据，因此需要离线使用，关闭该 storaged 进程，并同时保持 meta_server 已启动。具体用法请参考下方说明。

如何使用

具体用法如下所示，用户可以通过执行不带参数的 db_dump 命令获得帮助。其中 space 参数是必须的，而 db_path 以及 meta_server 具有默认值，用户可以按照实际配置。vids、parts、tags、edges 可以任意组合，导出你需要的数据。

  1.   ./db_dump --space=<space name>
  3. required:
  4.        --space=<space name>
  5.         # A space name must be given.
  7. optional:
  8.        --db_path=<path to rocksdb>
  9.          # Path to the RocksDB data directory. If nebula was installed in `/usr/local/nebula`,
  10.          # the db_path would be /usr/local/nebula/data/storage/nebula/
  11.          # Default: ./
  13.        --meta_server=<ip:port,...>
  14.          # A list of meta severs' ip:port separated by comma.
  15.          # Default: 127.0.0.1:45500
  17.        --mode= scan | stat
  18.          # scan: print to screen when records meet the condition, and also print statistics to screen in final.
  19.          # stat: print statistics to screen.
  20.          # Default: scan
  22.        --vids=<list of vid>
  23.          # A list of vids separated by comma. This parameter means vertex_id/edge_src_id
  24.          # Would scan the whole space's records if it is not given.
  26.        --parts=<list of partition id>
  27.          # A list of partition ids separated by comma.
  28.          # Would output all partitions if it is not given.
  30.        --tags=<list of tag name>
  31.          # A list of tag name separated by comma.
  33.        --edges=<list of edge name>
  34.          # A list of edge name separated by comma.
  36.        --limit=<N>
  37.          # A positive number that limits the output.
  38.          # Would output all if set to 0 or negative.
  39.          # Default: 1000

下面是一些示例：

  1. // 指定 space 导出数据
  2. ./db_dump --space=space_name
  4. // 指定space, db_path, meta_server
  5. ./db_dump --space=space_name --db_path=/usr/local/nebula/data/storage/nebula/ --meta_server=127.0.0.1:45513
  7. // 指定 mode=stat(统计模式)，此时只返回统计信息，不打印数据
  8. ./db_dump --space=space_name --mode=stat --db_path=/usr/local/nebula/data/storage/nebula/ --meta_server=127.0.0.1:45513
  10. // 指定 vid 导出该点以及以该点为起始点的边
  11. ./db_dump --space=space_name --mode=stat --db_path=/usr/local/nebula/data/storage/nebula/ --meta_server=127.0.0.1:45513 --vids=123,456
  13. // 指定 tag 类型，导出具有该 tag 的点
  14. ./db_dump --space=space_name --mode=stat --db_path=/usr/local/nebula/data/storage/nebula/ --meta_server=127.0.0.1:45513 --tags=tag1,tag2

返回的数据格式：

  1. // 点，key: part_id, vertex_id, tag_name, value: <prop_list>
  2. [vertex] key: 1, 0, poi value:mid:0,8191765721868409651,8025713627522363385,1993089399535188613,3926276052777355165,5123607763506443893,2990089379644866415,poi_name_0,上海,华东,30.2824,120.016,poi_stat_0,poi_fc_0,poi_sc_0,0,poi_star_0,
  4. // 边, key: part_id, src_id, edge_name, rank, dst_id, value: <prop_list>
  5. [edge] key: 1, 0, consume_poi_reverse, 0, 656384 value:mid:656384,mid:0,7.19312,mid:656384,3897457441682646732,mun:656384,4038264117233984707,dun:656384,empe:656384,mobile:656384,gender:656384,age:656384,rs:656384,fpd:656384,0.75313,1.34433,fpd:656384,0.03567,7.56212,
  7. // 统计
  8. =======================================================
  9. COUNT: 10           #本次导出记录数量
  10. VERTEX COUNT: 1     #本次导出点数量
  11. EDGE COUNT: 9       #本次导出边数量
  12. TAG STATISTICS:     #本次导出tag统计
  13.         poi : 1
  14. EDGE STATISTICS:    #本次导出edge统计
  15.         consume_poi_reverse : 9
  16. =======================================================