HugeGraph-Tools Quick Start

1 HugeGraph-Tools概述

HugeGraph-Tools 是 HugeGraph 的自动化部署、管理和备份/还原组件。

2 获取 HugeGraph-Tools

有两种方式可以获取 HugeGraph-Tools：(它被包含子 Toolchain 中)

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

2.1 下载二进制tar包

下载最新版本的 HugeGraph-Toolchain 包, 然后进入 tools 子目录

  1. wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
  2. tar zxf *hugegraph*.tar.gz

2.2 下载源码编译安装

源码编译前请确保安装了wget命令

下载最新版本的 HugeGraph-Toolchain 源码包, 然后根目录编译或者单独编译 tool 子模块：

  1. # 1. get from github
  2. git clone https://github.com/apache/hugegraph-toolchain.git
  4. # 2. get from direct  (e.g. here is 1.0.0, please choose the latest version)
  5. wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0-src.tar.gz

编译生成 tar 包:

  1. cd hugegraph-tools
  2. mvn package -DskipTests

生成 tar 包 hugegraph-tools-${version}.tar.gz

3 使用

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 的服务地址，默认是 http://127.0.0.1:8080
  • –user，当 HugeGraph-Server 开启认证时，传递用户名
  • –password，当 HugeGraph-Server 开启认证时，传递用户的密码
  • –timeout，连接 HugeGraph-Server 时的超时时间，默认是 30s
  • –trust-store-file，证书文件的路径，当 –url 使用 https 时，HugeGraph-Client 使用的 truststore 文件，默认为空，代表使用 hugegraph-tools 内置的 truststore 文件 conf/hugegraph.truststore
  • –trust-store-password，证书文件的密码，当 –url 使用 https 时，HugeGraph-Client 使用的 truststore 的密码，默认为空，代表使用 hugegraph-tools 内置的 truststore 文件的密码

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

全局变量环境变量示例
–urlHUGEGRAPH_URLexport HUGEGRAPH_URL=http://127.0.0.1:8080
–graphHUGEGRAPH_GRAPHexport HUGEGRAPH_GRAPH=hugegraph
–userHUGEGRAPH_USERNAMEexport HUGEGRAPH_USERNAME=admin
–passwordHUGEGRAPH_PASSWORDexport HUGEGRAPH_PASSWORD=test
–timeoutHUGEGRAPH_TIMEOUTexport HUGEGRAPH_TIMEOUT=30
–trust-store-fileHUGEGRAPH_TRUST_STORE_FILEexport HUGEGRAPH_TRUST_STORE_FILE=/tmp/trust-store
–trust-store-passwordHUGEGRAPH_TRUST_STORE_PASSWORDexport HUGEGRAPH_TRUST_STORE_PASSWORD=xxxx

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

  1. #!/bin/bash
  3. # Set environment here if needed
  4. #export HUGEGRAPH_URL=
  5. #export HUGEGRAPH_GRAPH=
  6. #export HUGEGRAPH_USERNAME=
  7. #export HUGEGRAPH_PASSWORD=
  8. #export HUGEGRAPH_TIMEOUT=
  9. #export HUGEGRAPH_TRUST_STORE_FILE=
  10. #export HUGEGRAPH_TRUST_STORE_PASSWORD=
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, LOADING]
  • 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”，包括双引号

当需要把备份的图原样恢复到一个新的图中的时候，需要先将图模式设置为 RESTORING 模式；当需要将备份的图合并到已存在的图中时，需要先将图模式设置为 MERGING 模式。

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

    –file 和 –script 二者互斥，必须设置其中之一

  • 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

    –file 和 –script 二者互斥，必须设置其中之一

