| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>HugeGraph – Quick Start</title><link>/docs/quickstart/</link><description>Recent content in Quick Start on HugeGraph</description><generator>Hugo -- gohugo.io</generator><atom:link href="/docs/quickstart/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: HugeGraph-Server Quick Start</title><link>/docs/quickstart/hugegraph-server/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/quickstart/hugegraph-server/</guid><description> |
| <h3 id="1-hugegraph-server-overview">1 HugeGraph-Server Overview</h3> |
| <p><code>HugeGraph-Server</code> is the core part of the HugeGraph Project, contains submodules such as Core, Backend, API.</p> |
| <p>The Core Module is an implementation of the Tinkerpop interface; The Backend module is used to save the graph data to the data store, currently supported backends include: Memory, Cassandra, ScyllaDB, RocksDB; The API Module provides HTTP Server, which converts Client&rsquo;s HTTP request into a call to Core Module.</p> |
| <blockquote> |
| <p>There will be two spellings HugeGraph-Server and HugeGraphServer in the document, and other |
| modules are similar. There is no big difference in the meaning of these two ways, |
| which can be distinguished as follows: <code>HugeGraph-Server</code> represents the code of server-related |
| components, <code>HugeGraphServer</code> represents the service process.</p> |
| </blockquote> |
| <h3 id="2-dependency-for-buildingrunning">2 Dependency for Building/Running</h3> |
| <h4 id="21-install-java-11-jdk-11">2.1 Install Java 11 (JDK 11)</h4> |
| <p>Consider using Java 11 to run <code>HugeGraph-Server</code> (compatible with Java 8 before 1.5.0), |
| and configure by yourself.</p> |
| <p><strong>Be sure to execute the <code>java -version</code> command to check the jdk version before reading</strong></p> |
| <blockquote> |
| <p>Note: Using Java8 will lose some security guarantees, we recommend using Java11 in production or</p> |
| <p>environments exposed to the public network and enable <a href="/docs/config/config-authentication/">Auth authentication</a>.</p> |
| </blockquote> |
| <h3 id="3-deploy">3 Deploy</h3> |
| <p>There are four ways to deploy HugeGraph-Server components:</p> |
| <ul> |
| <li>Method 1: Use Docker container (Convenient for Test/Dev)</li> |
| <li>Method 2: Download the binary tarball</li> |
| <li>Method 3: Source code compilation</li> |
| <li>Method 4: One-click deployment</li> |
| </ul> |
| <h4 id="31-use-docker-container-convenient-for-testdev">3.1 Use Docker container (Convenient for Test/Dev)</h4> |
| <!-- 3.1 is linked by another place. if change 3.1's title, please check --> |
| <p>You can refer to <a href="https://hub.docker.com/r/hugegraph/hugegraph">Docker deployment guide</a>.</p> |
| <p>We can use <code>docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph</code> to quickly start an inner <code>HugeGraph server</code> with <code>RocksDB</code> in background.</p> |
| <p>Optional:</p> |
| <ol> |
| <li>use <code>docker exec -it graph bash</code> to enter the container to do some operations.</li> |
| <li>use <code>docker run -itd --name=graph -p 8080:8080 -e PRELOAD=&quot;true&quot; hugegraph/hugegraph</code> to start with a <strong>built-in</strong> example graph. We can use <code>RESTful API</code> to verify the result. The detailed step can refer to <a href="#517-create-an-example-graph-when-startup">5.1.7</a></li> |
| <li>use <code>-e PASSWORD=123456</code> to enable auth mode and set the passoword for admin. You cna find more details from <a href="/docs/config/config-authentication#Use-docker-to-enble-authentication-mode">Config Authentication</a></li> |
| </ol> |
| <p>If you use docker desktop, you can set the option like:</p> |
| <div style="text-align: center;"> |
| <img src="/docs/images/images-server/31docker-option.jpg" alt="image" style="width:33%;"> |
| </div> |
| <p>Also, if we want to manage the other Hugegraph related instances in one file, we can use <code>docker-compose</code> to deploy, with the command <code>docker-compose up -d</code> (you can config only <code>server</code>). Here is an example <code>docker-compose.yml</code>:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">version</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;3&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">services</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">server</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph/hugegraph</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">container_name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">server</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># environment:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># - PRELOAD=true</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># PRELOAD is a option to preload a build-in sample graph when initializing.</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># - PASSWORD=123456</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># PASSWORD is an option to enable auth mode with the password you set.</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ports</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><blockquote> |
| <p>Note:</p> |
| <ol> |
| <li> |
| <p>The docker image of hugegraph is a convenience release to start hugegraph quickly, but not <strong>official distribution</strong> artifacts. You can find more details from <a href="https://infra.apache.org/release-distribution.html#dockerhub">ASF Release Distribution Policy</a>.</p> |
| </li> |
| <li> |
| <p>Recommand to use <code>release tag</code>(like <code>1.3.0</code>) for the stable version. Use <code>latest</code> tag to experience the newest functions in development.</p> |
| </li> |
| </ol> |
| </blockquote> |
| <h4 id="32-download-the-binary-tar-tarball">3.2 Download the binary tar tarball</h4> |
| <p>You could download the binary tarball from the download page of ASF site like this:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># use the latest version, here is 1.3.0 for example</span> |
| </span></span><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>/apache-hugegraph-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz |
| </span></span><span style="display:flex;"><span>tar zxf *hugegraph*.tar.gz |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># (Optional) verify the integrity with SHA512 (recommended)</span> |
| </span></span><span style="display:flex;"><span>shasum -a <span style="color:#0000cf;font-weight:bold">512</span> apache-hugegraph-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz |
| </span></span><span style="display:flex;"><span>curl https://downloads.apache.org/incubator/hugegraph/<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>/apache-hugegraph-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz.sha512 |
| </span></span></code></pre></div><h4 id="33-source-code-compilation">3.3 Source code compilation</h4> |
| <p>Please ensure that the wget command is installed before compiling the source code</p> |
| <p>We could get HugeGraph <strong>source code</strong> by 2 ways: (So as the other HugeGraph repos/modules)</p> |
| <ul> |
| <li>download the stable/release version from the ASF site</li> |
| <li>clone the unstable/latest version by GitBox(ASF) or GitHub</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Way 1. download release package from the ASF site</span> |
| </span></span><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>/apache-hugegraph-incubating-src-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz |
| </span></span><span style="display:flex;"><span>tar zxf *hugegraph*.tar.gz |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># (Optional) verify the integrity with SHA512 (recommended)</span> |
| </span></span><span style="display:flex;"><span>shasum -a <span style="color:#0000cf;font-weight:bold">512</span> apache-hugegraph-incubating-src-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz |
| </span></span><span style="display:flex;"><span>curl https://downloads.apache.org/incubator/hugegraph/<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>/apache-hugegraph-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>-src.tar.gz.sha512 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Way2 : clone the latest code by git way (e.g GitHub)</span> |
| </span></span><span style="display:flex;"><span>git clone https://github.com/apache/hugegraph.git |
| </span></span></code></pre></div><p>Compile and generate tarball</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> *hugegraph |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># (Optional) use &#34;-P stage&#34; param if you build failed with the latest code(during pre-release period)</span> |
| </span></span><span style="display:flex;"><span>mvn package -DskipTests -ntp |
| </span></span></code></pre></div><p>The execution log is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>...... |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> Reactor Summary <span style="color:#204a87;font-weight:bold">for</span> hugegraph 1.3.0: |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph .......................................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 2.405 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-core ..................................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 13.405 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-api ...................................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 25.943 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-cassandra ................................ SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 54.270 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-scylladb ................................. SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 1.032 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-rocksdb .................................. SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 34.752 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-mysql .................................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 1.778 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-palo ..................................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 1.070 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-hbase .................................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 32.124 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-postgresql ............................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 1.823 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-dist ..................................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 17.426 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-example .................................. SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span> 1.941 s<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> hugegraph-test ..................................... SUCCESS <span style="color:#ce5c00;font-weight:bold">[</span>01:01 min<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> BUILD SUCCESS |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">[</span>INFO<span style="color:#ce5c00;font-weight:bold">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span>...... |
| </span></span></code></pre></div><p>After successful execution, <code>*hugegraph-*.tar.gz</code> files will be generated in the hugegraph directory, which is the tarball generated by compilation.</p> |
| <h4 id="34-one-click-deployment">3.4 One-click deployment</h4> |
| <p><code>HugeGraph-Tools</code> provides a command-line tool for one-click deployment, users can use this tool to quickly download, decompress, configure and start <code>HugeGraphServer</code> and <code>HugeGraph-Hubble</code> with one click.</p> |
| <p>Of course, you should download the tarball of <code>HugeGraph-Toolchain</code> first.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># download toolchain binary package, it includes loader + tool + hubble</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># please check the latest version (e.g. here is 1.3.0)</span> |
| </span></span><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/1.3.0/apache-hugegraph-toolchain-incubating-1.3.0.tar.gz |
| </span></span><span style="display:flex;"><span>tar zxf *hugegraph-*.tar.gz |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># enter the tool&#39;s package</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87">cd</span> *hugegraph*/*tool* |
| </span></span></code></pre></div><blockquote> |
| <p>note: <code>${version}</code> is the version, The latest version can refer to <a href="/docs/download/download">Download Page</a>, or click the link to download directly from the Download page</p> |
| </blockquote> |
| <p>The general entry script for HugeGraph-Tools is <code>bin/hugegraph</code>, Users can use the <code>help</code> command to view its usage, here only the commands for one-click deployment are introduced.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/hugegraph deploy -v <span style="color:#ce5c00;font-weight:bold">{</span>hugegraph-version<span style="color:#ce5c00;font-weight:bold">}</span> -p <span style="color:#ce5c00;font-weight:bold">{</span>install-path<span style="color:#ce5c00;font-weight:bold">}</span> <span style="color:#ce5c00;font-weight:bold">[</span>-u <span style="color:#ce5c00;font-weight:bold">{</span>download-path-prefix<span style="color:#ce5c00;font-weight:bold">}]</span> |
| </span></span></code></pre></div><p><code>{hugegraph-version}</code> indicates the version of HugeGraphServer and HugeGraphStudio to be deployed, users can view the <code>conf/version-mapping.yaml</code> file for version information, <code>{install-path}</code> specify the installation directory of HugeGraphServer and HugeGraphStudio, <code>{download-path-prefix}</code> optional, specify the download address of HugeGraphServer and HugeGraphStudio tarball, use default download URL if not provided, for example, to start HugeGraph-Server and HugeGraphStudio version 0.6, write the above command as <code>bin/hugegraph deploy -v 0.6 -p services</code>.</p> |
| <h3 id="4-config">4 Config</h3> |
| <p>If you need to quickly start HugeGraph just for testing, then you only need to modify a few configuration items (see next section). |
| for detailed configuration introduction, please refer to <a href="/docs/config/config-guide">configuration document</a> and <a href="/docs/config/config-option">introduction to configuration items</a></p> |
| <h3 id="5-startup">5 Startup</h3> |
| <h4 id="51-use-a-startup-script-to-startup">5.1 Use a startup script to startup</h4> |
| <p>The startup is divided into &ldquo;first startup&rdquo; and &ldquo;non-first startup.&rdquo; This distinction is because the back-end database needs to be initialized before the first startup, and then the service is started. |
| after the service is stopped artificially, or when the service needs to be started again for other reasons, because the backend database is persistent, you can start the service directly.</p> |
| <p>When HugeGraphServer starts, it will connect to the backend storage and try to check the version number of the backend storage. If the backend is not initialized or the backend has been initialized but the version does not match (old version data), HugeGraphServer will fail to start and give an error message.</p> |
| <p>If you need to access HugeGraphServer externally, please modify the <code>restserver.url</code> configuration item of <code>rest-server.properties</code> |
| （default is <code>http://127.0.0.1:8080</code>）, change to machine name or IP address.</p> |
| <p>Since the configuration (hugegraph.properties) and startup steps required by various backends are slightly different, the following will introduce the configuration and startup of each backend one by one.</p> |
| <p>If you want to use HugeGraph authentication mode, you should follow the <a href="https://hugegraph.apache.org/docs/config/config-authentication/">Server Authentication Configuration</a> before you start Server later.</p> |
| <h5 id="511-memory">5.1.1 Memory</h5> |
| <details> |
| <summary>Click to expand/collapse Memory configuration and startup methods</summary> |
| <p>Update hugegraph.properties</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>backend=memory |
| </span></span><span style="display:flex;"><span>serializer=text |
| </span></span></code></pre></div><blockquote> |
| <p>The data of the Memory backend is stored in memory and cannot be persisted. It does not need to initialize the backend. This is the only backend that does not require initialization.</p> |
| </blockquote> |
| <p>Start server</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-hugegraph.sh |
| </span></span><span style="display:flex;"><span>Starting HugeGraphServer... |
| </span></span><span style="display:flex;"><span>Connecting to HugeGraphServer <span style="color:#ce5c00;font-weight:bold">(</span>http://127.0.0.1:8080/graphs<span style="color:#ce5c00;font-weight:bold">)</span>....OK |
| </span></span></code></pre></div><p>The prompted url is the same as the restserver.url configured in rest-server.properties</p> |
| </details> |
| <h5 id="512-rocksdb">5.1.2 RocksDB</h5> |
| <details> |
| <summary>Click to expand/collapse RocksDB configuration and startup methods</summary> |
| <blockquote> |
| <p>RocksDB is an embedded database that does not require manual installation and deployment. GCC version &gt;= 4.3.0 (GLIBCXX_3.4.10) is required. If not, GCC needs to be upgraded in advance</p> |
| </blockquote> |
| <p>Update hugegraph.properties</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>backend=rocksdb |
| </span></span><span style="display:flex;"><span>serializer=binary |
| </span></span><span style="display:flex;"><span>rocksdb.data_path=. |
| </span></span><span style="display:flex;"><span>rocksdb.wal_path=. |
| </span></span></code></pre></div><p>Initialize the database (required on first startup or a new configuration was manually added under &lsquo;conf/graphs/&rsquo;)</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> *hugegraph-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span> |
| </span></span><span style="display:flex;"><span>bin/init-store.sh |
| </span></span></code></pre></div><p>Start server</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-hugegraph.sh |
| </span></span><span style="display:flex;"><span>Starting HugeGraphServer... |
| </span></span><span style="display:flex;"><span>Connecting to HugeGraphServer <span style="color:#ce5c00;font-weight:bold">(</span>http://127.0.0.1:8080/graphs<span style="color:#ce5c00;font-weight:bold">)</span>....OK |
| </span></span></code></pre></div></details> |
| <h5 id="513-cassandra">5.1.3 Cassandra</h5> |
| <details> |
| <summary>Click to expand/collapse Cassandra configuration and startup methods</summary> |
| <blockquote> |
| <p>users need to install Cassandra by themselves, requiring version 3.0 or above, <a href="http://cassandra.apache.org/download/">download link</a></p> |
| </blockquote> |
| <p>Update hugegraph.properties</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>backend=cassandra |
| </span></span><span style="display:flex;"><span>serializer=cassandra |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span># cassandra backend config |
| </span></span><span style="display:flex;"><span>cassandra.host=localhost |
| </span></span><span style="display:flex;"><span>cassandra.port=9042 |
| </span></span><span style="display:flex;"><span>cassandra.username= |
| </span></span><span style="display:flex;"><span>cassandra.password= |
| </span></span><span style="display:flex;"><span>#cassandra.connect_timeout=5 |
| </span></span><span style="display:flex;"><span>#cassandra.read_timeout=20 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>#cassandra.keyspace.strategy=SimpleStrategy |
| </span></span><span style="display:flex;"><span>#cassandra.keyspace.replication=3 |
| </span></span></code></pre></div><p>Initialize the database (required on first startup or a new configuration was manually added under &lsquo;conf/graphs/&rsquo;)</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> *hugegraph-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span> |
| </span></span><span style="display:flex;"><span>bin/init-store.sh |
| </span></span><span style="display:flex;"><span>Initing HugeGraph Store... |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:51 <span style="color:#0000cf;font-weight:bold">1424</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.HugeGraph <span style="color:#ce5c00;font-weight:bold">[]</span> - Opening backend store: <span style="color:#4e9a06">&#39;cassandra&#39;</span> |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:52 <span style="color:#0000cf;font-weight:bold">2389</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Failed to connect keyspace: hugegraph, try init keyspace later |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:52 <span style="color:#0000cf;font-weight:bold">2472</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Failed to connect keyspace: hugegraph, try init keyspace later |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:52 <span style="color:#0000cf;font-weight:bold">2557</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Failed to connect keyspace: hugegraph, try init keyspace later |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:53 <span style="color:#0000cf;font-weight:bold">2797</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Store initialized: huge_graph |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:53 <span style="color:#0000cf;font-weight:bold">2945</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Store initialized: huge_schema |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:53 <span style="color:#0000cf;font-weight:bold">3044</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Store initialized: huge_index |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:53 <span style="color:#0000cf;font-weight:bold">3046</span> <span style="color:#ce5c00;font-weight:bold">[</span>pool-3-thread-1<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.Transaction <span style="color:#ce5c00;font-weight:bold">[]</span> - Clear cache on event <span style="color:#4e9a06">&#39;store.init&#39;</span> |
| </span></span><span style="display:flex;"><span>2017-12-01 11:26:59 <span style="color:#0000cf;font-weight:bold">9720</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.HugeGraph <span style="color:#ce5c00;font-weight:bold">[]</span> - Opening backend store: <span style="color:#4e9a06">&#39;cassandra&#39;</span> |
| </span></span><span style="display:flex;"><span>2017-12-01 11:27:00 <span style="color:#0000cf;font-weight:bold">9805</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Failed to connect keyspace: hugegraph1, try init keyspace later |
| </span></span><span style="display:flex;"><span>2017-12-01 11:27:00 <span style="color:#0000cf;font-weight:bold">9886</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Failed to connect keyspace: hugegraph1, try init keyspace later |
| </span></span><span style="display:flex;"><span>2017-12-01 11:27:00 <span style="color:#0000cf;font-weight:bold">9955</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Failed to connect keyspace: hugegraph1, try init keyspace later |
| </span></span><span style="display:flex;"><span>2017-12-01 11:27:00 <span style="color:#0000cf;font-weight:bold">10175</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Store initialized: huge_graph |
| </span></span><span style="display:flex;"><span>2017-12-01 11:27:00 <span style="color:#0000cf;font-weight:bold">10321</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Store initialized: huge_schema |
| </span></span><span style="display:flex;"><span>2017-12-01 11:27:00 <span style="color:#0000cf;font-weight:bold">10413</span> <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.store.cassandra.CassandraStore <span style="color:#ce5c00;font-weight:bold">[]</span> - Store initialized: huge_index |
| </span></span><span style="display:flex;"><span>2017-12-01 11:27:00 <span style="color:#0000cf;font-weight:bold">10413</span> <span style="color:#ce5c00;font-weight:bold">[</span>pool-3-thread-1<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> org.apache.hugegraph.backend.Transaction <span style="color:#ce5c00;font-weight:bold">[]</span> - Clear cache on event <span style="color:#4e9a06">&#39;store.init&#39;</span> |
| </span></span></code></pre></div><p>Start server</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-hugegraph.sh |
| </span></span><span style="display:flex;"><span>Starting HugeGraphServer... |
| </span></span><span style="display:flex;"><span>Connecting to HugeGraphServer <span style="color:#ce5c00;font-weight:bold">(</span>http://127.0.0.1:8080/graphs<span style="color:#ce5c00;font-weight:bold">)</span>....OK |
| </span></span></code></pre></div></details> |
| <h5 id="514-scylladb">5.1.4 ScyllaDB</h5> |
| <details> |
| <summary>Click to expand/collapse ScyllaDB configuration and startup methods</summary> |
| <blockquote> |
| <p>users need to install ScyllaDB by themselves, version 2.1 or above is recommended, <a href="https://docs.scylladb.com/getting-started/">download link</a></p> |
| </blockquote> |
| <p>Update hugegraph.properties</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>backend=scylladb |
| </span></span><span style="display:flex;"><span>serializer=scylladb |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span># cassandra backend config |
| </span></span><span style="display:flex;"><span>cassandra.host=localhost |
| </span></span><span style="display:flex;"><span>cassandra.port=9042 |
| </span></span><span style="display:flex;"><span>cassandra.username= |
| </span></span><span style="display:flex;"><span>cassandra.password= |
| </span></span><span style="display:flex;"><span>#cassandra.connect_timeout=5 |
| </span></span><span style="display:flex;"><span>#cassandra.read_timeout=20 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>#cassandra.keyspace.strategy=SimpleStrategy |
| </span></span><span style="display:flex;"><span>#cassandra.keyspace.replication=3 |
| </span></span></code></pre></div><p>Since the scylladb database itself is an &ldquo;optimized version&rdquo; based on cassandra, if the user does not have scylladb installed, they can also use cassandra as the backend storage directly. They only need to change the backend and serializer to scylladb, and the host and post point to the seeds and port of the cassandra cluster. Yes, but it is not recommended to do so, it will not take advantage of scylladb itself.</p> |
| <p>Initialize the database (required on first startup or a new configuration was manually added under &lsquo;conf/graphs/&rsquo;)</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> *hugegraph-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span> |
| </span></span><span style="display:flex;"><span>bin/init-store.sh |
| </span></span></code></pre></div><p>Start server</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-hugegraph.sh |
| </span></span><span style="display:flex;"><span>Starting HugeGraphServer... |
| </span></span><span style="display:flex;"><span>Connecting to HugeGraphServer <span style="color:#ce5c00;font-weight:bold">(</span>http://127.0.0.1:8080/graphs<span style="color:#ce5c00;font-weight:bold">)</span>....OK |
| </span></span></code></pre></div></details> |
| <h5 id="515-hbase">5.1.5 HBase</h5> |
| <details> |
| <summary>Click to expand/collapse HBase configuration and startup methods</summary> |
| <blockquote> |
| <p>users need to install HBase by themselves, requiring version 2.0 or above,<a href="https://hbase.apache.org/downloads.html">download link</a></p> |
| </blockquote> |
| <p>Update hugegraph.properties</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>backend=hbase |
| </span></span><span style="display:flex;"><span>serializer=hbase |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span># hbase backend config |
| </span></span><span style="display:flex;"><span>hbase.hosts=localhost |
| </span></span><span style="display:flex;"><span>hbase.port=2181 |
| </span></span><span style="display:flex;"><span># Note: recommend to modify the HBase partition number by the actual/env data amount &amp; RS amount before init store |
| </span></span><span style="display:flex;"><span># it may influence the loading speed a lot |
| </span></span><span style="display:flex;"><span>#hbase.enable_partition=true |
| </span></span><span style="display:flex;"><span>#hbase.vertex_partitions=10 |
| </span></span><span style="display:flex;"><span>#hbase.edge_partitions=30 |
| </span></span></code></pre></div><p>Initialize the database (required on first startup or a new configuration was manually added under &lsquo;conf/graphs/&rsquo;)</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> *hugegraph-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span> |
| </span></span><span style="display:flex;"><span>bin/init-store.sh |
| </span></span></code></pre></div><p>Start server</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-hugegraph.sh |
| </span></span><span style="display:flex;"><span>Starting HugeGraphServer... |
| </span></span><span style="display:flex;"><span>Connecting to HugeGraphServer <span style="color:#ce5c00;font-weight:bold">(</span>http://127.0.0.1:8080/graphs<span style="color:#ce5c00;font-weight:bold">)</span>....OK |
| </span></span></code></pre></div><blockquote> |
| <p>for more other backend configurations, please refer to<a href="/docs/config/config-option">introduction to configuration options</a></p> |
| </blockquote> |
| </details> |
| <h5 id="516-mysql">5.1.6 MySQL</h5> |
| <details> |
| <summary>Click to expand/collapse MySQL configuration and startup methods</summary> |
| <blockquote> |
| <p>Due to MySQL is under GPL license, which is not compatible with Apache License indeed, Users need to install MySQL, <a href="https://dev.mysql.com/downloads/mysql/">Download Link</a></p> |
| </blockquote> |
| <p>Download MySQL&rsquo;s [driver package] (<a href="https://repo1.maven.org/maven2/mysql/mysql-connector-java/)">https://repo1.maven.org/maven2/mysql/mysql-connector-java/)</a>, such as <code>mysql-connector-java-8.0.30.jar</code>, and put it into HugeGraph- Server&rsquo;s <code>lib</code> directory.</p> |
| <p>Modify <code>hugegraph.properties</code>, configure the database URL, username and password, <code>store</code> is the database name, if not, it will be created automatically.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>backend=mysql |
| </span></span><span style="display:flex;"><span>serializer=mysql |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>store=hugegraph |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span># mysql backend config |
| </span></span><span style="display:flex;"><span>jdbc.driver=com.mysql.cj.jdbc.Driver |
| </span></span><span style="display:flex;"><span>jdbc.url=jdbc:mysql://127.0.0.1:3306 |
| </span></span><span style="display:flex;"><span>jdbc.username= |
| </span></span><span style="display:flex;"><span>jdbc.password= |
| </span></span><span style="display:flex;"><span>jdbc.reconnect_max_times=3 |
| </span></span><span style="display:flex;"><span>jdbc.reconnect_interval=3 |
| </span></span><span style="display:flex;"><span>jdbc.ssl_mode=false |
| </span></span></code></pre></div><p>Initialize the database (required on first startup or a new configuration was manually added under &lsquo;conf/graphs/&rsquo;)</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> *hugegraph-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span> |
| </span></span><span style="display:flex;"><span>bin/init-store.sh |
| </span></span></code></pre></div><p>Start server</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-hugegraph.sh |
| </span></span><span style="display:flex;"><span>Starting HugeGraphServer... |
| </span></span><span style="display:flex;"><span>Connecting to HugeGraphServer <span style="color:#ce5c00;font-weight:bold">(</span>http://127.0.0.1:8080/graphs<span style="color:#ce5c00;font-weight:bold">)</span>....OK |
| </span></span></code></pre></div></details> |
| <h5 id="517-create-an-example-graph-when-startup">5.1.7 Create an example graph when startup</h5> |
| <p>Carry the <code>-p true</code> arguments when starting the script, which indicates <code>preload</code>, to create a sample graph.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>bin/start-hugegraph.sh -p true |
| </span></span><span style="display:flex;"><span>Starting HugeGraphServer in daemon mode... |
| </span></span><span style="display:flex;"><span>Connecting to HugeGraphServer (http://127.0.0.1:8080/graphs)......OK |
| </span></span></code></pre></div><p>And use the RESTful API to request <code>HugeGraphServer</code> and get the following result:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">&gt;</span> <span style="color:#000">curl</span> <span style="color:#4e9a06">&#34;http://localhost:8080/graphs/hugegraph/graph/vertices&#34;</span> <span style="color:#ce5c00;font-weight:bold">|</span> <span style="color:#000">gunzip</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;vertices&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">[{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;2:lop&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;lop&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;java&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">328</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;1:josh&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;josh&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;Beijing&#34;</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;1:marko&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;Beijing&#34;</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;1:peter&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;peter&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">35</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;Shanghai&#34;</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;1:vadas&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vadas&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">27</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;Hongkong&#34;</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;2:ripple&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;ripple&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;java&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">199</span><span style="color:#000;font-weight:bold">}}]}</span> |
| </span></span></code></pre></div><p>This indicates the successful creation of the sample graph.</p> |
| <h4 id="52-use-docker-to-startup">5.2 Use Docker to startup</h4> |
| <p>In <a href="#33-use-docker-container">3.3 Use Docker container</a>, we have introduced how to use docker to deploy <code>hugegraph-server</code>. <code>server</code> can also preload an example graph by setting the parameter.</p> |
| <h5 id="521-uses-cassandra-as-storage">5.2.1 Uses Cassandra as storage</h5> |
| <details> |
| <summary> Click to expand/collapse Cassandra configuration and startup methods</summary> |
| <p>When using Docker, we can use Cassandra as the backend storage. We highly recommend using docker-compose directly to manage both the server and Cassandra.</p> |
| <p>The sample <code>docker-compose.yml</code> can be obtained on <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/docker/example/docker-compose-cassandra.yml">GitHub</a>, and you can start it with <code>docker-compose up -d</code>. (If using Cassandra 4.0 as the backend storage, it takes approximately two minutes to initialize. Please be patient.)</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">version</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;3&#34;</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">services</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">graph</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph/hugegraph</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">container_name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">cas-server</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ports</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">environment</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">hugegraph.backend</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">cassandra</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">hugegraph.serializer</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">cassandra</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">hugegraph.cassandra.host</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">cas-cassandra</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">hugegraph.cassandra.port</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">9042</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">networks</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">ca-network</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">depends_on</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">cassandra</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">healthcheck</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">test</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;CMD&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;bin/gremlin-console.sh&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;--&#34;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;-e&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;scripts/remote-connect.groovy&#34;</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">interval</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">10s</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">timeout</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">30s</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">retries</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">3</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">cassandra</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">cassandra:4</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">container_name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">cas-cassandra</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ports</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#0000cf;font-weight:bold">7000</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">7000</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#0000cf;font-weight:bold">9042</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">9042</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">security_opt</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">seccomp:unconfined</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">networks</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">ca-network</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">healthcheck</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">test</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;CMD&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;cqlsh&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;--execute&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;describe keyspaces;&#34;</span><span style="color:#000;font-weight:bold">]</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">interval</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">10s</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">timeout</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">30s</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">retries</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">5</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">networks</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ca-network</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">volumes</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">hugegraph-data</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><p>In this yaml file, configuration parameters related to Cassandra need to be passed as environment variables in the format of <code>hugegraph.&lt;parameter_name&gt;</code>.</p> |
| <p>Specifically, in the configuration file <code>hugegraph.properties</code> , there are settings like <code>backend=xxx</code> and <code>cassandra.host=xxx</code>. To configure these settings during the process of passing environment variables, we need to prepend <code>hugegraph.</code> to these configurations, like <code>hugegraph.backend</code> and <code>hugegraph.cassandra.host</code>.</p> |
| <p>The rest of the configurations can be referenced under <a href="#4-config">4 config</a></p> |
| </details> |
| <h5 id="522-create-example-graph-when-starting-server">5.2.2 Create example graph when starting server</h5> |
| <p>Set the environment variable <code>PRELOAD=true</code> when starting Docker in order to load data during the execution of the startup script.</p> |
| <ol> |
| <li> |
| <p>Use <code>docker run</code></p> |
| <p>Use <code>docker run -itd --name=server -p 8080:8080 -e PRELOAD=true hugegraph/hugegraph:latest</code></p> |
| </li> |
| <li> |
| <p>Use <code>docker-compose</code></p> |
| <p>Create <code>docker-compose.yml</code> as following. We should set the environment variable <code>PRELOAD=true</code>. <a href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy"><code>example.groovy</code></a> is a predefined script to preload the sample data. If needed, we can mount a new <code>example.groovy</code> to change the preload data.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">version</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;3&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">services</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">server</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph/hugegraph:latest</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">container_name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">server</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">environment</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#000">PRELOAD=true</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ports</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><p>Use <code>docker-compose up -d</code> to start the container</p> |
| </li> |
| </ol> |
| <p>And use the RESTful API to request <code>HugeGraphServer</code> and get the following result:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">&gt;</span> <span style="color:#000">curl</span> <span style="color:#4e9a06">&#34;http://localhost:8080/graphs/hugegraph/graph/vertices&#34;</span> <span style="color:#ce5c00;font-weight:bold">|</span> <span style="color:#000">gunzip</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;vertices&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">[{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;2:lop&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;lop&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;java&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">328</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;1:josh&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;josh&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;Beijing&#34;</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;1:marko&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;Beijing&#34;</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;1:peter&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;peter&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">35</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;Shanghai&#34;</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;1:vadas&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vadas&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">27</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;Hongkong&#34;</span><span style="color:#000;font-weight:bold">}},{</span><span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;2:ripple&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;label&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;type&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;vertex&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;properties&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;ripple&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#4e9a06">&#34;java&#34;</span><span style="color:#000;font-weight:bold">,</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">199</span><span style="color:#000;font-weight:bold">}}]}</span> |
| </span></span></code></pre></div><p>This indicates the successful creation of the sample graph.</p> |
| <h3 id="6-access-server">6. Access server</h3> |
| <h4 id="61-service-startup-status-check">6.1 Service startup status check</h4> |
| <p>Use <code>jps</code> to see a service process</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>jps |
| </span></span><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">6475</span> HugeGraphServer |
| </span></span></code></pre></div><p><code>curl</code> request <code>RESTfulAPI</code></p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">echo</span> <span style="color:#4e9a06">`</span>curl -o /dev/null -s -w %<span style="color:#ce5c00;font-weight:bold">{</span>http_code<span style="color:#ce5c00;font-weight:bold">}</span> <span style="color:#4e9a06">&#34;http://localhost:8080/graphs/hugegraph/graph/vertices&#34;</span><span style="color:#4e9a06">`</span> |
| </span></span></code></pre></div><p>Return 200, which means the server starts normally.</p> |
| <h4 id="62-request-server">6.2 Request Server</h4> |
| <p>The RESTful API of HugeGraphServer includes various types of resources, typically including graph, schema, gremlin, traverser and task.</p> |
| <ul> |
| <li><code>graph</code> contains <code>vertices</code>、<code>edges</code></li> |
| <li><code>schema</code> contains <code>vertexlabels</code>、 <code>propertykeys</code>、 <code>edgelabels</code>、<code>indexlabels</code></li> |
| <li><code>gremlin</code> contains various <code>Gremlin</code> statements, such as <code>g.v()</code>, which can be executed synchronously or asynchronously</li> |
| <li><code>traverser</code> contains various advanced queries including shortest paths, intersections, N-step reachable neighbors, etc.</li> |
| <li><code>task</code> contains query and delete with asynchronous tasks</li> |
| </ul> |
| <h5 id="621-get-vertices-and-its-related-properties-in-hugegraph">6.2.1 Get vertices and its related properties in <code>hugegraph</code></h5> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl http://localhost:8080/graphs/hugegraph/graph/vertices |
| </span></span></code></pre></div><p><em>explanation</em></p> |
| <ol> |
| <li> |
| <p>Since there are many vertices and edges in the graph, for list-type requests, such as getting all vertices, getting all edges, etc., the server will compress the data and return it, so when use curl, you get a bunch of garbled characters, you can redirect to gunzip for decompression. It is recommended to use Chrome browser + Restlet plugin to send HTTP requests for testing.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>curl &#34;http://localhost:8080/graphs/hugegraph/graph/vertices&#34; | gunzip |
| </span></span></code></pre></div></li> |
| <li> |
| <p>The current default configuration of HugeGraphServer can only be accessed locally, and the configuration can be modified so that it can be accessed on other machines.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>vim conf/rest-server.properties |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>restserver.url=http://0.0.0.0:8080 |
| </span></span></code></pre></div></li> |
| </ol> |
| <p>response body:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> &#34;vertices&#34;: [ |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> &#34;id&#34;: &#34;2lop&#34;, |
| </span></span><span style="display:flex;"><span> &#34;label&#34;: &#34;software&#34;, |
| </span></span><span style="display:flex;"><span> &#34;type&#34;: &#34;vertex&#34;, |
| </span></span><span style="display:flex;"><span> &#34;properties&#34;: { |
| </span></span><span style="display:flex;"><span> &#34;price&#34;: [ |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> &#34;id&#34;: &#34;price&#34;, |
| </span></span><span style="display:flex;"><span> &#34;value&#34;: 328 |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> ], |
| </span></span><span style="display:flex;"><span> &#34;name&#34;: [ |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> &#34;id&#34;: &#34;name&#34;, |
| </span></span><span style="display:flex;"><span> &#34;value&#34;: &#34;lop&#34; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> ], |
| </span></span><span style="display:flex;"><span> &#34;lang&#34;: [ |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> &#34;id&#34;: &#34;lang&#34;, |
| </span></span><span style="display:flex;"><span> &#34;value&#34;: &#34;java&#34; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> ] |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> &#34;id&#34;: &#34;1josh&#34;, |
| </span></span><span style="display:flex;"><span> &#34;label&#34;: &#34;person&#34;, |
| </span></span><span style="display:flex;"><span> &#34;type&#34;: &#34;vertex&#34;, |
| </span></span><span style="display:flex;"><span> &#34;properties&#34;: { |
| </span></span><span style="display:flex;"><span> &#34;name&#34;: [ |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> &#34;id&#34;: &#34;name&#34;, |
| </span></span><span style="display:flex;"><span> &#34;value&#34;: &#34;josh&#34; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> ], |
| </span></span><span style="display:flex;"><span> &#34;age&#34;: [ |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> &#34;id&#34;: &#34;age&#34;, |
| </span></span><span style="display:flex;"><span> &#34;value&#34;: 32 |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> ] |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> ... |
| </span></span><span style="display:flex;"><span> ] |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p id="swaggerui-example"></p> |
| <p>For detailed API, please refer to <a href="/docs/clients/restful-api">RESTful-API</a></p> |
| <p>You can also visit <code>localhost:8080/swagger-ui/index.html</code> to check the API.</p> |
| <div style="text-align: center;"> |
| <img src="/docs/images/images-server/swagger-ui.png" alt="image"> |
| </div> |
| <p>When using Swagger UI to debug the API provided by HugeGraph, if HugeGraph Server turns on authentication mode, you can enter authentication information on the Swagger page.</p> |
| <div style="text-align: center;"> |
| <img src="/docs/images/images-server/swagger-ui-where-set-auth-example.png" alt="image"> |
| </div> |
| <p>Currently, HugeGraph supports setting authentication information in two forms: Basic and Bearer.</p> |
| <div style="text-align: center;"> |
| <img src="/docs/images/images-server/swagger-ui-set-auth-example.png" alt="image"> |
| </div> |
| <h3 id="7-stop-server">7 Stop Server</h3> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#000">$cd</span> *hugegraph-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">$bin</span>/stop-hugegraph.sh |
| </span></span></code></pre></div><h3 id="8-debug-server-with-intellij-idea">8 Debug Server with IntelliJ IDEA</h3> |
| <p>Please refer to <a href="/docs/contribution-guidelines/hugegraph-server-idea-setup">Setup Server in IDEA</a></p></description></item><item><title>Docs: HugeGraph-Loader Quick Start</title><link>/docs/quickstart/hugegraph-loader/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/quickstart/hugegraph-loader/</guid><description> |
| <h3 id="1-hugegraph-loader-overview">1 HugeGraph-Loader Overview</h3> |
| <p>HugeGraph-Loader is the data import component of HugeGraph, which can convert data from various data sources into graph vertices and edges and import them into the graph database in batches.</p> |
| <p>Currently supported data sources include:</p> |
| <ul> |
| <li>Local disk file or directory, supports TEXT, CSV and JSON format files, supports compressed files</li> |
| <li>HDFS file or directory, supports compressed files</li> |
| <li>Mainstream relational databases, such as MySQL, PostgreSQL, Oracle, SQL Server</li> |
| </ul> |
| <p>Local disk files and HDFS files support resumable uploads.</p> |
| <p>It will be explained in detail below.</p> |
| <blockquote> |
| <p>Note: HugeGraph-Loader requires HugeGraph Server service, please refer to <a href="/docs/quickstart/hugegraph-server">HugeGraph-Server Quick Start</a> to download and start Server</p> |
| </blockquote> |
| <h3 id="2-get-hugegraph-loader">2 Get HugeGraph-Loader</h3> |
| <p>There are two ways to get HugeGraph-Loader:</p> |
| <ul> |
| <li>Use docker image (Convenient for Test/Dev)</li> |
| <li>Download the compiled tarball</li> |
| <li>Clone source code then compile and install</li> |
| </ul> |
| <h4 id="21-use-docker-image-convenient-for-testdev">2.1 Use Docker image (Convenient for Test/Dev)</h4> |
| <p>We can deploy the loader service using <code>docker run -itd --name loader hugegraph/loader</code>. For the data that needs to be loaded, it can be copied into the loader container either by mounting <code>-v /path/to/data/file:/loader/file</code> or by using <code>docker cp</code>.</p> |
| <p>Alternatively, to start the loader using docker-compose, the command is <code>docker-compose up -d</code>. An example of the docker-compose.yml is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">version</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;3&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">services</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">server</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph/hugegraph</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">container_name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">server</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ports</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">loader</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph/loader</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">container_name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">loader</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># mount your own data here</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># volumes:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># - /path/to/data/file:/loader/file</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><p>The specific data loading process can be referenced under <a href="#45-use-docker-to-load-data">4.5 User Docker to load data</a></p> |
| <blockquote> |
| <p>Note:</p> |
| <ol> |
| <li> |
| <p>The docker image of hugegraph-loader is a convenience release to start hugegraph-loader quickly, but not <strong>official distribution</strong> artifacts. You can find more details from <a href="https://infra.apache.org/release-distribution.html#dockerhub">ASF Release Distribution Policy</a>.</p> |
| </li> |
| <li> |
| <p>Recommand to use <code>release tag</code>(like <code>1.2.0</code>) for the stable version. Use <code>latest</code> tag to experience the newest functions in development.</p> |
| </li> |
| </ol> |
| </blockquote> |
| <h4 id="22-download-the-compiled-archive">2.2 Download the compiled archive</h4> |
| <p>Download the latest version of the HugeGraph-Toolchain release package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>/apache-hugegraph-toolchain-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz |
| </span></span><span style="display:flex;"><span>tar zxf *hugegraph*.tar.gz |
| </span></span></code></pre></div><h4 id="23-clone-source-code-to-compile-and-install">2.3 Clone source code to compile and install</h4> |
| <p>Clone the latest version of HugeGraph-Loader source package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 1. get from github</span> |
| </span></span><span style="display:flex;"><span>git clone https://github.com/apache/hugegraph-toolchain.git |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 2. get from direct (e.g. here is 1.0.0, please choose the latest version)</span> |
| </span></span><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>/apache-hugegraph-toolchain-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>-src.tar.gz |
| </span></span></code></pre></div><details> |
| <summary>click to fold/collapse hwo to install ojdbc</summary> |
| <p>Due to the license limitation of the <code>Oracle OJDBC</code>, you need to manually install ojdbc to the local maven repository. |
| Visit the <a href="https://www.oracle.com/database/technologies/appdev/jdbc-drivers-archive.html">Oracle jdbc downloads</a> page. Select Oracle Database 12c Release 2 (12.2.0.1) drivers, as shown in the following figure.</p> |
| <p>After opening the link, select &ldquo;ojdbc8.jar&rdquo;.</p> |
| <p>Install ojdbc8 to the local maven repository, enter the directory where <code>ojdbc8.jar</code> is located, and execute the following command.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>mvn install:install-file -Dfile=./ojdbc8.jar -DgroupId=com.oracle -DartifactId=ojdbc8 -Dversion=12.2.0.1 -Dpackaging=jar |
| </span></span></code></pre></div></details> |
| <p>Compile and generate tar package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> hugegraph-loader |
| </span></span><span style="display:flex;"><span>mvn clean package -DskipTests |
| </span></span></code></pre></div><h3 id="3-how-to-use">3 How to use</h3> |
| <p>The basic process of using HugeGraph-Loader is divided into the following steps:</p> |
| <ul> |
| <li>Write graph schema</li> |
| <li>Prepare data files</li> |
| <li>Write input source map files</li> |
| <li>Execute command import</li> |
| </ul> |
| <h4 id="31-construct-graph-schema">3.1 Construct graph schema</h4> |
| <p>This step is the modeling process. Users need to have a clear idea of their existing data and the graph model they want to create, and then write the schema to build the graph model.</p> |
| <p>For example, if you want to create a graph with two types of vertices and two types of edges, the vertices are &ldquo;people&rdquo; and &ldquo;software&rdquo;, the edges are &ldquo;people know people&rdquo; and &ldquo;people create software&rdquo;, and these vertices and edges have some attributes, For example, the vertex &ldquo;person&rdquo; has: &ldquo;name&rdquo;, &ldquo;age&rdquo; and other attributes, |
| &ldquo;Software&rdquo; includes: &ldquo;name&rdquo;, &ldquo;sale price&rdquo; and other attributes; side &ldquo;knowledge&rdquo; includes: &ldquo;date&rdquo; attribute and so on.</p> |
| <div style="text-align: center;"> |
| <img src="/docs/images/demo-graph-model.png" alt="image"> |
| <p>graph model example</p> |
| </div> |
| <p>After designing the graph model, we can use <code>groovy</code> to write the definition of <code>schema</code> and save it to a file, here named <code>schema.groovy</code>.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-groovy" data-lang="groovy"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// Create some properties |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asInt</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asDouble</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// Create the person vertex type, which has three attributes: name, age, city, and the primary key is name |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// Create a software vertex type, which has two properties: name, price, the primary key is name |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// Create the knows edge type, which goes from person to person |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">sourceLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">targetLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// Create the created edge type, which points from person to software |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">sourceLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">targetLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span></code></pre></div><blockquote> |
| <p>Please refer to the corresponding section in <a href="/docs/clients/hugegraph-client">hugegraph-client</a> for the detailed description of the schema.</p> |
| </blockquote> |
| <h4 id="32-prepare-data">3.2 Prepare data</h4> |
| <p>The data sources currently supported by HugeGraph-Loader include:</p> |
| <ul> |
| <li>local disk file or directory</li> |
| <li>HDFS file or directory</li> |
| <li>Partial relational database</li> |
| <li>Kafka topic</li> |
| </ul> |
| <h5 id="321-data-source-structure">3.2.1 Data source structure</h5> |
| <h6 id="3211-local-disk-file-or-directory">3.2.1.1 Local disk file or directory</h6> |
| <p>The user can specify a local disk file as the data source. If the data is scattered in multiple files, a certain directory is also supported as the data source, but multiple directories are not supported as the data source for the time being.</p> |
| <p>For example: my data is scattered in multiple files, part-0, part-1 &hellip; part-n. To perform the import, it must be ensured that they are placed in one directory. Then in the loader&rsquo;s mapping file, specify <code>path</code> as the directory.</p> |
| <p>Supported file formats include:</p> |
| <ul> |
| <li>TEXT</li> |
| <li>CSV</li> |
| <li>JSON</li> |
| </ul> |
| <p>TEXT is a text file with custom delimiters, the first line is usually the header, and the name of each column is recorded, and no header line is allowed (specified in the mapping file). Each remaining row represents a record, which will be converted into a vertex/edge; each column of the row corresponds to a field, which will be converted into the id, label or attribute of the vertex/edge;</p> |
| <p>An example is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>id|name|lang|price|ISBN |
| </span></span><span style="display:flex;"><span>1|lop|java|328|ISBN978-7-107-18618-5 |
| </span></span><span style="display:flex;"><span>2|ripple|java|199|ISBN978-7-100-13678-5 |
| </span></span></code></pre></div><p>CSV is a TEXT file with commas <code>,</code> as delimiters. When a column value itself contains a comma, the column value needs to be enclosed in double quotes, for example:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>marko,29,Beijing |
| </span></span><span style="display:flex;"><span>&#34;li,nary&#34;,26,&#34;Wu,han&#34; |
| </span></span></code></pre></div><p>The JSON file requires that each line is a JSON string, and the format of each line needs to be consistent.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;vadas&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;20160110&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;weight&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.5</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;josh&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;20130220&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;weight&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1.0</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="3212-hdfs-file-or-directory">3.2.1.2 HDFS file or directory</h6> |
| <p>Users can also specify HDFS files or directories as data sources, all of the above requirements for <code>local disk files or directories</code> apply here. In addition, since HDFS usually stores compressed files, loader also provides support for compressed files, and <code>local disk file or directory</code> also supports compressed files.</p> |
| <p>Currently supported compressed file types include: GZIP, BZ2, XZ, LZMA, SNAPPY_RAW, SNAPPY_FRAMED, Z, DEFLATE, LZ4_BLOCK, LZ4_FRAMED, ORC, and PARQUET.</p> |
| <h6 id="3213-mainstream-relational-database">3.2.1.3 Mainstream relational database</h6> |
| <p>The loader also supports some relational databases as data sources, and currently supports MySQL, PostgreSQL, Oracle and SQL Server.</p> |
| <p>However, the requirements for the table structure are relatively strict at present. If <strong>association query</strong> needs to be done during the import process, such a table structure is not allowed. The associated query means: after reading a row of the table, it is found that the value of a certain column cannot be used directly (such as a foreign key), and you need to do another query to determine the true value of the column.</p> |
| <p>For example: Suppose there are three tables, person, software and created</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>// person schema |
| </span></span><span style="display:flex;"><span>id | name | age | city |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>// software schema |
| </span></span><span style="display:flex;"><span>id | name | lang | price |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>// created schema |
| </span></span><span style="display:flex;"><span>id | p_id | s_id | date |
| </span></span></code></pre></div><p>If the id strategy of person or software is specified as PRIMARY_KEY when modeling (schema), choose name as the primary key (note: this is the concept of vertex-label in hugegraph), when importing edge data, the source vertex and target need to be spliced out. For the id of the vertex, you must go to the person/software table with p_id/s_id to find the corresponding name. In the case of the schema that requires additional query, the loader does not support it temporarily. In this case, the following two methods can be used instead:</p> |
| <ol> |
| <li>The id strategy of person and software is still specified as PRIMARY_KEY, but the id column of the person table and software table is used as the primary key attribute of the vertex, so that the id can be generated by directly splicing p_id and s_id with the label of the vertex when importing an edge;</li> |
| <li>Specify the id policy of person and software as CUSTOMIZE, and then directly use the id column of the person table and the software table as the vertex id, so that p_id and s_id can be used directly when importing edges;</li> |
| </ol> |
| <p>The key point is to make the edge use p_id and s_id directly, don&rsquo;t check it again.</p> |
| <h5 id="322-prepare-vertex-and-edge-data">3.2.2 Prepare vertex and edge data</h5> |
| <h6 id="3221-vertex-data">3.2.2.1 Vertex Data</h6> |
| <p>The vertex data file consists of data line by line. Generally, each line is used as a vertex, and each column is used as a vertex attribute. The following description uses CSV format as an example.</p> |
| <ul> |
| <li>person vertex data (the data itself does not contain a header)</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>Tom,48,Beijing |
| </span></span><span style="display:flex;"><span>Jerry,36,Shanghai |
| </span></span></code></pre></div><ul> |
| <li>software vertex data (the data itself contains the header)</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>name,price |
| </span></span><span style="display:flex;"><span>Photoshop,999 |
| </span></span><span style="display:flex;"><span>Office,388 |
| </span></span></code></pre></div><h6 id="3222-edge-data">3.2.2.2 Edge data</h6> |
| <p>The edge data file consists of data line by line. Generally, each line is used as an edge. Some columns are used as the IDs of the source and target vertices, and other columns are used as edge attributes. The following uses JSON format as an example.</p> |
| <ul> |
| <li>knows edge data</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;Tom&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;Jerry&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;2008-12-12&#34;</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><ul> |
| <li>created edge data</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;Tom&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;Photoshop&#34;</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;Tom&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;Office&#34;</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;Jerry&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;Office&#34;</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="33-write-data-source-mapping-file">3.3 Write data source mapping file</h4> |
| <h5 id="331-mapping-file-overview">3.3.1 Mapping file overview</h5> |
| <p>The mapping file of the input source is used to describe how to establish the mapping relationship between the input source data and the vertex type/edge type of the graph. It is organized in <code>JSON</code> format and consists of multiple mapping blocks, each of which is responsible for mapping an input source. Mapped to vertices and edges.</p> |
| <p>Specifically, each mapping block contains <strong>an input source</strong> and multiple <strong>vertex mapping</strong> and <strong>edge mapping</strong> blocks, and the input source block corresponds to the <code>local disk file or directory</code>, <code> HDFS file or directory</code> and <code>relational database</code> are responsible for describing the basic information of the data source, such as where the data is, what format, what is the delimiter, etc. The vertex map/edge map is bound to the input source, which columns of the input source can be selected, which columns are used as ids, which columns are used as attributes, and what attributes are mapped to each column, the values of the columns are mapped to what values of attributes, and so on.</p> |
| <p>In the simplest terms, each mapping block describes: where is the file to be imported, which type of vertices/edges each line of the file is to be used as, which columns of the file need to be imported, and the corresponding vertices/edges of these columns. what properties etc.</p> |
| <blockquote> |
| <p>Note: The format of the mapping file before version 0.11.0 and the format after 0.11.0 has changed greatly. For the convenience of expression, the mapping file (format) before 0.11.0 is called version 1.0, and the version after 0.11.0 is version 2.0 . And unless otherwise specified, the &ldquo;map file&rdquo; refers to version 2.0.</p> |
| </blockquote> |
| <details> |
| <summary>Click to expand/collapse the skeleton of the map file for version 2.0</summary> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;version&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;2.0&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;structs&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;1&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;vertices&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;edges&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div></details> |
| <br/> |
| <p>Two versions of the mapping file are given directly here (the above graph model and data file are described)</p> |
| <details> |
| <summary>Click to expand/collapse mapping file for version 2.0</summary> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;version&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;2.0&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;structs&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;1&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skip&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;FILE&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;vertex_person.csv&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;file_filter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;extensions&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;*&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;CSV&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;delimiter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;,&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;date_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;yyyy-MM-dd HH:mm:ss&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;time_zone&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;GMT+8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skipped_line&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;regex&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;(^#|^//).*|&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;compression&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;header&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;city&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;charset&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;UTF-8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;list_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;start_symbol&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;[&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;elem_delimiter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;|&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;end_symbol&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;]&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;vertices&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skip&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;unfold&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;field_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;value_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;selected&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;ignored&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;null_values&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;update_strategies&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;edges&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;2&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skip&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;FILE&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;vertex_software.csv&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;file_filter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;extensions&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;*&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;CSV&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;delimiter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;,&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;date_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;yyyy-MM-dd HH:mm:ss&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;time_zone&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;GMT+8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skipped_line&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;regex&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;(^#|^//).*|&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;compression&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;header&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;charset&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;UTF-8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;list_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;start_symbol&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;elem_delimiter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;,&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;end_symbol&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;vertices&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skip&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;unfold&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;field_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;value_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;selected&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;ignored&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;null_values&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;update_strategies&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;edges&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;3&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skip&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;FILE&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;edge_knows.json&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;file_filter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;extensions&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;*&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;JSON&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;delimiter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;date_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;yyyy-MM-dd HH:mm:ss&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;time_zone&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;GMT+8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skipped_line&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;regex&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;(^#|^//).*|&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;compression&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;header&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;charset&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;UTF-8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;list_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;vertices&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;edges&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skip&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;source_name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;unfold_source&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;target_name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;unfold_target&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;field_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;value_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;selected&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;ignored&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;null_values&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;update_strategies&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;4&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skip&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;FILE&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;edge_created.json&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;file_filter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;extensions&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;*&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;JSON&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;delimiter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;date_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;yyyy-MM-dd HH:mm:ss&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;time_zone&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;GMT+8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skipped_line&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;regex&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;(^#|^//).*|&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;compression&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;header&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;charset&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;UTF-8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;list_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">null</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;vertices&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;edges&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skip&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;source_name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;unfold_source&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;target_name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;unfold_target&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;field_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;value_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;selected&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;ignored&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;null_values&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;update_strategies&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div></details> |
| <br/> |
| <details> |
| <summary>Click to expand/collapse mapping file for version 1.0</summary> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;vertices&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;vertex_person.csv&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;CSV&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;header&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;charset&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;UTF-8&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;vertex_software.csv&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;CSV&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;edges&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;edge_knows.json&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;JSON&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;field_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;edge_created.json&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;JSON&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;field_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div></details> |
| <br/> |
| <p>The 1.0 version of the mapping file is centered on the vertex and edge, and sets the input source; while the 2.0 version is centered on the input source, and sets the vertex and edge mapping. Some input sources (such as a file) can generate both vertices and edges. If you write in the 1.0 format, you need to write an input block in each of the vertex and edge mapping blocks. The two input blocks are exactly the same ; and the 2.0 version only needs to write input once. Therefore, compared with version 1.0, version 2.0 can save some repetitive writing of input.</p> |
| <p>In the bin directory of hugegraph-loader-{version}, there is a script tool <code>mapping-convert.sh</code> that can directly convert the mapping file of version 1.0 to version 2.0. The usage is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/mapping-convert.sh struct.json |
| </span></span></code></pre></div><p>A struct-v2.json will be generated in the same directory as struct.json.</p> |
| <h5 id="332-input-source">3.3.2 Input Source</h5> |
| <p>Input sources are currently divided into four categories: FILE, HDFS, JDBC and KAFKA, which are distinguished by the <code>type</code> node. We call them local file input sources, HDFS input sources, JDBC input sources, and KAFKA input sources, which are described below.</p> |
| <h6 id="3321-local-file-input-source">3.3.2.1 Local file input source</h6> |
| <ul> |
| <li>id: The id of the input source. This field is used to support some internal functions. It is not required (it will be automatically generated if it is not filled in). It is strongly recommended to write it, which is very helpful for debugging;</li> |
| <li>skip: whether to skip the input source, because the JSON file cannot add comments, if you do not want to import an input source during a certain import, but do not want to delete the configuration of the input source, you can set it to true to skip it, the default is false, not required;</li> |
| <li>input: input source map block, composite structure |
| <ul> |
| <li>type: input source type, file or FILE must be filled;</li> |
| <li>path: the path of the local file or directory, the absolute path or the relative path relative to the mapping file, it is recommended to use the absolute path, required;</li> |
| <li>file_filter: filter files with compound conditions from <code>path</code>, compound structure, currently only supports configuration extensions, represented by child node <code>extensions</code>, the default is &ldquo;*&rdquo;, which means to keep all files;</li> |
| <li>format: the format of the local file, the optional values are CSV, TEXT and JSON, which must be uppercase and required;</li> |
| <li>header: the column name of each column of the file, if not specified, the first line of the data file will be used as the header; when the file itself has a header and the header is specified, the first line of the file will be treated as a normal data line; JSON The file does not need to specify a header, optional;</li> |
| <li>delimiter: The column delimiter of the file line, the default is comma <code>&quot;,&quot;</code> as the delimiter, the <code>JSON</code> file does not need to be specified, optional;</li> |
| <li>charset: the encoded character set of the file, the default is <code>UTF-8</code>, optional;</li> |
| <li>date_format: custom date format, the default value is yyyy-MM-dd HH:mm:ss, optional; if the date is presented in the form of a timestamp, this item must be written as <code>timestamp</code> (fixed writing);</li> |
| <li>time_zone: Set which time zone the date data is in, the default value is <code>GMT+8</code>, optional;</li> |
| <li>skipped_line: The line to be skipped, compound structure, currently only the regular expression of the line to be skipped can be configured, described by the child node <code>regex</code>, no line is skipped by default, optional;</li> |
| <li>compression: The compression format of the file, the optional values are NONE, GZIP, BZ2, XZ, LZMA, SNAPPY_RAW, SNAPPY_FRAMED, Z, DEFLATE, LZ4_BLOCK, LZ4_FRAMED, ORC and PARQUET, the default is NONE, which means a non-compressed file, optional;</li> |
| <li>list_format: When a column of the file (non-JSON) is a collection structure (the Cardinality of the PropertyKey in the corresponding figure is Set or List), you can use this item to set the start character, separator, and end character of the column, compound structure : |
| <ul> |
| <li>start_symbol: The start character of the collection structure column (the default value is <code>[</code>, JSON format currently does not support specification)</li> |
| <li>elem_delimiter: the delimiter of the collection structure column (the default value is <code>|</code>, JSON format currently only supports native <code>,</code> delimiter)</li> |
| <li>end_symbol: the end character of the collection structure column (the default value is <code>]</code>, the JSON format does not currently support specification)</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <h6 id="3322-hdfs-input-source">3.3.2.2 HDFS input source</h6> |
| <p>The nodes and meanings of the above <code>local file input source</code> are basically applicable here. Only the different and unique nodes of the HDFS input source are listed below.</p> |
| <ul> |
| <li>type: input source type, must fill in hdfs or HDFS, required;</li> |
| <li>path: the path of the HDFS file or directory, it must be the absolute path of HDFS, required;</li> |
| <li>core_site_path: the path of the core-site.xml file of the HDFS cluster, the key point is to specify the address of the NameNode (<code>fs.default.name</code>) and the implementation of the file system (<code>fs.hdfs.impl</code>);</li> |
| </ul> |
| <h6 id="3323-jdbc-input-source">3.3.2.3 JDBC input source</h6> |
| <p>As mentioned above, it supports multiple relational databases, but because their mapping structures are very similar, they are collectively referred to as JDBC input sources, and then use the <code>vendor</code> node to distinguish different databases.</p> |
| <ul> |
| <li>type: input source type, must fill in jdbc or JDBC, required;</li> |
| <li>vendor: database type, optional options are [MySQL, PostgreSQL, Oracle, SQLServer], case-insensitive, required;</li> |
| <li>driver: the type of driver used by jdbc, required;</li> |
| <li>url: the url of the database that jdbc wants to connect to, required;</li> |
| <li>database: the name of the database to be connected, required;</li> |
| <li>schema: The name of the schema to be connected, different databases have different requirements, and the details are explained below;</li> |
| <li>table: the name of the table to be connected, at least one of <code>table</code> or <code>custom_sql</code> is required;</li> |
| <li>custom_sql: custom SQL statement, at least one of <code>table</code> or <code>custom_sql</code> is required;</li> |
| <li>username: username to connect to the database, required;</li> |
| <li>password: password for connecting to the database, required;</li> |
| <li>batch_size: The size of one page when obtaining table data by page, the default is 500, optional;</li> |
| </ul> |
| <p><strong>MYSQL</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Node</th> |
| <th>Fixed value or common value</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>vendor</td> |
| <td>MYSQL</td> |
| </tr> |
| <tr> |
| <td>driver</td> |
| <td>com.mysql.cj.jdbc.Driver</td> |
| </tr> |
| <tr> |
| <td>url</td> |
| <td>jdbc:mysql://127.0.0.1:3306</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>schema: nullable, if filled in, it must be the same as the value of database</p> |
| <p><strong>POSTGRESQL</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Node</th> |
| <th>Fixed value or common value</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>vendor</td> |
| <td>POSTGRESQL</td> |
| </tr> |
| <tr> |
| <td>driver</td> |
| <td>org.postgresql.Driver</td> |
| </tr> |
| <tr> |
| <td>url</td> |
| <td>jdbc:postgresql://127.0.0.1:5432</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>schema: nullable, default is &ldquo;public&rdquo;</p> |
| <p><strong>ORACLE</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Node</th> |
| <th>Fixed value or common value</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>vendor</td> |
| <td>ORACLE</td> |
| </tr> |
| <tr> |
| <td>driver</td> |
| <td>oracle.jdbc.driver.OracleDriver</td> |
| </tr> |
| <tr> |
| <td>url</td> |
| <td>jdbc:oracle:thin:@127.0.0.1:1521</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>schema: nullable, the default value is the same as the username</p> |
| <p><strong>SQLSERVER</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Node</th> |
| <th>Fixed value or common value</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>vendor</td> |
| <td>SQLSERVER</td> |
| </tr> |
| <tr> |
| <td>driver</td> |
| <td>com.microsoft.sqlserver.jdbc.SQLServerDriver</td> |
| </tr> |
| <tr> |
| <td>url</td> |
| <td>jdbc:sqlserver://127.0.0.1:1433</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>schema: required</p> |
| <h6 id="3324-kafka-input-source">3.3.2.4 Kafka input source</h6> |
| <ul> |
| <li>type: input source type, <code>kafka</code> or <code>KAFKA</code>, required;</li> |
| <li>bootstrap_server: set the list of kafka bootstrap servers;</li> |
| <li>topic: the topic to subscribe to;</li> |
| <li>group: group of Kafka consumers;</li> |
| <li>from_beginning: set whether to read from the beginning;</li> |
| <li>format: format of the local file, options are CSV, TEXT and JSON, must be uppercase, required;</li> |
| <li>header: column name of each column of the file, if not specified, the first line of the data file will be used as the header; when the file itself has a header and the header is specified, the first line of the file will be treated as an ordinary data line; JSON files do not need to specify the header, optional;</li> |
| <li>delimiter: delimiter of the file line, default is comma &ldquo;,&rdquo; as delimiter, JSON files do not need to specify, optional;</li> |
| <li>charset: encoding charset of the file, default is UTF-8, optional;</li> |
| <li>date_format: customized date format, default value is yyyy-MM-dd HH:mm:ss, optional; if the date is presented in the form of timestamp, this item must be written as timestamp (fixed);</li> |
| <li>extra_date_formats: a customized list of other date formats, empty by default, optional; each item in the list is an alternate date format to the date_format specified date format;</li> |
| <li>time_zone: set which time zone the date data is in, default is GMT+8, optional;</li> |
| <li>skipped_line: the line you want to skip, composite structure, currently can only configure the regular expression of the line to be skipped, described by the child node regex, the default is not to skip any line, optional;</li> |
| <li>early_stop: the record pulled from Kafka broker at a certain time is empty, stop the task, default is false, only for debugging, optional;</li> |
| </ul> |
| <h5 id="333-vertex-and-edge-mapping">3.3.3 Vertex and Edge Mapping</h5> |
| <p>The nodes of vertex and edge mapping (a key in the JSON file) have a lot of the same parts. The same parts are introduced first, and then the unique nodes of <code>vertex map</code> and <code>edge map</code> are introduced respectively.</p> |
| <p><strong>Nodes of the same section</strong></p> |
| <ul> |
| <li>label: <code>label</code> to which the vertex/edge data to be imported belongs, required;</li> |
| <li>field_mapping: Map the column name of the input source column to the attribute name of the vertex/edge, optional;</li> |
| <li>value_mapping: map the data value of the input source to the attribute value of the vertex/edge, optional;</li> |
| <li>selected: select some columns to insert, other unselected ones are not inserted, cannot exist at the same time as <code>ignored</code>, optional;</li> |
| <li>ignored: ignore some columns so that they do not participate in insertion, cannot exist at the same time as <code>selected</code>, optional;</li> |
| <li>null_values: You can specify some strings to represent null values, such as &ldquo;NULL&rdquo;. If the vertex/edge attribute corresponding to this column is also a nullable attribute, the value of this attribute will not be set when constructing the vertex/edge, optional ;</li> |
| <li>update_strategies: If the data needs to be <strong>updated</strong> in batches in a specific way, you can specify a specific update strategy for each attribute (see below for details), optional;</li> |
| <li>unfold: Whether to unfold the column, each unfolded column will form a row with other columns, which is equivalent to unfolding into multiple rows; for example, the value of a certain column (id column) of the file is <code>[1,2,3]</code>, The values of other columns are <code>18,Beijing</code>. When unfold is set, this row will become 3 rows, namely: <code>1,18,Beijing</code>, <code>2,18,Beijing</code> and <code>3,18, Beijing</code>. Note that this will only expand the column selected as id. Default false, optional;</li> |
| </ul> |
| <p><strong>Update strategy</strong> supports 8 types: (requires all uppercase)</p> |
| <ol> |
| <li>Value accumulation: <code>SUM</code></li> |
| <li>Take the greater of the two numbers/dates: <code>BIGGER</code></li> |
| <li>Take the smaller of two numbers/dates: <code>SMALLER</code></li> |
| <li><strong>Set</strong> property takes union: <code>UNION</code></li> |
| <li><strong>Set</strong> attribute intersection: <code>INTERSECTION</code></li> |
| <li><strong>List</strong> attribute append element: <code>APPEND</code></li> |
| <li><strong>List/Set</strong> attribute delete element: <code>ELIMINATE</code></li> |
| <li>Override an existing property: <code>OVERRIDE</code></li> |
| </ol> |
| <p><strong>Note:</strong> If the newly imported attribute value is empty, the existing old data will be used instead of the empty value. For the effect, please refer to the following example</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// The update strategy is specified in the JSON file as follows |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;vertices&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;update_strategies&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;age&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;SMALLER&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;set&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;UNION&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;vertex_person.txt&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;TEXT&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;header&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;set&#34;</span><span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// 1. Write a line of data with the OVERRIDE update strategy (null means empty here) |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#a40000">&#39;a</span> <span style="color:#a40000">b</span> <span style="color:#204a87;font-weight:bold">null</span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#a40000">&#39;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// 2. Write another line |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#a40000">&#39;</span><span style="color:#204a87;font-weight:bold">null</span> <span style="color:#204a87;font-weight:bold">null</span> <span style="color:#a40000">c</span> <span style="color:#a40000">d&#39;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// 3. Finally we can get |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#a40000">&#39;a</span> <span style="color:#a40000">b</span> <span style="color:#a40000">c</span> <span style="color:#a40000">d&#39;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// If there is no update strategy, you will get |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#a40000">&#39;</span><span style="color:#204a87;font-weight:bold">null</span> <span style="color:#204a87;font-weight:bold">null</span> <span style="color:#a40000">c</span> <span style="color:#a40000">d&#39;</span> |
| </span></span></code></pre></div><blockquote> |
| <p><strong>Note</strong> : After adopting the batch update strategy, the number of disk read requests will increase significantly, and the import speed will be several times slower than that of pure write coverage (at this time HDD disk [IOPS](<a href="https://en.wikipedia">https://en.wikipedia</a> .org/wiki/IOPS) will be the bottleneck, SSD is recommended for speed)</p> |
| </blockquote> |
| <p><strong>Unique Nodes for Vertex Maps</strong></p> |
| <ul> |
| <li>id: Specify a column as the id column of the vertex. When the vertex id policy is <code>CUSTOMIZE</code>, it is required; when the id policy is <code>PRIMARY_KEY</code>, it must be empty;</li> |
| </ul> |
| <p><strong>Unique Nodes for Edge Maps</strong></p> |
| <ul> |
| <li>source: Select certain columns of the input source as the id column of <strong>source vertex</strong>. When the id policy of the source vertex is <code>CUSTOMIZE</code>, a certain column must be specified as the id column of the vertex; when the id policy of the source vertex is <code> When PRIMARY_KEY</code>, one or more columns must be specified for splicing the id of the generated vertex, that is, no matter which id strategy is used, this item is required;</li> |
| <li>target: Specify certain columns as the id columns of <strong>target vertex</strong>, similar to source, so I won&rsquo;t repeat them;</li> |
| <li>unfold_source: Whether to unfold the source column of the file, the effect is similar to that in the vertex map, and will not be repeated;</li> |
| <li>unfold_target: Whether to unfold the target column of the file, the effect is similar to that in the vertex mapping, and will not be repeated;</li> |
| </ul> |
| <h4 id="34-execute-command-import">3.4 Execute command import</h4> |
| <p>After preparing the graph model, data file, and input source mapping relationship file, the data file can be imported into the graph database.</p> |
| <p>The import process is controlled by commands submitted by the user, and the user can control the specific process of execution through different parameters.</p> |
| <h5 id="341-parameter-description">3.4.1 Parameter description</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>Parameter</th> |
| <th>Default value</th> |
| <th>Required or not</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><code>-f</code> or <code>--file</code></td> |
| <td></td> |
| <td>Y</td> |
| <td>path to configure script</td> |
| </tr> |
| <tr> |
| <td><code>-g</code> or <code>--graph</code></td> |
| <td></td> |
| <td>Y</td> |
| <td>graph space name</td> |
| </tr> |
| <tr> |
| <td><code>-s</code> or <code>--schema</code></td> |
| <td></td> |
| <td>Y</td> |
| <td>schema file path</td> |
| </tr> |
| <tr> |
| <td><code>-h</code> or <code>--host</code></td> |
| <td>localhost</td> |
| <td></td> |
| <td>address of HugeGraphServer</td> |
| </tr> |
| <tr> |
| <td><code>-p</code> or <code>--port</code></td> |
| <td>8080</td> |
| <td></td> |
| <td>port number of HugeGraphServer</td> |
| </tr> |
| <tr> |
| <td><code>--username</code></td> |
| <td>null</td> |
| <td></td> |
| <td>When HugeGraphServer enables permission authentication, the username of the current graph</td> |
| </tr> |
| <tr> |
| <td><code>--token</code></td> |
| <td>null</td> |
| <td></td> |
| <td>When HugeGraphServer has enabled authorization authentication, the token of the current graph</td> |
| </tr> |
| <tr> |
| <td><code>--protocol</code></td> |
| <td>http</td> |
| <td></td> |
| <td>Protocol for sending requests to the server, optional http or https</td> |
| </tr> |
| <tr> |
| <td><code>--trust-store-file</code></td> |
| <td></td> |
| <td></td> |
| <td>When the request protocol is https, the client&rsquo;s certificate file path</td> |
| </tr> |
| <tr> |
| <td><code>--trust-store-password</code></td> |
| <td></td> |
| <td></td> |
| <td>When the request protocol is https, the client certificate password</td> |
| </tr> |
| <tr> |
| <td><code>--clear-all-data</code></td> |
| <td>false</td> |
| <td></td> |
| <td>Whether to clear the original data on the server before importing data</td> |
| </tr> |
| <tr> |
| <td><code>--clear-timeout</code></td> |
| <td>240</td> |
| <td></td> |
| <td>Timeout for clearing the original data on the server before importing data</td> |
| </tr> |
| <tr> |
| <td><code>--incremental-mode</code></td> |
| <td>false</td> |
| <td></td> |
| <td>Whether to use the breakpoint resume mode, only the input source is FILE and HDFS support this mode, enabling this mode can start the import from the place where the last import stopped</td> |
| </tr> |
| <tr> |
| <td><code>--failure-mode</code></td> |
| <td>false</td> |
| <td></td> |
| <td>When the failure mode is true, the data that failed before will be imported. Generally speaking, the failed data file needs to be manually corrected and edited, and then imported again</td> |
| </tr> |
| <tr> |
| <td><code>--batch-insert-threads</code></td> |
| <td>CPUs</td> |
| <td></td> |
| <td>Batch insert thread pool size (CPUs is the number of <strong>logical cores</strong> available to the current OS)</td> |
| </tr> |
| <tr> |
| <td><code>--single-insert-threads</code></td> |
| <td>8</td> |
| <td></td> |
| <td>Size of single insert thread pool</td> |
| </tr> |
| <tr> |
| <td><code>--max-conn</code></td> |
| <td>4 * CPUs</td> |
| <td></td> |
| <td>The maximum number of HTTP connections between HugeClient and HugeGraphServer, it is recommended to adjust this when <strong>adjusting threads</strong></td> |
| </tr> |
| <tr> |
| <td><code>--max-conn-per-route</code></td> |
| <td>2 * CPUs</td> |
| <td></td> |
| <td>The maximum number of HTTP connections for each route between HugeClient and HugeGraphServer, it is recommended to adjust this item at the same time when <strong>adjusting the thread</strong></td> |
| </tr> |
| <tr> |
| <td><code>--batch-size</code></td> |
| <td>500</td> |
| <td></td> |
| <td>The number of data items in each batch when importing data</td> |
| </tr> |
| <tr> |
| <td><code>--max-parse-errors</code></td> |
| <td>1</td> |
| <td></td> |
| <td>The maximum number of lines of data parsing errors allowed, and the program exits when this value is reached</td> |
| </tr> |
| <tr> |
| <td><code>--max-insert-errors</code></td> |
| <td>500</td> |
| <td></td> |
| <td>The maximum number of rows of data insertion errors allowed, and the program exits when this value is reached</td> |
| </tr> |
| <tr> |
| <td><code>--timeout</code></td> |
| <td>60</td> |
| <td></td> |
| <td>Timeout (seconds) for inserting results to return</td> |
| </tr> |
| <tr> |
| <td><code>--shutdown-timeout</code></td> |
| <td>10</td> |
| <td></td> |
| <td>Waiting time for multithreading to stop (seconds)</td> |
| </tr> |
| <tr> |
| <td><code>--retry-times</code></td> |
| <td>0</td> |
| <td></td> |
| <td>Number of retries when a specific exception occurs</td> |
| </tr> |
| <tr> |
| <td><code>--retry-interval</code></td> |
| <td>10</td> |
| <td></td> |
| <td>interval before retry (seconds)</td> |
| </tr> |
| <tr> |
| <td><code>--check-vertex</code></td> |
| <td>false</td> |
| <td></td> |
| <td>Whether to check whether the vertex connected by the edge exists when inserting the edge</td> |
| </tr> |
| <tr> |
| <td><code>--print-progress</code></td> |
| <td>true</td> |
| <td></td> |
| <td>Whether to print the number of imported items in the console in real time</td> |
| </tr> |
| <tr> |
| <td><code>--dry-run</code></td> |
| <td>false</td> |
| <td></td> |
| <td>Turn on this mode, only parsing but not importing, usually used for testing</td> |
| </tr> |
| <tr> |
| <td><code>--help</code></td> |
| <td>false</td> |
| <td></td> |
| <td>print help information</td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="342-breakpoint-continuation-mode">3.4.2 Breakpoint Continuation Mode</h5> |
| <p>Usually, the Loader task takes a long time to execute. If the import interrupt process exits for some reason, and next time you want to continue the import from the interrupted point, this is the scenario of using breakpoint continuation.</p> |
| <p>The user sets the command line parameter &ndash;incremental-mode to true to open the breakpoint resume mode. The key to breakpoint continuation lies in the progress file. When the import process exits, the import progress at the time of exit will be recorded. |
| Recorded in the progress file, the progress file is located in the <code>${struct}</code> directory, the file name is like <code>load-progress ${date}</code>, ${struct} is the prefix of the mapping file, and ${date} is the start of the import |
| moment. For example, for an import task started at <code>2019-10-10 12:30:30</code>, the mapping file used is <code>struct-example.json</code>, then the path of the progress file is the same as struct-example.json |
| Sibling <code>struct-example/load-progress 2019-10-10 12:30:30</code>.</p> |
| <blockquote> |
| <p>Note: The generation of progress files is independent of whether &ndash;incremental-mode is turned on or not, and a progress file is generated at the end of each import.</p> |
| </blockquote> |
| <p>If the data file formats are all legal and the import task is stopped by the user (CTRL + C or kill, kill -9 is not supported), that is to say, if there is no error record, the next import only needs to be set |
| Continue for the breakpoint.</p> |
| <p>But if the limit of &ndash;max-parse-errors or &ndash;max-insert-errors is reached because too much data is invalid or network abnormality is reached, Loader will record these original rows that failed to insert into |
| In the failed file, after the user modifies the data lines in the failed file, set &ndash;reload-failure to true to import these &ldquo;failed files&rdquo; as input sources (does not affect the normal file import), |
| Of course, if there is still a problem with the modified data line, it will be logged again to the failure file (don&rsquo;t worry about duplicate lines).</p> |
| <p>Each vertex map or edge map will generate its own failure file when data insertion fails. The failure file is divided into a parsing failure file (suffix .parse-error) and an insertion failure file (suffix .insert-error). |
| They are stored in the <code>${struct}/current</code> directory. For example, there is a vertex mapping person and an edge mapping knows in the mapping file, each of which has some error lines. When the Loader exits, you will see the following files in the <code>${struct}/current</code> directory:</p> |
| <ul> |
| <li>person-b4cd32ab.parse-error: Vertex map person parses wrong data</li> |
| <li>person-b4cd32ab.insert-error: Vertex map person inserts wrong data</li> |
| <li>knows-eb6b2bac.parse-error: edge map knows parses wrong data</li> |
| <li>knows-eb6b2bac.insert-error: edge map knows inserts wrong data</li> |
| </ul> |
| <blockquote> |
| <p>.parse-error and .insert-error do not always exist together. Only lines with parsing errors will have .parse-error files, and only lines with insertion errors will have .insert-error files.</p> |
| </blockquote> |
| <h5 id="343-logs-directory-file-description">3.4.3 logs directory file description</h5> |
| <p>The log and error data during program execution will be written into hugegraph-loader.log file.</p> |
| <h5 id="344-execute-command">3.4.4 Execute command</h5> |
| <p>Run bin/hugegraph-loader and pass in parameters</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/hugegraph-loader -g <span style="color:#ce5c00;font-weight:bold">{</span>GRAPH_NAME<span style="color:#ce5c00;font-weight:bold">}</span> -f <span style="color:#4e9a06">${</span><span style="color:#000">INPUT_DESC_FILE</span><span style="color:#4e9a06">}</span> -s <span style="color:#4e9a06">${</span><span style="color:#000">SCHEMA_FILE</span><span style="color:#4e9a06">}</span> -h <span style="color:#ce5c00;font-weight:bold">{</span>HOST<span style="color:#ce5c00;font-weight:bold">}</span> -p <span style="color:#ce5c00;font-weight:bold">{</span>PORT<span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span></code></pre></div><h3 id="4-complete-example">4 Complete example</h3> |
| <p>Given below is an example in the example directory of the hugegraph-loader package. (<a href="https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-loader/assembly/static/example/file">GitHub address</a>)</p> |
| <h4 id="41-prepare-data">4.1 Prepare data</h4> |
| <p>Vertex file: <code>example/file/vertex_person.csv</code></p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>marko,29,Beijing |
| </span></span><span style="display:flex;"><span>vadas,27,Hongkong |
| </span></span><span style="display:flex;"><span>josh,32,Beijing |
| </span></span><span style="display:flex;"><span>peter,35,Shanghai |
| </span></span><span style="display:flex;"><span>&#34;li,nary&#34;,26,&#34;Wu,han&#34; |
| </span></span><span style="display:flex;"><span>tom,null,NULL |
| </span></span></code></pre></div><p>Vertex file: <code>example/file/vertex_software.txt</code></p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>id|name|lang|price|ISBN |
| </span></span><span style="display:flex;"><span>1|lop|java|328|ISBN978-7-107-18618-5 |
| </span></span><span style="display:flex;"><span>2|ripple|java|199|ISBN978-7-100-13678-5 |
| </span></span></code></pre></div><p>Edge file: <code>example/file/edge_knows.json</code></p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;vadas&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;20160110&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;weight&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.5</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;josh&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;20130220&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;weight&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1.0</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>Edge file: <code>example/file/edge_created.json</code></p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;aname&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;bname&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;lop&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;20171210&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;weight&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.4</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;aname&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;josh&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;bname&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;lop&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;20091111&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;weight&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.4</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;aname&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;josh&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;bname&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;ripple&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;20171210&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;weight&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1.0</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span><span style="color:#204a87;font-weight:bold">&#34;aname&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;peter&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;bname&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;lop&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;date&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;20170324&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">&#34;weight&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.2</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="42-write-schema">4.2 Write schema</h4> |
| <details> |
| <summary>Click to expand/collapse schema file: example/file/schema.groovy</summary> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-groovy" data-lang="groovy"><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asInt</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asDouble</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asDouble</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;personByAge&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">onV</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">range</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;personByCity&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">onV</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">secondary</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;personByAgeAndCity&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">onV</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">secondary</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;softwareByPrice&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">onV</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">range</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">sourceLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">targetLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">sourceLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">targetLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;createdByDate&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">onE</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">secondary</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;createdByWeight&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">onE</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">range</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knowsByWeight&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">onE</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">range</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span></code></pre></div></details> |
| <h4 id="43-write-the-input-source-mapping-file-examplefilestructjson">4.3 Write the input source mapping file <code>example/file/struct.json</code></h4> |
| <details> |
| <summary>Click to expand/collapse the input source mapping file example/file/struct.json</summary> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;vertices&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;example/file/vertex_person.csv&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;CSV&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;header&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;charset&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;UTF-8&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;skipped_line&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;regex&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;(^#|^//).*&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;null_values&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;NULL&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;null&#34;</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;&#34;</span><span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;example/file/vertex_software.txt&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;TEXT&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;delimiter&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;|&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;charset&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;GBK&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;id&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;ignored&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;ISBN&#34;</span><span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;edges&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;example/file/edge_knows.json&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;JSON&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;date_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;yyyyMMdd&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;field_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;label&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;target&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;target_id&#34;</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;input&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;type&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;file&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;path&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;example/file/edge_created.json&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;JSON&#34;</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;date_format&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;yyyy-MM-dd&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;field_mapping&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;source_name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;name&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div></details> |
| <h4 id="44-command-to-import">4.4 Command to import</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>sh bin/hugegraph-loader.sh -g hugegraph -f example/file/struct.json -s example/file/schema.groovy |
| </span></span></code></pre></div><p>After the import is complete, statistics similar to the following will appear:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>vertices/edges has been loaded this <span style="color:#204a87">time</span> : 8/6 |
| </span></span><span style="display:flex;"><span>-------------------------------------------------- |
| </span></span><span style="display:flex;"><span>count metrics |
| </span></span><span style="display:flex;"><span> input <span style="color:#204a87">read</span> success : <span style="color:#0000cf;font-weight:bold">14</span> |
| </span></span><span style="display:flex;"><span> input <span style="color:#204a87">read</span> failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> vertex parse success : <span style="color:#0000cf;font-weight:bold">8</span> |
| </span></span><span style="display:flex;"><span> vertex parse failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> vertex insert success : <span style="color:#0000cf;font-weight:bold">8</span> |
| </span></span><span style="display:flex;"><span> vertex insert failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> edge parse success : <span style="color:#0000cf;font-weight:bold">6</span> |
| </span></span><span style="display:flex;"><span> edge parse failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> edge insert success : <span style="color:#0000cf;font-weight:bold">6</span> |
| </span></span><span style="display:flex;"><span> edge insert failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span></code></pre></div><h4 id="45-use-docker-to-load-data">4.5 Use Docker to load data</h4> |
| <h5 id="451-use-docker-exec-to-load-data-directly">4.5.1 Use docker exec to load data directly</h5> |
| <h6 id="4511-prepare-data">4.5.1.1 Prepare data</h6> |
| <p>If you just want to try out the loader, you can import the built-in example dataset without needing to prepare additional data yourself.</p> |
| <p>If using custom data, before importing data with the loader, we need to copy the data into the container.</p> |
| <p>First, following the steps in <a href="#41-prepare-data">4.1-4.3</a>, we can prepare the data and then use <code>docker cp</code> to copy the prepared data into the loader container.</p> |
| <p>Suppose we&rsquo;ve prepared the corresponding dataset following the above steps, stored in the <code>hugegraph-dataset</code> folder with the following file structure:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>tree -f hugegraph-dataset/ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>hugegraph-dataset |
| </span></span><span style="display:flex;"><span>├── hugegraph-dataset/edge_created.json |
| </span></span><span style="display:flex;"><span>├── hugegraph-dataset/edge_knows.json |
| </span></span><span style="display:flex;"><span>├── hugegraph-dataset/schema.groovy |
| </span></span><span style="display:flex;"><span>├── hugegraph-dataset/struct.json |
| </span></span><span style="display:flex;"><span>├── hugegraph-dataset/vertex_person.csv |
| </span></span><span style="display:flex;"><span>└── hugegraph-dataset/vertex_software.txt |
| </span></span></code></pre></div><p>Copy the files into the container.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>docker cp hugegraph-dataset loader:/loader/dataset |
| </span></span><span style="display:flex;"><span>docker <span style="color:#204a87">exec</span> -it loader ls /loader/dataset |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>edge_created.json edge_knows.json schema.groovy struct.json vertex_person.csv vertex_software.txt |
| </span></span></code></pre></div><h6 id="4512-data-loading">4.5.1.2 Data loading</h6> |
| <p>Taking the built-in example dataset as an example, we can use the following command to load the data.</p> |
| <p>If you need to import your custom dataset, you just need to modify the paths for <code>-f</code> (data script) and <code>-s</code> (schema) configurations.</p> |
| <p>&ldquo;You can refer to <a href="#341-parameter-description">3.4.1 Parameter description</a> for the rest of the parameters.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>docker <span style="color:#204a87">exec</span> -it loader bin/hugegraph-loader.sh -g hugegraph -f example/file/struct.json -s example/file/schema.groovy -h server -p <span style="color:#0000cf;font-weight:bold">8080</span> |
| </span></span></code></pre></div><p>If loading a custom dataset, following the previous example, you would use:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>docker <span style="color:#204a87">exec</span> -it loader bin/hugegraph-loader.sh -g hugegraph -f /loader/dataset/struct.json -s /loader/dataset/schema.groovy -h server -p <span style="color:#0000cf;font-weight:bold">8080</span> |
| </span></span></code></pre></div><blockquote> |
| <p>If <code>loader</code> and <code>server</code> are in the same Docker network, you can specify <code>-h {server_container_name}</code>; otherwise, you need to specify the IP of the <code>server</code> host (in our example, <code>server_container_name</code> is <code>server</code>).</p> |
| </blockquote> |
| <p>Then we can obverse the result:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>HugeGraphLoader worked in NORMAL MODE |
| </span></span><span style="display:flex;"><span>vertices/edges loaded this <span style="color:#204a87">time</span> : 8/6 |
| </span></span><span style="display:flex;"><span>-------------------------------------------------- |
| </span></span><span style="display:flex;"><span>count metrics |
| </span></span><span style="display:flex;"><span> input <span style="color:#204a87">read</span> success : <span style="color:#0000cf;font-weight:bold">14</span> |
| </span></span><span style="display:flex;"><span> input <span style="color:#204a87">read</span> failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> vertex parse success : <span style="color:#0000cf;font-weight:bold">8</span> |
| </span></span><span style="display:flex;"><span> vertex parse failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> vertex insert success : <span style="color:#0000cf;font-weight:bold">8</span> |
| </span></span><span style="display:flex;"><span> vertex insert failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> edge parse success : <span style="color:#0000cf;font-weight:bold">6</span> |
| </span></span><span style="display:flex;"><span> edge parse failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> edge insert success : <span style="color:#0000cf;font-weight:bold">6</span> |
| </span></span><span style="display:flex;"><span> edge insert failure : <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span>-------------------------------------------------- |
| </span></span><span style="display:flex;"><span>meter metrics |
| </span></span><span style="display:flex;"><span> total <span style="color:#204a87">time</span> : 0.199s |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">read</span> <span style="color:#204a87">time</span> : 0.046s |
| </span></span><span style="display:flex;"><span> load <span style="color:#204a87">time</span> : 0.153s |
| </span></span><span style="display:flex;"><span> vertex load <span style="color:#204a87">time</span> : 0.077s |
| </span></span><span style="display:flex;"><span> vertex load rate<span style="color:#ce5c00;font-weight:bold">(</span>vertices/s<span style="color:#ce5c00;font-weight:bold">)</span> : <span style="color:#0000cf;font-weight:bold">103</span> |
| </span></span><span style="display:flex;"><span> edge load <span style="color:#204a87">time</span> : 0.112s |
| </span></span><span style="display:flex;"><span> edge load rate<span style="color:#ce5c00;font-weight:bold">(</span>edges/s<span style="color:#ce5c00;font-weight:bold">)</span> : <span style="color:#0000cf;font-weight:bold">53</span> |
| </span></span></code></pre></div><p>You can also use <code>curl</code> or <code>hubble</code> to observe the import result. Here&rsquo;s an example using <code>curl</code>:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>&gt; curl <span style="color:#4e9a06">&#34;http://localhost:8080/graphs/hugegraph/graph/vertices&#34;</span> <span style="color:#000;font-weight:bold">|</span> gunzip |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;vertices&#34;</span>:<span style="color:#ce5c00;font-weight:bold">[{</span><span style="color:#4e9a06">&#34;id&#34;</span>:1,<span style="color:#4e9a06">&#34;label&#34;</span>:<span style="color:#4e9a06">&#34;software&#34;</span>,<span style="color:#4e9a06">&#34;type&#34;</span>:<span style="color:#4e9a06">&#34;vertex&#34;</span>,<span style="color:#4e9a06">&#34;properties&#34;</span>:<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span>:<span style="color:#4e9a06">&#34;lop&#34;</span>,<span style="color:#4e9a06">&#34;lang&#34;</span>:<span style="color:#4e9a06">&#34;java&#34;</span>,<span style="color:#4e9a06">&#34;price&#34;</span>:328.0<span style="color:#ce5c00;font-weight:bold">}}</span>,<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;id&#34;</span>:2,<span style="color:#4e9a06">&#34;label&#34;</span>:<span style="color:#4e9a06">&#34;software&#34;</span>,<span style="color:#4e9a06">&#34;type&#34;</span>:<span style="color:#4e9a06">&#34;vertex&#34;</span>,<span style="color:#4e9a06">&#34;properties&#34;</span>:<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span>:<span style="color:#4e9a06">&#34;ripple&#34;</span>,<span style="color:#4e9a06">&#34;lang&#34;</span>:<span style="color:#4e9a06">&#34;java&#34;</span>,<span style="color:#4e9a06">&#34;price&#34;</span>:199.0<span style="color:#ce5c00;font-weight:bold">}}</span>,<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;id&#34;</span>:<span style="color:#4e9a06">&#34;1:tom&#34;</span>,<span style="color:#4e9a06">&#34;label&#34;</span>:<span style="color:#4e9a06">&#34;person&#34;</span>,<span style="color:#4e9a06">&#34;type&#34;</span>:<span style="color:#4e9a06">&#34;vertex&#34;</span>,<span style="color:#4e9a06">&#34;properties&#34;</span>:<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span>:<span style="color:#4e9a06">&#34;tom&#34;</span><span style="color:#ce5c00;font-weight:bold">}}</span>,<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;id&#34;</span>:<span style="color:#4e9a06">&#34;1:josh&#34;</span>,<span style="color:#4e9a06">&#34;label&#34;</span>:<span style="color:#4e9a06">&#34;person&#34;</span>,<span style="color:#4e9a06">&#34;type&#34;</span>:<span style="color:#4e9a06">&#34;vertex&#34;</span>,<span style="color:#4e9a06">&#34;properties&#34;</span>:<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span>:<span style="color:#4e9a06">&#34;josh&#34;</span>,<span style="color:#4e9a06">&#34;age&#34;</span>:32,<span style="color:#4e9a06">&#34;city&#34;</span>:<span style="color:#4e9a06">&#34;Beijing&#34;</span><span style="color:#ce5c00;font-weight:bold">}}</span>,<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;id&#34;</span>:<span style="color:#4e9a06">&#34;1:marko&#34;</span>,<span style="color:#4e9a06">&#34;label&#34;</span>:<span style="color:#4e9a06">&#34;person&#34;</span>,<span style="color:#4e9a06">&#34;type&#34;</span>:<span style="color:#4e9a06">&#34;vertex&#34;</span>,<span style="color:#4e9a06">&#34;properties&#34;</span>:<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span>:<span style="color:#4e9a06">&#34;marko&#34;</span>,<span style="color:#4e9a06">&#34;age&#34;</span>:29,<span style="color:#4e9a06">&#34;city&#34;</span>:<span style="color:#4e9a06">&#34;Beijing&#34;</span><span style="color:#ce5c00;font-weight:bold">}}</span>,<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;id&#34;</span>:<span style="color:#4e9a06">&#34;1:peter&#34;</span>,<span style="color:#4e9a06">&#34;label&#34;</span>:<span style="color:#4e9a06">&#34;person&#34;</span>,<span style="color:#4e9a06">&#34;type&#34;</span>:<span style="color:#4e9a06">&#34;vertex&#34;</span>,<span style="color:#4e9a06">&#34;properties&#34;</span>:<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span>:<span style="color:#4e9a06">&#34;peter&#34;</span>,<span style="color:#4e9a06">&#34;age&#34;</span>:35,<span style="color:#4e9a06">&#34;city&#34;</span>:<span style="color:#4e9a06">&#34;Shanghai&#34;</span><span style="color:#ce5c00;font-weight:bold">}}</span>,<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;id&#34;</span>:<span style="color:#4e9a06">&#34;1:vadas&#34;</span>,<span style="color:#4e9a06">&#34;label&#34;</span>:<span style="color:#4e9a06">&#34;person&#34;</span>,<span style="color:#4e9a06">&#34;type&#34;</span>:<span style="color:#4e9a06">&#34;vertex&#34;</span>,<span style="color:#4e9a06">&#34;properties&#34;</span>:<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span>:<span style="color:#4e9a06">&#34;vadas&#34;</span>,<span style="color:#4e9a06">&#34;age&#34;</span>:27,<span style="color:#4e9a06">&#34;city&#34;</span>:<span style="color:#4e9a06">&#34;Hongkong&#34;</span><span style="color:#ce5c00;font-weight:bold">}}</span>,<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;id&#34;</span>:<span style="color:#4e9a06">&#34;1:li,nary&#34;</span>,<span style="color:#4e9a06">&#34;label&#34;</span>:<span style="color:#4e9a06">&#34;person&#34;</span>,<span style="color:#4e9a06">&#34;type&#34;</span>:<span style="color:#4e9a06">&#34;vertex&#34;</span>,<span style="color:#4e9a06">&#34;properties&#34;</span>:<span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#4e9a06">&#34;name&#34;</span>:<span style="color:#4e9a06">&#34;li,nary&#34;</span>,<span style="color:#4e9a06">&#34;age&#34;</span>:26,<span style="color:#4e9a06">&#34;city&#34;</span>:<span style="color:#4e9a06">&#34;Wu,han&#34;</span><span style="color:#ce5c00;font-weight:bold">}}]}</span> |
| </span></span></code></pre></div><p>If you want to check the import result of edges, you can use <code>curl &quot;http://localhost:8080/graphs/hugegraph/graph/edges&quot; | gunzip</code>.</p> |
| <h5 id="452-enter-the-docker-container-to-load-data">4.5.2 Enter the docker container to load data</h5> |
| <p>Besides using <code>docker exec</code> directly for data import, we can also enter the container for data loading. The basic process is similar to <a href="#451-use-docker-exec-to-load-data-directly">4.5.1</a>.</p> |
| <p>Enter the container by <code>docker exec -it loader bash</code> and execute the command:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>sh bin/hugegraph-loader.sh -g hugegraph -f example/file/struct.json -s example/file/schema.groovy -h server -p <span style="color:#0000cf;font-weight:bold">8080</span> |
| </span></span></code></pre></div><p>The results of the execution will be similar to those shown in <a href="#451-use-docker-exec-to-load-data-directly">4.5.1</a>.</p> |
| <h4 id="46-import-data-by-spark-loader">4.6 Import data by spark-loader</h4> |
| <blockquote> |
| <p>Spark version: Spark 3+, other versions has not been tested.<br> |
| HugeGraph Toolchain version: toolchain-1.0.0</p> |
| </blockquote> |
| <p>The parameters of <code>spark-loader</code> are divided into two parts. Note: Because the abbreviations of |
| these two parameter names have overlapping parts, please use the full name of the parameter. |
| And there is no need to guarantee the order between the two parameters.</p> |
| <ul> |
| <li>hugegraph parameters (Reference: <a href="https://hugegraph.apache.org/docs/quickstart/hugegraph-loader/#341-parameter-description">hugegraph-loader parameter description</a> )</li> |
| <li>Spark task submission parameters (Reference: <a href="https://spark.apache.org/docs/3.3.0/submitting-applications.html#content">Submitting Applications</a>)</li> |
| </ul> |
| <p>Example:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>sh bin/hugegraph-spark-loader.sh --master yarn <span style="color:#4e9a06">\ |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06"></span>--deploy-mode cluster --name spark-hugegraph-loader --file ./hugegraph.json <span style="color:#4e9a06">\ |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06"></span>--username admin --token admin --host xx.xx.xx.xx --port <span style="color:#0000cf;font-weight:bold">8093</span> <span style="color:#4e9a06">\ |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06"></span>--graph graph-test --num-executors <span style="color:#0000cf;font-weight:bold">6</span> --executor-cores <span style="color:#0000cf;font-weight:bold">16</span> --executor-memory 15g |
| </span></span></code></pre></div></description></item><item><title>Docs: HugeGraph-Hubble Quick Start</title><link>/docs/quickstart/hugegraph-hubble/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/quickstart/hugegraph-hubble/</guid><description> |
| <h3 id="1-hugegraph-hubble-overview">1 HugeGraph-Hubble Overview</h3> |
| <blockquote> |
| <p><strong>Note:</strong> The current version of Hubble has not yet added Auth/Login related interfaces and |
| standalone protection, it will be added in the next Release version (≥ 1.5). |
| Please be careful not to expose it in a public network environment or untrusted networks to |
| avoid related SEC issues (you can also use IP &amp; port whitelist + HTTPS)</p> |
| </blockquote> |
| <p><strong>HugeGraph-Hubble</strong> is HugeGraph&rsquo;s one-stop visual analysis platform. The platform covers the whole |
| process from data modeling, to efficient data import, to real-time and offline analysis of data, and |
| unified management of graphs, realizing the whole process wizard of graph application. It is designed |
| to improve the user&rsquo;s use fluency, lower the user&rsquo;s use threshold, and provide a more efficient and easy-to-use user experience.</p> |
| <p>The platform mainly includes the following modules:</p> |
| <h5 id="graph-management">Graph Management</h5> |
| <p>The graph management module realizes the unified management of multiple graphs and graph access, editing, deletion, and query by creating graph and connecting the platform and graph data.</p> |
| <h5 id="metadata-modeling">Metadata Modeling</h5> |
| <p>The metadata modeling module realizes the construction and management of graph models by creating attribute libraries, vertex types, edge types, and index types. The platform provides two modes, list mode and graph mode, which can display the metadata model in real time, which is more intuitive. At the same time, it also provides a metadata reuse function across graphs, which saves the tedious and repetitive creation process of the same metadata, greatly improves modeling efficiency and enhances ease of use.</p> |
| <h5 id="graph-analysis">Graph Analysis</h5> |
| <p>By inputting the graph traversal language Gremlin, high-performance general analysis of graph data can be realized, and functions such as customized multidimensional path query of vertices can be provided, and three kinds of graph result display methods are provided, including: graph form, table form, Json form, and multidimensional display. The data form meets the needs of various scenarios used by users. It provides functions such as running records and collection of common statements, realizing the traceability of graph operations, and the reuse and sharing of query input, which is fast and efficient. It supports the export of graph data, and the export format is Json format.</p> |
| <h5 id="task-management">Task Management</h5> |
| <p>For Gremlin tasks that need to traverse the whole graph, index creation and reconstruction, |
| and other time-consuming asynchronous tasks, the platform provides corresponding task management |
| functions to achieve unified management and result viewing of asynchronous tasks.</p> |
| <h5 id="data-import">Data Import</h5> |
| <blockquote> |
| <p>&ldquo;Note: The data import function is currently suitable for preliminary use. For formal data import, |
| please use <a href="/docs/quickstart/hugegraph-loader">hugegraph-loader</a>, which has much better performance, stability, and functionality.&rdquo;</p> |
| </blockquote> |
| <p>Data import is to convert the user&rsquo;s business data into the vertices and edges of the graph and |
| insert it into the graph database. The platform provides a wizard-style visual import module. |
| By creating import tasks, the management of import tasks and the parallel operation of multiple |
| import tasks are realized. Improve import performance. After entering the import task, you only |
| need to follow the platform step prompts, upload files as needed, and fill in the content to easily |
| implement the import process of graph data. At the same time, it supports breakpoint resuming, |
| error retry mechanism, etc., which reduces import costs and improves efficiency.</p> |
| <h3 id="2-deploy">2 Deploy</h3> |
| <p>There are three ways to deploy <code>hugegraph-hubble</code></p> |
| <ul> |
| <li>Use Docker (Convenient for Test/Dev)</li> |
| <li>Download the Toolchain binary package</li> |
| <li>Source code compilation</li> |
| </ul> |
| <h4 id="21-use-docker-convenient-for-testdev">2.1 Use docker (Convenient for Test/Dev)</h4> |
| <blockquote> |
| <p><strong>Special Note</strong>: If you are starting <code>hubble</code> with Docker, and <code>hubble</code> and the server are on the same host. When configuring the hostname for the graph on the Hubble web page, please do not directly set it to <code>localhost/127.0.0.1</code>. This will refer to the <code>hubble</code> container internally rather than the host machine, resulting in a connection failure to the server.</p> |
| <p>If <code>hubble</code> and <code>server</code> is in the same docker network, we <strong>recommend</strong> using the <code>container_name</code> (in our example, it is <code>server</code>) as the hostname, and <code>8080</code> as the port. Or you can use the <strong>host IP</strong> as the hostname, and the port is configured by the host for the server.</p> |
| </blockquote> |
| <p>We can use <code>docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble</code> to quick start <a href="https://hub.docker.com/r/hugegraph/hubble">hubble</a>.</p> |
| <p>Alternatively, you can use Docker Compose to start <code>hubble</code>. Additionally, if <code>hubble</code> and the graph are in the same Docker network, you can access the graph using the container name of the graph, eliminating the need for the host machine&rsquo;s IP address.</p> |
| <p>Use <code>docker-compose up -d</code>，<code>docker-compose.yml</code> is following:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">version</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#39;3&#39;</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">services</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">server</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph/hugegraph</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">container_name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">server</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ports</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8080</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">hubble</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph/hubble</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">container_name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hubble</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">ports</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>- <span style="color:#0000cf;font-weight:bold">8088</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8088</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><blockquote> |
| <p>Note:</p> |
| <ol> |
| <li> |
| <p>The docker image of hugegraph-hubble is a convenience release to start hugegraph-hubble quickly, but not <strong>official distribution</strong> artifacts. You can find more details from <a href="https://infra.apache.org/release-distribution.html#dockerhub">ASF Release Distribution Policy</a>.</p> |
| </li> |
| <li> |
| <p>Recommand to use <code>release tag</code>(like <code>1.2.0</code>) for the stable version. Use <code>latest</code> tag to experience the newest functions in development.</p> |
| </li> |
| </ol> |
| </blockquote> |
| <h4 id="22-download-the-toolchain-binary-package">2.2 Download the Toolchain binary package</h4> |
| <p><code>hubble</code> is in the <code>toolchain</code> project. First, download the binary tar tarball</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>/apache-hugegraph-toolchain-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz |
| </span></span><span style="display:flex;"><span>tar -xvf apache-hugegraph-toolchain-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz |
| </span></span><span style="display:flex;"><span><span style="color:#204a87">cd</span> apache-hugegraph-toolchain-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span>.tar.gz/apache-hugegraph-hubble-incubating-<span style="color:#ce5c00;font-weight:bold">{</span>version<span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>Run <code>hubble</code></p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-hubble.sh |
| </span></span></code></pre></div><p>Then, we can see:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>starting HugeGraphHubble ..............timed out with http status <span style="color:#0000cf;font-weight:bold">502</span> |
| </span></span><span style="display:flex;"><span>2023-08-30 20:38:34 <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> o.a.h.HugeGraphHubble <span style="color:#ce5c00;font-weight:bold">[]</span> - Starting HugeGraphHubble v1.0.0 on cpu05 with PID xxx <span style="color:#ce5c00;font-weight:bold">(</span>~/apache-hugegraph-toolchain-incubating-1.0.0/apache-hugegraph-hubble-incubating-1.0.0/lib/hubble-be-1.0.0.jar started by <span style="color:#000">$USER</span> in ~/apache-hugegraph-toolchain-incubating-1.0.0/apache-hugegraph-hubble-incubating-1.0.0<span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span>2023-08-30 20:38:38 <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> c.z.h.HikariDataSource <span style="color:#ce5c00;font-weight:bold">[]</span> - hugegraph-hubble-HikariCP - Start completed. |
| </span></span><span style="display:flex;"><span>2023-08-30 20:38:41 <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> o.a.c.h.Http11NioProtocol <span style="color:#ce5c00;font-weight:bold">[]</span> - Starting ProtocolHandler <span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#4e9a06">&#34;http-nio-0.0.0.0-8088&#34;</span><span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span>2023-08-30 20:38:41 <span style="color:#ce5c00;font-weight:bold">[</span>main<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>INFO <span style="color:#ce5c00;font-weight:bold">]</span> o.a.h.HugeGraphHubble <span style="color:#ce5c00;font-weight:bold">[]</span> - Started HugeGraphHubble in 7.379 seconds <span style="color:#ce5c00;font-weight:bold">(</span>JVM running <span style="color:#204a87;font-weight:bold">for</span> 8.499<span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p>Then use a web browser to access <code>ip:8088</code> and you can see the <code>Hubble</code> page. You can stop the service using bin/stop-hubble.sh.</p> |
| <h4 id="23-source-code-compilation">2.3 Source code compilation</h4> |
| <p><strong>Note</strong>: Compiling Hubble requires the user&rsquo;s local environment to have Node.js V16.x and yarn installed.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>apt install curl build-essential |
| </span></span><span style="display:flex;"><span>curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh <span style="color:#000;font-weight:bold">|</span> bash |
| </span></span><span style="display:flex;"><span><span style="color:#204a87">source</span> ~/.bashrc |
| </span></span><span style="display:flex;"><span>nvm install <span style="color:#0000cf;font-weight:bold">16</span> |
| </span></span></code></pre></div><p>Then, verify that the installed Node.js version is 16.x (please note that higher Node version may cause conflicts).</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>node -v |
| </span></span></code></pre></div><p>install <code>yarn</code> by the command below:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>npm install -g yarn |
| </span></span></code></pre></div><p>Download the toolchain source code.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>git clone https://github.com/apache/hugegraph-toolchain.git |
| </span></span></code></pre></div><p>Compile <code>hubble</code>. It depends on the loader and client, so you need to build these dependencies in advance during the compilation process (you can skip this step later).</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#204a87">cd</span> incubator-hugegraph-toolchain |
| </span></span><span style="display:flex;"><span>sudo pip install -r hugegraph-hubble/hubble-dist/assembly/travis/requirements.txt |
| </span></span><span style="display:flex;"><span>mvn install -pl hugegraph-client,hugegraph-loader -am -Dmaven.javadoc.skip<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87">true</span> -DskipTests -ntp |
| </span></span><span style="display:flex;"><span><span style="color:#204a87">cd</span> hugegraph-hubble |
| </span></span><span style="display:flex;"><span>mvn -e compile package -Dmaven.javadoc.skip<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87">true</span> -Dmaven.test.skip<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87">true</span> -ntp |
| </span></span><span style="display:flex;"><span><span style="color:#204a87">cd</span> apache-hugegraph-hubble-incubating* |
| </span></span></code></pre></div><p>Run <code>hubble</code></p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-hubble.sh -d |
| </span></span></code></pre></div><h3 id="3platform-workflow">3 Platform Workflow</h3> |
| <p>The module usage process of the platform is as follows:</p> |
| <div style="text-align: center;"> |
| <img src="/docs/images/images-hubble/2平台使用流程.png" alt="image"> |
| </div> |
| <h3 id="4platform-instructions">4 Platform Instructions</h3> |
| <h4 id="41graph-management">4.1 Graph Management</h4> |
| <h5 id="411graph-creation">4.1.1 Graph creation</h5> |
| <p>Under the graph management module, click [Create graph], and realize the connection of multiple graphs by filling in the graph ID, graph name, host name, port number, username, and password information.</p> |
| <div style="text-align: center;"> |
| <img src="/docs/images/images-hubble/311图创建.png" alt="image"> |
| </div> |
| <p>Create graph by filling in the content as follows:</p> |
| <center> |
| <img src="/docs/images/images-hubble/311图创建2.png" alt="image"> |
| </center> |
| <blockquote> |
| <p><strong>Special Note</strong>: If you are starting <code>hubble</code> with Docker, and <code>hubble</code> and the server are on the same host. When configuring the hostname for the graph on the Hubble web page, please do not directly set it to <code>localhost/127.0.0.1</code>. If <code>hubble</code> and <code>server</code> is in the same docker network, we <strong>recommend</strong> using the <code>container_name</code> (in our example, it is <code>graph</code>) as the hostname, and <code>8080</code> as the port. Or you can use the <strong>host IP</strong> as the hostname, and the port is configured by the host for the server.</p> |
| </blockquote> |
| <h5 id="412graph-access">4.1.2 Graph Access</h5> |
| <p>Realize the information access of the graph space. After entering, you can perform operations such as multidimensional query analysis, metadata management, data import, and algorithm analysis of the graph.</p> |
| <center> |
| <img src="/docs/images/images-hubble/312图访问.png" alt="image"> |
| </center> |
| <h5 id="413graph-management">4.1.3 Graph management</h5> |
| <ol> |
| <li>Users can achieve unified management of graphs through overview, search, and information editing and deletion of single graphs.</li> |
| <li>Search range: You can search for the graph name and ID.</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/313图管理.png" alt="image"> |
| </center> |
| <h4 id="42metadata-modeling-list--graph-mode">4.2 Metadata Modeling (list + graph mode)</h4> |
| <h5 id="421module-entry">4.2.1 Module entry</h5> |
| <p>Left navigation:</p> |
| <center> |
| <img src="/docs/images/images-hubble/321元数据入口.png" alt="image"> |
| </center> |
| <h5 id="422property-type">4.2.2 Property type</h5> |
| <h6 id="4221create-type">4.2.2.1 Create type</h6> |
| <ol> |
| <li>Fill in or select the attribute name, data type, and cardinality to complete the creation of the attribute.</li> |
| <li>Created attributes can be used as attributes of vertex type and edge type.</li> |
| </ol> |
| <p>List mode:</p> |
| <center> |
| <img src="/docs/images/images-hubble/3221属性创建.png" alt="image"> |
| </center> |
| <p>Graph mode:</p> |
| <center> |
| <img src="/docs/images/images-hubble/3221属性创建2.png" alt="image"> |
| </center> |
| <h6 id="4222reuse">4.2.2.2 Reuse</h6> |
| <ol> |
| <li>The platform provides the [Reuse] function, which can directly reuse the metadata of other graphs.</li> |
| <li>Select the graph ID that needs to be reused, and continue to select the attributes that need to be reused. After that, the platform will check whether there is a conflict. After passing, the metadata can be reused.</li> |
| </ol> |
| <p>Select reuse items:</p> |
| <center> |
| <img src="/docs/images/images-hubble/3222属性复用.png" alt="image"> |
| </center> |
| <p>Check reuse items:</p> |
| <center> |
| <img src="/docs/images/images-hubble/3222属性复用2.png" alt="image"> |
| </center> |
| <h6 id="4223management">4.2.2.3 Management</h6> |
| <ol> |
| <li>You can delete a single item or delete it in batches in the attribute list.</li> |
| </ol> |
| <h5 id="423vertex-type">4.2.3 Vertex type</h5> |
| <h6 id="4231create-type">4.2.3.1 Create type</h6> |
| <ol> |
| <li>Fill in or select the vertex type name, ID strategy, association attribute, primary key attribute, vertex style, content displayed below the vertex in the query result, and index information: including whether to create a type index, and the specific content of the attribute index, complete the vertex Type creation.</li> |
| </ol> |
| <p>List mode:</p> |
| <center> |
| <img src="/docs/images/images-hubble/3231顶点创建.png" alt="image"> |
| </center> |
| <p>Graph mode:</p> |
| <center> |
| <img src="/docs/images/images-hubble/3231顶点创建2.png" alt="image"> |
| </center> |
| <h6 id="4232-reuse">4.2.3.2 Reuse</h6> |
| <ol> |
| <li>The multiplexing of vertex types will reuse the attributes and attribute indexes associated with this type together.</li> |
| <li>The reuse method is similar to the property reuse, see 3.2.2.2.</li> |
| </ol> |
| <h6 id="4233-administration">4.2.3.3 Administration</h6> |
| <ol> |
| <li> |
| <p>Editing operations are available. The vertex style, association type, vertex display content, and attribute index can be edited, and the rest cannot be edited.</p> |
| </li> |
| <li> |
| <p>You can delete a single item or delete it in batches.</p> |
| </li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/3233顶点删除.png" alt="image"> |
| </center> |
| <h5 id="424-edge-types">4.2.4 Edge Types</h5> |
| <h6 id="4241-create">4.2.4.1 Create</h6> |
| <ol> |
| <li>Fill in or select the edge type name, start point type, end point type, associated attributes, whether to allow multiple connections, edge style, content displayed below the edge in the query result, and index information: including whether to create a type index, and attribute index The specific content, complete the creation of the edge type.</li> |
| </ol> |
| <p>List mode:</p> |
| <center> |
| <img src="/docs/images/images-hubble/3241边创建.png" alt="image"> |
| </center> |
| <p>Graph mode:</p> |
| <center> |
| <img src="/docs/images/images-hubble/3241边创建2.png" alt="image"> |
| </center> |
| <h6 id="4242-reuse">4.2.4.2 Reuse</h6> |
| <ol> |
| <li>The reuse of the edge type will reuse the start point type, end point type, associated attribute and attribute index of this type.</li> |
| <li>The reuse method is similar to the property reuse, see 3.2.2.2.</li> |
| </ol> |
| <h6 id="4243-administration">4.2.4.3 Administration</h6> |
| <ol> |
| <li>Editing operations are available. Edge styles, associated attributes, edge display content, and attribute indexes can be edited, and the rest cannot be edited, the same as the vertex type.</li> |
| <li>You can delete a single item or delete it in batches.</li> |
| </ol> |
| <h5 id="425-index-types">4.2.5 Index Types</h5> |
| <p>Displays vertex and edge indices for vertex types and edge types.</p> |
| <h4 id="43-data-import">4.3 Data Import</h4> |
| <blockquote> |
| <p><strong>Note</strong>：currently, we recommend to use <a href="/en/docs/quickstart/hugegraph-loader">hugegraph-loader</a> to import data formally. The built-in import of <code>hubble</code> is used for <strong>testing</strong> and <strong>getting started</strong>.</p> |
| </blockquote> |
| <p>The usage process of data import is as follows:</p> |
| <center> |
| <img src="/docs/images/images-hubble/33导入流程.png" alt="image"> |
| </center> |
| <h5 id="431module-entrance">4.3.1 Module entrance</h5> |
| <p>Left navigation:</p> |
| <center> |
| <img src="/docs/images/images-hubble/331导入入口.png" alt="image"> |
| </center> |
| <h5 id="432-create-task">4.3.2 Create task</h5> |
| <ol> |
| <li>Fill in the task name and remarks (optional) to create an import task.</li> |
| <li>Multiple import tasks can be created and imported in parallel.</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/332创建任务.png" alt="image"> |
| </center> |
| <h5 id="433-uploading-files">4.3.3 Uploading files</h5> |
| <ol> |
| <li>Upload the file that needs to be composed. The currently supported format is CSV, which will be updated continuously in the future.</li> |
| <li>Multiple files can be uploaded at the same time.</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/333上传文件.png" alt="image"> |
| </center> |
| <h5 id="434-setting-up-data-mapping">4.3.4 Setting up data mapping</h5> |
| <ol> |
| <li> |
| <p>Set up data mapping for uploaded files, including file settings and type settings</p> |
| </li> |
| <li> |
| <p>File settings: Check or fill in whether to include the header, separator, encoding format and other settings of the file itself, all set the default values, no need to fill in manually</p> |
| </li> |
| <li> |
| <p>Type setting:</p> |
| <ol> |
| <li> |
| <p>Vertex map and edge map:</p> |
| <p>【Vertex Type】: Select the vertex type, and upload the column data in the file for its ID mapping;</p> |
| <p>【Edge Type】: Select the edge type and map the column data of the uploaded file to the ID column of its start point type and end point type;</p> |
| </li> |
| <li> |
| <p>Mapping settings: upload the column data in the file for the attribute mapping of the selected vertex type. Here, if the attribute name is the same as the header name of the file, the mapping attribute can be automatically matched, and there is no need to manually fill in the selection.</p> |
| </li> |
| <li> |
| <p>After completing the setting, the setting list will be displayed before proceeding to the next step. It supports the operations of adding, editing and deleting mappings.</p> |
| </li> |
| </ol> |
| </li> |
| </ol> |
| <p>Fill in the settings map:</p> |
| <center> |
| <img src="/docs/images/images-hubble/334设置映射.png" alt="image"> |
| </center> |
| <p>Mapping list:</p> |
| <center> |
| <img src="/docs/images/images-hubble/334设置映射2.png" alt="image"> |
| </center> |
| <h5 id="435-import-data">4.3.5 Import data</h5> |
| <p>Before importing, you need to fill in the import setting parameters. After filling in, you can start importing data into the gallery.</p> |
| <ol> |
| <li>Import settings</li> |
| </ol> |
| <ul> |
| <li>The import setting parameter items are as shown in the figure below, all set the default value, no need to fill in manually</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/335导入设置.png" alt="image"> |
| </center> |
| <ol start="2"> |
| <li>Import details</li> |
| </ol> |
| <ul> |
| <li>Click Start Import to start the file import task</li> |
| <li>The import details provide the mapping type, import speed, import progress, time-consuming and the specific status of the current task set for each uploaded file, and can pause, resume, stop and other operations for each task</li> |
| <li>If the import fails, you can view the specific reason</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/335导入详情.png" alt="image"> |
| </center> |
| <h4 id="44-data-analysis">4.4 Data Analysis</h4> |
| <h5 id="441-module-entry">4.4.1 Module entry</h5> |
| <p>Left navigation:</p> |
| <center> |
| <img src="/docs/images/images-hubble/341分析入口.png" alt="image"> |
| </center> |
| <h5 id="442-multi-image-switching">4.4.2 Multi-image switching</h5> |
| <p>By switching the entrance on the left, flexibly switch the operation space of multiple graphs</p> |
| <center> |
| <img src="/docs/images/images-hubble/342多图切换.png" alt="image"> |
| </center> |
| <h5 id="443-graph-analysis-and-processing">4.4.3 Graph Analysis and Processing</h5> |
| <p>HugeGraph supports Gremlin, a graph traversal query language of Apache TinkerPop3. Gremlin is a general graph database query language. By entering Gremlin statements and clicking execute, you can perform query and analysis operations on graph data, and create and delete vertices/edges. , vertex/edge attribute modification, etc.</p> |
| <p>After Gremlin query, below is the graph result display area, which provides 3 kinds of graph result display modes: [Graph Mode], [Table Mode], [Json Mode].</p> |
| <p>Support zoom, center, full screen, export and other operations.</p> |
| <p>【Picture Mode】</p> |
| <center> |
| <img src="/docs/images/images-hubble/343图分析-图.png" alt="image"> |
| </center> |
| <p>【Table mode】</p> |
| <center> |
| <img src="/docs/images/images-hubble/343图分析-表格.png" alt="image"> |
| </center> |
| <p>【Json mode】</p> |
| <center> |
| <img src="/docs/images/images-hubble/343图分析-json.png" alt="image"> |
| </center> |
| <h5 id="444-data-details">4.4.4 Data Details</h5> |
| <p>Click the vertex/edge entity to view the data details of the vertex/edge, including: vertex/edge type, vertex ID, attribute and corresponding value, expand the information display dimension of the graph, and improve the usability.</p> |
| <h5 id="445-multidimensional-path-query-of-graph-results">4.4.5 Multidimensional Path Query of Graph Results</h5> |
| <p>In addition to the global query, in-depth customized query and hidden operations can be performed for the vertices in the query result to realize customized mining of graph results.</p> |
| <p>Right-click a vertex, and the menu entry of the vertex appears, which can be displayed, inquired, hidden, etc.</p> |
| <ul> |
| <li>Expand: Click to display the vertices associated with the selected point.</li> |
| <li>Query: By selecting the edge type and edge direction associated with the selected point, and then selecting its attributes and corresponding filtering rules under this condition, a customized path display can be realized.</li> |
| <li>Hide: When clicked, hides the selected point and its associated edges.</li> |
| </ul> |
| <p>Double-clicking a vertex also displays the vertex associated with the selected point.</p> |
| <center> |
| <img src="/docs/images/images-hubble/345定制路径查询.png" alt="image"> |
| </center> |
| <h5 id="446-add-vertexedge">4.4.6 Add vertex/edge</h5> |
| <h6 id="4461-added-vertex">4.4.6.1 Added vertex</h6> |
| <p>In the graph area, two entries can be used to dynamically add vertices, as follows:</p> |
| <ol> |
| <li>Click on the graph area panel, the Add Vertex entry appears</li> |
| <li>Click the first icon in the action bar in the upper right corner</li> |
| </ol> |
| <p>Complete the addition of vertices by selecting or filling in the vertex type, ID value, and attribute information.</p> |
| <p>The entry is as follows:</p> |
| <center> |
| <img src="/docs/images/images-hubble/346新增顶点.png" alt="image"> |
| </center> |
| <p>Add the vertex content as follows:</p> |
| <center> |
| <img src="/docs/images/images-hubble/346新增顶点2.png" alt="image"> |
| </center> |
| <h6 id="4462-add-edge">4.4.6.2 Add edge</h6> |
| <p>Right-click a vertex in the graph result to add the outgoing or incoming edge of that point.</p> |
| <h5 id="447-execute-the-query-of-records-and-favorites">4.4.7 Execute the query of records and favorites</h5> |
| <ol> |
| <li>Record each query record at the bottom of the graph area, including: query time, execution type, content, status, time-consuming, as well as [collection] and [load] operations, to achieve a comprehensive record of graph execution, with traces to follow, and Can quickly load and reuse execution content</li> |
| <li>Provides the function of collecting sentences, which can be used to collect frequently used sentences, which is convenient for fast calling of high-frequency sentences.</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/347收藏.png" alt="image"> |
| </center> |
| <h4 id="45-task-management">4.5 Task Management</h4> |
| <h5 id="451-module-entry">4.5.1 Module entry</h5> |
| <p>Left navigation:</p> |
| <center> |
| <img src="/docs/images/images-hubble/351任务管理入口.png" alt="image"> |
| </center> |
| <h5 id="452-task-management">4.5.2 Task Management</h5> |
| <ol> |
| <li>Provide unified management and result viewing of asynchronous tasks. There are 4 types of asynchronous tasks, namely:</li> |
| </ol> |
| <ul> |
| <li>gremlin: Gremlin tasks</li> |
| <li>algorithm: OLAP algorithm task</li> |
| <li>remove_schema: remove metadata</li> |
| <li>rebuild_index: rebuild the index</li> |
| </ul> |
| <ol start="2"> |
| <li>The list displays the asynchronous task information of the current graph, including: task ID, task name, task type, creation time, time-consuming, status, operation, and realizes the management of asynchronous tasks.</li> |
| <li>Support filtering by task type and status</li> |
| <li>Support searching for task ID and task name</li> |
| <li>Asynchronous tasks can be deleted or deleted in batches</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/352任务列表.png" alt="image"> |
| </center> |
| <h5 id="453-gremlin-asynchronous-tasks">4.5.3 Gremlin asynchronous tasks</h5> |
| <ol> |
| <li>Create a task</li> |
| </ol> |
| <ul> |
| <li>The data analysis module currently supports two Gremlin operations, Gremlin query and Gremlin task; if the user switches to the Gremlin task, after clicking execute, an asynchronous task will be created in the asynchronous task center;</li> |
| </ul> |
| <ol start="2"> |
| <li>Task submission</li> |
| </ol> |
| <ul> |
| <li>After the task is submitted successfully, the graph area returns the submission result and task ID</li> |
| </ul> |
| <ol start="3"> |
| <li>Mission details</li> |
| </ol> |
| <ul> |
| <li>Provide [View] entry, you can jump to the task details to view the specific execution of the current task After jumping to the task center, the currently executing task line will be displayed directly</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/353gremlin任务.png" alt="image"> |
| </center> |
| <p>Click to view the entry to jump to the task management list, as follows:</p> |
| <center> |
| <img src="/docs/images/images-hubble/353gremlin任务2.png" alt="image"> |
| </center> |
| <ol start="4"> |
| <li>View the results</li> |
| </ol> |
| <ul> |
| <li>The results are displayed in the form of json</li> |
| </ul> |
| <h5 id="454-olap-algorithm-tasks">4.5.4 OLAP algorithm tasks</h5> |
| <p>There is no visual OLAP algorithm execution on Hubble. You can call the RESTful API to perform OLAP algorithm tasks, find the corresponding tasks by ID in the task management, and view the progress and results.</p> |
| <h5 id="455-delete-metadata-rebuild-index">4.5.5 Delete metadata, rebuild index</h5> |
| <ol> |
| <li>Create a task</li> |
| </ol> |
| <ul> |
| <li>In the metadata modeling module, when deleting metadata, an asynchronous task for deleting metadata can be created</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/355删除元数据.png" alt="image"> |
| </center> |
| <ul> |
| <li>When editing an existing vertex/edge type operation, when adding an index, an asynchronous task of creating an index can be created</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/355构建索引.png" alt="image"> |
| </center> |
| <ol start="2"> |
| <li>Task details</li> |
| </ol> |
| <ul> |
| <li>After confirming/saving, you can jump to the task center to view the details of the current task</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/355任务详情.png" alt="image"> |
| </center></description></item><item><title>Docs: HugeGraph-Client Quick Start</title><link>/docs/quickstart/hugegraph-client/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/quickstart/hugegraph-client/</guid><description> |
| <h3 id="1-overview-of-hugegraph">1 Overview Of Hugegraph</h3> |
| <p><a href="https://github.com/apache/hugegraph-toolchain">HugeGraph-Client</a> sends HTTP request to HugeGraph-Server to obtain and parse the execution result of Server. |
| We support HugeGraph-Client for Java/Go/<a href="https://github.com/apache/incubator-hugegraph-ai/tree/main/hugegraph-python-client">Python</a> language. |
| You can use <a href="/cn/docs/clients/hugegraph-client">Client-API</a> to write code to operate HugeGraph, such as adding, deleting, modifying, and querying schema and graph data, or executing gremlin statements.</p> |
| <blockquote> |
| <p><a href="https://github.com/apache/incubator-hugegraph-toolchain/blob/master/hugegraph-client-go/README.en.md">HugeGraph client SDK tool based on Go language</a> (version &gt;=1.2.0)</p> |
| </blockquote> |
| <h3 id="2-what-you-need">2 What You Need</h3> |
| <ul> |
| <li>Java 11 (also support Java 8)</li> |
| <li>Maven 3.5+</li> |
| </ul> |
| <h3 id="3-how-to-use">3 How To Use</h3> |
| <p>The basic steps to use HugeGraph-Client are as follows:</p> |
| <ul> |
| <li>Build a new Maven project by IDEA or Eclipse</li> |
| <li>Add HugeGraph-Client dependency in pom file;</li> |
| <li>Create an object to invoke the interface of HugeGraph-Client</li> |
| </ul> |
| <p>See the complete example in the following section for the detail.</p> |
| <h3 id="4-complete-example">4 Complete Example</h3> |
| <h4 id="41-build-new-maven-project">4.1 Build New Maven Project</h4> |
| <p>Using IDEA or Eclipse to create the project:</p> |
| <ul> |
| <li><a href="http://www.vogella.com/tutorials/EclipseMaven/article.html">Build by Eclipse</a></li> |
| <li><a href="https://vaadin.com/docs/-/part/framework/getting-started/getting-started-idea.html">Build by Intellij Idea</a></li> |
| </ul> |
| <h4 id="42-add-hugegraph-client-dependency-in-pom">4.2 Add Hugegraph-Client Dependency In POM</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">&lt;dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&lt;groupId&gt;</span>org.apache.hugegraph<span style="color:#204a87;font-weight:bold">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&lt;artifactId&gt;</span>hugegraph-client<span style="color:#204a87;font-weight:bold">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#8f5902;font-style:italic">&lt;!-- Update to the latest release version --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&lt;version&gt;</span>1.3.0<span style="color:#204a87;font-weight:bold">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">&lt;/dependencies&gt;</span> |
| </span></span></code></pre></div><blockquote> |
| <p>Note: The versions of all graph components remain consistent</p> |
| </blockquote> |
| <h4 id="43-example">4.3 Example</h4> |
| <h5 id="431-singleexample">4.3.1 SingleExample</h5> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">java.io.IOException</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">java.util.Iterator</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">java.util.List</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.driver.GraphManager</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.driver.GremlinManager</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.driver.HugeClient</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.driver.SchemaManager</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.structure.constant.T</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.structure.graph.Edge</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.structure.graph.Path</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.structure.graph.Vertex</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.structure.gremlin.Result</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.structure.gremlin.ResultSet</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">class</span> <span style="color:#000">SingleExample</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">static</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">main</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">String</span><span style="color:#ce5c00;font-weight:bold">[]</span> <span style="color:#000">args</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#204a87;font-weight:bold">throws</span> <span style="color:#000">IOException</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#8f5902;font-style:italic">// If connect failed will throw a exception. |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#000">HugeClient</span> <span style="color:#000">hugeClient</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">HugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">builder</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;http://localhost:8080&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">build</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">SchemaManager</span> <span style="color:#000">schema</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">hugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">schema</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asInt</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asDouble</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asDate</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asInt</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;personByCity&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">onV</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">secondary</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;personByAgeAndCity&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">onV</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">secondary</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;softwareByPrice&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">onV</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">range</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">sourceLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">targetLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">sourceLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">targetLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;createdByDate&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">onE</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">secondary</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;createdByWeight&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">onE</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">range</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knowsByWeight&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">onE</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">range</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">GraphManager</span> <span style="color:#000">graph</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">hugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">graph</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">marko</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addVertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">T</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">LABEL</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">29</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;Beijing&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">vadas</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addVertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">T</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">LABEL</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;vadas&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">27</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;Hongkong&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">lop</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addVertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">T</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">LABEL</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;lop&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;java&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">328</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">josh</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addVertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">T</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">LABEL</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;josh&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">32</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;Beijing&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">ripple</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addVertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">T</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">LABEL</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;ripple&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;java&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">199</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">peter</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addVertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">T</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">LABEL</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;peter&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">35</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;city&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;Shanghai&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">vadas</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2016-01-10&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">0</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">5</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2013-02-20&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">1</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">0</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2017-12-10&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">0</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">4</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2009-11-11&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">0</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">4</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">ripple</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2017-12-10&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">1</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">0</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">peter</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2017-03-24&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;weight&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">0</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">2</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">GremlinManager</span> <span style="color:#000">gremlin</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">hugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">gremlin</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;==== Path ====&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">ResultSet</span> <span style="color:#000">resultSet</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">gremlin</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">gremlin</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;g.V().outE().path()&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">execute</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Iterator</span><span style="color:#ce5c00;font-weight:bold">&lt;</span><span style="color:#000">Result</span><span style="color:#ce5c00;font-weight:bold">&gt;</span> <span style="color:#000">results</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">resultSet</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">iterator</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">results</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">forEachRemaining</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">result</span> <span style="color:#ce5c00;font-weight:bold">-&gt;</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">result</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getObject</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">getClass</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Object</span> <span style="color:#000">object</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">result</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getObject</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">if</span> <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">object</span> <span style="color:#204a87;font-weight:bold">instanceof</span> <span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(((</span><span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#000">object</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">id</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">}</span> <span style="color:#204a87;font-weight:bold">else</span> <span style="color:#204a87;font-weight:bold">if</span> <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">object</span> <span style="color:#204a87;font-weight:bold">instanceof</span> <span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(((</span><span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#000">object</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">id</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">}</span> <span style="color:#204a87;font-weight:bold">else</span> <span style="color:#204a87;font-weight:bold">if</span> <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">object</span> <span style="color:#204a87;font-weight:bold">instanceof</span> <span style="color:#000">Path</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">List</span><span style="color:#ce5c00;font-weight:bold">&lt;</span><span style="color:#000">Object</span><span style="color:#ce5c00;font-weight:bold">&gt;</span> <span style="color:#000">elements</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#ce5c00;font-weight:bold">((</span><span style="color:#000">Path</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#000">object</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">objects</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">elements</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">forEach</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">element</span> <span style="color:#ce5c00;font-weight:bold">-&gt;</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">element</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getClass</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">element</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">});</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">}</span> <span style="color:#204a87;font-weight:bold">else</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">object</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">});</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">hugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">close</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="432-batchexample">4.3.2 BatchExample</h5> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">java.util.ArrayList</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">java.util.List</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.driver.GraphManager</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.driver.HugeClient</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.driver.SchemaManager</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.structure.graph.Edge</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.hugegraph.structure.graph.Vertex</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">class</span> <span style="color:#000">BatchExample</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">static</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">main</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">String</span><span style="color:#ce5c00;font-weight:bold">[]</span> <span style="color:#000">args</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#8f5902;font-style:italic">// If connect failed will throw a exception. |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#000">HugeClient</span> <span style="color:#000">hugeClient</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">HugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">builder</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;http://localhost:8080&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">build</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">SchemaManager</span> <span style="color:#000">schema</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">hugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">schema</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asInt</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asText</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asDate</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">asInt</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">nullableKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">append</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;softwareByPrice&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">onV</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">range</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">link</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">link</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">properties</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;createdByDate&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">onE</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">by</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">secondary</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ifNotExist</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">create</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#8f5902;font-style:italic">// get schema object by name |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getPropertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;createdByDate&#34;</span><span style="color:#ce5c00;font-weight:bold">));</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#8f5902;font-style:italic">// list all schema objects |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getPropertyKeys</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getVertexLabels</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getEdgeLabels</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">schema</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getIndexLabels</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">GraphManager</span> <span style="color:#000">graph</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">hugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">graph</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">marko</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;marko&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">29</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">vadas</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;vadas&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">27</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">lop</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;lop&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;java&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">328</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">josh</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;josh&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">32</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">ripple</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;software&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;ripple&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;lang&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;java&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;price&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">199</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Vertex</span> <span style="color:#000">peter</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;person&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;peter&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;age&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">35</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Edge</span> <span style="color:#000">markoKnowsVadas</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">source</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">target</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">vadas</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2016-01-10&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Edge</span> <span style="color:#000">markoKnowsJosh</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;knows&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">source</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">target</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2013-02-20&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Edge</span> <span style="color:#000">markoCreateLop</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">source</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">target</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;2017-12-10&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Edge</span> <span style="color:#000">joshCreateRipple</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">source</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">target</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">ripple</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;2017-12-10&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Edge</span> <span style="color:#000">joshCreateLop</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">source</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">target</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">&#34;2009-11-11&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">Edge</span> <span style="color:#000">peterCreateLop</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;created&#34;</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">source</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">peter</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">target</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">property</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">&#34;date&#34;</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;2017-03-24&#34;</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">List</span><span style="color:#ce5c00;font-weight:bold">&lt;</span><span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">&gt;</span> <span style="color:#000">vertices</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">ArrayList</span><span style="color:#ce5c00;font-weight:bold">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">vadas</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">ripple</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">peter</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">List</span><span style="color:#ce5c00;font-weight:bold">&lt;</span><span style="color:#000">Edge</span><span style="color:#ce5c00;font-weight:bold">&gt;</span> <span style="color:#000">edges</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">ArrayList</span><span style="color:#ce5c00;font-weight:bold">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">edges</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">markoKnowsVadas</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">edges</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">markoKnowsJosh</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">edges</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">markoCreateLop</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">edges</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">joshCreateRipple</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">edges</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">joshCreateLop</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">edges</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">add</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">peterCreateLop</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">vertices</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addVertices</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">forEach</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">vertex</span> <span style="color:#ce5c00;font-weight:bold">-&gt;</span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">vertex</span><span style="color:#ce5c00;font-weight:bold">));</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">edges</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">addEdges</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">edges</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">false</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">edges</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">forEach</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">edge</span> <span style="color:#ce5c00;font-weight:bold">-&gt;</span> <span style="color:#000">System</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">out</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">println</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">edge</span><span style="color:#ce5c00;font-weight:bold">));</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">hugeClient</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">close</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span></code></pre></div><h3 id="44-run-the-example">4.4 Run The Example</h3> |
| <p>Before running Example, you need to start the Server. For the startup process, see<a href="/docs/quickstart/hugegraph-server">HugeGraph-Server Quick Start</a>.</p> |
| <h3 id="45-more-information-about-client-api">4.5 More Information About Client-API</h3> |
| <p>See<a href="/docs/clients/hugegraph-client">Introduce basic API of HugeGraph-Client</a>.</p></description></item><item><title>Docs: HugeGraph-AI Quick Start</title><link>/docs/quickstart/hugegraph-ai/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/quickstart/hugegraph-ai/</guid><description> |
| <h3 id="1-hugegraph-ai-overview">1 HugeGraph-AI Overview</h3> |
| <p>hugegraph-ai aims to explore the integration of HugeGraph and artificial intelligence (AI), including applications combined |
| with large models, integration with graph machine learning components, etc., to provide comprehensive support for developers to use HugeGraph&rsquo;s AI capabilities in projects.</p> |
| <h3 id="2-environment-requirements">2 Environment Requirements</h3> |
| <ul> |
| <li>python 3.8+</li> |
| <li>hugegraph 1.0.0+</li> |
| </ul> |
| <h3 id="3-preparation">3 Preparation</h3> |
| <ul> |
| <li>Start the HugeGraph database, you can achieve this through Docker. Please refer to this <a href="https://hub.docker.com/r/hugegraph/hugegraph">link</a> for guidance.</li> |
| <li>Start the gradio interactive demo, you can start with the following command, and open <a href="http://127.0.0.1:8001">http://127.0.0.1:8001</a> after starting</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># ${PROJECT_ROOT_DIR} is the root directory of hugegraph-ai, which needs to be configured by yourself</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87">export</span> <span style="color:#000">PYTHONPATH</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">${</span><span style="color:#000">PROJECT_ROOT_DIR</span><span style="color:#4e9a06">}</span>/hugegraph-llm/src:<span style="color:#4e9a06">${</span><span style="color:#000">PROJECT_ROOT_DIR</span><span style="color:#4e9a06">}</span>/hugegraph-python-client/src |
| </span></span><span style="display:flex;"><span>python3 ./hugegraph-llm/src/hugegraph_llm/utils/gradio_demo.py |
| </span></span></code></pre></div><ul> |
| <li>Configure HugeGraph database connection information and LLM information, which can be configured in two ways: |
| <ol> |
| <li>Configure the <code>./hugegraph-llm/src/config/config.ini</code> file</li> |
| <li>In gradio, after completing the configurations for LLM and HugeGraph, click on <code>Initialize configs</code>, the complete and initialized configuration file will be outputted. |
| <img src="/docs/images/gradio-config.png" alt="gradio-config"></li> |
| </ol> |
| </li> |
| <li>offline download NLTK stopwords</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>python3 ./hugegraph_llm/operators/common_op/nltk_helper.py |
| </span></span></code></pre></div><h3 id="4-how-to-use">4 How to use</h3> |
| <h4 id="41-build-a-knowledge-graph-in-hugegraph-through-llm">4.1 Build a knowledge graph in HugeGraph through LLM</h4> |
| <h5 id="411-build-a-knowledge-graph-through-the-gradio-interactive-interface">4.1.1 Build a knowledge graph through the gradio interactive interface</h5> |
| <ul> |
| <li>Parameter description: |
| <ul> |
| <li>Text: The input text.</li> |
| <li>Schema: Accepts the following two types of text: |
| <ul> |
| <li>User-defined JSON format schema.</li> |
| <li>Specify the name of the HugeGraph graph instance, which will automatically extract the schema of the graph.</li> |
| </ul> |
| </li> |
| <li>Disambiguate word sense: Whether to disambiguate word sense.</li> |
| <li>Commit to hugegraph: Whether to submit the constructed knowledge graph to the HugeGraph server</li> |
| </ul> |
| </li> |
| </ul> |
| <p><img src="/docs/images/gradio-kg.png" alt="gradio-config"></p> |
| <h5 id="412-build-a-knowledge-graph-through-code">4.1.2 Build a knowledge graph through code</h5> |
| <ul> |
| <li>Complete code</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">from</span> <span style="color:#000">hugegraph_llm.llms.init_llm</span> <span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">LLMs</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">from</span> <span style="color:#000">hugegraph_llm.operators.kg_construction_task</span> <span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">KgBuilder</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">llm</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">LLMs</span><span style="color:#000;font-weight:bold">()</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">get_llm</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">builder</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">KgBuilder</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">llm</span><span style="color:#000;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">builder</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">import_schema</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">from_hugegraph</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;test_graph&#34;</span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">extract_triples</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">TEXT</span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">disambiguate_word_sense</span><span style="color:#000;font-weight:bold">()</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">commit_to_hugegraph</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">run</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">)</span> |
| </span></span></code></pre></div><ul> |
| <li>Sequence Diagram |
| <img src="/docs/images/kg-uml.png" alt="gradio-config"></li> |
| </ul> |
| <ol> |
| <li>Initialize: Initialize the LLMs instance, get the LLM, and then create a task instance <code>KgBuilder</code> for graph construction. <code>KgBuilder</code> defines multiple operators, and users can freely combine them according to their needs. (tip: <code>print_result()</code> can print the result of each step in the console, without affecting the overall execution logic)</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">llm</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">LLMs</span><span style="color:#000;font-weight:bold">()</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">get_llm</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">builder</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">KgBuilder</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">llm</span><span style="color:#000;font-weight:bold">)</span> |
| </span></span></code></pre></div><ol start="2"> |
| <li>Import Schema: Import using the <code>import_schema</code> method, which supports three modes: |
| <ul> |
| <li>Import from a HugeGraph instance, specify the name of the HugeGraph graph instance, and it will automatically extract the schema of the graph.</li> |
| <li>Import from a user-defined schema, accept user-defined JSON format schema.</li> |
| <li>Import from the extraction result (release soon)</li> |
| </ul> |
| </li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Import schema from a HugeGraph instance</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">builder</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">import_schema</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">from_hugegraph</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;test_graph&#34;</span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Import schema from user-defined schema</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">builder</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">import_schema</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">from_user_defined</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;xxx&#34;</span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Import schema from an extraction result</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">builder</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">import_schema</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">from_extraction</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;xxx&#34;</span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span></code></pre></div><ol start="3"> |
| <li>Extract triples: Use the <code>extract_triples</code> method to extract triples from the text.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">TEXT</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#4e9a06">&#34;Meet Sarah, a 30-year-old attorney, and her roommate, James, whom she&#39;s shared a home with since 2010.&#34;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">builder</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">extract_triples</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">TEXT</span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span></code></pre></div><ol start="4"> |
| <li>Disambiguate word sense: Use the <code>disambiguate_word_sense</code> method to disambiguate word sense.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">builder</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">disambiguate_word_sense</span><span style="color:#000;font-weight:bold">()</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span></code></pre></div><ol start="5"> |
| <li>Commit to HugeGraph: Use the <code>commit_to_hugegraph</code> method to submit the constructed knowledge graph to the HugeGraph instance.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">builder</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">commit_to_hugegraph</span><span style="color:#000;font-weight:bold">()</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span></code></pre></div><ol start="6"> |
| <li>Run: Use the <code>run</code> method to execute the above operations.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">builder</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">run</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span></code></pre></div><h4 id="42-retrieval-augmented-generation-rag-based-on-hugegraph">4.2 Retrieval augmented generation (RAG) based on HugeGraph</h4> |
| <h5 id="411-interactive-qa-through-gradio">4.1.1 Interactive Q&amp;A through gradio</h5> |
| <ol> |
| <li>First click the <code>Initialize HugeGraph test data</code> button to initialize the HugeGraph data. |
| <img src="/docs/images/gradio-rag-1.png" alt="gradio-config"></li> |
| <li>Then click the <code>Retrieval augmented generation</code> button to generate the answer to the question. |
| <img src="/docs/images/gradio-rag-2.png" alt="gradio-config"></li> |
| </ol> |
| <h5 id="412-build-graph-rag-through-code">4.1.2 Build Graph RAG through code</h5> |
| <ul> |
| <li>code</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">graph_rag</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">GraphRAG</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">result</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000;font-weight:bold">(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">graph_rag</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">extract_keyword</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">text</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;Tell me about Al Pacino.&#34;</span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">query_graph_for_rag</span><span style="color:#000;font-weight:bold">(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">max_deep</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#0000cf;font-weight:bold">2</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">max_items</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#0000cf;font-weight:bold">30</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">synthesize_answer</span><span style="color:#000;font-weight:bold">()</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">run</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">verbose</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87;font-weight:bold">True</span><span style="color:#000;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">)</span> |
| </span></span></code></pre></div><ol> |
| <li>extract_keyword: Extract keywords and expand synonyms.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">graph_rag</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">extract_keyword</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">text</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#34;Tell me about Al Pacino.&#34;</span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span></code></pre></div><ol start="2"> |
| <li>query_graph_for_rag: Retrieve the corresponding keywords and their multi-degree associated relationships from HugeGraph. |
| <ul> |
| <li>max_deep: The maximum depth of hugegraph retrieval.</li> |
| <li>max_items: The maximum number of results returned by hugegraph.</li> |
| </ul> |
| </li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">graph_rag</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">query_graph_for_rag</span><span style="color:#000;font-weight:bold">(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">max_deep</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#0000cf;font-weight:bold">2</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">max_items</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#0000cf;font-weight:bold">30</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">)</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span></code></pre></div><ol start="3"> |
| <li>synthesize_answer: Summarize the results and organize the language to answer the question.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">graph_rag</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">synthesize_answer</span><span style="color:#000;font-weight:bold">()</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">print_result</span><span style="color:#000;font-weight:bold">()</span> |
| </span></span></code></pre></div><ol start="4"> |
| <li>run: Execute the above operations.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-python" data-lang="python"><span style="display:flex;"><span><span style="color:#000">graph_rag</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">run</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">verbose</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87;font-weight:bold">True</span><span style="color:#000;font-weight:bold">)</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: HugeGraph-Tools Quick Start</title><link>/docs/quickstart/hugegraph-tools/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/quickstart/hugegraph-tools/</guid><description> |
| <h3 id="1-hugegraph-tools-overview">1 HugeGraph-Tools Overview</h3> |
| <p>HugeGraph-Tools is an automated deployment, management and backup/restore component of HugeGraph.</p> |
| <h3 id="2-get-hugegraph-tools">2 Get HugeGraph-Tools</h3> |
| <p>There are two ways to get HugeGraph-Tools:</p> |
| <ul> |
| <li>Download the compiled tarball</li> |
| <li>Clone source code then compile and install</li> |
| </ul> |
| <h4 id="21-download-the-compiled-archive">2.1 Download the compiled archive</h4> |
| <p>Download the latest version of the HugeGraph-Toolchain package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz |
| </span></span><span style="display:flex;"><span>tar zxf *hugegraph*.tar.gz |
| </span></span></code></pre></div><h4 id="22-clone-source-code-to-compile-and-install">2.2 Clone source code to compile and install</h4> |
| <p>Please ensure that the wget command is installed before compiling the source code</p> |
| <p>Download the latest version of the HugeGraph-Tools source package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 1. get from github</span> |
| </span></span><span style="display:flex;"><span>git clone https://github.com/apache/hugegraph-toolchain.git |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 2. get from direct (e.g. here is 1.0.0, please choose the latest version)</span> |
| </span></span><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0-src.tar.gz |
| </span></span></code></pre></div><p>Compile and generate tar package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> hugegraph-tools |
| </span></span><span style="display:flex;"><span>mvn package -DskipTests |
| </span></span></code></pre></div><p>Generate tar package hugegraph-tools-${version}.tar.gz</p> |
| <h3 id="3-how-to-use">3 How to use</h3> |
| <h4 id="31-function-overview">3.1 Function overview</h4> |
| <p>After decompression, enter the hugegraph-tools directory, you can use <code>bin/hugegraph</code> or <code>bin/hugegraph help</code> to view the usage information. mainly divided:</p> |
| <ul> |
| <li>Graph management Type，graph-mode-set、graph-mode-get、graph-list、graph-get and graph-clear</li> |
| <li>Asynchronous task management Type，task-list、task-get、task-delete、task-cancel and task-clear</li> |
| <li>Gremlin Type，gremlin-execute and gremlin-schedule</li> |
| <li>Backup/Restore Type，backup、restore、migrate、schedule-backup and dump</li> |
| <li>Install the deployment Type，deploy、clear、start-all and stop-all</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Usage: hugegraph <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>command<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#204a87">command</span> options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span></code></pre></div><h5 id="32-options-global-variable">3.2 [options]-Global Variable</h5> |
| <p><code>options</code> is a global variable of HugeGraph-Tools, which can be configured in hugegraph-tools/bin/hugegraph, including:</p> |
| <ul> |
| <li>&ndash;graph，HugeGraph-Tools The name of the graph to operate on, the default value is hugegraph</li> |
| <li>&ndash;url，The service address of HugeGraph-Server, the default is http://127.0.0.1:8080</li> |
| <li>&ndash;user，When HugeGraph-Server opens authentication, pass username</li> |
| <li>&ndash;password，When HugeGraph-Server opens authentication, pass the user&rsquo;s password</li> |
| <li>&ndash;timeout，Timeout when connecting to HugeGraph-Server, the default is 30s</li> |
| <li>&ndash;trust-store-file，The path of the certificate file, when &ndash;url uses https, the truststore file used by HugeGraph-Client, the default is empty, which means using the built-in truststore file conf/hugegraph.truststore of hugegraph-tools</li> |
| <li>&ndash;trust-store-password，The password of the certificate file, when &ndash;url uses https, the password of the truststore used by HugeGraph-Client, the default is empty, representing the password of the built-in truststore file of hugegraph-tools</li> |
| </ul> |
| <p>The above global variables can also be set through environment variables. One way is to use export on the command line to set temporary environment variables, which are valid until the command line is closed</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Global Variable</th> |
| <th>Environment Variable</th> |
| <th>Example</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>&ndash;url</td> |
| <td>HUGEGRAPH_URL</td> |
| <td>export HUGEGRAPH_URL=http://127.0.0.1:8080</td> |
| </tr> |
| <tr> |
| <td>&ndash;graph</td> |
| <td>HUGEGRAPH_GRAPH</td> |
| <td>export HUGEGRAPH_GRAPH=hugegraph</td> |
| </tr> |
| <tr> |
| <td>&ndash;user</td> |
| <td>HUGEGRAPH_USERNAME</td> |
| <td>export HUGEGRAPH_USERNAME=admin</td> |
| </tr> |
| <tr> |
| <td>&ndash;password</td> |
| <td>HUGEGRAPH_PASSWORD</td> |
| <td>export HUGEGRAPH_PASSWORD=test</td> |
| </tr> |
| <tr> |
| <td>&ndash;timeout</td> |
| <td>HUGEGRAPH_TIMEOUT</td> |
| <td>export HUGEGRAPH_TIMEOUT=30</td> |
| </tr> |
| <tr> |
| <td>&ndash;trust-store-file</td> |
| <td>HUGEGRAPH_TRUST_STORE_FILE</td> |
| <td>export HUGEGRAPH_TRUST_STORE_FILE=/tmp/trust-store</td> |
| </tr> |
| <tr> |
| <td>&ndash;trust-store-password</td> |
| <td>HUGEGRAPH_TRUST_STORE_PASSWORD</td> |
| <td>export HUGEGRAPH_TRUST_STORE_PASSWORD=xxxx</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>Another way is to set the environment variable in the bin/hugegraph script:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">#!/bin/bash |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Set environment here if needed</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">#export HUGEGRAPH_URL=</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">#export HUGEGRAPH_GRAPH=</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">#export HUGEGRAPH_USERNAME=</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">#export HUGEGRAPH_PASSWORD=</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">#export HUGEGRAPH_TIMEOUT=</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">#export HUGEGRAPH_TRUST_STORE_FILE=</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">#export HUGEGRAPH_TRUST_STORE_PASSWORD=</span> |
| </span></span></code></pre></div><h5 id="33-graph-management-typegraph-mode-setgraph-mode-getgraph-listgraph-get-and-graph-clear">3.3 Graph Management Type，graph-mode-set、graph-mode-get、graph-list、graph-get and graph-clear</h5> |
| <ul> |
| <li>graph-mode-set，set graph restore mode |
| <ul> |
| <li>&ndash;graph-mode or -m, required, specifies the mode to be set, legal values include [NONE, RESTORING, MERGING, LOADING]</li> |
| </ul> |
| </li> |
| <li>graph-mode-get，get graph restore mode</li> |
| <li>graph-list，list all graphs in a HugeGraph-Server</li> |
| <li>graph-get，get a graph and its storage backend type</li> |
| <li>graph-clear，clear all schema and data of a graph |
| <ul> |
| <li>&ndash;confirm-message Or -c, required, delete confirmation information, manual input is required, double confirmation to prevent accidental deletion, &ldquo;I&rsquo;m sure to delete all data&rdquo;, including double quotes</li> |
| </ul> |
| </li> |
| </ul> |
| <blockquote> |
| <p>When you need to restore the backup graph to a new graph, you need to set the graph mode to RESTORING mode; when you need to merge the backup graph into an existing graph, you need to first set the graph mode to MERGING model.</p> |
| </blockquote> |
| <h5 id="34-asynchronous-task-management-typetask-listtask-get-and-task-delete">3.4 Asynchronous task management Type，task-list、task-get and task-delete</h5> |
| <ul> |
| <li>task-list，List the asynchronous tasks in a graph, which can be filtered according to the status of the tasks |
| <ul> |
| <li>&ndash;status，Optional, specify the status of the task to view, i.e. filter tasks by status</li> |
| <li>&ndash;limit，Optional, specify the number of tasks to be obtained, the default is -1, which means to obtain all eligible tasks</li> |
| </ul> |
| </li> |
| <li>task-get，Get detailed information about an asynchronous task |
| <ul> |
| <li>&ndash;task-id，Required, specifies the ID of the asynchronous task</li> |
| </ul> |
| </li> |
| <li>task-delete，Delete information about an asynchronous task |
| <ul> |
| <li>&ndash;task-id，Required, specifies the ID of the asynchronous task</li> |
| </ul> |
| </li> |
| <li>task-cancel，Cancel the execution of an asynchronous task |
| <ul> |
| <li>&ndash;task-id，ID of the asynchronous task to cancel</li> |
| </ul> |
| </li> |
| <li>task-clear，Clean up completed asynchronous tasks |
| <ul> |
| <li>&ndash;force，Optional. When set, it means to clean up all asynchronous tasks. Unfinished ones are canceled first, and then all asynchronous tasks are cleared. By default, only completed asynchronous tasks are cleaned up</li> |
| </ul> |
| </li> |
| </ul> |
| <h5 id="35-gremlin-typegremlin-execute-and-gremlin-schedule">3.5 Gremlin Type，gremlin-execute and gremlin-schedule</h5> |
| <ul> |
| <li>gremlin-execute, send Gremlin statements to HugeGraph-Server to execute query or modification operations, execute synchronously, and return results after completion |
| <ul> |
| <li>&ndash;file or -f, specify the script file to execute, UTF-8 encoding, mutually exclusive with &ndash;script</li> |
| <li>&ndash;script or -s, specifies the script string to execute, mutually exclusive with &ndash;file</li> |
| <li>&ndash;aliases or -a, Gremlin alias settings, the format is: key1=value1,key2=value2,&hellip;</li> |
| <li>&ndash;bindings or -b, Gremlin binding settings, the format is: key1=value1,key2=value2,&hellip;</li> |
| <li>&ndash;language or -l, the language of the Gremlin script, the default is gremlin-groovy</li> |
| </ul> |
| <blockquote> |
| <p>&ndash;file and &ndash;script are mutually exclusive, one of them must be set</p> |
| </blockquote> |
| </li> |
| <li>gremlin-schedule, send Gremlin statements to HugeGraph-Server to perform query or modification operations, asynchronous execution, and return the asynchronous task id immediately after the task is submitted |
| <ul> |
| <li>&ndash;file or -f, specify the script file to execute, UTF-8 encoding, mutually exclusive with &ndash;script</li> |
| <li>&ndash;script or -s, specifies the script string to execute, mutually exclusive with &ndash;file</li> |
| <li>&ndash;bindings or -b, Gremlin binding settings, the format is: key1=value1,key2=value2,&hellip;</li> |
| <li>&ndash;language or -l, the language of the Gremlin script, the default is gremlin-groovy</li> |
| </ul> |
| <blockquote> |
| <p>&ndash;file and &ndash;script are mutually exclusive, one of them must be set</p> |
| </blockquote> |
| </li> |
| </ul> |
| <h5 id="36-backuprestore-type">3.6 Backup/Restore Type</h5> |
| <ul> |
| <li>backup, back up the schema or data in a certain graph out of the HugeGraph system, and store it on the local disk or HDFS in the form of JSON |
| <ul> |
| <li>&ndash;format, the backup format, optional values include [json, text], the default is json</li> |
| <li>&ndash;all-properties, whether to back up all properties of vertices/edges, only valid when &ndash;format is text, default false</li> |
| <li>&ndash;label, the type of vertices/edges to be backed up, only valid when &ndash;format is text, only valid when backing up vertices or edges</li> |
| <li>&ndash;properties, properties of vertices/edges to be backed up, separated by commas, only valid when &ndash;format is text, valid only when backing up vertices or edges</li> |
| <li>&ndash;compress, whether to compress data during backup, the default is true</li> |
| <li>&ndash;directory or -d, the directory to store schema or data, the default is &lsquo;./{graphName}&rsquo; for local directory, and &lsquo;{fs.default.name}/{graphName}&rsquo; for HDFS</li> |
| <li>&ndash;huge-types or -t, the data types to be backed up, separated by commas, the optional value is &lsquo;all&rsquo; or a combination of one or more [vertex, edge, vertex_label, edge_label, property_key, index_label], &lsquo;all&rsquo; Represents all 6 types, namely vertices, edges and all schemas</li> |
| <li>&ndash;log or -l, specify the log directory, the default is the current directory</li> |
| <li>&ndash;retry, specify the number of failed retries, the default is 3</li> |
| <li>&ndash;split-size or -s, specifies the size of splitting vertices or edges when backing up, the default is 1048576</li> |
| <li>-D, use the mode of -Dkey=value to specify dynamic parameters, and specify HDFS configuration items when backing up data to HDFS, for example: -Dfs.default.name=hdfs://localhost:9000</li> |
| </ul> |
| </li> |
| <li>restore, restore schema or data stored in JSON format to a new graph (RESTORING mode) or merge into an existing graph (MERGING mode) |
| <ul> |
| <li>&ndash;directory or -d, the directory to store schema or data, the default is &lsquo;./{graphName}&rsquo; for local directory, and &lsquo;{fs.default.name}/{graphName}&rsquo; for HDFS</li> |
| <li>&ndash;clean, whether to delete the directory specified by &ndash;directory after the recovery map is completed, the default is false</li> |
| <li>&ndash;huge-types or -t, data types to restore, separated by commas, optional value is &lsquo;all&rsquo; or a combination of one or more [vertex, edge, vertex_label, edge_label, property_key, index_label], &lsquo;all&rsquo; Represents all 6 types, namely vertices, edges and all schemas</li> |
| <li>&ndash;log or -l, specify the log directory, the default is the current directory</li> |
| <li>&ndash;retry, specify the number of failed retries, the default is 3</li> |
| <li>-D, use the mode of -Dkey=value to specify dynamic parameters, which are used to specify HDFS configuration items when restoring graphs from HDFS, for example: -Dfs.default.name=hdfs://localhost:9000</li> |
| </ul> |
| <blockquote> |
| <p>restore command can be used only if &ndash;format is executed as backup for json</p> |
| </blockquote> |
| </li> |
| <li>migrate, migrate the currently connected graph to another HugeGraphServer |
| <ul> |
| <li>&ndash;target-graph, the name of the target graph, the default is hugegraph</li> |
| <li>&ndash;target-url, the HugeGraphServer where the target graph is located, the default is http://127.0.0.1:8081</li> |
| <li>&ndash;target-username, the username to access the target map</li> |
| <li>&ndash;target-password, the password to access the target map</li> |
| <li>&ndash;target-timeout, the timeout for accessing the target map</li> |
| <li>&ndash;target-trust-store-file, access the truststore file used by the target graph</li> |
| <li>&ndash;target-trust-store-password, the password to access the truststore used by the target map</li> |
| <li>&ndash;directory or -d, during the migration process, the directory where the schema or data of the source graph is stored. For a local directory, the default is &lsquo;./{graphName}&rsquo;; for HDFS, the default is &lsquo;{fs.default.name}/ {graphName}&rsquo;</li> |
| <li>&ndash;huge-types or -t, the data types to be migrated, separated by commas, the optional value is &lsquo;all&rsquo; or a combination of one or more [vertex, edge, vertex_label, edge_label, property_key, index_label], &lsquo;all&rsquo; Represents all 6 types, namely vertices, edges and all schemas</li> |
| <li>&ndash;log or -l, specify the log directory, the default is the current directory</li> |
| <li>&ndash;retry, specify the number of failed retries, the default is 3</li> |
| <li>&ndash;split-size or -s, specify the size of the vertex or edge block when backing up the source graph during the migration process, the default is 1048576</li> |
| <li>-D, use the mode of -Dkey=value to specify dynamic parameters, which are used to specify HDFS configuration items when the data needs to be backed up to HDFS during the migration process, for example: -Dfs.default.name=hdfs://localhost: 9000</li> |
| <li>&ndash;graph-mode or -m, the mode to set the target graph when restoring the source graph to the target graph, legal values include [RESTORING, MERGING]</li> |
| <li>&ndash;keep-local-data, whether to keep the backup of the source map generated in the process of migrating the map, the default is false, that is, the backup of the source map is not kept after the default migration map ends</li> |
| </ul> |
| </li> |
| <li>schedule-backup, periodically back up the graph and keep a certain number of the latest backups (currently only supports local file systems) |
| <ul> |
| <li>&ndash;directory or -d, required, specifies the directory of the backup data</li> |
| <li>&ndash;backup-num, optional, specifies the number of latest backups to save, defaults to 3</li> |
| <li>&ndash;interval, an optional item, specifies the backup cycle, the format is the same as the Linux crontab format</li> |
| </ul> |
| </li> |
| <li>dump, export all the vertices and edges of the entire graph, and store them in <code>vertex vertex-edge1 vertex-edge2...</code>JSON format by default. |
| Users can also customize the storage format, just need to be in <code>hugegraph-tools/src/main/java/com/baidu/hugegraph/formatter</code> |
| Implement a class inherited from <code>Formatter</code> in the directory, such as <code>CustomFormatter</code>, and specify this class as formatter when using it, for example |
| <code>bin/hugegraph dump -f CustomFormatter</code> |
| <ul> |
| <li>&ndash;formatter or -f, specify the formatter to use, the default is JsonFormatter</li> |
| <li>&ndash;directory or -d, the directory where schema or data is stored, the default is the current directory</li> |
| <li>&ndash;log or -l, specify the log directory, the default is the current directory</li> |
| <li>&ndash;retry, specify the number of failed retries, the default is 3</li> |
| <li>&ndash;split-size or -s, specifies the size of splitting vertices or edges when backing up, the default is 1048576</li> |
| <li>-D, use the mode of -Dkey=value to specify dynamic parameters, and specify HDFS configuration items when backing up data to HDFS, for example: -Dfs.default.name=hdfs://localhost:9000</li> |
| </ul> |
| </li> |
| </ul> |
| <h5 id="37-install-the-deployment-type">3.7 Install the deployment type</h5> |
| <ul> |
| <li>deploy, one-click download, install and start HugeGraph-Server and HugeGraph-Studio |
| <ul> |
| <li>-v, required, specifies the version number of HugeGraph-Server and HugeGraph-Studio installed, the latest is 0.9</li> |
| <li>-p, required, specifies the installed HugeGraph-Server and HugeGraph-Studio directories</li> |
| <li>-u, optional, specifies the link to download the HugeGraph-Server and HugeGraph-Studio compressed packages</li> |
| </ul> |
| </li> |
| <li>clear, clean up HugeGraph-Server and HugeGraph-Studio directories and tarballs |
| <ul> |
| <li>-p, required, specifies the directory of HugeGraph-Server and HugeGraph-Studio to be cleaned</li> |
| </ul> |
| </li> |
| <li>start-all, start HugeGraph-Server and HugeGraph-Studio with one click, and start monitoring, automatically pull up the service when the service dies |
| <ul> |
| <li>-v, required, specifies the version number of HugeGraph-Server and HugeGraph-Studio to be started, the latest is 0.9</li> |
| <li>-p, required, specifies the directory where HugeGraph-Server and HugeGraph-Studio are installed</li> |
| </ul> |
| </li> |
| <li>stop-all, close HugeGraph-Server and HugeGraph-Studio with one click</li> |
| </ul> |
| <blockquote> |
| <p>There is an optional parameter -u in the deploy command. When provided, the specified download address will be used instead of the default download address to download the tar package, and the address will be written into the <code>~/hugegraph-download-url-prefix</code> file; if no address is specified later When -u and <code>~/hugegraph-download-url-prefix</code> are not specified, the tar package will be downloaded from the address specified by <code>~/hugegraph-download-url-prefix</code>; if there is neither -u nor <code>~/hugegraph-download-url-prefix</code>, it will be downloaded from the default download address</p> |
| </blockquote> |
| <h5 id="38-specific-command-parameters">3.8 Specific command parameters</h5> |
| <p>The specific parameters of each subcommand are as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Usage: hugegraph <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span>command<span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#204a87">command</span> options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --graph |
| </span></span><span style="display:flex;"><span> Name of graph |
| </span></span><span style="display:flex;"><span> Default: hugegraph |
| </span></span><span style="display:flex;"><span> --password |
| </span></span><span style="display:flex;"><span> Password of user |
| </span></span><span style="display:flex;"><span> --timeout |
| </span></span><span style="display:flex;"><span> Connection timeout |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">30</span> |
| </span></span><span style="display:flex;"><span> --trust-store-file |
| </span></span><span style="display:flex;"><span> The path of client truststore file used when https protocol is enabled |
| </span></span><span style="display:flex;"><span> --trust-store-password |
| </span></span><span style="display:flex;"><span> The password of the client truststore file used when the https protocol |
| </span></span><span style="display:flex;"><span> is enabled |
| </span></span><span style="display:flex;"><span> --url |
| </span></span><span style="display:flex;"><span> The URL of HugeGraph-Server |
| </span></span><span style="display:flex;"><span> Default: http://127.0.0.1:8080 |
| </span></span><span style="display:flex;"><span> --user |
| </span></span><span style="display:flex;"><span> Name of user |
| </span></span><span style="display:flex;"><span> Commands: |
| </span></span><span style="display:flex;"><span> graph-list List all graphs |
| </span></span><span style="display:flex;"><span> Usage: graph-list |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> graph-get Get graph info |
| </span></span><span style="display:flex;"><span> Usage: graph-get |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> graph-clear Clear graph schema and data |
| </span></span><span style="display:flex;"><span> Usage: graph-clear <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> * --confirm-message, -c |
| </span></span><span style="display:flex;"><span> Confirm message of graph clear is <span style="color:#4e9a06">&#34;I&#39;m sure to delete all data&#34;</span>. |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">(</span>Note: include <span style="color:#4e9a06">&#34;&#34;</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> graph-mode-set Set graph mode |
| </span></span><span style="display:flex;"><span> Usage: graph-mode-set <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> * --graph-mode, -m |
| </span></span><span style="display:flex;"><span> Graph mode, include: <span style="color:#ce5c00;font-weight:bold">[</span>NONE, RESTORING, MERGING<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Possible Values: <span style="color:#ce5c00;font-weight:bold">[</span>NONE, RESTORING, MERGING, LOADING<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> graph-mode-get Get graph mode |
| </span></span><span style="display:flex;"><span> Usage: graph-mode-get |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> task-list List tasks |
| </span></span><span style="display:flex;"><span> Usage: task-list <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --limit |
| </span></span><span style="display:flex;"><span> Limit number, no limit <span style="color:#204a87;font-weight:bold">if</span> not provided |
| </span></span><span style="display:flex;"><span> Default: -1 |
| </span></span><span style="display:flex;"><span> --status |
| </span></span><span style="display:flex;"><span> Status of task |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> task-get Get task info |
| </span></span><span style="display:flex;"><span> Usage: task-get <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> * --task-id |
| </span></span><span style="display:flex;"><span> Task id |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> task-delete Delete task |
| </span></span><span style="display:flex;"><span> Usage: task-delete <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> * --task-id |
| </span></span><span style="display:flex;"><span> Task id |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> task-cancel Cancel task |
| </span></span><span style="display:flex;"><span> Usage: task-cancel <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> * --task-id |
| </span></span><span style="display:flex;"><span> Task id |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> task-clear Clear completed tasks |
| </span></span><span style="display:flex;"><span> Usage: task-clear <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --force |
| </span></span><span style="display:flex;"><span> Force to clear all tasks, cancel all uncompleted tasks firstly, |
| </span></span><span style="display:flex;"><span> and delete all completed tasks |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#204a87">false</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> gremlin-execute Execute Gremlin statements |
| </span></span><span style="display:flex;"><span> Usage: gremlin-execute <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --aliases, -a |
| </span></span><span style="display:flex;"><span> Gremlin aliases, valid format is: <span style="color:#4e9a06">&#39;key1=value1,key2=value2...&#39;</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> --bindings, -b |
| </span></span><span style="display:flex;"><span> Gremlin bindings, valid format is: <span style="color:#4e9a06">&#39;key1=value1,key2=value2...&#39;</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> --file, -f |
| </span></span><span style="display:flex;"><span> Gremlin Script file to be executed, UTF-8 encoded, exclusive to |
| </span></span><span style="display:flex;"><span> --script |
| </span></span><span style="display:flex;"><span> --language, -l |
| </span></span><span style="display:flex;"><span> Gremlin script language |
| </span></span><span style="display:flex;"><span> Default: gremlin-groovy |
| </span></span><span style="display:flex;"><span> --script, -s |
| </span></span><span style="display:flex;"><span> Gremlin script to be executed, exclusive to --file |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> gremlin-schedule Execute Gremlin statements as asynchronous job |
| </span></span><span style="display:flex;"><span> Usage: gremlin-schedule <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --bindings, -b |
| </span></span><span style="display:flex;"><span> Gremlin bindings, valid format is: <span style="color:#4e9a06">&#39;key1=value1,key2=value2...&#39;</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> --file, -f |
| </span></span><span style="display:flex;"><span> Gremlin Script file to be executed, UTF-8 encoded, exclusive to |
| </span></span><span style="display:flex;"><span> --script |
| </span></span><span style="display:flex;"><span> --language, -l |
| </span></span><span style="display:flex;"><span> Gremlin script language |
| </span></span><span style="display:flex;"><span> Default: gremlin-groovy |
| </span></span><span style="display:flex;"><span> --script, -s |
| </span></span><span style="display:flex;"><span> Gremlin script to be executed, exclusive to --file |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> backup Backup graph schema/data. If directory is on HDFS, use -D to |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">set</span> HDFS params. For exmaple: |
| </span></span><span style="display:flex;"><span> -Dfs.default.name<span style="color:#ce5c00;font-weight:bold">=</span>hdfs://localhost:9000 |
| </span></span><span style="display:flex;"><span> Usage: backup <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --all-properties |
| </span></span><span style="display:flex;"><span> All properties to be backup flag |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#204a87">false</span> |
| </span></span><span style="display:flex;"><span> --compress |
| </span></span><span style="display:flex;"><span> compress flag |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#204a87">true</span> |
| </span></span><span style="display:flex;"><span> --directory, -d |
| </span></span><span style="display:flex;"><span> Directory of graph schema/data, default is <span style="color:#4e9a06">&#39;./{graphname}&#39;</span> in |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">local</span> file system or <span style="color:#4e9a06">&#39;{fs.default.name}/{graphname}&#39;</span> in HDFS |
| </span></span><span style="display:flex;"><span> --format |
| </span></span><span style="display:flex;"><span> File format, valid is <span style="color:#ce5c00;font-weight:bold">[</span>json, text<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Default: json |
| </span></span><span style="display:flex;"><span> --huge-types, -t |
| </span></span><span style="display:flex;"><span> Type of schema/data. Concat with <span style="color:#4e9a06">&#39;,&#39;</span> <span style="color:#204a87;font-weight:bold">if</span> more than one. <span style="color:#4e9a06">&#39;all&#39;</span> means |
| </span></span><span style="display:flex;"><span> all vertices, edges and schema, in other words, <span style="color:#4e9a06">&#39;all&#39;</span> equals with |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#39;vertex,edge,vertex_label,edge_label,property_key,index_label&#39;</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">[</span>PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> --label |
| </span></span><span style="display:flex;"><span> Vertex or edge label, only valid when <span style="color:#204a87">type</span> is vertex or edge |
| </span></span><span style="display:flex;"><span> --log, -l |
| </span></span><span style="display:flex;"><span> Directory of log |
| </span></span><span style="display:flex;"><span> Default: ./logs |
| </span></span><span style="display:flex;"><span> --properties |
| </span></span><span style="display:flex;"><span> Vertex or edge properties to backup, only valid when <span style="color:#204a87">type</span> is |
| </span></span><span style="display:flex;"><span> vertex or edge |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">[]</span> |
| </span></span><span style="display:flex;"><span> --retry |
| </span></span><span style="display:flex;"><span> Retry times, default is <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> --split-size, -s |
| </span></span><span style="display:flex;"><span> Split size of shard |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">1048576</span> |
| </span></span><span style="display:flex;"><span> -D |
| </span></span><span style="display:flex;"><span> HDFS config parameters |
| </span></span><span style="display:flex;"><span> Syntax: -Dkey<span style="color:#ce5c00;font-weight:bold">=</span>value |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> schedule-backup Schedule backup task |
| </span></span><span style="display:flex;"><span> Usage: schedule-backup <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --backup-num |
| </span></span><span style="display:flex;"><span> The number of latest backups to keep |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> * --directory, -d |
| </span></span><span style="display:flex;"><span> The directory of backups stored |
| </span></span><span style="display:flex;"><span> --interval |
| </span></span><span style="display:flex;"><span> The interval of backup, format is: <span style="color:#4e9a06">&#34;a b c d e&#34;</span>. <span style="color:#4e9a06">&#39;a&#39;</span> means minute |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">0</span> - 59<span style="color:#ce5c00;font-weight:bold">)</span>, <span style="color:#4e9a06">&#39;b&#39;</span> means hour <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">0</span> - 23<span style="color:#ce5c00;font-weight:bold">)</span>, <span style="color:#4e9a06">&#39;c&#39;</span> means day of month <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">1</span> - |
| </span></span><span style="display:flex;"><span> 31<span style="color:#ce5c00;font-weight:bold">)</span>, <span style="color:#4e9a06">&#39;d&#39;</span> means month <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">1</span> - 12<span style="color:#ce5c00;font-weight:bold">)</span>, <span style="color:#4e9a06">&#39;e&#39;</span> means day of week <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">0</span> - 6<span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">Sunday</span><span style="color:#ce5c00;font-weight:bold">=</span>0<span style="color:#ce5c00;font-weight:bold">)</span>, <span style="color:#4e9a06">&#34;*&#34;</span> means all |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#4e9a06">&#34;0 0 * * *&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> dump Dump graph to files |
| </span></span><span style="display:flex;"><span> Usage: dump <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --directory, -d |
| </span></span><span style="display:flex;"><span> Directory of graph schema/data, default is <span style="color:#4e9a06">&#39;./{graphname}&#39;</span> in |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">local</span> file system or <span style="color:#4e9a06">&#39;{fs.default.name}/{graphname}&#39;</span> in HDFS |
| </span></span><span style="display:flex;"><span> --formatter, -f |
| </span></span><span style="display:flex;"><span> Formatter to customize format of vertex/edge |
| </span></span><span style="display:flex;"><span> Default: JsonFormatter |
| </span></span><span style="display:flex;"><span> --log, -l |
| </span></span><span style="display:flex;"><span> Directory of log |
| </span></span><span style="display:flex;"><span> Default: ./logs |
| </span></span><span style="display:flex;"><span> --retry |
| </span></span><span style="display:flex;"><span> Retry times, default is <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> --split-size, -s |
| </span></span><span style="display:flex;"><span> Split size of shard |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">1048576</span> |
| </span></span><span style="display:flex;"><span> -D |
| </span></span><span style="display:flex;"><span> HDFS config parameters |
| </span></span><span style="display:flex;"><span> Syntax: -Dkey<span style="color:#ce5c00;font-weight:bold">=</span>value |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> restore Restore graph schema/data. If directory is on HDFS, use -D to |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">set</span> HDFS params <span style="color:#204a87;font-weight:bold">if</span> needed. For |
| </span></span><span style="display:flex;"><span> exmaple:-Dfs.default.name<span style="color:#ce5c00;font-weight:bold">=</span>hdfs://localhost:9000 |
| </span></span><span style="display:flex;"><span> Usage: restore <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --clean |
| </span></span><span style="display:flex;"><span> Whether to remove the directory of graph data after restored |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#204a87">false</span> |
| </span></span><span style="display:flex;"><span> --directory, -d |
| </span></span><span style="display:flex;"><span> Directory of graph schema/data, default is <span style="color:#4e9a06">&#39;./{graphname}&#39;</span> in |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">local</span> file system or <span style="color:#4e9a06">&#39;{fs.default.name}/{graphname}&#39;</span> in HDFS |
| </span></span><span style="display:flex;"><span> --huge-types, -t |
| </span></span><span style="display:flex;"><span> Type of schema/data. Concat with <span style="color:#4e9a06">&#39;,&#39;</span> <span style="color:#204a87;font-weight:bold">if</span> more than one. <span style="color:#4e9a06">&#39;all&#39;</span> means |
| </span></span><span style="display:flex;"><span> all vertices, edges and schema, in other words, <span style="color:#4e9a06">&#39;all&#39;</span> equals with |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#39;vertex,edge,vertex_label,edge_label,property_key,index_label&#39;</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">[</span>PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> --log, -l |
| </span></span><span style="display:flex;"><span> Directory of log |
| </span></span><span style="display:flex;"><span> Default: ./logs |
| </span></span><span style="display:flex;"><span> --retry |
| </span></span><span style="display:flex;"><span> Retry times, default is <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> -D |
| </span></span><span style="display:flex;"><span> HDFS config parameters |
| </span></span><span style="display:flex;"><span> Syntax: -Dkey<span style="color:#ce5c00;font-weight:bold">=</span>value |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> migrate Migrate graph |
| </span></span><span style="display:flex;"><span> Usage: migrate <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --directory, -d |
| </span></span><span style="display:flex;"><span> Directory of graph schema/data, default is <span style="color:#4e9a06">&#39;./{graphname}&#39;</span> in |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">local</span> file system or <span style="color:#4e9a06">&#39;{fs.default.name}/{graphname}&#39;</span> in HDFS |
| </span></span><span style="display:flex;"><span> --graph-mode, -m |
| </span></span><span style="display:flex;"><span> Mode used when migrating to target graph, include: <span style="color:#ce5c00;font-weight:bold">[</span>RESTORING, |
| </span></span><span style="display:flex;"><span> MERGING<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Default: RESTORING |
| </span></span><span style="display:flex;"><span> Possible Values: <span style="color:#ce5c00;font-weight:bold">[</span>NONE, RESTORING, MERGING, LOADING<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> --huge-types, -t |
| </span></span><span style="display:flex;"><span> Type of schema/data. Concat with <span style="color:#4e9a06">&#39;,&#39;</span> <span style="color:#204a87;font-weight:bold">if</span> more than one. <span style="color:#4e9a06">&#39;all&#39;</span> means |
| </span></span><span style="display:flex;"><span> all vertices, edges and schema, in other words, <span style="color:#4e9a06">&#39;all&#39;</span> equals with |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#39;vertex,edge,vertex_label,edge_label,property_key,index_label&#39;</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">[</span>PROPERTY_KEY, VERTEX_LABEL, EDGE_LABEL, INDEX_LABEL, VERTEX, EDGE<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> --keep-local-data |
| </span></span><span style="display:flex;"><span> Whether to keep the <span style="color:#204a87">local</span> directory of graph data after restored |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#204a87">false</span> |
| </span></span><span style="display:flex;"><span> --log, -l |
| </span></span><span style="display:flex;"><span> Directory of log |
| </span></span><span style="display:flex;"><span> Default: ./logs |
| </span></span><span style="display:flex;"><span> --retry |
| </span></span><span style="display:flex;"><span> Retry times, default is <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span> --split-size, -s |
| </span></span><span style="display:flex;"><span> Split size of shard |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">1048576</span> |
| </span></span><span style="display:flex;"><span> --target-graph |
| </span></span><span style="display:flex;"><span> The name of target graph to migrate |
| </span></span><span style="display:flex;"><span> Default: hugegraph |
| </span></span><span style="display:flex;"><span> --target-password |
| </span></span><span style="display:flex;"><span> The password of target graph to migrate |
| </span></span><span style="display:flex;"><span> --target-timeout |
| </span></span><span style="display:flex;"><span> The timeout to connect target graph to migrate |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span> --target-trust-store-file |
| </span></span><span style="display:flex;"><span> The trust store file of target graph to migrate |
| </span></span><span style="display:flex;"><span> --target-trust-store-password |
| </span></span><span style="display:flex;"><span> The trust store password of target graph to migrate |
| </span></span><span style="display:flex;"><span> --target-url |
| </span></span><span style="display:flex;"><span> The url of target graph to migrate |
| </span></span><span style="display:flex;"><span> Default: http://127.0.0.1:8081 |
| </span></span><span style="display:flex;"><span> --target-user |
| </span></span><span style="display:flex;"><span> The username of target graph to migrate |
| </span></span><span style="display:flex;"><span> -D |
| </span></span><span style="display:flex;"><span> HDFS config parameters |
| </span></span><span style="display:flex;"><span> Syntax: -Dkey<span style="color:#ce5c00;font-weight:bold">=</span>value |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#ce5c00;font-weight:bold">{}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> deploy Install HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> Usage: deploy <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> * -p |
| </span></span><span style="display:flex;"><span> Install path of HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> -u |
| </span></span><span style="display:flex;"><span> Download url prefix path of HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> * -v |
| </span></span><span style="display:flex;"><span> Version of HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> start-all Start HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> Usage: start-all <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> * -p |
| </span></span><span style="display:flex;"><span> Install path of HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> * -v |
| </span></span><span style="display:flex;"><span> Version of HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> clear Clear HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> Usage: clear <span style="color:#ce5c00;font-weight:bold">[</span>options<span style="color:#ce5c00;font-weight:bold">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> * -p |
| </span></span><span style="display:flex;"><span> Install path of HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> stop-all Stop HugeGraph-Server and HugeGraph-Studio |
| </span></span><span style="display:flex;"><span> Usage: stop-all |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">help</span> Print usage |
| </span></span><span style="display:flex;"><span> Usage: <span style="color:#204a87">help</span> |
| </span></span></code></pre></div><h5 id="39-specific-command-example">3.9 Specific command example</h5> |
| <h6 id="1-gremlin-statement">1. gremlin statement</h6> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Execute gremlin synchronously</span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph gremlin-execute --script <span style="color:#4e9a06">&#39;g.V().count()&#39;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Execute gremlin asynchronously</span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph gremlin-schedule --script <span style="color:#4e9a06">&#39;g.V().count()&#39;</span> |
| </span></span></code></pre></div><h6 id="2-show-task-status">2. Show task status</h6> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list --limit <span style="color:#0000cf;font-weight:bold">5</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph task-list --status success |
| </span></span></code></pre></div><h6 id="3-set-and-show-graph-mode">3. Set and show graph mode</h6> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m RESTORING MERGING NONE |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m RESTORING |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-get |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-list |
| </span></span></code></pre></div><h6 id="4-cleanup-graph">4. Cleanup Graph</h6> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-clear -c <span style="color:#4e9a06">&#34;I&#39;m sure to delete all data&#34;</span> |
| </span></span></code></pre></div><h6 id="5-backup-graph">5. Backup Graph</h6> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph backup -t all --directory ./backup-test |
| </span></span></code></pre></div><h6 id="6-periodic-backup-graph">6. Periodic Backup Graph</h6> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph --interval */2 * * * * schedule-backup -d ./backup-0.10.2 |
| </span></span></code></pre></div><h6 id="7-recovery-graph">7. Recovery Graph</h6> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># set graph mode</span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m RESTORING |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># recovery graph</span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph restore -t all --directory ./backup-test |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># restore graph mode</span> |
| </span></span><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph graph-mode-set -m NONE |
| </span></span></code></pre></div><h6 id="8-graph-migration">8. Graph Migration</h6> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>./bin/hugegraph --url http://127.0.0.1:8080 --graph hugegraph migrate --target-url http://127.0.0.1:8090 --target-graph hugegraph |
| </span></span></code></pre></div></description></item><item><title>Docs: HugeGraph-Computer Quick Start</title><link>/docs/quickstart/hugegraph-computer/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/quickstart/hugegraph-computer/</guid><description> |
| <h2 id="1-hugegraph-computer-overview">1 HugeGraph-Computer Overview</h2> |
| <p>The <a href="https://github.com/apache/incubator-hugegraph-computer"><code>HugeGraph-Computer</code></a> is a distributed graph processing system for HugeGraph (OLAP). It is an implementation of <a href="https://kowshik.github.io/JPregel/pregel_paper.pdf">Pregel</a>. It runs on Kubernetes framework.</p> |
| <h3 id="features">Features</h3> |
| <ul> |
| <li>Support distributed MPP graph computing, and integrates with HugeGraph as graph input/output storage.</li> |
| <li>Based on BSP(Bulk Synchronous Parallel) model, an algorithm performs computing through multiple parallel iterations, every iteration is a superstep.</li> |
| <li>Auto memory management. The framework will never be OOM(Out of Memory) since it will split some data to disk if it doesn&rsquo;t have enough memory to hold all the data.</li> |
| <li>The part of edges or the messages of super node can be in memory, so you will never lose it.</li> |
| <li>You can load the data from HDFS or HugeGraph, or any other system.</li> |
| <li>You can output the results to HDFS or HugeGraph, or any other system.</li> |
| <li>Easy to develop a new algorithm. You just need to focus on a vertex only processing just like as in a single server, without worrying about message transfer and memory/storage management.</li> |
| </ul> |
| <h2 id="2-dependency-for-buildingrunning">2 Dependency for Building/Running</h2> |
| <h3 id="21-install-java-11-jdk-11">2.1 Install Java 11 (JDK 11)</h3> |
| <p><strong>Must</strong> use ≥ <code>Java 11</code> to run <code>Computer</code>, and configure by yourself.</p> |
| <p><strong>Be sure to execute the <code>java -version</code> command to check the jdk version before reading</strong></p> |
| <h2 id="3-get-started">3 Get Started</h2> |
| <h3 id="31-run-pagerank-algorithm-locally">3.1 Run PageRank algorithm locally</h3> |
| <blockquote> |
| <p>To run algorithm with HugeGraph-Computer, you need to install Java 11 or later versions.</p> |
| <p>You also need to deploy HugeGraph-Server and <a href="https://etcd.io/docs/v3.5/quickstart/">Etcd</a>.</p> |
| </blockquote> |
| <p>There are two ways to get HugeGraph-Computer:</p> |
| <ul> |
| <li>Download the compiled tarball</li> |
| <li>Clone source code then compile and package</li> |
| </ul> |
| <h4 id="311-download-the-compiled-archive">3.1.1 Download the compiled archive</h4> |
| <p>Download the latest version of the HugeGraph-Computer release package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>wget https://downloads.apache.org/incubator/hugegraph/<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>/apache-hugegraph-computer-incubating-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>.tar.gz |
| </span></span><span style="display:flex;"><span>tar zxvf apache-hugegraph-computer-incubating-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>.tar.gz -C hugegraph-computer |
| </span></span></code></pre></div><h4 id="312-clone-source-code-to-compile-and-package">3.1.2 Clone source code to compile and package</h4> |
| <p>Clone the latest version of HugeGraph-Computer source package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>$ git clone https://github.com/apache/hugegraph-computer.git |
| </span></span></code></pre></div><p>Compile and generate tar package:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> hugegraph-computer |
| </span></span><span style="display:flex;"><span>mvn clean package -DskipTests |
| </span></span></code></pre></div><h4 id="313-start-master-node">3.1.3 Start master node</h4> |
| <blockquote> |
| <p>You can use <code>-c</code> parameter specify the configuration file, more computer config please see:<a href="/docs/config/config-computer#computer-config-options">Computer Config Options</a></p> |
| </blockquote> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#204a87">cd</span> hugegraph-computer |
| </span></span><span style="display:flex;"><span>bin/start-computer.sh -d <span style="color:#204a87">local</span> -r master |
| </span></span></code></pre></div><h4 id="314-start-worker-node">3.1.4 Start worker node</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>bin/start-computer.sh -d <span style="color:#204a87">local</span> -r worker |
| </span></span></code></pre></div><h4 id="315-query-algorithm-results">3.1.5 Query algorithm results</h4> |
| <p>3.1.5.1 Enable <code>OLAP</code> index query for server</p> |
| <p>If OLAP index is not enabled, it needs to enable, more reference: <a href="/docs/clients/restful-api/graphs/#634-modify-graphs-read-mode-this-operation-requires-administrator-privileges">modify-graphs-read-mode</a></p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-http" data-lang="http"><span style="display:flex;"><span><span style="color:#a40000">PUT http://localhost:8080/graphs/hugegraph/graph_read_mode |
| </span></span></span><span style="display:flex;"><span><span style="color:#a40000"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#a40000">&#34;ALL&#34; |
| </span></span></span></code></pre></div><p>3.1.5.2 Query <code>page_rank</code> property value:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>curl <span style="color:#4e9a06">&#34;http://localhost:8080/graphs/hugegraph/graph/vertices?page&amp;limit=3&#34;</span> <span style="color:#000;font-weight:bold">|</span> gunzip |
| </span></span></code></pre></div><h3 id="32-run-pagerank-algorithm-in-kubernetes">3.2 Run PageRank algorithm in Kubernetes</h3> |
| <blockquote> |
| <p>To run algorithm with HugeGraph-Computer you need to deploy HugeGraph-Server first</p> |
| </blockquote> |
| <h4 id="321-install-hugegraph-computer-crd">3.2.1 Install HugeGraph-Computer CRD</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Kubernetes version &gt;= v1.16</span> |
| </span></span><span style="display:flex;"><span>kubectl apply -f https://raw.githubusercontent.com/apache/hugegraph-computer/master/computer-k8s-operator/manifest/hugegraph-computer-crd.v1.yaml |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Kubernetes version &lt; v1.16</span> |
| </span></span><span style="display:flex;"><span>kubectl apply -f https://raw.githubusercontent.com/apache/hugegraph-computer/master/computer-k8s-operator/manifest/hugegraph-computer-crd.v1beta1.yaml |
| </span></span></code></pre></div><h4 id="322-show-crd">3.2.2 Show CRD</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>kubectl get crd |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>NAME CREATED AT |
| </span></span><span style="display:flex;"><span>hugegraphcomputerjobs.hugegraph.apache.org 2021-09-16T08:01:08Z |
| </span></span></code></pre></div><h4 id="323-install-hugegraph-computer-operatoretcd-server">3.2.3 Install hugegraph-computer-operator&amp;etcd-server</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>kubectl apply -f https://raw.githubusercontent.com/apache/hugegraph-computer/master/computer-k8s-operator/manifest/hugegraph-computer-operator.yaml |
| </span></span></code></pre></div><h4 id="324-wait-for-hugegraph-computer-operatoretcd-server-deployment-to-complete">3.2.4 Wait for hugegraph-computer-operator&amp;etcd-server deployment to complete</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>kubectl get pod -n hugegraph-computer-operator-system |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>NAME READY STATUS RESTARTS AGE |
| </span></span><span style="display:flex;"><span>hugegraph-computer-operator-controller-manager-58c5545949-jqvzl 1/1 Running <span style="color:#0000cf;font-weight:bold">0</span> 15h |
| </span></span><span style="display:flex;"><span>hugegraph-computer-operator-etcd-28lm67jxk5 1/1 Running <span style="color:#0000cf;font-weight:bold">0</span> 15h |
| </span></span></code></pre></div><h4 id="325-submit-job">3.2.5 Submit job</h4> |
| <blockquote> |
| <p>More computer crd please see: <a href="/docs/config/config-computer#hugegraph-computer-crd">Computer CRD</a></p> |
| <p>More computer config please see: <a href="/docs/config/config-computer#computer-config-options">Computer Config Options</a></p> |
| </blockquote> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#000">cat &lt;&lt;EOF | kubectl apply --filename -</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph.apache.org/v1</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">HugeGraphComputerJob</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">namespace</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph-computer-operator-system</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">&amp;jobName</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">pagerank-sample</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">spec</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">jobId</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">*jobName</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">algorithmName</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">page_rank</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">image</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph/hugegraph-computer:latest</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># algorithm image url</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">jarFile</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">/hugegraph/hugegraph-computer/algorithm/builtin-algorithm.jar</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># algorithm jar path</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">pullPolicy</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Always</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">workerCpu</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;4&#34;</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">workerMemory</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;4Gi&#34;</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">workerInstances</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">5</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">computerConf</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">job.partitions_count</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;20&#34;</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">algorithm.params_class</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.hugegraph.computer.algorithm.centrality.pagerank.PageRankParams</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">hugegraph.url</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">http://${hugegraph-server-host}:${hugegraph-server-port}</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># hugegraph server url</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">hugegraph.name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">hugegraph</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># hugegraph graph name</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#000">EOF</span><span style="color:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><h4 id="326-show-job">3.2.6 Show job</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>kubectl get hcjob/pagerank-sample -n hugegraph-computer-operator-system |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>NAME JOBID JOBSTATUS |
| </span></span><span style="display:flex;"><span>pagerank-sample pagerank-sample RUNNING |
| </span></span></code></pre></div><h4 id="327-show-log-of-nodes">3.2.7 Show log of nodes</h4> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Show the master log</span> |
| </span></span><span style="display:flex;"><span>kubectl logs -l <span style="color:#000">component</span><span style="color:#ce5c00;font-weight:bold">=</span>pagerank-sample-master -n hugegraph-computer-operator-system |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Show the worker log</span> |
| </span></span><span style="display:flex;"><span>kubectl logs -l <span style="color:#000">component</span><span style="color:#ce5c00;font-weight:bold">=</span>pagerank-sample-worker -n hugegraph-computer-operator-system |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># Show diagnostic log of a job</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># NOTE: diagnostic log exist only when the job fails, and it will only be saved for one hour.</span> |
| </span></span><span style="display:flex;"><span>kubectl get event --field-selector <span style="color:#000">reason</span><span style="color:#ce5c00;font-weight:bold">=</span>ComputerJobFailed --field-selector involvedObject.name<span style="color:#ce5c00;font-weight:bold">=</span>pagerank-sample -n hugegraph-computer-operator-system |
| </span></span></code></pre></div><h4 id="328-show-success-event-of-a-job">3.2.8 Show success event of a job</h4> |
| <blockquote> |
| <p>NOTE: it will only be saved for one hour</p> |
| </blockquote> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>kubectl get event --field-selector <span style="color:#000">reason</span><span style="color:#ce5c00;font-weight:bold">=</span>ComputerJobSucceed --field-selector involvedObject.name<span style="color:#ce5c00;font-weight:bold">=</span>pagerank-sample -n hugegraph-computer-operator-system |
| </span></span></code></pre></div><h4 id="329-query-algorithm-results">3.2.9 Query algorithm results</h4> |
| <p>If the output to <code>Hugegraph-Server</code> is consistent with Locally, if output to <code>HDFS</code>, please check the result file in the directory of <code>/hugegraph-computer/results/{jobId}</code> directory.</p> |
| <h2 id="4-built-in-algorithms-document">4 Built-In algorithms document</h2> |
| <h3 id="41-supported-algorithms-list">4.1 Supported algorithms list:</h3> |
| <h6 id="centrality-algorithm">Centrality Algorithm:</h6> |
| <ul> |
| <li>PageRank</li> |
| <li>BetweennessCentrality</li> |
| <li>ClosenessCentrality</li> |
| <li>DegreeCentrality</li> |
| </ul> |
| <h6 id="community-algorithm">Community Algorithm:</h6> |
| <ul> |
| <li>ClusteringCoefficient</li> |
| <li>Kcore</li> |
| <li>Lpa</li> |
| <li>TriangleCount</li> |
| <li>Wcc</li> |
| </ul> |
| <h6 id="path-algorithm">Path Algorithm:</h6> |
| <ul> |
| <li>RingsDetection</li> |
| <li>RingsDetectionWithFilter</li> |
| </ul> |
| <p>More algorithms please see: <a href="https://github.com/apache/hugegraph-computer/tree/master/computer-algorithm/src/main/java/org/apache/hugegraph/computer/algorithm">Built-In algorithms</a></p> |
| <h3 id="42-algorithm-describe">4.2 Algorithm describe</h3> |
| <p>TODO</p> |
| <h2 id="5-algorithm-development-guide">5 Algorithm development guide</h2> |
| <p>TODO</p> |
| <h2 id="6-note">6 Note</h2> |
| <ul> |
| <li>If some classes under computer-k8s cannot be found, you need to execute <code>mvn compile</code> in advance to generate corresponding classes.</li> |
| </ul></description></item></channel></rss> |
