HugeGraph-Tools Quick Start

1export VERSION=1.7.0
2export ARCHIVE="apache-hugegraph-toolchain-incubating-${VERSION}"
3wget "https://downloads.apache.org/hugegraph/${VERSION}/${ARCHIVE}.tar.gz"
4tar zxf "${ARCHIVE}.tar.gz"

1# 1. get from github
2git clone https://github.com/apache/hugegraph-toolchain.git
3
4# 2. 下载发布版源码包
5export VERSION=1.7.0
6export ARCHIVE="apache-hugegraph-toolchain-incubating-${VERSION}"
7wget "https://downloads.apache.org/hugegraph/${VERSION}/${ARCHIVE}-src.tar.gz"

1cd hugegraph-toolchain
2mvn package -pl hugegraph-tools -am -DskipTests -ntp

1Usage: hugegraph [options] [command] [command options]

 1#!/bin/bash
 2
 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=

  1Usage: 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
 24
 25    graph-get      Get graph info
 26      Usage: graph-get
 27
 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 "")
 34
 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]
 41
 42    graph-mode-get      Get graph mode
 43      Usage: graph-mode-get
 44
 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
 53
 54    task-get      Get task info
 55      Usage: task-get [options]
 56        Options:
 57        * --task-id
 58            Task id
 59            Default: 0
 60
 61    task-delete      Delete task
 62      Usage: task-delete [options]
 63        Options:
 64        * --task-id
 65            Task id
 66            Default: 0
 67
 68    task-cancel      Cancel task
 69      Usage: task-cancel [options]
 70        Options:
 71        * --task-id
 72            Task id
 73            Default: 0
 74
 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
 82
 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
100
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
115
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: {}
157
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 * * *"
172
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: {}
195
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: {}
222
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: {}
272
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
282
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
290
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
296
297    stop-all      Stop HugeGraph-Server and HugeGraph-Studio
298      Usage: stop-all
299
300    help      Print usage
301      Usage: help

1# 同步执行gremlin
2./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph gremlin-execute --script 'g.V().count()'
3
4# 异步执行gremlin
5./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph gremlin-schedule --script 'g.V().count()'

1./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list
2
3./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list --limit 5
4
5./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list --status success

1./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m RESTORING
2
3./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-get
4
5./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-list

1./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-clear -c "I'm sure to delete all data"

1./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph backup -t all --directory ./backup-test

1./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph schedule-backup -d ./backup --interval "*/2 * * * *"

1# 设置图模式
2./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m RESTORING
3
4# 恢复图
5./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph restore -t all --directory ./backup-test
6
7# 恢复图模式
8./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m NONE

1./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph migrate --target-url http://127.0.0.1:8090 --target-graph hugegraph