3.6 备份/恢复类
  • backup，将某张图中的 schema 或者 data 备份到 HugeGraph 系统之外，以 JSON 形式存在本地磁盘或者 HDFS
    • –format，备份的格式，可选值包括 [json, text]，默认为 json
    • –all-properties，是否备份顶点/边全部的属性，仅在 –format 为 text 是有效，默认 false
    • –label，要备份的顶点/边的类型，仅在 –format 为 text 是有效，只有备份顶点或者边的时候有效
    • –properties，要备份的顶点/边的属性，逗号分隔，仅在 –format 为 text 是有效，只有备份顶点或者边的时候有效
    • –compress，备份时是否压缩数据，默认为 true
    • –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}’
    • –clean，是否在恢复图完成后删除 –directory 指定的目录，默认为 false
    • –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

    只有当 –format 为 json 执行 backup 时，才可以使用 restore 命令恢复

  • migrate, 将当前连接的图迁移至另一个 HugeGraphServer 中

    • –target-graph，目标图的名字，默认为 hugegraph
    • –target-url，目标图所在的 HugeGraphServer，默认为 http://127.0.0.1:8081
    • –target-username，访问目标图的用户名
    • –target-password，访问目标图的密码
    • –target-timeout，访问目标图的超时时间
    • –target-trust-store-file，访问目标图使用的 truststore 文件
    • –target-trust-store-password，访问目标图使用的 truststore 的密码
    • –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]
    • –keep-local-data，是否保留在迁移图的过程中产生的源图的备份，默认为 false，即默认迁移图结束后不保留产生的源图备份
  • 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 的目录，默认为当前目录
    • –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

