有两种方式可以获取 HugeGraph-Tools：

    • 下载二进制tar包
    • 下载源码编译安装

    2.1 下载二进制tar包

    下载最新版本的 HugeGraph-Tools 包：

    2.2 下载源码编译安装

    下载最新版本的 HugeGraph-Tools 源码包：

    编译生成 tar 包:

    3.1 功能概览

    解压后，进入 hugegraph-tools 目录，可以使用bin/hugegraph或者bin/hugegraph help来查看 usage 信息。主要分为：

    • 图管理类，graph-mode-set、graph-mode-get、graph-list、graph-get 和 graph-clear
    • 异步任务管理类，task-list、task-get、task-delete、task-cancel 和 task-clear
    • Gremlin类，gremlin-execute 和 gremlin-schedule
    • 备份/恢复类，backup、restore、migrate、schedule-backup 和 dump
    • 安装部署类，deploy、clear、start-all 和 stop-all
    1. Usage: hugegraph [options] [command] [command options]
    3.2 [options]-全局变量

    options是 HugeGraph-Tools 的全局变量，可以在 hugegraph-tools/bin/hugegraph 中配置,包括：

    • —graph，HugeGraph-Tools 操作的图的名字，默认值是 hugegraph
    • —url，HugeGraph-Server 的服务地址，默认是
    • —user，当 HugeGraph-Server 开启认证时，传递用户名
    • —password，当 HugeGraph-Server 开启认证时，传递用户的密码
    • —timeout, 连接 HugeGraph-Server 时的超时时间，默认是 30s

    上述全局变量，也可以通过环境变量来设置。一种方式是在命令行使用 export 设置临时环境变量，在该命令行关闭之前均有效

    另一种方式是在 bin/hugegraph 脚本中设置环境变量：

    3.3 图管理类，graph-mode-set、graph-mode-get、graph-list、graph-get和graph-clear
    • graph-mode-set，设置图的 restore mode
      • —graph-mode 或者 -m，必填项，指定将要设置的模式，合法值包括 [NONE, RESTORING, MERGING]
    • graph-mode-get，获取图的 restore mode
    • graph-list，列出某个 HugeGraph-Server 中全部的图
    • graph-get，获取某个图及其存储后端类型
    • graph-clear，清除某个图的全部 schema 和 data
      • —confirm-message 或者 -c，必填项，删除确认信息，需要手动输入，二次确认防止误删，”I’m sure to delete all data”，包括双引号
    3.4 异步任务管理类，task-list、task-get和task-delete
    • task-list，列出某个图中的异步任务，可以根据任务的状态过滤
      • —status，选填项，指定要查看的任务的状态，即按状态过滤任务
      • —limit，选填项，指定要获取的任务的数目，默认为 -1，意思为获取全部符合条件的任务
    • task-get，获取某个异步任务的详细信息
      • —task-id，必填项，指定异步任务的 ID
    • task-delete，删除某个异步任务的信息
      • —task-id，必填项，指定异步任务的 ID
    • task-cancel，取消某个异步任务的执行
      • —task-id，要取消的异步任务的 ID
    • task-clear，清理完成的异步任务
      • —force，选填项，设置时，表示清理全部异步任务，未执行完成的先取消，然后清除所有异步任务。默认只清理已完成的异步任务
    3.5 Gremlin类，gremlin-execute和gremlin-schedule
    • gremlin-execute，发送 Gremlin 语句到 HugeGraph-Server 来执行查询或修改操作，同步执行，结束后返回结果
      • —file 或者 -f，指定要执行的脚本文件，UTF-8编码，与 —script 互斥
      • —script 或者 -s，指定要执行的脚本字符串，与 —file 互斥
      • —aliases 或者 -a，Gremlin 别名设置，格式为：key1=value1,key2=value2,…
      • —bindings 或者 -b，Gremlin 绑定设置，格式为：key1=value1,key2=value2,…
      • —language 或者 -l，Gremlin 脚本的语言，默认为 gremlin-groovy
    • gremlin-schedule，发送 Gremlin 语句到 HugeGraph-Server 来执行查询或修改操作，异步执行，任务提交后立刻返回异步任务id
      • —file 或者 -f，指定要执行的脚本文件，UTF-8编码，与 —script 互斥
      • —script 或者 -s，指定要执行的脚本字符串，与 —file 互斥
      • —bindings 或者 -b，Gremlin 绑定设置，格式为：key1=value1,key2=value2,…
      • —language 或者 -l，Gremlin 脚本的语言，默认为 gremlin-groovy
    3.6 备份/恢复类
    • backup，将某张图中的 schema 或者 data 备份到 HugeGraph 系统之外，以 JSON 形式存在本地磁盘或者 HDFS
      • —directory 或者 -d，存储 schema 或者 data 的目录，本地目录时，默认为’./{graphName}’，HDFS 时，默认为 ‘{fs.default.name}/{graphName}’
      • —huge-types 或者 -t，要备份的数据类型，逗号分隔，可选值为 ‘all’ 或者 一个或多个 [vertex,edge,vertex_label,edge_label,property_key,index_label] 的组合，’all’ 代表全部6种类型，即顶点、边和所有schema
      • —log 或者 -l，指定日志目录，默认为当前目录
      • —retry，指定失败重试次数，默认为 3
      • —split-size 或者 -s，指定在备份时对顶点或者边分块的大小，默认为 1048576
      • -D，用 -Dkey=value 的模式指定动态参数，用来备份数据到 HDFS 时，指定 HDFS 的配置项，例如：-Dfs.default.name=hdfs://localhost:9000
    • restore，将 JSON 格式存储的 schema 或者 data 恢复到一个新图中（RESTORING 模式）或者合并到已存在的图中（MERGING 模式）
      • —directory 或者 -d，存储 schema 或者 data 的目录，本地目录时，默认为’./{graphName}’，HDFS 时，默认为 ‘{fs.default.name}/{graphName}’
      • —huge-types 或者 -t，要恢复的数据类型，逗号分隔，可选值为 ‘all’ 或者 一个或多个 [vertex,edge,vertex_label,edge_label,property_key,index_label] 的组合，’all’ 代表全部6种类型，即顶点、边和所有schema
      • —log 或者 -l，指定日志目录，默认为当前目录
      • —retry，指定失败重试次数，默认为 3
      • -D，用 -Dkey=value 的模式指定动态参数，用来从 HDFS 恢复图时，指定 HDFS 的配置项，例如：-Dfs.default.name=hdfs://localhost:9000
    • migrate, 将图从一个 HugeGraphServer 迁移至另一个 HugeGraphServer
      • —source-graph，源图的名字
      • —source-url，源图所在的 HugeGraphServer 的URL
      • —target-graph，目标图的名字
      • —target-url，目标图所在的 HugeGraphServer
      • —directory 或者 -d，迁移过程中，存储源图的 schema 或者 data 的目录，本地目录时，默认为’./{graphName}’，HDFS 时，默认为 ‘{fs.default.name}/{graphName}’
      • —huge-types 或者 -t，要迁移的数据类型，逗号分隔，可选值为 ‘all’ 或者 一个或多个 [vertex,edge,vertex_label,edge_label,property_key,index_label] 的组合，’all’ 代表全部6种类型，即顶点、边和所有schema
      • —log 或者 -l，指定日志目录，默认为当前目录
      • —retry，指定失败重试次数，默认为 3
      • —split-size 或者 -s，指定迁移过程中对源图进行备份时顶点或者边分块的大小，默认为 1048576
      • -D，用 -Dkey=value 的模式指定动态参数，用来在迁移图过程中需要备份数据到 HDFS 时，指定 HDFS 的配置项，例如：-Dfs.default.name=hdfs://localhost:9000
      • —graph-mode 或者 -m，将源图恢复到目标图时将目标图设置的模式，合法值包括 [RESTORING, MERGING]
      • —clean，是否删除在迁移图的过程中产生的源图的备份，默认为 true，即默认迁移图结束后清理产生的源图备份
    • schedule-backup，周期性对图执行备份操作，并保留一定数目的最新备份（目前仅支持本地文件系统）
      • —directory 或者 -d，必填项，指定备份数据的目录
      • —backup-num，选填项，指定保存的最新的备份的数目，默认为 3
      • —interval，选填项，指定进行备份的周期，格式同 Linux crontab 格式
    • dump，把整张图的顶点和边全部导出，默认以vertex vertex-edge1 vertex-edge2...JSON格式存储。用户也可以自定义存储格式，只需要在hugegraph-tools/src/main/java/com/baidu/hugegraph/formatter目录下实现一个继承自Formatter的类，例如CustomFormatter，使用时指定该类为formatter即可，例如bin/hugegraph dump -f CustomFormatter
      • —formatter 或者 -f，指定使用的 formatter，默认为 JsonFormatter
      • —directory 或者 -d，存储 schema 或者 data 的目录，默认为当前目录
      • —huge-types 或者 -t，要备份的数据类型，逗号分隔，可选值为 ‘all’ 或者 一个或多个 [vertex,edge,vertex_label,edge_label,property_key,index_label] 的组合，’all’ 代表全部6种类型
      • —log 或者 -l，指定日志目录，默认为当前目录
      • —retry，指定失败重试次数，默认为 3
      • —split-size 或者 -s，指定在备份时对顶点或者边分块的大小，默认为 1048576
      • -D，用 -Dkey=value 的模式指定动态参数，用来备份数据到 HDFS 时，指定 HDFS 的配置项，例如：-Dfs.default.name=hdfs://localhost:9000
    3.7 安装部署类
    • deploy，一键下载、安装和启动 HugeGraph-Server 和 HugeGraph-Studio
      • -v，必填项，指明安装的 HugeGraph-Server 和 HugeGraph-Studio 的版本号，最新的是 0.9
      • -p，必填项，指定安装的 HugeGraph-Server 和 HugeGraph-Studio 目录
      • -u，选填项，指定下载 HugeGraph-Server 和 HugeGraph-Studio 压缩包的链接
    • clear，清理 HugeGraph-Server 和 HugeGraph-Studio 目录和tar包
      • -p，必填项，指定要清理的 HugeGraph-Server 和 HugeGraph-Studio 的目录
    • start-all，一键启动 HugeGraph-Server 和 HugeGraph-Studio，并启动监控，服务死掉时自动拉起服务
      • -v，必填项，指明要启动的 HugeGraph-Server 和 HugeGraph-Studio 的版本号，最新的是 0.9
      • -p，必填项，指定安装了 HugeGraph-Server 和 HugeGraph-Studio 的目录
    • stop-all，一键关闭 HugeGraph-Server 和 HugeGraph-Studio
    3.8 具体命令参数

    各子命令的具体参数如下：

    1. Usage: hugegraph [options] [command] [command options]
    2.   Options:
    3.     --graph
    4.       Name of graph
    5.       Default: hugegraph
    6.     --password
    7.       Password of user
    8.     --timeout
    9.       Connection timeout
    10.       Default: 30
    11.     --url
    12.       The URL of HugeGraph-Server
    13.       Default: http://127.0.0.1:8080
    14.     --user
    15.       User Name
    16.   Commands:
    17.     graph-list      List all graphs
    18.       Usage: graph-list
    20.     graph-get      Get graph info
    21.       Usage: graph-get
    23.     graph-clear      Clear graph schema and data
    24.         Options:
    25.         * --confirm-message, -c
    26.             Confirm message of graph clear is "I'm sure to delete all data". 
    27.             (Note: include "")
    29.     graph-mode-set      Set graph mode
    30.       Usage: graph-mode-set [options]
    31.         Options:
    32.         * --graph-mode, -m
    33.             Graph mode, include: [NONE, RESTORING, MERGING]
    34.             Possible Values: [NONE, RESTORING, MERGING]
    36.     graph-mode-get      Get graph mode
    37.       Usage: graph-mode-get
    39.     task-list      List tasks
    40.       Usage: task-list [options]
    41.         Options:
    42.           --limit
    43.             Limit number, no limit if not provided
    44.             Default: -1
    45.           --status
    46.             Status of task
    48.     task-get      Get task info
    49.       Usage: task-get [options]
    50.         Options:
    51.         * --task-id
    52.             Task id
    53.             Default: 0
    55.     task-delete      Delete task
    56.       Usage: task-delete [options]
    57.         Options:
    58.         * --task-id
    59.             Task id
    60.             Default: 0
    62.     task-cancel      Cancel task
    63.       Usage: task-cancel [options]
    64.         Options:
    65.         * --task-id
    66.             Task id
    67.             Default: 0
    69.     task-clear      Clear completed tasks
    70.       Usage: task-clear [options]
    71.         Options:
    72.           --force
    73.             Force to clear all tasks, cancel all uncompleted tasks firstly, 
    74.             and delete all completed tasks
    75.             Default: false
    77.     gremlin-execute      Execute Gremlin statements
    78.       Usage: gremlin-execute [options]
    79.         Options:
    80.           --aliases, -a
    81.             Gremlin aliases, valid format is: 'key1=value1,key2=value2...'
    82.             Default: {}
    83.           --bindings, -b
    84.             Gremlin bindings, valid format is: 'key1=value1,key2=value2...'
    86.           --file, -f
    87.             Gremlin Script file to be executed, UTF-8 encoded, exclusive to 
    88.             --script 
    89.           --language, -l
    90.             Gremlin script language
    91.             Default: gremlin-groovy
    92.           --script, -s
    93.             Gremlin script to be executed, exclusive to --file
    95.     gremlin-schedule      Execute Gremlin statements as asynchronous job
    96.       Usage: gremlin-schedule [options]
    97.         Options:
    98.           --bindings, -b
    99.             Gremlin bindings, valid format is: 'key1=value1,key2=value2...'
    100.             Default: {}
    101.           --file, -f
    102.             Gremlin Script file to be executed, UTF-8 encoded, exclusive to 
    103.             --script 
    104.           --language, -l
    105.             Gremlin script language
    106.             Default: gremlin-groovy
    107.           --script, -s
    108.             Gremlin script to be executed, exclusive to --file
    110.     backup      Backup graph schema/data. If directory is on HDFS, use -D to 
    111.             set HDFS params if needed. For exmaple: 
    112.             -Dfs.default.name=hdfs://localhost:9000 
    113.       Usage: backup [options]
    114.         Options:
    115.           --directory, -d
    116.             Directory of graph schema/data, default is './{graphname}' in 
    117.             local file system or '{fs.default.name}/{graphname}' in HDFS
    118.           --huge-types, -t
    119.             Type of schema/data. Concat with ',' if more than one. 'all' means 
    120.             all vertices, edges and schema, in other words, 'all' equals with 
    121.             'vertex,edge,vertex_label,edge_label,property_key,index_label' 
    122.             Default: [PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE]
    123.           --log, -l
    124.             Directory of log
    125.             Default: ./logs
    126.           --retry
    127.             Retry times, default is 3
    128.             Default: 3
    129.           --split-size, -s
    130.             Split size of shard
    131.             Default: 1048576
    132.           -D
    133.             HDFS config parameters
    134.             Syntax: -Dkey=value
    135.             Default: {}
    137.     schedule-backup      Schedule backup task
    138.       Usage: schedule-backup [options]
    139.         Options:
    140.           --backup-num
    141.             The number of latest backups to keep
    142.             Default: 3
    143.         * --directory, -d
    144.             The directory of backups stored
    145.           --interval
    146.             The interval of backup, format is: "a b c d e". 'a' means minute 
    147.             (0 - 59), 'b' means hour (0 - 23), 'c' means day of month (1 - 
    148.             31), 'd' means month (1 - 12), 'e' means day of week (0 - 6) 
    149.             (Sunday=0), "*" means all
    150.             Default: "0 0 * * *"
    151.     dump      Dump graph to files
    152.       Usage: dump [options]
    153.         Options:
    154.           --directory, -d
    155.             Directory of graph schema/data, default is './{graphname}' in 
    156.             local file system or '{fs.default.name}/{graphname}' in HDFS
    157.           --formatter, -f
    158.             Formatter to customize format of vertex/edge
    159.             Default: JsonFormatter
    160.           --huge-types, -t
    161.             Type of schema/data. Concat with ',' if more than one. 'all' means 
    162.             all vertices, edges and schema, in other words, 'all' equals with 
    163.             'vertex,edge,vertex_label,edge_label,property_key,index_label' 
    164.             Default: [PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE]
    165.           --log, -l
    166.             Directory of log
    167.             Default: ./logs
    168.           --retry
    169.             Retry times, default is 3
    170.             Default: 3
    171.           --split-size, -s
    172.             Split size of shard
    173.             Default: 1048576
    174.           -D
    175.             HDFS config parameters
    176.             Syntax: -Dkey=value
    177.             Default: {}
    179.     restore      Restore graph schema/data. If directory is on HDFS, use -D to 
    180.             set HDFS params if needed. For 
    181.             exmaple:-Dfs.default.name=hdfs://localhost:9000 
    183.         Options:
    184.           --clean
    185.             Whether to remove the directory of graph data after restored
    186.             Default: false
    187.           --directory, -d
    188.             Directory of graph schema/data, default is './{graphname}' in 
    189.             local file system or '{fs.default.name}/{graphname}' in HDFS
    190.           --huge-types, -t
    191.             Type of schema/data. Concat with ',' if more than one. 'all' means 
    192.             all vertices, edges and schema, in other words, 'all' equals with 
    193.             'vertex,edge,vertex_label,edge_label,property_key,index_label' 
    194.             Default: [PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE]
    195.           --log, -l
    196.             Directory of log
    197.             Default: ./logs
    198.           --retry
    199.             Retry times, default is 3
    200.             Default: 3
    201.           -D
    202.             HDFS config parameters
    203.             Syntax: -Dkey=value
    204.             Default: {}
    206.     migrate      Migrate graph
    207.       Usage: migrate [options]
    208.         Options:
    209.           --clean
    210.             Whether to remove the directory of graph data after restored
    211.             Default: true
    212.           --directory, -d
    213.             Directory of graph schema/data, default is './{graphname}' in 
    214.             local file system or '{fs.default.name}/{graphname}' in HDFS
    215.           --graph-mode, -m
    216.             Mode used when migrating to target graph, include: [RESTORING, 
    217.             MERGING] 
    218.             Default: RESTORING
    219.             Possible Values: [NONE, RESTORING, MERGING]
    220.           --huge-types, -t
    221.             Type of schema/data. Concat with ',' if more than one. 'all' means 
    222.             all vertices, edges and schema, in other words, 'all' equals with 
    223.             'vertex,edge,vertex_label,edge_label,property_key,index_label' 
    224.             Default: [PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE]
    225.           --log, -l
    226.             Directory of log
    227.             Default: ./logs
    228.           --retry
    229.             Retry times, default is 3
    230.             Default: 3
    231.           --source-graph
    232.             The source graph to migrate
    233.             Default: hugegraph
    234.           --source-url
    235.             The source graph url to migrate
    236.             Default: http://127.0.0.1:8080
    237.           --split-size, -s
    238.             Split size of shard
    239.             Default: 1048576
    240.           --target-graph
    241.             The target graph to migrate
    242.             Default: hugegraph
    243.           --target-url
    244.             The target graph url to migrate
    245.             Default: http://127.0.0.1:8081
    246.           -D
    247.             HDFS config parameters
    248.             Syntax: -Dkey=value
    249.             Default: {}
    251.     deploy      Install HugeGraph-Server and HugeGraph-Studio
    252.       Usage: deploy [options]
    253.         Options:
    254.         * -p
    255.             Install path of HugeGraph-Server and HugeGraph-Studio
    256.           -u
    257.             Download url prefix path of HugeGraph-Server and HugeGraph-Studio
    258.         * -v
    259.             Version of HugeGraph-Server and HugeGraph-Studio
    261.     start-all      Start HugeGraph-Server and HugeGraph-Studio
    262.       Usage: start-all [options]
    263.         Options:
    264.         * -p
    265.             Install path of HugeGraph-Server and HugeGraph-Studio
    266.         * -v
    267.             Version of HugeGraph-Server and HugeGraph-Studio
    269.     clear      Clear HugeGraph-Server and HugeGraph-Studio
    270.       Usage: clear [options]
    271.         Options:
    272.         * -p
    273.             Install path of HugeGraph-Server and HugeGraph-Studio
    275.     stop-all      Stop HugeGraph-Server and HugeGraph-Studio
    276.       Usage: stop-all
    278.       Usage: help