deploy命令中有可选参数 -u，提供时会使用指定的下载地址替代默认下载地址下载 tar 包，并且将地址写入~/hugegraph-download-url-prefix文件中；之后如果不指定地址时，会优先从~/hugegraph-download-url-prefix指定的地址下载 tar 包；如果 -u 和~/hugegraph-download-url-prefix都没有时，会从默认下载地址进行下载

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.     --trust-store-file
  12.       The path of client truststore file used when https protocol is enabled
  13.     --trust-store-password
  14.       The password of the client truststore file used when the https protocol 
  15.       is enabled
  16.     --url
  17.       The URL of HugeGraph-Server
  18.       Default: http://127.0.0.1:8080
  19.     --user
  20.       Name of user
  21.   Commands:
  22.     graph-list      List all graphs
  23.       Usage: graph-list
  25.     graph-get      Get graph info
  26.       Usage: graph-get
  28.     graph-clear      Clear graph schema and data
  29.       Usage: graph-clear [options]
  30.         Options:
  31.         * --confirm-message, -c
  32.             Confirm message of graph clear is "I'm sure to delete all data". 
  33.             (Note: include "")
  35.     graph-mode-set      Set graph mode
  36.       Usage: graph-mode-set [options]
  37.         Options:
  38.         * --graph-mode, -m
  39.             Graph mode, include: [NONE, RESTORING, MERGING]
  40.             Possible Values: [NONE, RESTORING, MERGING, LOADING]
  42.     graph-mode-get      Get graph mode
  43.       Usage: graph-mode-get
  45.     task-list      List tasks
  46.       Usage: task-list [options]
  47.         Options:
  48.           --limit
  49.             Limit number, no limit if not provided
  50.             Default: -1
  51.           --status
  52.             Status of task
  54.     task-get      Get task info
  55.       Usage: task-get [options]
  56.         Options:
  57.         * --task-id
  58.             Task id
  59.             Default: 0
  61.     task-delete      Delete task
  62.       Usage: task-delete [options]
  63.         Options:
  64.         * --task-id
  65.             Task id
  66.             Default: 0
  68.     task-cancel      Cancel task
  69.       Usage: task-cancel [options]
  70.         Options:
  71.         * --task-id
  72.             Task id
  73.             Default: 0
  75.     task-clear      Clear completed tasks
  76.       Usage: task-clear [options]
  77.         Options:
  78.           --force
  79.             Force to clear all tasks, cancel all uncompleted tasks firstly, 
  80.             and delete all completed tasks
  81.             Default: false
  83.     gremlin-execute      Execute Gremlin statements
  84.       Usage: gremlin-execute [options]
  85.         Options:
  86.           --aliases, -a
  87.             Gremlin aliases, valid format is: 'key1=value1,key2=value2...'
  88.             Default: {}
  89.           --bindings, -b
  90.             Gremlin bindings, valid format is: 'key1=value1,key2=value2...'
  91.             Default: {}
  92.           --file, -f
  93.             Gremlin Script file to be executed, UTF-8 encoded, exclusive to 
  94.             --script 
  95.           --language, -l
  96.             Gremlin script language
  97.             Default: gremlin-groovy
  98.           --script, -s
  99.             Gremlin script to be executed, exclusive to --file
  101.     gremlin-schedule      Execute Gremlin statements as asynchronous job
  102.       Usage: gremlin-schedule [options]
  103.         Options:
  104.           --bindings, -b
  105.             Gremlin bindings, valid format is: 'key1=value1,key2=value2...'
  106.             Default: {}
  107.           --file, -f
  108.             Gremlin Script file to be executed, UTF-8 encoded, exclusive to 
  109.             --script 
  110.           --language, -l
  111.             Gremlin script language
  112.             Default: gremlin-groovy
  113.           --script, -s
  114.             Gremlin script to be executed, exclusive to --file
  116.     backup      Backup graph schema/data. If directory is on HDFS, use -D to 
  117.             set HDFS params. For exmaple:
  118.             -Dfs.default.name=hdfs://localhost:9000 
  119.       Usage: backup [options]
  120.         Options:
  121.           --all-properties
  122.             All properties to be backup flag
  123.             Default: false
  124.           --compress
  125.             compress flag
  126.             Default: true
  127.           --directory, -d
  128.             Directory of graph schema/data, default is './{graphname}' in 
  129.             local file system or '{fs.default.name}/{graphname}' in HDFS
  130.           --format
  131.             File format, valid is [json, text]
  132.             Default: json
  133.           --huge-types, -t
  134.             Type of schema/data. Concat with ',' if more than one. 'all' means 
  135.             all vertices, edges and schema, in other words, 'all' equals with 
  136.             'vertex,edge,vertex_label,edge_label,property_key,index_label' 
  137.             Default: [PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE]
  138.           --label
  139.             Vertex or edge label, only valid when type is vertex or edge
  140.           --log, -l
  141.             Directory of log
  142.             Default: ./logs
  143.           --properties
  144.             Vertex or edge properties to backup, only valid when type is
  145.             vertex or edge
  146.             Default: []
  147.           --retry
  148.             Retry times, default is 3
  149.             Default: 3
  150.           --split-size, -s
  151.             Split size of shard
  152.             Default: 1048576
  153.           -D
  154.             HDFS config parameters
  155.             Syntax: -Dkey=value
  156.             Default: {}
  158.     schedule-backup      Schedule backup task
  159.       Usage: schedule-backup [options]
  160.         Options:
  161.           --backup-num
  162.             The number of latest backups to keep
  163.             Default: 3
  164.         * --directory, -d
  165.             The directory of backups stored
  166.           --interval
  167.             The interval of backup, format is: "a b c d e". 'a' means minute 
  168.             (0 - 59), 'b' means hour (0 - 23), 'c' means day of month (1 - 
  169.             31), 'd' means month (1 - 12), 'e' means day of week (0 - 6) 
  170.             (Sunday=0), "*" means all
  171.             Default: "0 0 * * *"
  173.     dump      Dump graph to files
  174.       Usage: dump [options]
  175.         Options:
  176.           --directory, -d
  177.             Directory of graph schema/data, default is './{graphname}' in 
  178.             local file system or '{fs.default.name}/{graphname}' in HDFS
  179.           --formatter, -f
  180.             Formatter to customize format of vertex/edge
  181.             Default: JsonFormatter
  182.           --log, -l
  183.             Directory of log
  184.             Default: ./logs
  185.           --retry
  186.             Retry times, default is 3
  187.             Default: 3
  188.           --split-size, -s
  189.             Split size of shard
  190.             Default: 1048576
  191.           -D
  192.             HDFS config parameters
  193.             Syntax: -Dkey=value
  194.             Default: {}
  196.     restore      Restore graph schema/data. If directory is on HDFS, use -D to 
  197.             set HDFS params if needed. For 
  198.             exmaple:-Dfs.default.name=hdfs://localhost:9000 
  199.       Usage: restore [options]
  200.         Options:
  201.           --clean
  202.             Whether to remove the directory of graph data after restored
  203.             Default: false
  204.           --directory, -d
  205.             Directory of graph schema/data, default is './{graphname}' in 
  206.             local file system or '{fs.default.name}/{graphname}' in HDFS
  207.           --huge-types, -t
  208.             Type of schema/data. Concat with ',' if more than one. 'all' means 
  209.             all vertices, edges and schema, in other words, 'all' equals with 
  210.             'vertex,edge,vertex_label,edge_label,property_key,index_label' 
  211.             Default: [PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE]
  212.           --log, -l
  213.             Directory of log
  214.             Default: ./logs
  215.           --retry
  216.             Retry times, default is 3
  217.             Default: 3
  218.           -D
  219.             HDFS config parameters
  220.             Syntax: -Dkey=value
  221.             Default: {}
  223.     migrate      Migrate graph
  224.       Usage: migrate [options]
  225.         Options:
  226.           --directory, -d
  227.             Directory of graph schema/data, default is './{graphname}' in 
  228.             local file system or '{fs.default.name}/{graphname}' in HDFS
  229.           --graph-mode, -m
  230.             Mode used when migrating to target graph, include: [RESTORING, 
  231.             MERGING] 
  232.             Default: RESTORING
  233.             Possible Values: [NONE, RESTORING, MERGING, LOADING]
  234.           --huge-types, -t
  235.             Type of schema/data. Concat with ',' if more than one. 'all' means 
  236.             all vertices, edges and schema, in other words, 'all' equals with 
  237.             'vertex,edge,vertex_label,edge_label,property_key,index_label' 
  238.             Default: [PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE]
  239.           --keep-local-data
  240.             Whether to keep the local directory of graph data after restored
  241.             Default: false
  242.           --log, -l
  243.             Directory of log
  244.             Default: ./logs
  245.           --retry
  246.             Retry times, default is 3
  247.             Default: 3
  248.           --split-size, -s
  249.             Split size of shard
  250.             Default: 1048576
  251.           --target-graph
  252.             The name of target graph to migrate
  253.             Default: hugegraph
  254.           --target-password
  255.             The password of target graph to migrate
  256.           --target-timeout
  257.             The timeout to connect target graph to migrate
  258.             Default: 0
  259.           --target-trust-store-file
  260.             The trust store file of target graph to migrate
  261.           --target-trust-store-password
  262.             The trust store password of target graph to migrate
  263.           --target-url
  264.             The url of target graph to migrate
  265.             Default: http://127.0.0.1:8081
  266.           --target-user
  267.             The username of target graph to migrate
  268.           -D
  269.             HDFS config parameters
  270.             Syntax: -Dkey=value
  271.             Default: {}
  273.     deploy      Install HugeGraph-Server and HugeGraph-Studio
  274.       Usage: deploy [options]
  275.         Options:
  276.         * -p
  277.             Install path of HugeGraph-Server and HugeGraph-Studio
  278.           -u
  279.             Download url prefix path of HugeGraph-Server and HugeGraph-Studio
  280.         * -v
  281.             Version of HugeGraph-Server and HugeGraph-Studio
  283.     start-all      Start HugeGraph-Server and HugeGraph-Studio
  284.       Usage: start-all [options]
  285.         Options:
  286.         * -p
  287.             Install path of HugeGraph-Server and HugeGraph-Studio
  288.         * -v
  289.             Version of HugeGraph-Server and HugeGraph-Studio
  291.     clear      Clear HugeGraph-Server and HugeGraph-Studio
  292.       Usage: clear [options]
  293.         Options:
  294.         * -p
  295.             Install path of HugeGraph-Server and HugeGraph-Studio
  297.     stop-all      Stop HugeGraph-Server and HugeGraph-Studio
  298.       Usage: stop-all
  300.     help      Print usage
  301.       Usage: help
3.9 具体命令示例
1. gremlin语句
  1. # 同步执行gremlin
  2. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph gremlin-execute --script 'g.V().count()'
  4. # 异步执行gremlin
  5. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph gremlin-schedule --script 'g.V().count()'
2. 查看task情况
  1. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list
  3. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list --limit 5
  5. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list --status success
3. 图模式查看和设置
  1. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m RESTORING MERGING NONE
  3. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m RESTORING
  5. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-get
  7. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-list
4. 清理图
  1. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-clear -c "I'm sure to delete all data"
5. 图备份
  1. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph backup -t all --directory ./backup-test
6. 周期性的备份
  1. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph --interval */2 * * * * schedule-backup -d ./backup-0.10.2
7. 图恢复
  1. # 设置图模式
  2. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m RESTORING
  4. # 恢复图
  5. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph restore -t all --directory ./backup-test
  7. # 恢复图模式
  8. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m NONE
8. 图迁移
  1. ./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph migrate --target-url http://127.0.0.1:8090 --target-graph hugegraph

Last modified October 9, 2023: doc: enhance a string of problems to improve UE (#288) (69c20091)