| <!doctype html> |
| <html lang="cn" class="no-js"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> |
| <meta name="generator" content="Hugo 0.95.0" /> |
| <link rel="canonical" type="text/html" href="/cn/docs/"> |
| <link rel="alternate" type="application/rss+xml" href="/cn/docs/index.xml"> |
| <meta name="robots" content="noindex, nofollow"> |
| |
| |
| <link rel="shortcut icon" href="/favicons/favicon.ico" > |
| <link rel="apple-touch-icon" href="/favicons/apple-touch-icon-180x180.png" sizes="180x180"> |
| <link rel="icon" type="image/png" href="/favicons/favicon-16x16.png" sizes="16x16"> |
| <link rel="icon" type="image/png" href="/favicons/favicon-32x32.png" sizes="32x32"> |
| <link rel="icon" type="image/png" href="/favicons/android-36x36.png" sizes="36x36"> |
| <link rel="icon" type="image/png" href="/favicons/android-48x48.png" sizes="48x48"> |
| <link rel="icon" type="image/png" href="/favicons/android-72x72.png" sizes="72x72"> |
| <link rel="icon" type="image/png" href="/favicons/android-96x96.png" sizes="96x96"> |
| <link rel="icon" type="image/png" href="/favicons/android-144x144.png" sizes="144x144"> |
| <link rel="icon" type="image/png" href="/favicons/android-192x192.png" sizes="192x192"> |
| |
| <title>Documentation | HugeGraph</title> |
| <meta name="description" content="欢迎阅读HugeGraph文档 |
| "> |
| <meta property="og:title" content="Documentation" /> |
| <meta property="og:description" content="Apache HugeGraph 官网" /> |
| <meta property="og:type" content="website" /> |
| <meta property="og:url" content="/cn/docs/" /><meta property="og:site_name" content="HugeGraph" /> |
| |
| <meta itemprop="name" content="Documentation"> |
| <meta itemprop="description" content="Apache HugeGraph 官网"><meta name="twitter:card" content="summary"/> |
| <meta name="twitter:title" content="Documentation"/> |
| <meta name="twitter:description" content="Apache HugeGraph 官网"/> |
| |
| |
| |
| |
| <link rel="preload" href="/scss/main.min.0dc89c707c94a8edbf7722b8ffab87c78b14c4c3e2532e1f45bd6d12c3ccf83b.css" as="style"> |
| <link href="/scss/main.min.0dc89c707c94a8edbf7722b8ffab87c78b14c4c3e2532e1f45bd6d12c3ccf83b.css" rel="stylesheet" integrity=""> |
| |
| <script |
| src="https://code.jquery.com/jquery-3.5.1.min.js" |
| integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" |
| crossorigin="anonymous"></script> |
| <link rel="stylesheet" href="/css/prism.css"/> |
| |
| <script type="application/javascript"> |
| var doNotTrack = false; |
| if (!doNotTrack) { |
| window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; |
| ga('create', 'UA-00000000-0', 'auto'); |
| |
| ga('send', 'pageview'); |
| } |
| </script> |
| <script async src='https://www.google-analytics.com/analytics.js'></script> |
| |
| </head> |
| <body class="td-section"> |
| <header> |
| |
| <nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar"> |
| <a class="navbar-brand" href="/cn/"> |
| <span class="navbar-logo"><svg id="图层_1" data-name="图层 1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 16 16"><defs><style>.cls-1{fill:none;stroke:#fff;stroke-miterlimit:10;stroke-width:.5px;opacity:.3}.cls-2{fill:#229efa}.cls-3{fill:#9948f7}.cls-4{fill:#33bc7a}.cls-5{fill:url(#未命名的渐变_3)}.cls-6{fill:url(#未命名的渐变_13)}.cls-7{fill:url(#未命名的渐变_11)}</style><linearGradient id="未命名的渐变_3" x1="6.16" y1="14.63" x2="6.16" y2="6.01" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#2e3192"/><stop offset="0" stop-color="#229efa"/><stop offset=".44" stop-color="#239cf8"/><stop offset=".6" stop-color="#2795f2"/><stop offset=".71" stop-color="#2d8ae8"/><stop offset=".81" stop-color="#3679d9"/><stop offset=".89" stop-color="#4263c6"/><stop offset=".95" stop-color="#5048af"/><stop offset="1" stop-color="#5c319b"/></linearGradient><linearGradient id="未命名的渐变_13" x1="10.75" y1="8.2" x2="4.49" y2="1.94" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#991146"/><stop offset="0" stop-color="#326b4e"/><stop offset=".02" stop-color="#3a685c"/><stop offset=".07" stop-color="#506180"/><stop offset=".13" stop-color="#645aa0"/><stop offset=".19" stop-color="#7554bc"/><stop offset=".26" stop-color="#8250d2"/><stop offset=".35" stop-color="#8d4ce3"/><stop offset=".45" stop-color="#944aee"/><stop offset=".6" stop-color="#9848f5"/><stop offset="1" stop-color="#9948f7"/></linearGradient><linearGradient id="未命名的渐变_11" x1="15.34" y1="6.67" x2="7.88" y2="10.98" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#33bc7a"/><stop offset=".45" stop-color="#32ba7a"/><stop offset=".61" stop-color="#2fb37c"/><stop offset=".73" stop-color="#29a87e"/><stop offset=".82" stop-color="#219782"/><stop offset=".9" stop-color="#168186"/><stop offset=".97" stop-color="#09668b"/><stop offset="1" stop-color="#03598e"/></linearGradient></defs><title>logo</title><rect class="cls-1" x="-143.14" y="-373.46" width="597.8" height="424.44"/><circle class="cls-2" cx="12.02" cy="1.83" r="1.33"/><circle class="cls-3" cx="12.02" cy="14.17" r="1.33"/><circle class="cls-4" cx="1.33" cy="8" r="1.33"/><path class="cls-5" d="M7.91 10h0a2.65 2.65.0 01-.23-3.74A1.75 1.75.0 017.91 6h0A2.66 2.66.0 014.4 6h0a1.81 1.81.0 01.24.24A2.65 2.65.0 014.4 10h0a2.62 2.62.0 00-.89 2 2.65 2.65.0 104.4-2z"/><path class="cls-6" d="M12.19 5.49a2.78 2.78.0 01-.5.11A2.64 2.64.0 018.76 3.5h0a2.65 2.65.0 10-2.6 3.17A2.6 2.6.0 007 6.53H7a2.65 2.65.0 013.44 2 2.94 2.94.0 010-.51 2.65 2.65.0 011.75-2.53z"/><path class="cls-7" d="M13 5.35a2.64 2.64.0 00-2.59 2.12h0a3 3 0 01-.08.32A2.65 2.65.0 017.54 9.58a2.86 2.86.0 00.37.41h0a2.63 2.63.0 01.9 2 2.84 2.84.0 01-.05.51 2.64 2.64.0 013.12-2.06l.32.08h0a2.6 2.6.0 00.84.14 2.65 2.65.0 100-5.3z"/></svg></span><span class="font-weight-bold">HugeGraph</span> |
| </a> |
| <div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar"> |
| <ul class="navbar-nav mt-2 mt-lg-0"> |
| |
| |
| |
| <li class="nav-item mr-4 mb-2 mb-lg-0"> |
| |
| |
| |
| |
| |
| |
| <a class="nav-link" href="/cn/docs/" ><i class='fas fa-book pr-2'></i><span>Documentation</span></a> |
| </li> |
| |
| |
| |
| <li class="nav-item mr-4 mb-2 mb-lg-0"> |
| |
| |
| |
| |
| |
| |
| <a class="nav-link" href="https://github.com/apache/incubator-hugegraph" target="_blank" ><i class='fab fa-github pr-2'></i><span>GitHub</span></a> |
| </li> |
| |
| |
| |
| |
| |
| <li class="nav-item mr-4 mb-2 mb-lg-0"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a class="nav-link" href="/cn/community/" ><span>Community</span></a> |
| </li> |
| |
| |
| |
| |
| |
| |
| <li class="nav-item dropdown mr-4 d-none d-lg-block"> |
| |
| |
| <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> |
| 中文 |
| </a> |
| <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink"> |
| |
| <a class="dropdown-item" href="/docs/">English</a> |
| |
| </div> |
| </li> |
| |
| </ul> |
| </div> |
| <div class="navbar-nav d-none d-lg-block"></div> |
| </nav> |
| |
| </header> |
| <div class="container-fluid td-outer"> |
| <div class="td-main"> |
| <div class="row flex-xl-nowrap"> |
| <main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main"> |
| |
| |
| |
| |
| |
| <div class="td-content"> |
| <div class="pageinfo pageinfo-primary d-print-none"> |
| <p> |
| This is the multi-page printable view of this section. |
| <a href="#" onclick="print();return false;">Click here to print</a>. |
| </p><p> |
| <a href="/cn/docs/">Return to the regular view of this page</a>. |
| </p> |
| </div> |
| |
| |
| |
| <h1 class="title">Documentation</h1> |
| |
| |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>1: <a href="#pg-7dd24b6126e5b249f96de862bfc51025">Introduction with HugeGraph</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>2: <a href="#pg-64d47cfe1880443239e7c31f8fd1ac1a">Download HugeGraph</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>3: <a href="#pg-08b1b69f6319108b0455d24614fdd660">Quick Start</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>3.1: <a href="#pg-8ec2ee5fd8ff8e48255d55eab65d92b6">HugeGraph-Server Quick Start</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>3.2: <a href="#pg-685a02f8811d86f1ce195d7c73d9ea44">HugeGraph-Loader Quick Start</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>3.3: <a href="#pg-06d4cae527789fcda01ebf4e48c6559f">HugeGraph-Tools Quick Start</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>3.4: <a href="#pg-751ed124ec6dbb96d5e65c62dc9d4e85">HugeGraph-Hubble Quick Start</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>3.5: <a href="#pg-9cbf1b01e876dc8cdc2da1c17759eed3">HugeGraph-Client Quick Start</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>3.6: <a href="#pg-5721a0e0f2e5d89617d19f04a6a14d16">HugeGraph-Spark Quick Start</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>4: <a href="#pg-5074334c73aa450364a31470231ebff8">Config</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>4.1: <a href="#pg-af7e8f1dc385b255c4f38b3cbafe224a">HugeGraph 配置</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>4.2: <a href="#pg-6bfbb2db4e1f281942d741cef305e724">HugeGraph 配置项</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>4.3: <a href="#pg-7d189549d4201521c83e0d93a2474a2d">HugeGraph 内置用户权限与扩展权限配置及使用</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>4.4: <a href="#pg-7e400260398a18d0be72b1fe5a73f419">配置 HugeGraphServer 使用 https 协议</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>5: <a href="#pg-8f8368cdf9ec684d30761c6d28a34179">API</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1: <a href="#pg-a809bf70d5493b5046619919800e4de6">HugeGraph RESTful API</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.1: <a href="#pg-698c3217de07a8cb0dc0e93dbae29ee9">Schema API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.2: <a href="#pg-f7f4b3b6f4b7a965f8c30675df8e56f8">PropertyKey API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.3: <a href="#pg-28cb205879be97a55ddc8cd365c4438e">VertexLabel API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.4: <a href="#pg-41864d99c39fc7040549f6eaf5441daf">EdgeLabel API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.5: <a href="#pg-7099742fb947ad5dfde9e72216c10b8a">IndexLabel API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.6: <a href="#pg-bde129922f801ad9560757fcec64d05c">Rebuild API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.7: <a href="#pg-86bf520fd6b098231f4af6590328e871">Vertex API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.8: <a href="#pg-f40127b155ddd802d50c507ff1cf5530">Edge API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.9: <a href="#pg-f0adc653be0b454ce1952bdaf0afefa6">Traverser API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.10: <a href="#pg-ced5167413a6606a537e40b18f6fec3e">Rank API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.11: <a href="#pg-32aff6fa72d51caa846c2a72e5771c5d">Variable API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.12: <a href="#pg-3d75cf337650cd90a617c3ef7e9dca87">Graphs API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.13: <a href="#pg-d9de752e44e3a8a709d187e4101fd818">Task API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.14: <a href="#pg-e84b0f106294b580ca64918b72cc71d1">Gremlin API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.15: <a href="#pg-a3b125f257052209fcb98300d5c066a7">Authentication API</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.1.16: <a href="#pg-8e126d4f2f7317a1268d7edb65cd4fcc">Other API</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>5.2: <a href="#pg-3457a7585a93814fdbb1a44b68edc0d3">HugeGraph Java Client</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>5.3: <a href="#pg-1ebf9ecb86d8a6b8536fd581e696ce8c">Gremlin-Console</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>6: <a href="#pg-d2c6535126cca927d2a9c893abde92a0">GUIDES</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>6.1: <a href="#pg-dcb89d888ea6f4146ace522d76fe2776">HugeGraph Architecture Overview</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>6.2: <a href="#pg-3d0f9ef831ef5d7d11acfb09140359fa">HugeGraph Design Concepts</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>6.3: <a href="#pg-96a920d19e01666d95eded506d502ab4">HugeGraph Plugin机制及插件扩展流程</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>6.4: <a href="#pg-2c9db416c8d78f898d52c91ec12535d4">Backup Restore</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>6.5: <a href="#pg-3465b699399f48689cdc6b5e59a10d69">FAQ</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>7: <a href="#pg-3ed7a32fc6a58bb9d03dcd00dc874ba8">QUERY LANGUAGE</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>7.1: <a href="#pg-2696905b5b6cbdf2ad7f78085bd6baa9">HugeGraph Gremlin</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>7.2: <a href="#pg-29164f631ea2ad7e883c0ba00a843508">HugeGraph Examples</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>8: <a href="#pg-f0a22a813c843322c0d360d952e434ce">PERFORMANCE</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>8.1: <a href="#pg-63f6d63db3ee3a5270fc1ca0a0c0e181">HugeGraph BenchMark Performance</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>8.2: <a href="#pg-699ebe5daed825049424b7539aad30f9">HugeGraph-API Performance</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>8.2.1: <a href="#pg-dbfafc29a5e930415f78f72c47ee67f2">v0.5.6 Stand-alone(RocksDB)</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>8.2.2: <a href="#pg-fd5b165e28a07f1c35ab177b10e15dc8">v0.5.6 Cluster(Cassandra)</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>8.2.3: <a href="#pg-0005aca20e30ef2795411939ccbf0fd9">v0.4.4</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>8.2.4: <a href="#pg-d4233a3feb070643ef5d54a6f9c12cab">v0.2</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>8.3: <a href="#pg-8e73cd18ae7e460700391440de46c404">HugeGraph-Loader Performance</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>8.4: <a href="#pg-0b6ebbdbce17d47f26fcb874226e5edc"></a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>9: <a href="#pg-d9ec0777c4f7a8a41476a65f2ecca6f7">CHANGELOGS</a></li> |
| |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li>9.1: <a href="#pg-6b37a0af49c5e6b45aeac03f2a71eab6">HugeGraph 0.12 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.2: <a href="#pg-8ae4f43f2b0af1988d9f0a8cb3b1c073">HugeGraph 0.11 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.3: <a href="#pg-55638b919c2ec7668f5d3de2de0842d7">HugeGraph 0.10 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.4: <a href="#pg-5d75039168e433749fe461b9e0194290">HugeGraph 0.9 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.5: <a href="#pg-f98fd193653a4b93fb4b460f9f1333f8">HugeGraph 0.8 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.6: <a href="#pg-d2f7c78812d582db588f4a926a665a30">HugeGraph 0.7 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.7: <a href="#pg-a40680f3cb756d27c8ad790330229be2">HugeGraph 0.6 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.8: <a href="#pg-04bf2aaf34cd0b77f14833dec809fab4">HugeGraph 0.5 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.9: <a href="#pg-f3de79fd20e587ee8e2ed9c14e6b546e">HugeGraph 0.4.4 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.10: <a href="#pg-ac8684ea0cd7198b6b256e2e5df6b75f">HugeGraph 0.3.3 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.11: <a href="#pg-3eb16892048936d4f8440f9216d11b41">HugeGraph 0.2 Release Notes</a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>9.12: <a href="#pg-add34161ef49858de8d3ba17c475406f">HugeGraph 0.2.4 Release Notes</a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <li>10: <a href="#pg-dad363871d9408c4438794858aa44f57"></a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>11: <a href="#pg-01c617939d9e21dc19567e8753d6fd3b"></a></li> |
| |
| |
| |
| |
| |
| |
| |
| <li>12: <a href="#pg-a395eab4dc054c73b0174216cfbeaf1a"></a></li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| <div class="content"> |
| <p>欢迎阅读HugeGraph文档</p> |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style=""> |
| |
| <h1 id="pg-7dd24b6126e5b249f96de862bfc51025">1 - Introduction with HugeGraph</h1> |
| |
| <h3 id="summary">Summary</h3> |
| <p>HugeGraph是一款易用、高效、通用的开源图数据库系统（Graph Database，<a href="https://github.com/hugegraph/hugegraph">GitHub项目地址</a>）， |
| 实现了<a href="https://tinkerpop.apache.org">Apache TinkerPop3</a>框架及完全兼容<a href="https://tinkerpop.apache.org/gremlin.html">Gremlin</a>查询语言， |
| 具备完善的工具链组件，助力用户轻松构建基于图数据库之上的应用和产品。HugeGraph支持百亿以上的顶点和边快速导入，并提供毫秒级的关联关系查询能力（OLTP）， |
| 并可与Hadoop、Spark等大数据平台集成以进行离线分析（OLAP）。</p> |
| <p>HugeGraph典型应用场景包括深度关系探索、关联分析、路径搜索、特征抽取、数据聚类、社区检测、 |
| 知识图谱等，适用业务领域有如网络安全、电信诈骗、金融风控、广告推荐、社交网络和智能机器人等。</p> |
| <p>本系统的主要应用场景是解决反欺诈、威胁情报、黑产打击等业务的图数据存储和建模分析需求，在此基础上逐步扩展及支持了更多的通用图应用。</p> |
| <h3 id="features">Features</h3> |
| <p>HugeGraph支持在线及离线环境下的图操作，支持批量导入数据，支持高效的复杂关联关系分析，并且能够与大数据平台无缝集成。 |
| HugeGraph支持多用户并行操作，用户可输入Gremlin查询语句，并及时得到图查询结果，也可在用户程序中调用HugeGraph API进行图分析或查询。</p> |
| <p>本系统具备如下特点：</p> |
| <ul> |
| <li>易用：HugeGraph支持Gremlin图查询语言与RESTful API，同时提供图检索常用接口，具备功能齐全的周边工具，轻松实现基于图的各种查询分析运算。</li> |
| <li>高效：HugeGraph在图存储和图计算方面做了深度优化，提供多种批量导入工具，轻松完成百亿级数据快速导入，通过优化过的查询达到图检索的毫秒级响应。支持数千用户并发的在线实时操作。</li> |
| <li>通用：HugeGraph支持Apache Gremlin标准图查询语言和Property Graph标准图建模方法，支持基于图的OLTP和OLAP方案。集成Apache Hadoop及Apache Spark大数据平台。</li> |
| <li>可扩展：支持分布式存储、数据多副本及横向扩容，内置多种后端存储引擎，也可插件式轻松扩展后端存储引擎。</li> |
| <li>开放：HugeGraph代码开源（Apache 2 License），客户可自主修改定制，选择性回馈开源社区。</li> |
| </ul> |
| <p>本系统的功能包括但不限于：</p> |
| <ul> |
| <li>支持从多数据源批量导入数据(包括本地文件、HDFS文件、MySQL数据库等数据源)，支持多种文件格式导入(包括TXT、CSV、JSON等格式)</li> |
| <li>具备可视化操作界面，可用于操作、分析及展示图，降低用户使用门槛</li> |
| <li>优化的图接口：最短路径(Shortest Path)、K步连通子图(K-neighbor)、K步到达邻接点(K-out)、个性化推荐算法PersonalRank等</li> |
| <li>基于Apache TinkerPop3框架实现，支持Gremlin图查询语言</li> |
| <li>支持属性图，顶点和边均可添加属性，支持丰富的属性类型</li> |
| <li>具备独立的Schema元数据信息，拥有强大的图建模能力，方便第三方系统集成</li> |
| <li>支持多顶点ID策略：支持主键ID、支持自动生成ID、支持用户自定义字符串ID、支持用户自定义数字ID</li> |
| <li>可以对边和顶点的属性建立索引，支持精确查询、范围查询、全文检索</li> |
| <li>存储系统采用插件方式，支持RocksDB、Cassandra、ScyllaDB、HBase、MySQL、PostgreSQL、Palo以及InMemory等</li> |
| <li>与Hadoop、Spark GraphX等大数据系统集成，支持Bulk Load操作</li> |
| <li>支持高可用HA、数据多副本、备份恢复、监控等</li> |
| </ul> |
| <h3 id="modules">Modules</h3> |
| <ul> |
| <li><a href="/docs/quickstart/hugegraph-server">HugeGraph-Server</a>: HugeGraph-Server是HugeGraph项目的核心部分，包含Core、Backend、API等子模块； |
| <ul> |
| <li>Core：图引擎实现，向下连接Backend模块，向上支持API模块；</li> |
| <li>Backend：实现将图数据存储到后端，支持的后端包括：Memory、Cassandra、ScyllaDB、RocksDB、HBase、MySQL及PostgreSQL，用户根据实际情况选择一种即可；</li> |
| <li>API：内置REST Server，向用户提供RESTful API，同时完全兼容Gremlin查询。</li> |
| </ul> |
| </li> |
| <li><a href="/docs/quickstart/hugegraph-client">HugeGraph-Client</a>：HugeGraph-Client提供了RESTful API的客户端，用于连接HugeGraph-Server，目前仅实现Java版，其他语言用户可自行实现；</li> |
| <li><a href="/docs/quickstart/hugegraph-loader">HugeGraph-Loader</a>：HugeGraph-Loader是基于HugeGraph-Client的数据导入工具，将普通文本数据转化为图形的顶点和边并插入图形数据库中；</li> |
| <li><a href="/docs/quickstart/hugegraph-spark">HugeGraph-Spark</a>：HugeGraph-Spark能在图上做并行计算，例如PageRank算法等；</li> |
| <li><a href="/docs/quickstart/hugegraph-hubble">HugeGraph-Hubble</a>：HugeGraph-Hubble是HugeGraph的Web可视化管理平台，一站式可视化分析平台，平台涵盖了从数据建模，到数据快速导入，再到数据的在线、离线分析、以及图的统一管理的全过程；</li> |
| <li><a href="/docs/quickstart/hugegraph-tools">HugeGraph-Tools</a>：HugeGraph-Tools是HugeGraph的部署和管理工具，包括管理图、备份/恢复、Gremlin执行等功能。</li> |
| </ul> |
| <h3 id="contact-us">Contact Us</h3> |
| <ul> |
| <li><a href="https://github.com/apache/incubator-hugegraph/issues">Github Issues</a>: 反馈使用问题与功能需求 (优先使用)</li> |
| <li>反馈邮箱：<a href="mailto:hugegraph@googlegroups.com">hugegraph@googlegroups.com</a></li> |
| <li>微信公众号：HugeGraph</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-64d47cfe1880443239e7c31f8fd1ac1a">2 - Download HugeGraph</h1> |
| |
| <h3 id="latest-version">Latest version</h3> |
| <p>The latest HugeGraph: <strong>0.12.0</strong>, released on <em>2021-12-31</em>.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>components</th> |
| <th>description</th> |
| <th>download</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>HugeGraph-Server</td> |
| <td>HugeGraph的主程序</td> |
| <td><a href="https://github.com/hugegraph/hugegraph/releases/download/v0.12.0/hugegraph-0.12.0.tar.gz">0.12.0</a></td> |
| </tr> |
| <tr> |
| <td>HugeGraph-Hubble</td> |
| <td>基于Web的可视化图形界面</td> |
| <td><a href="https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.6.0/hugegraph-hubble-1.6.0.tar.gz">1.6.0</a></td> |
| </tr> |
| <tr> |
| <td>HugeGraph-Loader</td> |
| <td>数据导入工具</td> |
| <td><a href="https://github.com/hugegraph/hugegraph-loader/releases/download/v0.12.0/hugegraph-loader-0.12.0.tar.gz">0.12.0</a></td> |
| </tr> |
| <tr> |
| <td>HugeGraph-Tools</td> |
| <td>命令行工具集</td> |
| <td><a href="https://github.com/hugegraph/hugegraph-tools/releases/download/v1.6.0/hugegraph-tools-1.6.0.tar.gz">1.6.0</a></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="versions-mapping">Versions mapping</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>server</th> |
| <th>client</th> |
| <th>loader</th> |
| <th>hubble</th> |
| <th>common</th> |
| <th>tools</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a href="https://github.com/hugegraph/hugegraph/releases/download/v0.12.0/hugegraph-0.12.0.tar.gz">0.12.0</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/2.0.1">2.0.1</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-loader/releases/download/v0.12.0/hugegraph-loader-0.12.0.tar.gz">0.12.0</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.6.0/hugegraph-hubble-1.6.0.tar.gz">1.6.0</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-common/2.0.1">2.0.1</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-tools/releases/download/v1.6.0/hugegraph-tools-1.6.0.tar.gz">1.6.0</a></td> |
| </tr> |
| <tr> |
| <td><a href="https://github.com/hugegraph/hugegraph/releases/download/v0.11.2/hugegraph-0.11.2.tar.gz">0.11.2</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.9.1">1.9.1</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-loader/releases/download/v0.11.1/hugegraph-loader-0.11.1.tar.gz">0.11.1</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-hubble/releases/download/v1.5.0/hugegraph-hubble-1.5.0.tar.gz">1.5.0</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-common/1.8.1">1.8.1</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-tools/releases/download/v1.5.0/hugegraph-tools-1.5.0.tar.gz">1.5.0</a></td> |
| </tr> |
| <tr> |
| <td><a href="https://github.com/hugegraph/hugegraph/releases/download/v0.10.4/hugegraph-0.10.4.tar.gz">0.10.4</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.8.0">1.8.0</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-loader/releases/download/v0.10.1/hugegraph-loader-0.10.1.tar.gz">0.10.1</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-studio/releases/download/v0.10.0/hugegraph-studio-0.10.0.tar.gz">0.10.0</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-common/1.6.16">1.6.16</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-tools/releases/download/v1.4.0/hugegraph-tools-1.4.0.tar.gz">1.4.0</a></td> |
| </tr> |
| <tr> |
| <td><a href="https://github.com/hugegraph/hugegraph/releases/download/v0.9.2/hugegraph-0.9.2.tar.gz">0.9.2</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.7.0">1.7.0</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-loader/releases/download/v0.9.0/hugegraph-loader-0.9.0.tar.gz">0.9.0</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-studio/releases/download/v0.9.0/hugegraph-studio-0.9.0.tar.gz">0.9.0</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-common/1.6.0">1.6.0</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-tools/releases/download/v1.3.0/hugegraph-tools-1.3.0.tar.gz">1.3.0</a></td> |
| </tr> |
| <tr> |
| <td><a href="https://github.com/hugegraph/hugegraph/releases/download/v0.8.0/hugegraph-0.8.0.tar.gz">0.8.0</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.6.4">1.6.4</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-loader/releases/download/v0.8.0/hugegraph-loader-0.8.0.tar.gz">0.8.0</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-studio/releases/download/v0.8.0/hugegraph-studio-0.8.0.tar.gz">0.8.0</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-common/1.5.3">1.5.3</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-tools/releases/download/v1.2.0/hugegraph-tools-1.2.0.tar.gz">1.2.0</a></td> |
| </tr> |
| <tr> |
| <td><a href="https://github.com/hugegraph/hugegraph/releases/download/v0.7.4/hugegraph-0.7.4.tar.gz">0.7.4</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.8">1.5.8</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-loader/releases/download/v0.7.0/hugegraph-loader-0.7.0.tar.gz">0.7.0</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-studio/releases/download/v0.7.0/hugegraph-studio-0.7.0.tar.gz">0.7.0</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-common/1.4.9">1.4.9</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-tools/releases/download/v1.1.0/hugegraph-tools-1.1.0.tar.gz">1.1.0</a></td> |
| </tr> |
| <tr> |
| <td><a href="https://github.com/hugegraph/hugegraph/releases/download/v0.6.1/hugegraph-0.6.1.tar.gz">0.6.1</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.6">1.5.6</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-loader/releases/download/v0.6.1/hugegraph-loader-0.6.1.tar.gz">0.6.1</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-studio/releases/download/v0.6.1/hugegraph-studio-0.6.1.tar.gz">0.6.1</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-common/1.4.3">1.4.3</a></td> |
| <td><a href="https://github.com/hugegraph/hugegraph-tools/releases/download/v1.0.0/hugegraph-tools-1.0.0.tar.gz">1.0.0</a></td> |
| </tr> |
| <tr> |
| <td><a href="https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.5.6-SNAPSHOT.tar.gz">0.5.6</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.5.0">1.5.0</a></td> |
| <td><a href="https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.5.6-bin.tar.gz">0.5.6</a></td> |
| <td><a href="https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.5.0-SNAPSHOT.tar.gz">0.5.0</a></td> |
| <td>1.4.0</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a href="https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.4.5-SNAPSHOT.tar.gz">0.4.5</a></td> |
| <td><a href="https://mvnrepository.com/artifact/com.baidu.hugegraph/hugegraph-client/1.4.7">1.4.7</a></td> |
| <td><a href="https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.2.2-bin.tar.gz">0.2.2</a></td> |
| <td><a href="https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.4.1-SNAPSHOT.tar.gz">0.4.1</a></td> |
| <td>1.3.12</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <p>说明：最新的图分析和展示平台为 hubble，支持 0.10 及之后的 server 版本；studio 为 server 0.10.x 以及之前的版本的图分析和展示平台，其功能从 0.10 起不再更新。</p> |
| </blockquote> |
| <h3 id="release-notes">Release Notes</h3> |
| <ul> |
| <li>2021-12-31: Release HugeGraph 0.12.0，see <a href="/docs/changelog/hugegraph-0.12.0-release-notes">HugeGraph 0.12.0 Release Notes</a></li> |
| <li>2020-11-20: Release HugeGraph 0.11.2，see <a href="/docs/changelog/hugegraph-0.11.2-release-notes">HugeGraph 0.11.2 Release Notes</a></li> |
| <li>2019-11-08: Release HugeGraph 0.10.4，see <a href="/docs/changelog/hugegraph-0.10.4-release-notes">HugeGraph 0.10.4 Release Notes</a></li> |
| <li>2019-04-19: Release HugeGraph 0.9.2，see <a href="/docs/changelog/hugegraph-0.9.2-release-notes">HugeGraph 0.9.2 Release Notes</a></li> |
| <li>2018-11-23: Release HugeGraph 0.8.0，see <a href="/docs/changelog/hugegraph-0.8.0-release-notes">HugeGraph 0.8.0 Release Notes</a></li> |
| <li>2018-07-30: Release HugeGraph 0.7.4，see <a href="/docs/changelog/hugegraph-0.7.4-release-notes">HugeGraph 0.7.4 Release Notes</a></li> |
| <li>2018-06-01: Release HugeGraph 0.6.1，see <a href="/docs/changelog/hugegraph-0.6.1-release-notes">HugeGraph 0.6.1 Release Notes</a></li> |
| <li>2018-03-29: Release HugeGraph 0.5.6，see <a href="/docs/changelog/hugegraph-0.5.6-release-notes">HugeGraph 0.5.6 Release Notes</a></li> |
| <li>2018-01-12: Release HugeGraph 0.4.4，see <a href="/docs/changelog/hugegraph-0.4.4-release-notes">HugeGraph 0.4.4 Release Notes</a></li> |
| <li>2017-11-06: Release HugeGraph 0.3.3，see <a href="/docs/changelog/hugegraph-0.3.3-release-notes">HugeGraph 0.3.3 Release Notes</a></li> |
| <li>2017-09-08: Release HugeGraph 0.2.4，see <a href="/docs/changelog/hugegraph-0.2.4-release-notes">HugeGraph 0.2.4 Release Notes</a></li> |
| <li>2017-08-15: Release HugeGraph 0.2，see <a href="/docs/changelog/hugegraph-0.2-release-notes">HugeGraph 0.2 Release Notes</a></li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-08b1b69f6319108b0455d24614fdd660">3 - Quick Start</h1> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style=""> |
| |
| <h1 id="pg-8ec2ee5fd8ff8e48255d55eab65d92b6">3.1 - HugeGraph-Server Quick Start</h1> |
| |
| <h3 id="1-hugegraph-server概述">1 HugeGraph-Server概述</h3> |
| <p>HugeGraph-Server 是 HugeGraph 项目的核心部分，包含Core、Backend、API等子模块。</p> |
| <p>Core模块是Tinkerpop接口的实现，Backend模块用于管理数据存储，目前支持的后端包括：Memory、Cassandra、ScyllaDB以及RocksDB，API模块提供HTTP Server，将Client的HTTP请求转化为对Core的调用。</p> |
| <blockquote> |
| <p>文档中会大量出现<code>HugeGraph-Server</code>及<code>HugeGraphServer</code>这两种写法，其他组件也类似。这两种写法含义上并无大的差异，可以这么区分：<code>HugeGraph-Server</code>表示服务端相关组件代码，<code>HugeGraphServer</code>表示服务进程。</p> |
| </blockquote> |
| <h3 id="2-依赖">2 依赖</h3> |
| <h4 id="21-安装jdk-18">2.1 安装JDK-1.8</h4> |
| <p>HugeGraph-Server 基于jdk-1.8开发，代码用到了较多jdk-1.8中的类和方法，请用户自行安装配置。</p> |
| <p><strong>在往下阅读之前务必执行<code>java -version</code>命令查看jdk版本</strong></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>java -version |
| </span></span></code></pre></div><h4 id="22-安装gcc-430glibcxx_3410或更新版本可选">2.2 安装GCC-4.3.0(GLIBCXX_3.4.10)或更新版本（可选）</h4> |
| <p>如果使用的是RocksDB后端，请务必执行<code>gcc --version</code>命令查看gcc版本；若使用其他后端，则不需要。</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>gcc --version |
| </span></span></code></pre></div><h3 id="3-部署">3 部署</h3> |
| <p>有三种方式可以部署HugeGraph-Server组件：</p> |
| <ul> |
| <li>方式1：一键部署</li> |
| <li>方式2：下载tar包</li> |
| <li>方式3：源码编译</li> |
| </ul> |
| <h4 id="31-一键部署">3.1 一键部署</h4> |
| <p>HugeGraph-Tools提供了一键部署的命令行工具，用户可以使用该工具快速地一键下载、解压、配置并启动HugeGraphServer和HugeGraphStudio。 |
| 当然，还是得先下载HugeGraph-Tools的tar包。</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://github.com/hugegraph/hugegraph-tools/releases/download/v<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>/hugegraph-tools-<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 hugegraph-tools-<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><span style="color:#204a87">cd</span> hugegraph-tools-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span> |
| </span></span></code></pre></div><blockquote> |
| <p>注：${version}为版本号，最新版本号可参考<a href="/docs/download/download">Download页面</a>，或直接从Download页面点击链接下载</p> |
| </blockquote> |
| <p>HugeGraph-Tools 的总入口脚本是<code>bin/hugegraph</code>，用户可以使用<code>help</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/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>表示要部署的HugeGraphServer及HugeGraphStudio的版本，用户可查看<code>conf/version-mapping.yaml</code>文件获取版本信息，<code>{install-path}</code>指定HugeGraphServer及HugeGraphStudio的安装目录，<code>{download-path-prefix}</code>可选，指定HugeGraphServer及HugeGraphStudio tar包的下载地址，不提供时使用默认下载地址，比如要启动 0.6 版本的HugeGraph-Server及HugeGraphStudio将上述命令写为<code>bin/hugegraph deploy -v 0.6 -p services</code>即可。</p> |
| <h4 id="32-下载tar包">3.2 下载tar包</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>wget https://github.com/hugegraph/hugegraph/releases/download/v<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>/hugegraph-<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 hugegraph-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>.tar.gz |
| </span></span></code></pre></div><h4 id="33-源码编译">3.3 源码编译</h4> |
| <p>下载HugeGraph源代码</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/hugegraph/hugegraph.git |
| </span></span></code></pre></div><p>编译打包生成tar包</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>mvn package -DskipTests |
| </span></span></code></pre></div><p>执行日志如下：</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></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> 0.003 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> 15.335 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> 0.829 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> 1.095 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> 0.313 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> 0.506 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> 0.412 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> 0.359 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> 7.470 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> 0.403 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> 1.509 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> ------------------------------------------------------------------------ |
| </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>执行成功后，在hugegraph目录下生成 hugegraph-*.tar.gz 文件，就是编译生成的tar包。</p> |
| <h3 id="4-配置">4 配置</h3> |
| <p>如果需要快速启动HugeGraph仅用于测试，那么只需要进行少数几个配置项的修改即可（见下一节）。 |
| 详细的配置介绍请参考<a href="/docs/config/config-guide">配置文档</a>及<a href="/docs/config/config-option">配置项介绍</a></p> |
| <h3 id="5-启动">5 启动</h3> |
| <p>启动分为"首次启动"和"非首次启动"，这么区分是因为在第一次启动前需要初始化后端数据库，然后启动服务。 |
| 而在人为停掉服务后，或者其他原因需要再次启动服务时，因为后端数据库是持久化存在的，直接启动服务即可。</p> |
| <p>HugeGraphServer启动时会连接后端存储并尝试检查后端存储版本号，如果未初始化后端或者后端已初始化但版本不匹配时（旧版本数据），HugeGraphServer会启动失败，并给出错误信息。</p> |
| <p>如果需要外部访问HugeGraphServer，请修改<code>rest-server.properties</code>的<code>restserver.url</code>配置项 |
| （默认为<code>http://127.0.0.1:8080</code>），修改成机器名或IP地址。</p> |
| <p>由于各种后端所需的配置（hugegraph.properties）及启动步骤略有不同，下面逐一对各后端的配置及启动做介绍。</p> |
| <h4 id="51-memory">5.1 Memory</h4> |
| <p>修改 hugegraph.properties</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">backend=memory |
| serializer=text |
| </code></pre><blockquote> |
| <p>Memory后端的数据是保存在内存中无法持久化的，不需要初始化后端，这也是唯一一个不需要初始化的后端。</p> |
| </blockquote> |
| <p>启动 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>提示的 url 与 rest-server.properties 中配置的 restserver.url 一致</p> |
| <h4 id="52-rocksdb">5.2 RocksDB</h4> |
| <blockquote> |
| <p>RocksDB是一个嵌入式的数据库，不需要手动安装部署, 要求 GCC 版本 >= 4.3.0（GLIBCXX_3.4.10），如不满足，需要提前升级 GCC</p> |
| </blockquote> |
| <p>修改 hugegraph.properties</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">backend=rocksdb |
| serializer=binary |
| rocksdb.data_path=. |
| rocksdb.wal_path=. |
| </code></pre><p>初始化数据库（仅第一次启动时需要）</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>启动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><h4 id="53-cassandra">5.3 Cassandra</h4> |
| <blockquote> |
| <p>用户需自行安装 Cassandra，要求版本 3.0 以上，<a href="http://cassandra.apache.org/download/">下载地址</a></p> |
| </blockquote> |
| <p>修改 hugegraph.properties</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">backend=cassandra |
| serializer=cassandra |
| |
| # cassandra backend config |
| cassandra.host=localhost |
| cassandra.port=9042 |
| cassandra.username= |
| cassandra.password= |
| #cassandra.connect_timeout=5 |
| #cassandra.read_timeout=20 |
| |
| #cassandra.keyspace.strategy=SimpleStrategy |
| #cassandra.keyspace.replication=3 |
| </code></pre><p>初始化数据库（仅第一次启动时需要）</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> com.baidu.hugegraph.HugeGraph <span style="color:#ce5c00;font-weight:bold">[]</span> - Opening backend store: <span style="color:#4e9a06">'cassandra'</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> com.baidu.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> com.baidu.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> com.baidu.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> com.baidu.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> com.baidu.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> com.baidu.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> com.baidu.hugegraph.backend.Transaction <span style="color:#ce5c00;font-weight:bold">[]</span> - Clear cache on event <span style="color:#4e9a06">'store.init'</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> com.baidu.hugegraph.HugeGraph <span style="color:#ce5c00;font-weight:bold">[]</span> - Opening backend store: <span style="color:#4e9a06">'cassandra'</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> com.baidu.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> com.baidu.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> com.baidu.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> com.baidu.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> com.baidu.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> com.baidu.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> com.baidu.hugegraph.backend.Transaction <span style="color:#ce5c00;font-weight:bold">[]</span> - Clear cache on event <span style="color:#4e9a06">'store.init'</span> |
| </span></span></code></pre></div><p>启动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><h4 id="54-scylladb">5.4 ScyllaDB</h4> |
| <blockquote> |
| <p>用户需自行安装 ScyllaDB，推荐版本 2.1 以上，<a href="https://docs.scylladb.com/getting-started/">下载地址</a></p> |
| </blockquote> |
| <p>修改 hugegraph.properties</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">backend=scylladb |
| serializer=scylladb |
| |
| # cassandra backend config |
| cassandra.host=localhost |
| cassandra.port=9042 |
| cassandra.username= |
| cassandra.password= |
| #cassandra.connect_timeout=5 |
| #cassandra.read_timeout=20 |
| |
| #cassandra.keyspace.strategy=SimpleStrategy |
| #cassandra.keyspace.replication=3 |
| </code></pre><p>由于 scylladb 数据库本身就是基于 cassandra 的"优化版"，如果用户未安装 scylladb ，也可以直接使用 cassandra 作为后端存储，只需要把 backend 和 serializer 修改为 scylladb，host 和 post 指向 cassandra 集群的 seeds 和 port 即可，但是并不建议这样做，这样发挥不出 scylladb 本身的优势了。</p> |
| <p>初始化数据库（仅第一次启动时需要）</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>启动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><h4 id="55-hbase">5.5 HBase</h4> |
| <blockquote> |
| <p>用户需自行安装 HBase，要求版本 2.0 以上，<a href="https://hbase.apache.org/downloads.html">下载地址</a></p> |
| </blockquote> |
| <p>修改 hugegraph.properties</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">backend=hbase |
| serializer=hbase |
| |
| # hbase backend config |
| hbase.hosts=localhost |
| hbase.port=2181 |
| </code></pre><p>初始化数据库（仅第一次启动时需要）</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>启动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>更多其它后端配置可参考<a href="/docs/config/config-option">配置项介绍</a></p> |
| </blockquote> |
| <h3 id="6-访问server">6 访问Server</h3> |
| <h4 id="61-服务启动状态校验">6.1 服务启动状态校验</h4> |
| <p><code>jps</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>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>请求<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">"http://localhost:8080/graphs/hugegraph/graph/vertices"</span><span style="color:#4e9a06">`</span> |
| </span></span></code></pre></div><p>返回结果200，代表server启动正常</p> |
| <h4 id="62-请求server">6.2 请求Server</h4> |
| <p>HugeGraphServer的RESTful API包括多种类型的资源，典型的包括graph、schema、gremlin、traverser和task，</p> |
| <ul> |
| <li><code>graph</code>包含<code>vertices</code>、<code>edges</code></li> |
| <li><code>schema</code> 包含<code>vertexlabels</code>、 <code>propertykeys</code>、 <code>edgelabels</code>、<code>indexlabels</code></li> |
| <li><code>gremlin</code>包含各种<code>Gremlin</code>语句，如<code>g.v()</code>，可以同步或者异步执行</li> |
| <li><code>traverser</code>包含各种高级查询，包括最短路径、交叉点、N步可达邻居等</li> |
| <li><code>task</code>包含异步任务的查询和删除</li> |
| </ul> |
| <h5 id="621-获取hugegraph的顶点及相关属性">6.2.1 获取<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>说明</em></p> |
| <ol> |
| <li> |
| <p>由于图的点和边很多，对于 list 型的请求，比如获取所有顶点，获取所有边等，Server 会将数据压缩再返回， |
| 所以使用 curl 时得到一堆乱码，可以重定向至 gunzip 进行解压。推荐使用 Chrome 浏览器 + Restlet 插件发送 HTTP 请求进行测试。</p> |
| <pre tabindex="0"><code>curl "http://localhost:8080/graphs/hugegraph/graph/vertices" | gunzip |
| </code></pre></li> |
| <li> |
| <p>当前HugeGraphServer的默认配置只能是本机访问，可以修改配置，使其能在其他机器访问。</p> |
| <pre tabindex="0"><code>vim conf/rest-server.properties |
| |
| restserver.url=http://0.0.0.0:8080 |
| </code></pre></li> |
| </ol> |
| <p>响应体如下：</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">328</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lop"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</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:#a40000">...</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><p>详细的API请参考<a href="/dcos/clients/restful-api">RESTful-API</a>文档</p> |
| <h3 id="7-停止server">7 停止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> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-685a02f8811d86f1ce195d7c73d9ea44">3.2 - HugeGraph-Loader Quick Start</h1> |
| |
| <h3 id="1-hugegraph-loader概述">1 HugeGraph-Loader概述</h3> |
| <p>HugeGraph-Loader 是 HugeGragh 的数据导入组件，能够将多种数据源的数据转化为图的顶点和边并批量导入到图数据库中。</p> |
| <p>目前支持的数据源包括：</p> |
| <ul> |
| <li>本地磁盘文件或目录，支持 TEXT、CSV 和 JSON 格式的文件，支持压缩文件</li> |
| <li>HDFS 文件或目录，支持压缩文件</li> |
| <li>主流关系型数据库，如 MySQL、PostgreSQL、Oracle、SQL Server</li> |
| </ul> |
| <p>本地磁盘文件和 HDFS 文件支持断点续传。</p> |
| <p>后面会具体说明。</p> |
| <blockquote> |
| <p>注意：使用 HugeGraph-Loader 需要依赖 HugeGraph Server 服务，下载和启动 Server 请参考 <a href="/docs/quickstart/hugegraph-server">HugeGraph-Server Quick Start</a></p> |
| </blockquote> |
| <h3 id="2-获取-hugegraph-loader">2 获取 HugeGraph-Loader</h3> |
| <p>有两种方式可以获取 HugeGraph-Loader：</p> |
| <ul> |
| <li>下载已编译的压缩包</li> |
| <li>克隆源码编译安装</li> |
| </ul> |
| <h4 id="21-下载已编译的压缩包">2.1 下载已编译的压缩包</h4> |
| <p>下载最新版本的 HugeGraph-Loader release 包：</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://github.com/hugegraph/hugegraph-loader/releases/download/v<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>/hugegraph-loader-<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 hugegraph-loader-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>.tar.gz |
| </span></span></code></pre></div><h4 id="22-克隆源码编译安装">2.2 克隆源码编译安装</h4> |
| <p>克隆最新版本的 HugeGraph-Loader 源码包：</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/hugegraph/hugegraph-loader.git |
| </span></span></code></pre></div><p>由于Oracle ojdbc license的限制，需要手动安装ojdbc到本地maven仓库。 |
| 访问<a href="https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html">Oracle jdbc 下载</a> 页面。选择Oracle Database 12c Release 2 (12.2.0.1) drivers，如下图所示。</p> |
| <center> |
| <img src="/docs/images/oracle-download.png" alt="image"> |
| </center> |
| <p>打开链接后，选择“ojdbc8.jar”, 如下图所示。</p> |
| <center> |
| <img src="/docs/images/ojdbc8.png" alt="image"> |
| </center> |
| <p>把ojdbc8安装到本地maven仓库，进入<code>ojdbc8.jar</code>所在目录，执行以下命令。</p> |
| <pre tabindex="0"><code>mvn install:install-file -Dfile=./ojdbc8.jar -DgroupId=com.oracle -DartifactId=ojdbc8 -Dversion=12.2.0.1 -Dpackaging=jar |
| </code></pre><p>编译生成 tar 包:</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-使用流程">3 使用流程</h3> |
| <p>使用 HugeGraph-Loader 的基本流程分为以下几步：</p> |
| <ul> |
| <li>编写图模型</li> |
| <li>准备数据文件</li> |
| <li>编写输入源映射文件</li> |
| <li>执行命令导入</li> |
| </ul> |
| <h4 id="31-编写图模型">3.1 编写图模型</h4> |
| <p>这一步是建模的过程，用户需要对自己已有的数据和想要创建的图模型有一个清晰的构想，然后编写 schema 建立图模型。</p> |
| <p>比如想创建一个拥有两类顶点及两类边的图，顶点是"人"和"软件"，边是"人认识人"和"人创造软件"，并且这些顶点和边都带有一些属性，比如顶点"人"有：“姓名”、“年龄"等属性， |
| “软件"有：“名字”、“售卖价格"等属性；边"认识"有: “日期"属性等。</p> |
| <center> |
| <img src="/docs/images/demo-graph-model.png" alt="image"> |
| <p>示例图模型</p> |
| </center> |
| <p>在设计好了图模型之后，我们可以用<code>groovy</code>编写出<code>schema</code>的定义，并保存至文件中，这里命名为<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">// 创建一些属性 |
| </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">"name"</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">"age"</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">"city"</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">"date"</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">"price"</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">// 创建 person 顶点类型，其拥有三个属性：name, age, city，主键是 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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"name"</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">// 创建 software 顶点类型，其拥有两个属性：name, price，主键是 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">"software"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"name"</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">// 创建 knows 边类型，这类边是从 person 指向 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">"knows"</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">"person"</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">"person"</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">// 创建 created 边类型，这类边是从 person 指向 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">"created"</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">"person"</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">"software"</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>关于 schema 的详细说明请参考 <a href="/docs/clients/hugegraph-client">hugegraph-client</a> 中对应部分。</p> |
| </blockquote> |
| <h4 id="32-准备数据">3.2 准备数据</h4> |
| <p>目前 HugeGraph-Loader 支持的数据源包括：</p> |
| <ul> |
| <li>本地磁盘文件或目录</li> |
| <li>HDFS 文件或目录</li> |
| <li>部分关系型数据库</li> |
| </ul> |
| <h5 id="321-数据源结构">3.2.1 数据源结构</h5> |
| <h6 id="3211-本地磁盘文件或目录">3.2.1.1 本地磁盘文件或目录</h6> |
| <p>用户可以指定本地磁盘文件作为数据源，如果数据分散在多个文件中，也支持以某个目录作为数据源，但暂时不支持以多个目录作为数据源。</p> |
| <p>比如：我的数据分散在多个文件中，part-0、part-1 … part-n，要想执行导入，必须保证它们是放在一个目录下的。然后在 loader 的映射文件中，将<code>path</code>指定为该目录即可。</p> |
| <p>支持的文件格式包括：</p> |
| <ul> |
| <li>TEXT</li> |
| <li>CSV</li> |
| <li>JSON</li> |
| </ul> |
| <p>TEXT 是自定义分隔符的文本文件，第一行通常是标题，记录了每一列的名称，也允许没有标题行（在映射文件中指定）。其余的每行代表一条记录，会被转化为一个顶点/边；行的每一列对应一个字段，会被转化为顶点/边的 id、label 或属性；</p> |
| <p>示例如下：</p> |
| <pre tabindex="0"><code>id|name|lang|price|ISBN |
| 1|lop|java|328|ISBN978-7-107-18618-5 |
| 2|ripple|java|199|ISBN978-7-100-13678-5 |
| </code></pre><p>CSV 是分隔符为逗号<code>,</code>的 TEXT 文件，当列值本身包含逗号时，该列值需要用双引号包起来，如：</p> |
| <pre tabindex="0"><code>marko,29,Beijing |
| "li,nary",26,"Wu,han" |
| </code></pre><p>JSON 文件要求每一行都是一个 JSON 串，且每行的格式需保持一致。</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20160110"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"weight"</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20130220"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"weight"</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-文件或目录">3.2.1.2 HDFS 文件或目录</h6> |
| <p>用户也可以指定 HDFS 文件或目录作为数据源，上面关于<code>本地磁盘文件或目录</code>的要求全部适用于这里。除此之外，鉴于 HDFS 上通常存储的都是压缩文件，loader 也提供了对压缩文件的支持，并且<code>本地磁盘文件或目录</code>同样支持压缩文件。</p> |
| <p>目前支持的压缩文件类型包括：GZIP、BZ2、XZ、LZMA、SNAPPY_RAW、SNAPPY_FRAMED、Z、DEFLATE、LZ4_BLOCK、LZ4_FRAMED、ORC 和 PARQUET。</p> |
| <h6 id="3213-主流关系型数据库">3.2.1.3 主流关系型数据库</h6> |
| <p>loader 还支持以部分关系型数据库作为数据源，目前支持 MySQL、PostgreSQL、Oracle 和 SQL Server。</p> |
| <p>但目前对表结构要求较为严格，如果导入过程中需要做<strong>关联查询</strong>，这样的表结构是不允许的。关联查询的意思是：在读到表的某行后，发现某列的值不能直接使用（比如外键），需要再去做一次查询才能确定该列的真实值。</p> |
| <p>举个例子：假设有三张表，person、software 和 created</p> |
| <pre tabindex="0"><code>// person 表结构 |
| id | name | age | city |
| </code></pre><pre tabindex="0"><code>// software 表结构 |
| id | name | lang | price |
| </code></pre><pre tabindex="0"><code>// created 表结构 |
| id | p_id | s_id | date |
| </code></pre><p>如果在建模（schema）时指定 person 或 software 的 id 策略是 PRIMARY_KEY，选择以 name 作为 primary keys（注意：这是 hugegraph 中 vertexlabel 的概念），在导入边数据时，由于需要拼接出源顶点和目标顶点的 id，必须拿着 p_id/s_id 去 person/software 表中查到对应的 name，这种需要做额外查询的表结构的情况，loader 暂时是不支持的。这时可以采用以下两种方式替代：</p> |
| <ol> |
| <li>仍然指定 person 和 software 的 id 策略为 PRIMARY_KEY，但是以 person 表和 software 表的 id 列作为顶点的主键属性，这样导入边时直接使用 p_id 和 s_id 和顶点的 label 拼接就能生成 id 了；</li> |
| <li>指定 person 和 software 的 id 策略为 CUSTOMIZE，然后直接以 person 表和 software 表的 id 列作为顶点 id，这样导入边时直接使用 p_id 和 s_id 即可；</li> |
| </ol> |
| <p>关键点就是要让边能直接使用 p_id 和 s_id，不要再去查一次。</p> |
| <h5 id="322-准备顶点和边数据">3.2.2 准备顶点和边数据</h5> |
| <h6 id="3221-顶点数据">3.2.2.1 顶点数据</h6> |
| <p>顶点数据文件由一行一行的数据组成，一般每一行作为一个顶点，每一列会作为顶点属性。下面以 CSV 格式作为示例进行说明。</p> |
| <ul> |
| <li>person 顶点数据（数据本身不包含 header）</li> |
| </ul> |
| <pre tabindex="0"><code class="language-csv" data-lang="csv">Tom,48,Beijing |
| Jerry,36,Shanghai |
| </code></pre><ul> |
| <li>software 顶点数据（数据本身包含 header）</li> |
| </ul> |
| <pre tabindex="0"><code class="language-csv" data-lang="csv">name,price |
| Photoshop,999 |
| Office,388 |
| </code></pre><h6 id="3222-边数据">3.2.2.2 边数据</h6> |
| <p>边数据文件由一行一行的数据组成，一般每一行作为一条边，其中有部分列会作为源顶点和目标顶点的 id，其他列作为边属性。下面以 JSON 格式作为示例进行说明。</p> |
| <ul> |
| <li>knows 边数据</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Tom"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Jerry"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2008-12-12"</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><ul> |
| <li>created 边数据</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Tom"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Photoshop"</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Tom"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Office"</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Jerry"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Office"</span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="33-编写数据源映射文件">3.3 编写数据源映射文件</h4> |
| <h5 id="331-映射文件概述">3.3.1 映射文件概述</h5> |
| <p>输入源的映射文件用于描述如何将输入源数据与图的顶点类型/边类型建立映射关系，以<code>JSON</code>格式组织，由多个映射块组成，其中每一个映射块都负责将一个输入源映射为顶点和边。</p> |
| <p>具体而言，每个映射块包含<strong>一个输入源</strong>和多个<strong>顶点映射</strong>与<strong>边映射</strong>块，输入源块对应上面介绍的<code>本地磁盘文件或目录</code>、<code>HDFS 文件或目录</code>和<code>关系型数据库</code>，负责描述数据源的基本信息，比如数据在哪，是什么格式的，分隔符是什么等。顶点映射/边映射与该输入源绑定，可以选择输入源的哪些列，哪些列作为id、哪些列作为属性，以及每一列映射成什么属性，列的值映射成属性的什么值等等。</p> |
| <p>以最通俗的话讲，每一个映射块描述了：要导入的文件在哪，文件的每一行要作为哪一类顶点/边，文件的哪些列是需要导入的，以及这些列对应顶点/边的什么属性等。</p> |
| <blockquote> |
| <p>注意：0.11.0 版本以前的映射文件与 0.11.0 以后的格式变化较大，为表述方便，下面称 0.11.0 以前的映射文件（格式）为 1.0 版本，0.11.0 以后的为 2.0 版本。并且若无特殊说明，“映射文件”表示的是 2.0 版本的。</p> |
| </blockquote> |
| <p>2.0 版本的映射文件的框架为：</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></span><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:#4e9a06">"2.0"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"structs"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"vertices"</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">"edges"</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><p>这里直接给出两个版本的映射文件（描述了上面图模型和数据文件）</p> |
| <p>2.0 版本的映射文件：</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></span><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:#4e9a06">"2.0"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"structs"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip"</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">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"FILE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex_person.csv"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"file_filter"</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">"extensions"</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">"*"</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">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CSV"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"delimiter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">","</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date_format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"yyyy-MM-dd HH:mm:ss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"time_zone"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"GMT+8"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skipped_line"</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">"regex"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"(^#|^//).*|"</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">"compression"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</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">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"city"</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">"charset"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"UTF-8"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"list_format"</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">"start_symbol"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"["</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"elem_delimiter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"|"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end_symbol"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"]"</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">"vertices"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip"</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">"id"</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">"unfold"</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">"field_mapping"</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">"value_mapping"</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">"selected"</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">"ignored"</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">"null_values"</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">""</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">"update_strategies"</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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip"</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">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"FILE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex_software.csv"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"file_filter"</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">"extensions"</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">"*"</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">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CSV"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"delimiter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">","</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date_format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"yyyy-MM-dd HH:mm:ss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"time_zone"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"GMT+8"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skipped_line"</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">"regex"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"(^#|^//).*|"</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">"compression"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</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">"charset"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"UTF-8"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"list_format"</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">"start_symbol"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">""</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"elem_delimiter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">","</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end_symbol"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">""</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">"vertices"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip"</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">"id"</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">"unfold"</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">"field_mapping"</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">"value_mapping"</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">"selected"</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">"ignored"</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">"null_values"</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">""</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">"update_strategies"</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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip"</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">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"FILE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge_knows.json"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"file_filter"</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">"extensions"</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">"*"</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">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"JSON"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"delimiter"</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">"date_format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"yyyy-MM-dd HH:mm:ss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"time_zone"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"GMT+8"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skipped_line"</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">"regex"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"(^#|^//).*|"</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">"compression"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</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">"charset"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"UTF-8"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"list_format"</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">"vertices"</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">"edges"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip"</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">"source"</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">"source_name"</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">"unfold_source"</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">"target"</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">"target_name"</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">"unfold_target"</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">"field_mapping"</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</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">"value_mapping"</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">"selected"</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">"ignored"</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">"null_values"</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">""</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">"update_strategies"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"4"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip"</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">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"FILE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge_created.json"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"file_filter"</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">"extensions"</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">"*"</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">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"JSON"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"delimiter"</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">"date_format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"yyyy-MM-dd HH:mm:ss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"time_zone"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"GMT+8"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skipped_line"</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">"regex"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"(^#|^//).*|"</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">"compression"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</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">"charset"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"UTF-8"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"list_format"</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">"vertices"</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">"edges"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip"</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">"source"</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">"source_name"</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">"unfold_source"</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">"target"</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">"target_name"</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">"unfold_target"</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">"field_mapping"</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</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">"value_mapping"</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">"selected"</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">"ignored"</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">"null_values"</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">""</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">"update_strategies"</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><p>1.0 版本的映射文件：</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"vertices"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex_person.csv"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CSV"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"charset"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"UTF-8"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex_software.csv"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CSV"</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">"edges"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"source"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"source_name"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"target_name"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge_knows.json"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"JSON"</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">"field_mapping"</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"source"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"source_name"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"target_name"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge_created.json"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"JSON"</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">"field_mapping"</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</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><p>映射文件 1.0 版本是以顶点和边为中心，设置输入源；而 2.0 版本是以输入源为中心，设置顶点和边映射。有些输入源（比如一个文件）既能生成顶点，也能生成边，如果用 1.0 版的格式写，就需要在 vertex 和 egde 映射块中各写一次 input 块，这两次的 input 块是完全一样的；而 2.0 版本只需要写一次 input。所以 2.0 版相比于 1.0 版，能省掉一些 input 的重复书写。</p> |
| <p>在 hugegraph-loader-{version} 的 bin 目录下，有一个脚本工具 <code>mapping-convert.sh</code> 能直接将 1.0 版本的映射文件转换为 2.0 版本的，使用方式如下：</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>会在 struct.json 的同级目录下生成一个 struct-v2.json。</p> |
| <h5 id="332-输入源">3.3.2 输入源</h5> |
| <p>输入源目前分为三类：FILE、HDFS、JDBC，由<code>type</code>节点区分，我们称为本地文件输入源、HDFS 输入源和 JDBC 输入源，下面分别介绍。</p> |
| <h6 id="3321-本地文件输入源">3.3.2.1 本地文件输入源</h6> |
| <ul> |
| <li>id: 输入源的 id，该字段用于支持一些内部功能，非必填（未填时会自动生成），强烈建议写上，对于调试大有裨益；</li> |
| <li>skip: 是否跳过该输入源，由于 JSON 文件无法添加注释，如果某次导入时不想导入某个输入源，但又不想删除该输入源的配置，则可以设置为 true 将其跳过，默认为 false，非必填；</li> |
| <li>input: 输入源映射块，复合结构 |
| <ul> |
| <li>type: 输入源类型，必须填 file 或 FILE；</li> |
| <li>path: 本地文件或目录的路径，绝对路径或相对于映射文件的相对路径，建议使用绝对路径，必填；</li> |
| <li>file_filter: 从<code>path</code>中筛选复合条件的文件，复合结构，目前只支持配置扩展名，用子节点<code>extensions</code>表示，默认为”*"，表示保留所有文件；</li> |
| <li>format: 本地文件的格式，可选值为 CSV、TEXT 及 JSON，必须大写，必填；</li> |
| <li>header: 文件各列的列名，如不指定则会以数据文件第一行作为 header；当文件本身有标题且又指定了 header，文件的第一行会被当作普通的数据行；JSON 文件不需要指定 header，选填；</li> |
| <li>delimiter: 文件行的列分隔符，默认以逗号<code>","</code>作为分隔符，<code>JSON</code>文件不需要指定，选填；</li> |
| <li>charset: 文件的编码字符集，默认<code>UTF-8</code>，选填；</li> |
| <li>date_format: 自定义的日期格式，默认值为 yyyy-MM-dd HH:mm:ss，选填；如果日期是以时间戳的形式呈现的，此项须写为<code>timestamp</code>（固定写法）；</li> |
| <li>time_zone: 设置日期数据是处于哪个时区的，默认值为<code>GMT+8</code>，选填；</li> |
| <li>skipped_line: 想跳过的行，复合结构，目前只能配置要跳过的行的正则表达式，用子节点<code>regex</code>描述，默认不跳过任何行，选填；</li> |
| <li>compression: 文件的压缩格式，可选值为 NONE、GZIP、BZ2、XZ、LZMA、SNAPPY_RAW、SNAPPY_FRAMED、Z、DEFLATE、LZ4_BLOCK、LZ4_FRAMED、ORC 和 PARQUET，默认为 NONE，表示非压缩文件，选填；</li> |
| <li>list_format: 当文件(非 JSON )的某列是集合结构时（对应图中的 PropertyKey 的 Cardinality 为 Set 或 List），可以用此项设置该列的起始符、分隔符、结束符，复合结构: |
| <ul> |
| <li>start_symbol: 集合结构列的起始符 (默认值是 <code>[</code>, JSON 格式目前不支持指定)</li> |
| <li>elem_delimiter: 集合结构列的分隔符 (默认值是 <code>|</code>, JSON 格式目前只支持原生<code>,</code>分隔)</li> |
| <li>end_symbol: 集合结构列的结束符 (默认值是 <code>]</code>, JSON 格式目前不支持指定)</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <h6 id="3322-hdfs-输入源">3.3.2.2 HDFS 输入源</h6> |
| <p>上述<code>本地文件输入源</code>的节点及含义这里基本都适用，下面仅列出 HDFS 输入源不一样的和特有的节点。</p> |
| <ul> |
| <li>type: 输入源类型，必须填 hdfs 或 HDFS，必填；</li> |
| <li>path: HDFS 文件或目录的路径，必须是 HDFS 的绝对路径，必填；</li> |
| <li>core_site_path: HDFS 集群的 core-site.xml 文件路径，重点要指明 namenode 的地址（fs.default.name），以及文件系统的实现（fs.hdfs.impl）；</li> |
| </ul> |
| <h6 id="3323-jdbc-输入源">3.3.2.3 JDBC 输入源</h6> |
| <p>前面说到过支持多种关系型数据库，但由于它们的映射结构非常相似，故统称为 JDBC 输入源，然后用<code>vendor</code>节点区分不同的数据库。</p> |
| <ul> |
| <li>type: 输入源类型，必须填 jdbc 或 JDBC，必填；</li> |
| <li>vendor: 数据库类型，可选项为 [MySQL、PostgreSQL、Oracle、SQLServer]，不区分大小写，必填；</li> |
| <li>driver: jdbc 使用的 driver 类型，必填；</li> |
| <li>url: jdbc 要连接的数据库的 url，必填；</li> |
| <li>database: 要连接的数据库名，必填；</li> |
| <li>schema: 要连接的 schema 名，不同的数据库要求不一样，下面详细说明；</li> |
| <li>table: 要连接的表名，<code>custom_sql</code> 和 <code>table</code> 参数必须填其中一个；</li> |
| <li>custom_sql: 自定义 SQL 语句，<code>custom_sql</code> 和 <code>table</code> 参数必须填其中一个；</li> |
| <li>username: 连接数据库的用户名，必填；</li> |
| <li>password: 连接数据库的密码，必填；</li> |
| <li>batch_size: 按页获取表数据时的一页的大小，默认为 500，选填；</li> |
| </ul> |
| <p><strong>MYSQL</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>节点</th> |
| <th>固定值或常见值</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: 可空，若填写必须与database的值一样</p> |
| <p><strong>POSTGRESQL</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>节点</th> |
| <th>固定值或常见值</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: 可空，默认值为“public”</p> |
| <p><strong>ORACLE</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>节点</th> |
| <th>固定值或常见值</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: 可空，默认值与用户名相同</p> |
| <p><strong>SQLSERVER</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>节点</th> |
| <th>固定值或常见值</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: 必填</p> |
| <h5 id="331-顶点和边映射">3.3.1 顶点和边映射</h5> |
| <p>顶点和边映射的节点（JSON 文件中的一个 key）有很多相同的部分，下面先介绍相同部分，再分别介绍<code>顶点映射</code>和<code>边映射</code>的特有节点。</p> |
| <p><strong>相同部分的节点</strong></p> |
| <ul> |
| <li>label: 待导入的顶点/边数据所属的<code>label</code>，必填；</li> |
| <li>field_mapping: 将输入源列的列名映射为顶点/边的属性名，选填；</li> |
| <li>value_mapping: 将输入源的数据值映射为顶点/边的属性值，选填；</li> |
| <li>selected: 选择某些列插入，其他未选中的不插入，不能与<code>ignored</code>同时存在，选填；</li> |
| <li>ignored: 忽略某些列，使其不参与插入，不能与<code>selected</code>同时存在，选填；</li> |
| <li>null_values: 可以指定一些字符串代表空值，比如"NULL”，如果该列对应的顶点/边属性又是一个可空属性，那在构造顶点/边时不会设置该属性的值，选填；</li> |
| <li>update_strategies: 如果数据需要按特定方式批量<strong>更新</strong>时可以对每个属性指定具体的更新策略 (具体见下)，选填；</li> |
| <li>unfold: 是否将列展开，展开的每一列都会与其他列一起组成一行，相当于是展开成了多行；比如文件的某一列（id 列）的值是<code>[1,2,3]</code>，其他列的值是<code>18,Beijing</code>，当设置了 unfold 之后，这一行就会变成 3 行，分别是：<code>1,18,Beijing</code>，<code>2,18,Beijing</code>和<code>3,18,Beijing</code>。需要注意的是此项只会展开被选作为 id 的列。默认 false，选填；</li> |
| </ul> |
| <p><strong>更新策略</strong>支持8种 : (需要全大写)</p> |
| <ol> |
| <li>数值累加 : <code>SUM</code></li> |
| <li>两个数字/日期取更大的: <code>BIGGER</code></li> |
| <li>两个数字/日期取更小: <code>SMALLER</code></li> |
| <li><strong>Set</strong>属性取并集: <code>UNION</code></li> |
| <li><strong>Set</strong>属性取交集: <code>INTERSECTION</code></li> |
| <li><strong>List</strong>属性追加元素: <code>APPEND</code></li> |
| <li><strong>List/Set</strong>属性删除元素: <code>ELIMINATE</code></li> |
| <li>覆盖已有属性: <code>OVERRIDE</code></li> |
| </ol> |
| <p><strong>注意:</strong> 如果新导入的属性值为空, 会采用已有的旧数据而不会采用空值, 效果可以参考如下示例</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">// JSON文件中以如下方式指定更新策略 |
| </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">"vertices"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"update_strategies"</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">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SMALLER"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"set"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"UNION"</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">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex_person.txt"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"set"</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.写入一行带OVERRIDE更新策略的数据 (这里null代表空) |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#a40000">'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">'</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// 2.再写一行 |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#a40000">'</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'</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// 3.最后可以得到 |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#a40000">'a</span> <span style="color:#a40000">b</span> <span style="color:#a40000">c</span> <span style="color:#a40000">d'</span> |
| </span></span><span style="display:flex;"><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"></span><span style="color:#a40000">'</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'</span> |
| </span></span></code></pre></div><blockquote> |
| <p><strong>注意</strong> : 采用了批量更新的策略后, 磁盘读请求数会大幅上升, 导入速度相比纯写覆盖会慢数倍 (此时HDD磁盘<a href="https://en.wikipedia.org/wiki/IOPS">IOPS</a>会成为瓶颈, 建议采用SSD以保证速度)</p> |
| </blockquote> |
| <p><strong>顶点映射的特有节点</strong></p> |
| <ul> |
| <li>id: 指定某一列作为顶点的 id 列，当顶点 id 策略为<code>CUSTOMIZE</code>时，必填；当 id 策略为<code>PRIMARY_KEY</code>时，必须为空；</li> |
| </ul> |
| <p><strong>边映射的特有节点</strong></p> |
| <ul> |
| <li>source: 选择输入源某几列作为<strong>源顶点</strong>的 id 列，当源顶点的 id 策略为 <code>CUSTOMIZE</code>时，必须指定某一列作为顶点的 id 列；当源顶点的 id 策略为 <code>PRIMARY_KEY</code>时，必须指定一列或多列用于拼接生成顶点的 id，也就是说，不管是哪种 id 策略，此项必填；</li> |
| <li>target: 指定某几列作为<strong>目标顶点</strong>的 id 列，与 source 类似，不再赘述；</li> |
| <li>unfold_source: 是否展开文件的 source 列，效果与顶点映射中的类似，不再赘述；</li> |
| <li>unfold_target: 是否展开文件的 target 列，效果与顶点映射中的类似，不再赘述；</li> |
| </ul> |
| <h4 id="34-执行命令导入">3.4 执行命令导入</h4> |
| <p>准备好图模型、数据文件以及输入源映射关系文件后，接下来就可以将数据文件导入到图数据库中。</p> |
| <p>导入过程由用户提交的命令控制，用户可以通过不同的参数控制执行的具体流程。</p> |
| <h5 id="341-参数说明">3.4.1 参数说明</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>参数</th> |
| <th>默认值</th> |
| <th>是否必传</th> |
| <th>描述信息</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>-f 或 –file</td> |
| <td></td> |
| <td>Y</td> |
| <td>配置脚本的路径</td> |
| </tr> |
| <tr> |
| <td>-g 或 –graph</td> |
| <td></td> |
| <td>Y</td> |
| <td>图数据库空间</td> |
| </tr> |
| <tr> |
| <td>-s 或 –schema</td> |
| <td></td> |
| <td>Y</td> |
| <td>schema文件路径</td> |
| </tr> |
| <tr> |
| <td>-h 或 –host</td> |
| <td>localhost</td> |
| <td></td> |
| <td>HugeGraphServer 的地址</td> |
| </tr> |
| <tr> |
| <td>-p 或 –port</td> |
| <td>8080</td> |
| <td></td> |
| <td>HugeGraphServer 的端口号</td> |
| </tr> |
| <tr> |
| <td>–username</td> |
| <td>null</td> |
| <td></td> |
| <td>当 HugeGraphServer 开启了权限认证时，当前图的 username</td> |
| </tr> |
| <tr> |
| <td>–token</td> |
| <td>null</td> |
| <td></td> |
| <td>当 HugeGraphServer 开启了权限认证时，当前图的 token</td> |
| </tr> |
| <tr> |
| <td>–protocol</td> |
| <td>http</td> |
| <td></td> |
| <td>向服务端发请求的协议，可选 http 或 https</td> |
| </tr> |
| <tr> |
| <td>–trust-store-file</td> |
| <td></td> |
| <td></td> |
| <td>请求协议为 https 时，客户端的证书文件路径</td> |
| </tr> |
| <tr> |
| <td>–trust-store-password</td> |
| <td></td> |
| <td></td> |
| <td>请求协议为 https 时，客户端证书密码</td> |
| </tr> |
| <tr> |
| <td>–clear-all-data</td> |
| <td>false</td> |
| <td></td> |
| <td>导入数据前是否清除服务端的原有数据</td> |
| </tr> |
| <tr> |
| <td>–clear-timeout</td> |
| <td>240</td> |
| <td></td> |
| <td>导入数据前清除服务端的原有数据的超时时间</td> |
| </tr> |
| <tr> |
| <td>–incremental-mode</td> |
| <td>false</td> |
| <td></td> |
| <td>是否使用断点续导模式，仅输入源为 FILE 和 HDFS 支持该模式，启用该模式能从上一次导入停止的地方开始导</td> |
| </tr> |
| <tr> |
| <td>–failure-mode</td> |
| <td>false</td> |
| <td></td> |
| <td>失败模式为 true 时，会导入之前失败了的数据，一般来说失败数据文件需要在人工更正编辑好后，再次进行导入</td> |
| </tr> |
| <tr> |
| <td>–batch-insert-threads</td> |
| <td>CPUs</td> |
| <td></td> |
| <td>批量插入线程池大小 (CPUs是当前OS可用<strong>逻辑核</strong>个数)</td> |
| </tr> |
| <tr> |
| <td>–single-insert-threads</td> |
| <td>8</td> |
| <td></td> |
| <td>单条插入线程池的大小</td> |
| </tr> |
| <tr> |
| <td>–max-conn</td> |
| <td>4 * CPUs</td> |
| <td></td> |
| <td>HugeClient 与 HugeGraphServer 的最大 HTTP 连接数，<strong>调整线程</strong>的时候建议同时调整此项</td> |
| </tr> |
| <tr> |
| <td>–max-conn-per-route</td> |
| <td>2 * CPUs</td> |
| <td></td> |
| <td>HugeClient 与 HugeGraphServer 每个路由的最大 HTTP 连接数，<strong>调整线程</strong>的时候建议同时调整此项</td> |
| </tr> |
| <tr> |
| <td>–batch-size</td> |
| <td>500</td> |
| <td></td> |
| <td>导入数据时每个批次包含的数据条数</td> |
| </tr> |
| <tr> |
| <td>–max-parse-errors</td> |
| <td>1</td> |
| <td></td> |
| <td>最多允许多少行数据解析错误，达到该值则程序退出</td> |
| </tr> |
| <tr> |
| <td>–max-insert-errors</td> |
| <td>500</td> |
| <td></td> |
| <td>最多允许多少行数据插入错误，达到该值则程序退出</td> |
| </tr> |
| <tr> |
| <td>–timeout</td> |
| <td>60</td> |
| <td></td> |
| <td>插入结果返回的超时时间（秒）</td> |
| </tr> |
| <tr> |
| <td>–shutdown-timeout</td> |
| <td>10</td> |
| <td></td> |
| <td>多线程停止的等待时间（秒）</td> |
| </tr> |
| <tr> |
| <td>–retry-times</td> |
| <td>0</td> |
| <td></td> |
| <td>发生特定异常时的重试次数</td> |
| </tr> |
| <tr> |
| <td>–retry-interval</td> |
| <td>10</td> |
| <td></td> |
| <td>重试之前的间隔时间（秒）</td> |
| </tr> |
| <tr> |
| <td>–check-vertex</td> |
| <td>false</td> |
| <td></td> |
| <td>插入边时是否检查边所连接的顶点是否存在</td> |
| </tr> |
| <tr> |
| <td>–print-progress</td> |
| <td>true</td> |
| <td></td> |
| <td>是否在控制台实时打印导入条数</td> |
| </tr> |
| <tr> |
| <td>–dry-run</td> |
| <td>false</td> |
| <td></td> |
| <td>打开该模式，只解析不导入，通常用于测试</td> |
| </tr> |
| <tr> |
| <td>–help</td> |
| <td>false</td> |
| <td></td> |
| <td>打印帮助信息</td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="342-断点续导模式">3.4.2 断点续导模式</h5> |
| <p>通常情况下，Loader 任务都需要较长时间执行，如果因为某些原因导致导入中断进程退出，而下次希望能从中断的点继续导，这就是使用断点续导的场景。</p> |
| <p>用户设置命令行参数 –incremental-mode 为 true 即打开了断点续导模式。断点续导的关键在于进度文件，导入进程退出的时候，会把退出时刻的导入进度 |
| 记录到进度文件中，进度文件位于 <code>${struct}</code> 目录下，文件名形如 <code>load-progress ${date}</code> ，${struct} 为映射文件的前缀，${date} 为导入开始 |
| 的时刻。比如：在 <code>2019-10-10 12:30:30</code> 开始的一次导入任务，使用的映射文件为 <code>struct-example.json</code>，则进度文件的路径为与 struct-example.json |
| 同级的 <code>struct-example/load-progress 2019-10-10 12:30:30</code>。</p> |
| <blockquote> |
| <p>注意：进度文件的生成与 –incremental-mode 是否打开无关，每次导入结束都会生成一个进度文件。</p> |
| </blockquote> |
| <p>如果数据文件格式都是合法的，是用户自己停止（CTRL + C 或 kill，kill -9 不支持）的导入任务，也就是说没有错误记录的情况下，下一次导入只需要设置 |
| 为断点续导即可。</p> |
| <p>但如果是因为太多数据不合法或者网络异常，达到了 –max-parse-errors 或 –max-insert-errors 的限制，Loader 会把这些插入失败的原始行记录到 |
| 失败文件中，用户对失败文件中的数据行修改后，设置 –reload-failure 为 true 即可把这些"失败文件"也当作输入源进行导入（不影响正常的文件的导入）， |
| 当然如果修改后的数据行仍然有问题，则会被再次记录到失败文件中（不用担心会有重复行）。</p> |
| <p>每个顶点映射或边映射有数据插入失败时都会产生自己的失败文件，失败文件又分为解析失败文件（后缀 .parse-error）和插入失败文件（后缀 .insert-error）， |
| 它们被保存在 <code>${struct}/current</code> 目录下。比如映射文件中有一个顶点映射 person 和边映射 knows，它们各有一些错误行，当 Loader 退出后，在 |
| <code>${struct}/current</code> 目录下会看到如下文件：</p> |
| <ul> |
| <li>person-b4cd32ab.parse-error: 顶点映射 person 解析错误的数据</li> |
| <li>person-b4cd32ab.insert-error: 顶点映射 person 插入错误的数据</li> |
| <li>knows-eb6b2bac.parse-error: 边映射 knows 解析错误的数据</li> |
| <li>knows-eb6b2bac.insert-error: 边映射 knows 插入错误的数据</li> |
| </ul> |
| <blockquote> |
| <p>.parse-error 和 .insert-error 并不总是一起存在的，只有存在解析出错的行才会有 .parse-error 文件，只有存在插入出错的行才会有 .insert-error 文件。</p> |
| </blockquote> |
| <h5 id="343-logs-目录文件说明">3.4.3 logs 目录文件说明</h5> |
| <p>程序执行过程中各日志及错误数据会写入 hugegraph-loader.log 文件中。</p> |
| <h5 id="344-执行命令">3.4.4 执行命令</h5> |
| <p>运行 bin/hugeloader 并传入参数</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-完整示例">4 完整示例</h3> |
| <p>下面给出的是 hugegraph-loader 包中 example 目录下的例子。</p> |
| <h4 id="41-准备数据">4.1 准备数据</h4> |
| <p>顶点文件：<code>example/file/vertex_person.csv</code></p> |
| <pre tabindex="0"><code class="language-csv" data-lang="csv">marko,29,Beijing |
| vadas,27,Hongkong |
| josh,32,Beijing |
| peter,35,Shanghai |
| "li,nary",26,"Wu,han" |
| </code></pre><p>顶点文件：<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>name|lang|price |
| </span></span><span style="display:flex;"><span>lop|java|328 |
| </span></span><span style="display:flex;"><span>ripple|java|199 |
| </span></span></code></pre></div><p>边文件：<code>example/file/edge_knows.json</code></p> |
| <pre tabindex="0"><code>{"source_name": "marko", "target_name": "vadas", "date": "20160110", "weight": 0.5} |
| {"source_name": "marko", "target_name": "josh", "date": "20130220", "weight": 1.0} |
| </code></pre><p>边文件：<code>example/file/edge_created.json</code></p> |
| <pre tabindex="0"><code>{"aname": "marko", "bname": "lop", "date": "20171210", "weight": 0.4} |
| {"aname": "josh", "bname": "lop", "date": "20091111", "weight": 0.4} |
| {"aname": "josh", "bname": "ripple", "date": "20171210", "weight": 1.0} |
| {"aname": "peter", "bname": "lop", "date": "20170324", "weight": 0.2} |
| </code></pre><h4 id="42-编写schema">4.2 编写schema</h4> |
| <p>schema文件：<code>example/file/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:#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">"name"</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">"age"</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">"city"</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">"weight"</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">"lang"</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">"date"</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">"price"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"name"</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">"software"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"name"</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">"personByName"</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">"person"</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">"name"</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">"personByAge"</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">"person"</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">"age"</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">"personByCity"</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">"person"</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">"city"</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">"personByAgeAndCity"</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">"person"</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">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"softwareByPrice"</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">"software"</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">"price"</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">"knows"</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">"person"</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">"person"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"person"</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">"software"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"createdByDate"</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">"created"</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">"date"</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">"createdByWeight"</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">"created"</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">"weight"</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">"knowsByWeight"</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">"knows"</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">"weight"</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><h4 id="43-编写输入源映射文件examplefilestructjson">4.3 编写输入源映射文件<code>example/file/struct.json</code></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-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">"vertices"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"example/vertex_person.csv"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CSV"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"charset"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"UTF-8"</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">"mapping"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"city"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"example/vertex_software.text"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"delimiter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"|"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"charset"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"GBK"</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">"edges"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"source"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"source_name"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"target_name"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"example/edge_knows.json"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"JSON"</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">"mapping"</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">"source_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"source"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"aname"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"bname"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"example/edge_created.json"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"JSON"</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">"mapping"</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">"aname"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"bname"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</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><h4 id="44-执行命令导入">4.4 执行命令导入</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>导入结束后，会出现类似如下统计信息：</p> |
| <pre tabindex="0"><code>vertices/edges has been loaded this time : 8/6 |
| -------------------------------------------------- |
| count metrics |
| input read success : 14 |
| input read failure : 0 |
| vertex parse success : 8 |
| vertex parse failure : 0 |
| vertex insert success : 8 |
| vertex insert failure : 0 |
| edge parse success : 6 |
| edge parse failure : 0 |
| edge insert success : 6 |
| edge insert failure : 0 |
| </code></pre> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-06d4cae527789fcda01ebf4e48c6559f">3.3 - HugeGraph-Tools Quick Start</h1> |
| |
| <h3 id="1-hugegraph-tools概述">1 HugeGraph-Tools概述</h3> |
| <p>HugeGraph-Tools 是 HugeGragh 的自动化部署、管理和备份/还原组件。</p> |
| <h3 id="2-获取-hugegraph-tools">2 获取 HugeGraph-Tools</h3> |
| <p>有两种方式可以获取 HugeGraph-Tools：</p> |
| <ul> |
| <li>下载二进制tar包</li> |
| <li>下载源码编译安装</li> |
| </ul> |
| <h4 id="21-下载二进制tar包">2.1 下载二进制tar包</h4> |
| <p>下载最新版本的 HugeGraph-Tools 包：</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://github.com/hugegraph/hugegraph-tools/releases/download/v<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>/hugegraph-tools-<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 hugegraph-tools-<span style="color:#4e9a06">${</span><span style="color:#000">version</span><span style="color:#4e9a06">}</span>.tar.gz |
| </span></span></code></pre></div><h4 id="22-下载源码编译安装">2.2 下载源码编译安装</h4> |
| <p>下载最新版本的 HugeGraph-Tools 源码包：</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/hugegraph/hugegraph-tools.git |
| </span></span></code></pre></div><p>编译生成 tar 包:</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>生成 tar 包 hugegraph-tools-${version}.tar.gz</p> |
| <h3 id="3-使用">3 使用</h3> |
| <h4 id="31-功能概览">3.1 功能概览</h4> |
| <p>解压后，进入 hugegraph-tools 目录，可以使用<code>bin/hugegraph</code>或者<code>bin/hugegraph help</code>来查看 usage 信息。主要分为：</p> |
| <ul> |
| <li>图管理类，graph-mode-set、graph-mode-get、graph-list、graph-get 和 graph-clear</li> |
| <li>异步任务管理类，task-list、task-get、task-delete、task-cancel 和 task-clear</li> |
| <li>Gremlin类，gremlin-execute 和 gremlin-schedule</li> |
| <li>备份/恢复类，backup、restore、migrate、schedule-backup 和 dump</li> |
| <li>安装部署类，deploy、clear、start-all 和 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-全局变量">3.2 [options]-全局变量</h5> |
| <p><code>options</code>是 HugeGraph-Tools 的全局变量，可以在 hugegraph-tools/bin/hugegraph 中配置,包括：</p> |
| <ul> |
| <li>–graph，HugeGraph-Tools 操作的图的名字，默认值是 hugegraph</li> |
| <li>–url，HugeGraph-Server 的服务地址，默认是 http://127.0.0.1:8080</li> |
| <li>–user，当 HugeGraph-Server 开启认证时，传递用户名</li> |
| <li>–password，当 HugeGraph-Server 开启认证时，传递用户的密码</li> |
| <li>–timeout，连接 HugeGraph-Server 时的超时时间，默认是 30s</li> |
| <li>–trust-store-file，证书文件的路径，当 –url 使用 https 时，HugeGraph-Client 使用的 truststore 文件，默认为空，代表使用 hugegraph-tools 内置的 truststore 文件 conf/hugegraph.truststore</li> |
| <li>–trust-store-password，证书文件的密码，当 –url 使用 https 时，HugeGraph-Client 使用的 truststore 的密码，默认为空，代表使用 hugegraph-tools 内置的 truststore 文件的密码</li> |
| </ul> |
| <p>上述全局变量，也可以通过环境变量来设置。一种方式是在命令行使用 export 设置临时环境变量，在该命令行关闭之前均有效</p> |
| <table> |
| <thead> |
| <tr> |
| <th>全局变量</th> |
| <th>环境变量</th> |
| <th>示例</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>–url</td> |
| <td>HUGEGRAPH_URL</td> |
| <td>export HUGEGRAPH_URL=http://127.0.0.1:8080</td> |
| </tr> |
| <tr> |
| <td>–graph</td> |
| <td>HUGEGRAPH_GRAPH</td> |
| <td>export HUGEGRAPH_GRAPH=hugegraph</td> |
| </tr> |
| <tr> |
| <td>–user</td> |
| <td>HUGEGRAPH_USERNAME</td> |
| <td>export HUGEGRAPH_USERNAME=admin</td> |
| </tr> |
| <tr> |
| <td>–password</td> |
| <td>HUGEGRAPH_PASSWORD</td> |
| <td>export HUGEGRAPH_PASSWORD=test</td> |
| </tr> |
| <tr> |
| <td>–timeout</td> |
| <td>HUGEGRAPH_TIMEOUT</td> |
| <td>export HUGEGRAPH_TIMEOUT=30</td> |
| </tr> |
| <tr> |
| <td>–trust-store-file</td> |
| <td>HUGEGRAPH_TRUST_STORE_FILE</td> |
| <td>export HUGEGRAPH_TRUST_STORE_FILE=/tmp/trust-store</td> |
| </tr> |
| <tr> |
| <td>–trust-store-password</td> |
| <td>HUGEGRAPH_TRUST_STORE_PASSWORD</td> |
| <td>export HUGEGRAPH_TRUST_STORE_PASSWORD=xxxx</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>另一种方式是在 bin/hugegraph 脚本中设置环境变量：</p> |
| <pre tabindex="0"><code>#!/bin/bash |
| |
| # Set environment here if needed |
| #export HUGEGRAPH_URL= |
| #export HUGEGRAPH_GRAPH= |
| #export HUGEGRAPH_USERNAME= |
| #export HUGEGRAPH_PASSWORD= |
| #export HUGEGRAPH_TIMEOUT= |
| #export HUGEGRAPH_TRUST_STORE_FILE= |
| #export HUGEGRAPH_TRUST_STORE_PASSWORD= |
| </code></pre><h5 id="33-图管理类graph-mode-setgraph-mode-getgraph-listgraph-get和graph-clear">3.3 图管理类，graph-mode-set、graph-mode-get、graph-list、graph-get和graph-clear</h5> |
| <ul> |
| <li>graph-mode-set，设置图的 restore mode |
| <ul> |
| <li>–graph-mode 或者 -m，必填项，指定将要设置的模式，合法值包括 [NONE, RESTORING, MERGING, LOADING]</li> |
| </ul> |
| </li> |
| <li>graph-mode-get，获取图的 restore mode</li> |
| <li>graph-list，列出某个 HugeGraph-Server 中全部的图</li> |
| <li>graph-get，获取某个图及其存储后端类型</li> |
| <li>graph-clear，清除某个图的全部 schema 和 data |
| <ul> |
| <li>–confirm-message 或者 -c，必填项，删除确认信息，需要手动输入，二次确认防止误删，“I’m sure to delete all data”，包括双引号</li> |
| </ul> |
| </li> |
| </ul> |
| <blockquote> |
| <p>当需要把备份的图原样恢复到一个新的图中的时候，需要先将图模式设置为 RESTORING 模式；当需要将备份的图合并到已存在的图中时，需要先将图模式设置为 MERGING 模式。</p> |
| </blockquote> |
| <h5 id="34-异步任务管理类task-listtask-get和task-delete">3.4 异步任务管理类，task-list、task-get和task-delete</h5> |
| <ul> |
| <li>task-list，列出某个图中的异步任务，可以根据任务的状态过滤 |
| <ul> |
| <li>–status，选填项，指定要查看的任务的状态，即按状态过滤任务</li> |
| <li>–limit，选填项，指定要获取的任务的数目，默认为 -1，意思为获取全部符合条件的任务</li> |
| </ul> |
| </li> |
| <li>task-get，获取某个异步任务的详细信息 |
| <ul> |
| <li>–task-id，必填项，指定异步任务的 ID</li> |
| </ul> |
| </li> |
| <li>task-delete，删除某个异步任务的信息 |
| <ul> |
| <li>–task-id，必填项，指定异步任务的 ID</li> |
| </ul> |
| </li> |
| <li>task-cancel，取消某个异步任务的执行 |
| <ul> |
| <li>–task-id，要取消的异步任务的 ID</li> |
| </ul> |
| </li> |
| <li>task-clear，清理完成的异步任务 |
| <ul> |
| <li>–force，选填项，设置时，表示清理全部异步任务，未执行完成的先取消，然后清除所有异步任务。默认只清理已完成的异步任务</li> |
| </ul> |
| </li> |
| </ul> |
| <h5 id="35-gremlin类gremlin-execute和gremlin-schedule">3.5 Gremlin类，gremlin-execute和gremlin-schedule</h5> |
| <ul> |
| <li>gremlin-execute，发送 Gremlin 语句到 HugeGraph-Server 来执行查询或修改操作，同步执行，结束后返回结果 |
| <ul> |
| <li>–file 或者 -f，指定要执行的脚本文件，UTF-8编码，与 –script 互斥</li> |
| <li>–script 或者 -s，指定要执行的脚本字符串，与 –file 互斥</li> |
| <li>–aliases 或者 -a，Gremlin 别名设置，格式为：key1=value1,key2=value2,…</li> |
| <li>–bindings 或者 -b，Gremlin 绑定设置，格式为：key1=value1,key2=value2,…</li> |
| <li>–language 或者 -l，Gremlin 脚本的语言，默认为 gremlin-groovy</li> |
| </ul> |
| <blockquote> |
| <p>–file 和 –script 二者互斥，必须设置其中之一</p> |
| </blockquote> |
| </li> |
| <li>gremlin-schedule，发送 Gremlin 语句到 HugeGraph-Server 来执行查询或修改操作，异步执行，任务提交后立刻返回异步任务id |
| <ul> |
| <li>–file 或者 -f，指定要执行的脚本文件，UTF-8编码，与 –script 互斥</li> |
| <li>–script 或者 -s，指定要执行的脚本字符串，与 –file 互斥</li> |
| <li>–bindings 或者 -b，Gremlin 绑定设置，格式为：key1=value1,key2=value2,…</li> |
| <li>–language 或者 -l，Gremlin 脚本的语言，默认为 gremlin-groovy</li> |
| </ul> |
| <blockquote> |
| <p>–file 和 –script 二者互斥，必须设置其中之一</p> |
| </blockquote> |
| </li> |
| </ul> |
| <h5 id="36-备份恢复类">3.6 备份/恢复类</h5> |
| <ul> |
| <li>backup，将某张图中的 schema 或者 data 备份到 HugeGraph 系统之外，以 JSON 形式存在本地磁盘或者 HDFS |
| <ul> |
| <li>–format，备份的格式，可选值包括 [json, text]，默认为 json</li> |
| <li>–all-properties，是否备份顶点/边全部的属性，仅在 –format 为 text 是有效，默认 false</li> |
| <li>–label，要备份的顶点/边的类型，仅在 –format 为 text 是有效，只有备份顶点或者边的时候有效</li> |
| <li>–properties，要备份的顶点/边的属性，逗号分隔，仅在 –format 为 text 是有效，只有备份顶点或者边的时候有效</li> |
| <li>–compress，备份时是否压缩数据，默认为 true</li> |
| <li>–directory 或者 -d，存储 schema 或者 data 的目录，本地目录时，默认为’./{graphName}’，HDFS 时，默认为 ‘{fs.default.name}/{graphName}’</li> |
| <li>–huge-types 或者 -t，要备份的数据类型，逗号分隔，可选值为 ‘all’ 或者 一个或多个 [vertex,edge,vertex_label,edge_label,property_key,index_label] 的组合，‘all’ 代表全部6种类型，即顶点、边和所有schema</li> |
| <li>–log 或者 -l，指定日志目录，默认为当前目录</li> |
| <li>–retry，指定失败重试次数，默认为 3</li> |
| <li>–split-size 或者 -s，指定在备份时对顶点或者边分块的大小，默认为 1048576</li> |
| <li>-D，用 -Dkey=value 的模式指定动态参数，用来备份数据到 HDFS 时，指定 HDFS 的配置项，例如：-Dfs.default.name=hdfs://localhost:9000</li> |
| </ul> |
| </li> |
| <li>restore，将 JSON 格式存储的 schema 或者 data 恢复到一个新图中（RESTORING 模式）或者合并到已存在的图中（MERGING 模式） |
| <ul> |
| <li>–directory 或者 -d，存储 schema 或者 data 的目录，本地目录时，默认为’./{graphName}’，HDFS 时，默认为 ‘{fs.default.name}/{graphName}’</li> |
| <li>–clean，是否在恢复图完成后删除 –directory 指定的目录，默认为 false</li> |
| <li>–huge-types 或者 -t，要恢复的数据类型，逗号分隔，可选值为 ‘all’ 或者 一个或多个 [vertex,edge,vertex_label,edge_label,property_key,index_label] 的组合，‘all’ 代表全部6种类型，即顶点、边和所有schema</li> |
| <li>–log 或者 -l，指定日志目录，默认为当前目录</li> |
| <li>–retry，指定失败重试次数，默认为 3</li> |
| <li>-D，用 -Dkey=value 的模式指定动态参数，用来从 HDFS 恢复图时，指定 HDFS 的配置项，例如：-Dfs.default.name=hdfs://localhost:9000</li> |
| </ul> |
| <blockquote> |
| <p>只有当 –format 为 json 执行 backup 时，才可以使用 restore 命令恢复</p> |
| </blockquote> |
| </li> |
| <li>migrate, 将当前连接的图迁移至另一个 HugeGraphServer 中 |
| <ul> |
| <li>–target-graph，目标图的名字，默认为 hugegraph</li> |
| <li>–target-url，目标图所在的 HugeGraphServer，默认为 http://127.0.0.1:8081</li> |
| <li>–target-username，访问目标图的用户名</li> |
| <li>–target-password，访问目标图的密码</li> |
| <li>–target-timeout，访问目标图的超时时间</li> |
| <li>–target-trust-store-file，访问目标图使用的 truststore 文件</li> |
| <li>–target-trust-store-password，访问目标图使用的 truststore 的密码</li> |
| <li>–directory 或者 -d，迁移过程中，存储源图的 schema 或者 data 的目录，本地目录时，默认为’./{graphName}’，HDFS 时，默认为 ‘{fs.default.name}/{graphName}’</li> |
| <li>–huge-types 或者 -t，要迁移的数据类型，逗号分隔，可选值为 ‘all’ 或者 一个或多个 [vertex,edge,vertex_label,edge_label,property_key,index_label] 的组合，‘all’ 代表全部6种类型，即顶点、边和所有schema</li> |
| <li>–log 或者 -l，指定日志目录，默认为当前目录</li> |
| <li>–retry，指定失败重试次数，默认为 3</li> |
| <li>–split-size 或者 -s，指定迁移过程中对源图进行备份时顶点或者边分块的大小，默认为 1048576</li> |
| <li>-D，用 -Dkey=value 的模式指定动态参数，用来在迁移图过程中需要备份数据到 HDFS 时，指定 HDFS 的配置项，例如：-Dfs.default.name=hdfs://localhost:9000</li> |
| <li>–graph-mode 或者 -m，将源图恢复到目标图时将目标图设置的模式，合法值包括 [RESTORING, MERGING]</li> |
| <li>–keep-local-data，是否保留在迁移图的过程中产生的源图的备份，默认为 false，即默认迁移图结束后不保留产生的源图备份</li> |
| </ul> |
| </li> |
| <li>schedule-backup，周期性对图执行备份操作，并保留一定数目的最新备份（目前仅支持本地文件系统） |
| <ul> |
| <li>–directory 或者 -d，必填项，指定备份数据的目录</li> |
| <li>–backup-num，选填项，指定保存的最新的备份的数目，默认为 3</li> |
| <li>–interval，选填项，指定进行备份的周期，格式同 Linux crontab 格式</li> |
| </ul> |
| </li> |
| <li>dump，把整张图的顶点和边全部导出，默认以<code>vertex vertex-edge1 vertex-edge2...</code>JSON格式存储。 |
| 用户也可以自定义存储格式，只需要在<code>hugegraph-tools/src/main/java/com/baidu/hugegraph/formatter</code> |
| 目录下实现一个继承自<code>Formatter</code>的类，例如<code>CustomFormatter</code>，使用时指定该类为formatter即可，例如 |
| <code>bin/hugegraph dump -f CustomFormatter</code> |
| <ul> |
| <li>–formatter 或者 -f，指定使用的 formatter，默认为 JsonFormatter</li> |
| <li>–directory 或者 -d，存储 schema 或者 data 的目录，默认为当前目录</li> |
| <li>–log 或者 -l，指定日志目录，默认为当前目录</li> |
| <li>–retry，指定失败重试次数，默认为 3</li> |
| <li>–split-size 或者 -s，指定在备份时对顶点或者边分块的大小，默认为 1048576</li> |
| <li>-D，用 -Dkey=value 的模式指定动态参数，用来备份数据到 HDFS 时，指定 HDFS 的配置项，例如：-Dfs.default.name=hdfs://localhost:9000</li> |
| </ul> |
| </li> |
| </ul> |
| <h5 id="37-安装部署类">3.7 安装部署类</h5> |
| <ul> |
| <li>deploy，一键下载、安装和启动 HugeGraph-Server 和 HugeGraph-Studio |
| <ul> |
| <li>-v，必填项，指明安装的 HugeGraph-Server 和 HugeGraph-Studio 的版本号，最新的是 0.9</li> |
| <li>-p，必填项，指定安装的 HugeGraph-Server 和 HugeGraph-Studio 目录</li> |
| <li>-u，选填项，指定下载 HugeGraph-Server 和 HugeGraph-Studio 压缩包的链接</li> |
| </ul> |
| </li> |
| <li>clear，清理 HugeGraph-Server 和 HugeGraph-Studio 目录和tar包 |
| <ul> |
| <li>-p，必填项，指定要清理的 HugeGraph-Server 和 HugeGraph-Studio 的目录</li> |
| </ul> |
| </li> |
| <li>start-all，一键启动 HugeGraph-Server 和 HugeGraph-Studio，并启动监控，服务死掉时自动拉起服务 |
| <ul> |
| <li>-v，必填项，指明要启动的 HugeGraph-Server 和 HugeGraph-Studio 的版本号，最新的是 0.9</li> |
| <li>-p，必填项，指定安装了 HugeGraph-Server 和 HugeGraph-Studio 的目录</li> |
| </ul> |
| </li> |
| <li>stop-all，一键关闭 HugeGraph-Server 和 HugeGraph-Studio</li> |
| </ul> |
| <blockquote> |
| <p>deploy命令中有可选参数 -u，提供时会使用指定的下载地址替代默认下载地址下载 tar 包，并且将地址写入<code>~/hugegraph-download-url-prefix</code>文件中；之后如果不指定地址时，会优先从<code>~/hugegraph-download-url-prefix</code>指定的地址下载 tar 包；如果 -u 和<code>~/hugegraph-download-url-prefix</code>都没有时，会从默认下载地址进行下载</p> |
| </blockquote> |
| <h5 id="38-具体命令参数">3.8 具体命令参数</h5> |
| <p>各子命令的具体参数如下：</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">"I'm sure to delete all data"</span>. |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">(</span>Note: include <span style="color:#4e9a06">""</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">'key1=value1,key2=value2...'</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">'key1=value1,key2=value2...'</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">'key1=value1,key2=value2...'</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">'./{graphname}'</span> in |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">local</span> file system or <span style="color:#4e9a06">'{fs.default.name}/{graphname}'</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">','</span> <span style="color:#204a87;font-weight:bold">if</span> more than one. <span style="color:#4e9a06">'all'</span> means |
| </span></span><span style="display:flex;"><span> all vertices, edges and schema, in other words, <span style="color:#4e9a06">'all'</span> equals with |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">'vertex,edge,vertex_label,edge_label,property_key,index_label'</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">"a b c d e"</span>. <span style="color:#4e9a06">'a'</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">'b'</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">'c'</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">'d'</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">'e'</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">"*"</span> means all |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#4e9a06">"0 0 * * *"</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">'./{graphname}'</span> in |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">local</span> file system or <span style="color:#4e9a06">'{fs.default.name}/{graphname}'</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">'./{graphname}'</span> in |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">local</span> file system or <span style="color:#4e9a06">'{fs.default.name}/{graphname}'</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">','</span> <span style="color:#204a87;font-weight:bold">if</span> more than one. <span style="color:#4e9a06">'all'</span> means |
| </span></span><span style="display:flex;"><span> all vertices, edges and schema, in other words, <span style="color:#4e9a06">'all'</span> equals with |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">'vertex,edge,vertex_label,edge_label,property_key,index_label'</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">'./{graphname}'</span> in |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87">local</span> file system or <span style="color:#4e9a06">'{fs.default.name}/{graphname}'</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">','</span> <span style="color:#204a87;font-weight:bold">if</span> more than one. <span style="color:#4e9a06">'all'</span> means |
| </span></span><span style="display:flex;"><span> all vertices, edges and schema, in other words, <span style="color:#4e9a06">'all'</span> equals with |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">'vertex,edge,vertex_label,edge_label,property_key,index_label'</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-具体命令示例">3.9 具体命令示例</h5> |
| <h6 id="1-gremlin语句">1. gremlin语句</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"># 同步执行gremlin</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">'g.V().count()'</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 异步执行gremlin</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">'g.V().count()'</span> |
| </span></span></code></pre></div><h6 id="2-查看task情况">2. 查看task情况</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-图模式查看和设置">3. 图模式查看和设置</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-清理图">4. 清理图</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">"I'm sure to delete all data"</span> |
| </span></span></code></pre></div><h6 id="5-图备份">5. 图备份</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-周期性的备份">6. 周期性的备份</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-图恢复">7. 图恢复</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"># 设置图模式</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"># 恢复图</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"># 恢复图模式</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-图迁移">8. 图迁移</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> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-751ed124ec6dbb96d5e65c62dc9d4e85">3.4 - HugeGraph-Hubble Quick Start</h1> |
| |
| <h3 id="1-hugegraph-hubble概述">1 HugeGraph-Hubble概述</h3> |
| <p>HugeGraph是一款面向分析型，支持批量操作的图数据库系统，它由百度安全团队自主研发，全面支持<a href="https://tinkerpop.apache.org">Apache TinkerPop3</a>框架和<a href="https://tinkerpop.apache.org/gremlin.html">Gremlin</a>图查询语言，提供导出、备份、恢复等完善的工具链生态，有效解决海量图数据的存储、查询和关联分析需求。HugeGraph广泛应用于银行券商的风控打击、保险理赔、推荐搜索、公安犯罪打击、知识图谱构建、网络安全、IT运维等领域，致力于让更多行业、组织及用户享受到更广泛的数据综合价值。</p> |
| <p><strong>HugeGraph-Hubble</strong> 是HugeGraph的一站式可视化分析平台，平台涵盖了从数据建模，到数据快速导入，再到数据的在线、离线分析、以及图的统一管理的全过程，实现了图应用的全流程向导式操作，旨在提升用户的使用流畅度，降低用户的使用门槛，提供更为高效易用的使用体验。</p> |
| <p>平台主要包括以下模块：</p> |
| <h5 id="图管理">图管理</h5> |
| <p>图管理模块通过图的创建，连接平台与图数据，实现多图的统一管理，并实现图的访问、编辑、删除、查询操作。</p> |
| <h5 id="元数据建模">元数据建模</h5> |
| <p>元数据建模模块通过创建属性库，顶点类型，边类型，索引类型，实现图模型的构建与管理，平台提供两种模式，列表模式和图模式，可实时展示元数据模型，更加直观。同时还提供了跨图的元数据复用功能，省去相同元数据繁琐的重复创建过程，极大地提升建模效率，增强易用性。</p> |
| <h5 id="数据导入">数据导入</h5> |
| <p>数据导入是将用户的业务数据转化为图的顶点和边并插入图数据库中，平台提供了向导式的可视化导入模块，通过创建导入任务，实现导入任务的管理及多个导入任务的并行运行，提高导入效能。进入导入任务后，只需跟随平台步骤提示，按需上传文件，填写内容，就可轻松实现图数据的导入过程，同时支持断点续传，错误重试机制等，降低导入成本，提升效率。</p> |
| <h5 id="图分析">图分析</h5> |
| <p>通过输入图遍历语言Gremlin可实现图数据的高性能通用分析，并提供顶点的定制化多维路径查询等功能，提供3种图结果展示方式，包括：图形式、表格形式、Json形式，多维度展示数据形态，满足用户使用的多种场景需求。提供运行记录及常用语句收藏等功能，实现图操作的可追溯，以及查询输入的复用共享，快捷高效。支持图数据的导出，导出格式为Json格式。</p> |
| <h5 id="任务管理">任务管理</h5> |
| <p>对于需要遍历全图的Gremlin任务，索引的创建与重建等耗时较长的异步任务，平台提供相应的任务管理功能，实现异步任务的统一的管理与结果查看。</p> |
| <h3 id="2平台使用流程">2 平台使用流程</h3> |
| <p>平台的模块使用流程如下：</p> |
| <center> |
| <img src="/docs/images/images-hubble/2平台使用流程.png" alt="image"> |
| </center> |
| <h3 id="3平台使用说明">3 平台使用说明</h3> |
| <h4 id="31图管理">3.1 图管理</h4> |
| <h5 id="311图创建">3.1.1 图创建</h5> |
| <p>图管理模块下，点击【创建图】，通过填写图ID、图名称、主机名、端口号、用户名、密码的信息，实现多图的连接。</p> |
| <center> |
| <img src="/docs/images/images-hubble/311图创建.png" alt="image"> |
| </center> |
| <p>创建图填写内容如下：</p> |
| <center> |
| <img src="/docs/images/images-hubble/311图创建2.png" alt="image"> |
| </center> |
| <h5 id="312图访问">3.1.2 图访问</h5> |
| <p>实现图空间的信息访问，进入后，可进行图的多维查询分析、元数据管理、数据导入、算法分析等操作。</p> |
| <center> |
| <img src="/docs/images/images-hubble/312图访问.png" alt="image"> |
| </center> |
| <h5 id="313图管理">3.1.3 图管理</h5> |
| <ol> |
| <li>用户通过对图的概览、搜索以及单图的信息编辑与删除，实现图的统一管理。</li> |
| <li>搜索范围：可对图名称和ID进行搜索。</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/313图管理.png" alt="image"> |
| </center> |
| <h4 id="32元数据建模列表图模式">3.2 元数据建模（列表+图模式）</h4> |
| <h5 id="321模块入口">3.2.1 模块入口</h5> |
| <p>左侧导航处：</p> |
| <center> |
| <img src="/docs/images/images-hubble/321元数据入口.png" alt="image"> |
| </center> |
| <h5 id="322属性类型">3.2.2 属性类型</h5> |
| <h6 id="3221创建">3.2.2.1 创建</h6> |
| <ol> |
| <li>填写或选择属性名称、数据类型、基数，完成属性的创建。</li> |
| <li>创建的属性可作为顶点类型和边类型的属性。</li> |
| </ol> |
| <p>列表模式：</p> |
| <center> |
| <img src="/docs/images/images-hubble/3221属性创建.png" alt="image"> |
| </center> |
| <p>图模式：</p> |
| <center> |
| <img src="/docs/images/images-hubble/3221属性创建2.png" alt="image"> |
| </center> |
| <h6 id="3222复用">3.2.2.2 复用</h6> |
| <ol> |
| <li>平台提供【复用】功能，可直接复用其他图的元数据。</li> |
| <li>选择需要复用的图ID，继续选择需要复用的属性，之后平台会进行是否冲突的校验，通过后，可实现元数据的复用。</li> |
| </ol> |
| <p>选择复用项：</p> |
| <center> |
| <img src="/docs/images/images-hubble/3222属性复用.png" alt="image"> |
| </center> |
| <p>校验复用项：</p> |
| <center> |
| <img src="/docs/images/images-hubble/3222属性复用2.png" alt="image"> |
| </center> |
| <h6 id="3223管理">3.2.2.3 管理</h6> |
| <ol> |
| <li>在属性列表中可进行单条删除或批量删除操作。</li> |
| </ol> |
| <h5 id="323顶点类型">3.2.3 顶点类型</h5> |
| <h6 id="3231创建">3.2.3.1 创建</h6> |
| <ol> |
| <li>填写或选择顶点类型名称、ID策略、关联属性、主键属性，顶点样式、查询结果中顶点下方展示的内容，以及索引的信息：包括是否创建类型索引，及属性索引的具体内容，完成顶点类型的创建。</li> |
| </ol> |
| <p>列表模式：</p> |
| <center> |
| <img src="/docs/images/images-hubble/3231顶点创建.png" alt="image"> |
| </center> |
| <p>图模式：</p> |
| <center> |
| <img src="/docs/images/images-hubble/3231顶点创建2.png" alt="image"> |
| </center> |
| <h6 id="3232复用">3.2.3.2 复用</h6> |
| <ol> |
| <li>顶点类型的复用，会将此类型关联的属性和属性索引一并复用。</li> |
| <li>复用功能使用方法类似属性的复用，见3.2.2.2。</li> |
| </ol> |
| <h6 id="3233管理">3.2.3.3 管理</h6> |
| <ol> |
| <li> |
| <p>可进行编辑操作，顶点样式、关联类型、顶点展示内容、属性索引可编辑，其余不可编辑。</p> |
| </li> |
| <li> |
| <p>可进行单条删除或批量删除操作。</p> |
| </li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/3233顶点删除.png" alt="image"> |
| </center> |
| <h5 id="324边类型">3.2.4 边类型</h5> |
| <h6 id="3241创建">3.2.4.1 创建</h6> |
| <ol> |
| <li>填写或选择边类型名称、起点类型、终点类型、关联属性、是否允许多次连接、边样式、查询结果中边下方展示的内容，以及索引的信息：包括是否创建类型索引，及属性索引的具体内容，完成边类型的创建。</li> |
| </ol> |
| <p>列表模式：</p> |
| <center> |
| <img src="/docs/images/images-hubble/3241边创建.png" alt="image"> |
| </center> |
| <p>图模式：</p> |
| <center> |
| <img src="/docs/images/images-hubble/3241边创建2.png" alt="image"> |
| </center> |
| <h6 id="3242复用">3.2.4.2 复用</h6> |
| <ol> |
| <li>边类型的复用，会将此类型的起点类型、终点类型、关联的属性和属性索引一并复用。</li> |
| <li>复用功能使用方法类似属性的复用，见3.2.2.2。</li> |
| </ol> |
| <h6 id="3243管理">3.2.4.3 管理</h6> |
| <ol> |
| <li>可进行编辑操作，边样式、关联属性、边展示内容、属性索引可编辑，其余不可编辑，同顶点类型。</li> |
| <li>可进行单条删除或批量删除操作。</li> |
| </ol> |
| <h5 id="325索引类型">3.2.5 索引类型</h5> |
| <p>展示顶点类型和边类型的顶点索引和边索引。</p> |
| <h4 id="33数据导入">3.3 数据导入</h4> |
| <p>数据导入的使用流程如下：</p> |
| <center> |
| <img src="/docs/images/images-hubble/33导入流程.png" alt="image"> |
| </center> |
| <h5 id="331模块入口">3.3.1 模块入口</h5> |
| <p>左侧导航处：</p> |
| <center> |
| <img src="/docs/images/images-hubble/331导入入口.png" alt="image"> |
| </center> |
| <h5 id="332创建任务">3.3.2 创建任务</h5> |
| <ol> |
| <li>填写任务名称和备注（非必填），可以创建导入任务。</li> |
| <li>可创建多个导入任务，并行导入。</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/332创建任务.png" alt="image"> |
| </center> |
| <h5 id="333上传文件">3.3.3 上传文件</h5> |
| <ol> |
| <li>上传需要构图的文件，目前支持的格式为CSV，后续会不断更新。</li> |
| <li>可同时上传多个文件。</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/333上传文件.png" alt="image"> |
| </center> |
| <h5 id="334设置数据映射">3.3.4 设置数据映射</h5> |
| <ol> |
| <li> |
| <p>对上传的文件分别设置数据映射，包括文件设置和类型设置</p> |
| </li> |
| <li> |
| <p>文件设置：勾选或填写是否包含表头、分隔符、编码格式等文件本身的设置内容，均设置默认值，无需手动填写</p> |
| </li> |
| <li> |
| <p>类型设置：</p> |
| <ol> |
| <li> |
| <p>顶点映射和边映射：</p> |
| <p>【顶点类型】 ：选择顶点类型，并为其ID映射上传文件中列数据；</p> |
| <p>【边类型】：选择边类型，为其起点类型和终点类型的ID列映射上传文件的列数据；</p> |
| </li> |
| <li> |
| <p>映射设置：为选定的顶点类型的属性映射上传文件中的列数据，此处，若属性名称与文件的表头名称一致，可自动匹配映射属性，无需手动填选</p> |
| </li> |
| <li> |
| <p>完成设置后，显示设置列表，方可进行下一步操作，支持映射的新增、编辑、删除操作</p> |
| </li> |
| </ol> |
| </li> |
| </ol> |
| <p>设置映射的填写内容：</p> |
| <center> |
| <img src="/docs/images/images-hubble/334设置映射.png" alt="image"> |
| </center> |
| <p>映射列表：</p> |
| <center> |
| <img src="/docs/images/images-hubble/334设置映射2.png" alt="image"> |
| </center> |
| <h5 id="335导入数据">3.3.5 导入数据</h5> |
| <p>导入前需要填写导入设置参数，填写完成后，可开始向图库中导入数据</p> |
| <ol> |
| <li>导入设置</li> |
| </ol> |
| <ul> |
| <li>导入设置参数项如下图所示，均设置默认值，无需手动填写</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/335导入设置.png" alt="image"> |
| </center> |
| <ol start="2"> |
| <li>导入详情</li> |
| </ol> |
| <ul> |
| <li>点击开始导入，开始文件的导入任务</li> |
| <li>导入详情中提供每个上传文件设置的映射类型、导入速度、导入的进度、耗时以及当前任务的具体状态，并可对每个任务进行暂停、继续、停止等操作</li> |
| <li>若导入失败，可查看具体原因</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/335导入详情.png" alt="image"> |
| </center> |
| <h4 id="34数据分析">3.4 数据分析</h4> |
| <h5 id="341模块入口">3.4.1 模块入口</h5> |
| <p>左侧导航处：</p> |
| <center> |
| <img src="/docs/images/images-hubble/341分析入口.png" alt="image"> |
| </center> |
| <h5 id="342多图切换">3.4.2 多图切换</h5> |
| <p>通过左侧切换入口，灵活切换多图的操作空间</p> |
| <center> |
| <img src="/docs/images/images-hubble/342多图切换.png" alt="image"> |
| </center> |
| <h5 id="343图分析与处理">3.4.3 图分析与处理</h5> |
| <p>HugeGraph支持Apache TinkerPop3的图遍历查询语言Gremlin，Gremlin是一种通用的图数据库查询语言，通过输入Gremlin语句，点击执行，即可执行图数据的查询分析操作，并可实现顶点/边的创建及删除、顶点/边的属性修改等。</p> |
| <p>Gremlin查询后，下方为图结果展示区域，提供3种图结果展示方式，分别为：【图模式】、【表格模式】、【Json模式】。</p> |
| <p>支持缩放、居中、全屏、导出等操作。</p> |
| <p>【图模式】</p> |
| <center> |
| <img src="/docs/images/images-hubble/343图分析-图.png" alt="image"> |
| </center> |
| <p>【表格模式】</p> |
| <center> |
| <img src="/docs/images/images-hubble/343图分析-表格.png" alt="image"> |
| </center> |
| <p>【Json模式】</p> |
| <center> |
| <img src="/docs/images/images-hubble/343图分析-json.png" alt="image"> |
| </center> |
| <h5 id="344数据详情">3.4.4 数据详情</h5> |
| <p>点击顶点/边实体，可查看顶点/边的数据详情，包括：顶点/边类型，顶点ID，属性及对应值，拓展图的信息展示维度，提高易用性。</p> |
| <h5 id="345图结果的多维路径查询">3.4.5 图结果的多维路径查询</h5> |
| <p>除了全局的查询外，可针对查询结果中的顶点进行深度定制化查询以及隐藏操作，实现图结果的定制化挖掘。</p> |
| <p>右击顶点，出现顶点的菜单入口，可进行展示、查询、隐藏等操作。</p> |
| <ul> |
| <li>展开：点击后，展示与选中点关联的顶点。</li> |
| <li>查询：通过选择与选中点关联的边类型及边方向，在此条件下，再选择其属性及相应筛选规则，可实现定制化的路径展示。</li> |
| <li>隐藏：点击后，隐藏选中点及与之关联的边。</li> |
| </ul> |
| <p>双击顶点，也可展示与选中点关联的顶点。</p> |
| <center> |
| <img src="/docs/images/images-hubble/345定制路径查询.png" alt="image"> |
| </center> |
| <h5 id="346新增顶点边">3.4.6 新增顶点/边</h5> |
| <h6 id="3461新增顶点">3.4.6.1 新增顶点</h6> |
| <p>在图区可通过两个入口，动态新增顶点，如下：</p> |
| <ol> |
| <li>点击图区面板，出现添加顶点入口</li> |
| <li>点击右上角的操作栏中的首个图标</li> |
| </ol> |
| <p>通过选择或填写顶点类型、ID值、属性信息，完成顶点的增加。</p> |
| <p>入口如下：</p> |
| <center> |
| <img src="/docs/images/images-hubble/346新增顶点.png" alt="image"> |
| </center> |
| <p>添加顶点内容如下：</p> |
| <center> |
| <img src="/docs/images/images-hubble/346新增顶点2.png" alt="image"> |
| </center> |
| <h6 id="3462新增边">3.4.6.2 新增边</h6> |
| <p>右击图结果中的顶点，可增加该点的出边或者入边。</p> |
| <h5 id="347执行记录与收藏的查询">3.4.7 执行记录与收藏的查询</h5> |
| <ol> |
| <li>图区下方记载每次查询记录，包括：查询时间、执行类型、内容、状态、耗时、以及【收藏】和【加载】操作，实现图执行的全方位记录，有迹可循，并可对执行内容快速加载复用</li> |
| <li>提供语句的收藏功能，可对常用语句进行收藏操作，方便高频语句快速调用</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/347收藏.png" alt="image"> |
| </center> |
| <h4 id="35任务管理">3.5 任务管理</h4> |
| <h5 id="351模块入口">3.5.1 模块入口</h5> |
| <p>左侧导航处：</p> |
| <center> |
| <img src="/docs/images/images-hubble/351任务管理入口.png" alt="image"> |
| </center> |
| <h5 id="352任务管理">3.5.2 任务管理</h5> |
| <ol> |
| <li>提供异步任务的统一的管理与结果查看，异步任务包括4类，分别为：</li> |
| </ol> |
| <ul> |
| <li>gremlin：Gremlin任务</li> |
| <li>algorithm：OLAP算法任务</li> |
| <li>remove_schema：删除元数据</li> |
| <li>rebuild_index：重建索引</li> |
| </ul> |
| <ol start="2"> |
| <li>列表显示当前图的异步任务信息，包括：任务ID，任务名称，任务类型，创建时间，耗时，状态，操作，实现对异步任务的管理。</li> |
| <li>支持对任务类型和状态进行筛选</li> |
| <li>支持搜索任务ID和任务名称</li> |
| <li>可对异步任务进行删除或批量删除操作</li> |
| </ol> |
| <center> |
| <img src="/docs/images/images-hubble/352任务列表.png" alt="image"> |
| </center> |
| <h5 id="353gremlin异步任务">3.5.3 Gremlin异步任务</h5> |
| <p>1.创建任务</p> |
| <ul> |
| <li>数据分析模块，目前支持两种Gremlin操作，Gremlin查询和Gremlin任务；若用户切换到Gremlin任务，点击执行后，在异步任务中心会建立一条异步任务； |
| 2.任务提交</li> |
| <li>任务提交成功后，图区部分返回提交结果和任务ID |
| 3.任务详情</li> |
| <li>提供【查看】入口，可跳转到任务详情查看当前任务具体执行情况跳转到任务中心后，直接显示当前执行的任务行</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/353gremlin任务.png" alt="image"> |
| </center> |
| <p>点击查看入口，跳转到任务管理列表，如下：</p> |
| <center> |
| <img src="/docs/images/images-hubble/353gremlin任务2.png" alt="image"> |
| </center> |
| <p>4.查看结果</p> |
| <ul> |
| <li>结果通过json形式展示</li> |
| </ul> |
| <h5 id="354olap算法任务">3.5.4 OLAP算法任务</h5> |
| <p>Hubble上暂未提供可视化的OLAP算法执行，可调用RESTful API进行OLAP类算法任务，在任务管理中通过ID找到相应任务，查看进度与结果等。</p> |
| <h5 id="355删除元数据重建索引">3.5.5 删除元数据、重建索引</h5> |
| <p>1.创建任务</p> |
| <ul> |
| <li>在元数据建模模块中，删除元数据时，可建立删除元数据的异步任务</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/355删除元数据.png" alt="image"> |
| </center> |
| <ul> |
| <li>在编辑已有的顶点/边类型操作中，新增索引时，可建立创建索引的异步任务</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/355构建索引.png" alt="image"> |
| </center> |
| <p>2.任务详情</p> |
| <ul> |
| <li>确认/保存后，可跳转到任务中心查看当前任务的详情</li> |
| </ul> |
| <center> |
| <img src="/docs/images/images-hubble/355任务详情.png" alt="image"> |
| </center> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-9cbf1b01e876dc8cdc2da1c17759eed3">3.5 - HugeGraph-Client Quick Start</h1> |
| |
| <h3 id="1-hugegraph-client概述">1 HugeGraph-Client概述</h3> |
| <p>HugeGraph-Client向HugeGraph-Server发出HTTP请求，获取并解析Server的执行结果。目前仅提供了Java版，用户可以使用HugeGraph-Client编写Java代码操作HugeGraph，比如元数据和图数据的增删改查，或者执行gremlin语句。</p> |
| <h3 id="2-环境要求">2 环境要求</h3> |
| <ul> |
| <li>jdk1.8</li> |
| <li>maven-3.3.9</li> |
| </ul> |
| <h3 id="3-使用流程">3 使用流程</h3> |
| <p>使用HugeGraph-Client的基本步骤如下:</p> |
| <ul> |
| <li>新建Eclipse/ IDEA Maven项目；</li> |
| <li>在pom文件中添加HugeGraph-Client依赖；</li> |
| <li>创建类，调用HugeGraph-Client接口；</li> |
| </ul> |
| <p>详细使用过程见下节完整示例。</p> |
| <h3 id="4-完整示例">4 完整示例</h3> |
| <h4 id="41-新建maven工程">4.1 新建Maven工程</h4> |
| <p>可以选择Eclipse或者Intellij Idea创建工程：</p> |
| <ul> |
| <li><a href="http://www.vogella.com/tutorials/EclipseMaven/article.html">Eclipse新建Maven工程</a></li> |
| <li><a href="https://vaadin.com/docs/-/part/framework/getting-started/getting-started-idea.html">Intellij Idea 创建maven工程</a></li> |
| </ul> |
| <h4 id="42-添加hugegraph-client依赖">4.2 添加hugegraph-client依赖</h4> |
| <p>添加hugegraph-client依赖</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold"><dependencies></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><dependency></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><groupId></span>com.baidu.hugegraph<span style="color:#204a87;font-weight:bold"></groupId></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><artifactId></span>hugegraph-client<span style="color:#204a87;font-weight:bold"></artifactId></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><version></span>${version}<span style="color:#204a87;font-weight:bold"></version></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"></dependency></span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold"></dependencies></span> |
| </span></span></code></pre></div><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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">"http://localhost:8080"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"hugegraph"</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">"name"</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">"age"</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">"city"</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">"weight"</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">"lang"</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">"date"</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">"price"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"name"</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">"software"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"name"</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">"personByCity"</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">"person"</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">"city"</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">"personByAgeAndCity"</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">"person"</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">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"softwareByPrice"</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">"software"</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">"price"</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">"knows"</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">"person"</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">"person"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"person"</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">"software"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"createdByDate"</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">"created"</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">"date"</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">"createdByWeight"</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">"created"</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">"weight"</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">"knowsByWeight"</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">"knows"</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">"weight"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Hongkong"</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">"software"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lop"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"josh"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</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">"software"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"peter"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Shanghai"</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">"knows"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2016-01-10"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"knows"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2013-02-20"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2017-12-10"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2009-11-11"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2017-12-10"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2017-03-24"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"==== Path ===="</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">"g.V().outE().path()"</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"><</span><span style="color:#000">Result</span><span style="color:#ce5c00;font-weight:bold">></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">-></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"><</span><span style="color:#000">Object</span><span style="color:#ce5c00;font-weight:bold">></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">-></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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">com.baidu.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">"http://localhost:8080"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"hugegraph"</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">"name"</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">"age"</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">"lang"</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">"date"</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">"price"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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">"name"</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">"person"</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">"price"</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">"price"</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">"software"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"name"</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">"softwareByPrice"</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">"software"</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">"price"</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">"knows"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"person"</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">"date"</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">"created"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"software"</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">"date"</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">"createdByDate"</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">"created"</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">"date"</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">"name"</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">"person"</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">"knows"</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">"createdByDate"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"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">"age"</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">"software"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"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">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</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">"price"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"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">"age"</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">"software"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"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">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</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">"price"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"peter"</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">"age"</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">"knows"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2016-01-10"</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">"knows"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2013-02-20"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2017-12-10"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2017-12-10"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"2009-11-11"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2017-03-24"</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"><</span><span style="color:#000">Vertex</span><span style="color:#ce5c00;font-weight:bold">></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"><>();</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"><</span><span style="color:#000">Edge</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">new</span> <span style="color:#000">ArrayList</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">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">-></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">-></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-运行example">4.4 运行Example</h3> |
| <p>运行Example之前需要启动Server, 启动过程见<a href="/docs/quickstart/hugegraph-server">HugeGraph-Server Quick Start</a></p> |
| <h3 id="45-example示例说明">4.5 Example示例说明</h3> |
| <p>示例说明见<a href="/docs/clients/hugegraph-client">HugeGraph-Client基本API介绍</a></p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-5721a0e0f2e5d89617d19f04a6a14d16">3.6 - HugeGraph-Spark Quick Start</h1> |
| |
| <blockquote> |
| <p>Note: This project is archived now, consider use hugegraph-computer instead</p> |
| </blockquote> |
| <h3 id="1-hugegraph-spark概述">1 HugeGraph-Spark概述</h3> |
| <p>HugeGraph-Spark 是一个连接 HugeGraph 和 Spark GraphX 的工具，能够读取 HugeGraph 中的数据并转换成 Spark GraphX 的 RDD，然后执行 GraphX 中的各种图算法。</p> |
| <h3 id="2-环境依赖">2 环境依赖</h3> |
| <p>在使用 HugeGraph-Spark 前，需要依赖 HugeGraph Server 服务，下载和启动 Server 请参考 <a href="/docs/quickstart/hugegraph-server">HugeGraph-Server Quick Start</a>。另外，由于 HugeGraph-Spark 需要使用 Spark GraphX，所以还需要下载 spark，本文的示例使用的是 apache-spark-2.1.1。</p> |
| <pre tabindex="0"><code>wget https://archive.apache.org/dist/spark/spark-2.1.1/spark-2.1.1-bin-hadoop2.7.tgz |
| tar -zxvf spark-2.1.1-bin-hadoop2.7.tgz |
| cd spark-2.1.1-bin-hadoop2.7 |
| </code></pre><p>然后将 hugegraph-spark 的 jar 包拷贝到 spark 的 jars 目录下</p> |
| <pre tabindex="0"><code>cp {dir}/hugegraph-spark-0.9.0.jar jars |
| </code></pre><h3 id="3-配置">3 配置</h3> |
| <h4 id="31-配置项">3.1 配置项</h4> |
| <p>可以通过 <code>spark-default.properties</code> 或者命令行修改相关配置：</p> |
| <ul> |
| <li>spark.hugegraph.snapshot.dir: 首次加载 hugegraph 数据生成 RDD 时，会将数据序列化保存到 spark 能访问到的介质上，以便于下次直接从该位置读取数据生成 RDD。默认值为 file:///tmp/hugegraph-snapshot，还可以配置为 HDFS 的路径；</li> |
| <li>spark.hugegraph.name: 要访问的图的名字；</li> |
| <li>spark.hugegraph.server.url: HugeGraphServer 的地址，默认值为 http://localhost:8080；</li> |
| <li>spark.hugegraph.read.timeout: HugeClient 从 HugeGraphServer 获取数据的超时时间，单位为秒，默认值为 120；</li> |
| <li>spark.hugegraph.split.size: 从 HugeGraphServer 中获取顶点和边时数据分片的大小，以字节为单位，默认值为 16M；</li> |
| <li>spark.hugegraph.shard.page.size: 获取分片数据时，每个分页的大小，默认值为 500 条。</li> |
| </ul> |
| <h4 id="32-配置入口">3.2 配置入口</h4> |
| <p>HugeGraph-Spark 提供了两种添加配置项的方法：</p> |
| <ol> |
| <li>修改 conf/spark-defaults.conf</li> |
| </ol> |
| <p>首次安装的用户需要将 spark-defaults.conf.default 文件拷贝一份，如下：</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>cp conf/spark-defaults.conf.default conf/spark-defaults.conf |
| </span></span></code></pre></div><p>按需设置即可。</p> |
| <ol start="2"> |
| <li>在命令行中修改</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-bash" data-lang="bash"><span style="display:flex;"><span>bin/spark-shell --conf spark.hugegraph.snapshot.dir<span style="color:#ce5c00;font-weight:bold">=</span>file:///tmp/hugegraph-snapshot2 |
| </span></span></code></pre></div><h3 id="4-使用">4 使用</h3> |
| <h4 id="41-生成-graphx-graph-rdd">4.1 生成 GraphX Graph RDD</h4> |
| <p>启动 scala shell</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/spark-shell |
| </span></span></code></pre></div><blockquote> |
| <p>这种方式是以 local 模式启动，也支持 –master yarn 的模式运行。</p> |
| </blockquote> |
| <p>导入 hugegraph 相关类</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-scala" data-lang="scala"><span style="display:flex;"><span><span style="color:#000">scala</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">com.baidu.hugegraph.spark._</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">com.baidu.hugegraph.spark._</span> |
| </span></span></code></pre></div><p>初始化 graph 对象（GraphX RDD），并创建 snapshot</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-scala" data-lang="scala"><span style="display:flex;"><span><span style="color:#000">scala</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#204a87;font-weight:bold">val</span> <span style="color:#000">graph</span> <span style="color:#204a87;font-weight:bold">=</span> <span style="color:#000">sc</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">hugeGraph</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"hugegraph"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"http://localhost:8080"</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">org</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">apache</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">spark</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">graphx</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:#204a87;font-weight:bold">com.baidu.hugegraph.spark.structure.HugeSparkVertex</span>,<span style="color:#204a87;font-weight:bold">com.baidu.hugegraph.spark.structure.HugeSparkEdge</span><span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#204a87;font-weight:bold">=</span> <span style="color:#000">org</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">apache</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">spark</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">graphx</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">impl</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">GraphImpl</span><span style="color:#204a87;font-weight:bold">@</span><span style="color:#0000cf;font-weight:bold">1418</span><span style="color:#000">a1bd</span> |
| </span></span></code></pre></div><p>如果已经配置过<code>spark.hugegraph.server.url</code>参数，可以省略第二个参数，直接通过<code>val graph = sc.hugeGraph("hugegraph")</code>调用即可。</p> |
| <p>这一步通常很快，因为只是获取了 HugeGraph 数据的分片信息，还没有真正的去执行 action 操作。</p> |
| <h4 id="42-使用-graphx-进行图分析">4.2 使用 GraphX 进行图分析</h4> |
| <p>数据导入成功后可以对 graph 进行相关操作，示例如下：</p> |
| <h5 id="获取顶点个数">获取顶点个数</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-scala" data-lang="scala"><span style="display:flex;"><span><span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">count</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><p>注意：第一次执行这一步可能会很耗时，因为这里才真正的读数据并保存。</p> |
| <h5 id="获取边个数">获取边个数</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-scala" data-lang="scala"><span style="display:flex;"><span><span style="color:#000">graph</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:#000">count</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><h5 id="出度-top-10">出度 top 10</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-scala" data-lang="scala"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">val</span> <span style="color:#000">top10</span> <span style="color:#204a87;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">outDegrees</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">top</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">10</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">sc</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">makeRDD</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">top10</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#000">join</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:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#000">collect</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#000">foreach</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">println</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><h5 id="pagerank">PageRank</h5> |
| <p>PageRank的结果仍为一个图，包含<code>vertices</code> 与 <code>edges</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-scala" data-lang="scala"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">val</span> <span style="color:#000">ranks</span> <span style="color:#204a87;font-weight:bold">=</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">pageRank</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">0.0001</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p>获取 PageRank 的 top 10 的顶点。</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-scala" data-lang="scala"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">val</span> <span style="color:#000">top10</span> <span style="color:#204a87;font-weight:bold">=</span> <span style="color:#000">ranks</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">vertices</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#000">top</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">10</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p>更多 GraphX 的 API 请参考 <a href="http://spark.apache.org/graphx/">spark graphx官网</a>。</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-5074334c73aa450364a31470231ebff8">4 - Config</h1> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style=""> |
| |
| <h1 id="pg-af7e8f1dc385b255c4f38b3cbafe224a">4.1 - HugeGraph 配置</h1> |
| |
| <h3 id="1-概述">1 概述</h3> |
| <p>配置文件的目录为 hugegraph-release/conf，所有关于服务和图本身的配置都在此目录下。</p> |
| <p>主要的配置文件包括：gremlin-server.yaml、rest-server.properties 和 hugegraph.properties</p> |
| <p>HugeGraphServer 内部集成了 GremlinServer 和 RestServer，而 gremlin-server.yaml 和 rest-server.properties 就是用来配置这两个Server的。</p> |
| <ul> |
| <li><a href="http://tinkerpop.apache.org/docs/3.2.3/reference/#gremlin-server">GremlinServer</a>：GremlinServer接受用户的gremlin语句，解析后转而调用Core的代码。</li> |
| <li>RestServer：提供RESTful API，根据不同的HTTP请求，调用对应的Core API，如果用户请求体是gremlin语句，则会转发给GremlinServer，实现对图数据的操作。</li> |
| </ul> |
| <p>下面对这三个配置文件逐一介绍。</p> |
| <h3 id="2-gremlin-serveryaml">2 gremlin-server.yaml</h3> |
| <p>gremlin-server.yaml 文件默认的内容如下：</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:#8f5902;font-style:italic"># host and port of gremlin server, need to be consistent with host and port in rest-server.properties</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">#host: 127.0.0.1</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">#port: 8182</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:#8f5902;font-style:italic"># timeout in ms of gremlin query</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">scriptEvaluationTimeout</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">30000</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">channelizer</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer</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">graphs</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">conf/hugegraph.properties</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:#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">scriptEngines</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">gremlin-groovy</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">plugins</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">com.baidu.hugegraph.plugin.HugeGraphGremlinPlugin</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:#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">org.apache.tinkerpop.gremlin.server.jsr223.GremlinServerGremlinPlugin</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:#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">org.apache.tinkerpop.gremlin.jsr223.ImportGremlinPlugin</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">classImports</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">java.lang.Math,</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">com.baidu.hugegraph.backend.id.IdGenerator,</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">com.baidu.hugegraph.type.define.Directions,</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">com.baidu.hugegraph.type.define.NodeRole,</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">com.baidu.hugegraph.traversal.algorithm.CustomizePathsTraverser,</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">com.baidu.hugegraph.traversal.algorithm.CustomizedCrosspointsTraverser,</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">com.baidu.hugegraph.traversal.algorithm.FusiformSimilarityTraverser,</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">com.baidu.hugegraph.traversal.algorithm.HugeTraverser,</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">com.baidu.hugegraph.traversal.algorithm.NeighborRankTraverser,</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">com.baidu.hugegraph.traversal.algorithm.PathsTraverser,</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">com.baidu.hugegraph.traversal.algorithm.PersonalRankTraverser,</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">com.baidu.hugegraph.traversal.algorithm.ShortestPathTraverser,</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">com.baidu.hugegraph.traversal.algorithm.SubGraphTraverser,</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">com.baidu.hugegraph.traversal.optimize.Text,</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">com.baidu.hugegraph.traversal.optimize.TraversalUtil,</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">com.baidu.hugegraph.util.DateUtil</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;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">methodImports</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:#000">java.lang.Math#*]</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;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">org.apache.tinkerpop.gremlin.jsr223.ScriptFileGremlinPlugin</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">files</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:#000">scripts/empty-sample.groovy]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></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">serializers</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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GraphBinaryMessageSerializerV1,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV1d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV2d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV3d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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">metrics</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">consoleReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">180000</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">csvReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval: 180000, fileName</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">./metrics/gremlin-server-metrics.csv},</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">jmxReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">slf4jReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">180000</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">gangliaReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval: 180000, addressingMode</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">MULTICAST},</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">graphiteReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">180000</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:#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">maxInitialLineLength</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">4096</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">maxHeaderSize</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">8192</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">maxChunkSize</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">8192</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">maxContentLength</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">65536</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">maxAccumulationBufferComponents</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1024</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">resultIterationBatchSize</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">64</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">writeBufferLowWaterMark</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">32768</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">writeBufferHighWaterMark</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">65536</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">ssl</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">enabled</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><p>上面的配置项很多，但目前只需要关注如下几个配置项：channelizer 和 graphs。</p> |
| <ul> |
| <li>graphs：GremlinServer 启动时需要打开的图，该项是一个 map 结构，key 是图的名字，value 是该图的配置文件路径；</li> |
| <li>channelizer：GremlinServer 与客户端有两种通信方式，分别是 WebSocket 和 HTTP（默认）。如果选择 WebSocket， |
| 用户可以通过 <a href="/clients/gremlin-console.html">Gremlin-Console</a> 快速体验 HugeGraph 的特性，但是不支持大规模数据导入， |
| 推荐使用 HTTP 的通信方式，HugeGraph 的外围组件都是基于 HTTP 实现的；</li> |
| </ul> |
| <p>默认GremlinServer是服务在 localhost:8182，如果需要修改，配置 host、port 即可</p> |
| <ul> |
| <li>host：部署 GremlinServer 机器的机器名或 IP，目前 HugeGraphServer 不支持分布式部署，且GremlinServer不直接暴露给用户;</li> |
| <li>port：部署 GremlinServer 机器的端口；</li> |
| </ul> |
| <p>同时需要在 rest-server.properties 中增加对应的配置项 gremlinserver.url=http://host:port</p> |
| <h3 id="3-rest-serverproperties">3 rest-server.properties</h3> |
| <p>rest-server.properties 文件的默认内容如下：</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties"># bind url |
| restserver.url=http://127.0.0.1:8080 |
| # gremlin server url, need to be consistent with host and port in gremlin-server.yaml |
| #gremlinserver.url=http://127.0.0.1:8182 |
| |
| # graphs list with pair NAME:CONF_PATH |
| graphs=[hugegraph:conf/hugegraph.properties] |
| |
| # authentication |
| #auth.authenticator= |
| #auth.admin_token= |
| #auth.user_tokens=[] |
| |
| server.id=server-1 |
| server.role=master |
| </code></pre><ul> |
| <li>restserver.url：RestServer 提供服务的 url，根据实际环境修改；</li> |
| <li>graphs：RestServer 启动时也需要打开图，该项为 map 结构，key 是图的名字，value 是该图的配置文件路径；</li> |
| </ul> |
| <blockquote> |
| <p>注意：gremlin-server.yaml 和 rest-server.properties 都包含 graphs 配置项，而 <code>init-store</code> 命令是根据 gremlin-server.yaml 的 graphs 下的图进行初始化的。</p> |
| </blockquote> |
| <blockquote> |
| <p>配置项 gremlinserver.url 是 GremlinServer 为 RestServer 提供服务的 url，该配置项默认为 http://localhost:8182，如需修改，需要和 gremlin-server.yaml 中的 host 和 port 相匹配；</p> |
| </blockquote> |
| <h3 id="4-hugegraphproperties">4 hugegraph.properties</h3> |
| <p>hugegraph.properties 是一类文件，因为如果系统存在多个图，则会有多个相似的文件。该文件用来配置与图存储和查询相关的参数，文件的默认内容如下：</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties"># gremlin entrence to create graph |
| gremlin.graph=com.baidu.hugegraph.HugeFactory |
| |
| # cache config |
| #schema.cache_capacity=100000 |
| # vertex-cache default is 1000w, 10min expired |
| #vertex.cache_capacity=10000000 |
| #vertex.cache_expire=600 |
| # edge-cache default is 100w, 10min expired |
| #edge.cache_capacity=1000000 |
| #edge.cache_expire=600 |
| |
| # schema illegal name template |
| #schema.illegal_name_regex=\s+|~.* |
| |
| #vertex.default_label=vertex |
| |
| backend=rocksdb |
| serializer=binary |
| |
| store=hugegraph |
| |
| raft.mode=false |
| raft.safe_read=false |
| raft.use_snapshot=false |
| raft.endpoint=127.0.0.1:8281 |
| raft.group_peers=127.0.0.1:8281,127.0.0.1:8282,127.0.0.1:8283 |
| raft.path=./raft-log |
| raft.use_replicator_pipeline=true |
| raft.election_timeout=10000 |
| raft.snapshot_interval=3600 |
| raft.backend_threads=48 |
| raft.read_index_threads=8 |
| raft.queue_size=16384 |
| raft.queue_publish_timeout=60 |
| raft.apply_batch=1 |
| raft.rpc_threads=80 |
| raft.rpc_connect_timeout=5000 |
| raft.rpc_timeout=60000 |
| |
| search.text_analyzer=jieba |
| search.text_analyzer_mode=INDEX |
| |
| # rocksdb backend config |
| #rocksdb.data_path=/path/to/disk |
| #rocksdb.wal_path=/path/to/disk |
| |
| # cassandra backend config |
| cassandra.host=localhost |
| cassandra.port=9042 |
| cassandra.username= |
| cassandra.password= |
| #cassandra.connect_timeout=5 |
| #cassandra.read_timeout=20 |
| #cassandra.keyspace.strategy=SimpleStrategy |
| #cassandra.keyspace.replication=3 |
| |
| # hbase backend config |
| #hbase.hosts=localhost |
| #hbase.port=2181 |
| #hbase.znode_parent=/hbase |
| #hbase.threads_max=64 |
| |
| # mysql backend config |
| #jdbc.driver=com.mysql.jdbc.Driver |
| #jdbc.url=jdbc:mysql://127.0.0.1:3306 |
| #jdbc.username=root |
| #jdbc.password= |
| #jdbc.reconnect_max_times=3 |
| #jdbc.reconnect_interval=3 |
| #jdbc.sslmode=false |
| |
| # postgresql & cockroachdb backend config |
| #jdbc.driver=org.postgresql.Driver |
| #jdbc.url=jdbc:postgresql://localhost:5432/ |
| #jdbc.username=postgres |
| #jdbc.password= |
| |
| # palo backend config |
| #palo.host=127.0.0.1 |
| #palo.poll_interval=10 |
| #palo.temp_dir=./palo-data |
| #palo.file_limit_size=32 |
| </code></pre><p>重点关注未注释的几项：</p> |
| <ul> |
| <li>gremlin.graph：GremlinServer 的启动入口，用户不要修改此项；</li> |
| <li>backend：使用的后端存储，可选值有 memory、cassandra、scylladb 和 rocksdb；</li> |
| <li>serializer：主要为内部使用，用于将 schema、vertex 和 edge 序列化到后端，对应的可选值为 text、cassandra、scylladb 和 binary；(注：rocksdb后端值需是binary，其他后端backend与serializer值需保持一致，如hbase后端该值为hbase)</li> |
| <li>store：图存储到后端使用的数据库名，在 cassandra 和 scylladb 中就是 keyspace 名，此项的值与 GremlinServer 和 RestServer 中的图名并无关系，但是出于直观考虑，建议仍然使用相同的名字；</li> |
| <li>cassandra.host：backend 为 cassandra 或 scylladb 时此项才有意义，cassandra/scylladb 集群的 seeds；</li> |
| <li>cassandra.port：backend 为 cassandra 或 scylladb 时此项才有意义，cassandra/scylladb 集群的 native port；</li> |
| <li>rocksdb.data_path：backend 为 rocksdb 时此项才有意义，rocksdb 的数据目录</li> |
| <li>rocksdb.wal_path：backend 为 rocksdb 时此项才有意义，rocksdb 的日志目录</li> |
| <li>admin.token: 通过一个token来获取服务器的配置信息，例如：<a href="http://localhost:8080/graphs/hugegraph/conf?token=162f7848-0b6d-4faf-b557-3a0797869c55">http://localhost:8080/graphs/hugegraph/conf?token=162f7848-0b6d-4faf-b557-3a0797869c55</a></li> |
| </ul> |
| <h3 id="5-多图配置">5 多图配置</h3> |
| <p>我们的系统是可以存在多个图的，并且各个图的后端可以不一样，比如图 hugegraph 和 hugegraph1，其中 hugegraph 以 cassandra 作为后端，hugegraph1 以 rocksdb作为后端。</p> |
| <p>配置方法也很简单：</p> |
| <p><strong>修改 gremlin-server.yaml</strong></p> |
| <p>在 gremlin-server.yaml 的 graphs 域中添加一个键值对，键为图的名字，值为图的配置文件路径，比如：</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">graphs</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">conf/hugegraph.properties,</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">hugegraph1</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">conf/hugegraph1.properties</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><p><strong>修改 rest-server.properties</strong></p> |
| <p>在 rest-server.properties 的 graphs 域中添加一个键值对，键为图的名字，值为图的配置文件路径，比如：</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">graphs=[hugegraph:conf/hugegraph.properties, hugegraph1:conf/hugegraph1.properties] |
| </code></pre><p><strong>添加 hugegraph1.properties</strong></p> |
| <p>拷贝 hugegraph.properties，命名为 hugegraph1.properties，修改图对应的数据库名以及关于后端部分的参数，比如：</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">store=hugegraph1 |
| |
| ... |
| |
| backend=rocksdb |
| serializer=binary |
| </code></pre><p><strong>停止 Server，初始化执行 init-store.sh（为新的图创建数据库），重新启动 Server</strong></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/stop-hugegraph.sh |
| </span></span><span style="display:flex;"><span>$ bin/init-store.sh |
| </span></span><span style="display:flex;"><span>$ bin/start-hugegraph.sh |
| </span></span></code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-6bfbb2db4e1f281942d741cef305e724">4.2 - HugeGraph 配置项</h1> |
| |
| <h3 id="gremlin-server-配置项">Gremlin Server 配置项</h3> |
| <p>对应配置文件<code>gremlin-server.yaml</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>host</td> |
| <td>127.0.0.1</td> |
| <td>The host or ip of Gremlin Server.</td> |
| </tr> |
| <tr> |
| <td>port</td> |
| <td>8182</td> |
| <td>The listening port of Gremlin Server.</td> |
| </tr> |
| <tr> |
| <td>graphs</td> |
| <td>hugegraph: conf/hugegraph.properties</td> |
| <td>The map of graphs with name and config file path.</td> |
| </tr> |
| <tr> |
| <td>scriptEvaluationTimeout</td> |
| <td>30000</td> |
| <td>The timeout for gremlin script execution(millisecond).</td> |
| </tr> |
| <tr> |
| <td>channelizer</td> |
| <td>org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer</td> |
| <td>Indicates the protocol which the Gremlin Server provides service.</td> |
| </tr> |
| <tr> |
| <td>authentication</td> |
| <td>authenticator: com.baidu.hugegraph.auth.StandardAuthenticator, config: {tokens: conf/rest-server.properties}</td> |
| <td>The authenticator and config(contains tokens path) of authentication mechanism.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="rest-server--api-配置项">Rest Server & API 配置项</h3> |
| <p>对应配置文件<code>rest-server.properties</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>graphs</td> |
| <td>[hugegraph:conf/hugegraph.properties]</td> |
| <td>The map of graphs’ name and config file.</td> |
| </tr> |
| <tr> |
| <td>server.id</td> |
| <td>server-1</td> |
| <td>The id of rest server, used for license verification.</td> |
| </tr> |
| <tr> |
| <td>server.role</td> |
| <td>master</td> |
| <td>The role of nodes in the cluster, available types are [master, worker, computer]</td> |
| </tr> |
| <tr> |
| <td>restserver.url</td> |
| <td>http://127.0.0.1:8080</td> |
| <td>The url for listening of rest server.</td> |
| </tr> |
| <tr> |
| <td>ssl.keystore_file</td> |
| <td>server.keystore</td> |
| <td>The path of server keystore file used when https protocol is enabled.</td> |
| </tr> |
| <tr> |
| <td>ssl.keystore_password</td> |
| <td></td> |
| <td>The password of the path of the server keystore file used when the https protocol is enabled.</td> |
| </tr> |
| <tr> |
| <td>restserver.max_worker_threads</td> |
| <td>2 * CPUs</td> |
| <td>The maximum worker threads of rest server.</td> |
| </tr> |
| <tr> |
| <td>restserver.min_free_memory</td> |
| <td>64</td> |
| <td>The minimum free memory(MB) of rest server, requests will be rejected when the available memory of system is lower than this value.</td> |
| </tr> |
| <tr> |
| <td>restserver.request_timeout</td> |
| <td>30</td> |
| <td>The time in seconds within which a request must complete, -1 means no timeout.</td> |
| </tr> |
| <tr> |
| <td>restserver.connection_idle_timeout</td> |
| <td>30</td> |
| <td>The time in seconds to keep an inactive connection alive, -1 means no timeout.</td> |
| </tr> |
| <tr> |
| <td>restserver.connection_max_requests</td> |
| <td>256</td> |
| <td>The max number of HTTP requests allowed to be processed on one keep-alive connection, -1 means unlimited.</td> |
| </tr> |
| <tr> |
| <td>gremlinserver.url</td> |
| <td>http://127.0.0.1:8182</td> |
| <td>The url of gremlin server.</td> |
| </tr> |
| <tr> |
| <td>gremlinserver.max_route</td> |
| <td>8</td> |
| <td>The max route number for gremlin server.</td> |
| </tr> |
| <tr> |
| <td>gremlinserver.timeout</td> |
| <td>30</td> |
| <td>The timeout in seconds of waiting for gremlin server.</td> |
| </tr> |
| <tr> |
| <td>batch.max_edges_per_batch</td> |
| <td>500</td> |
| <td>The maximum number of edges submitted per batch.</td> |
| </tr> |
| <tr> |
| <td>batch.max_vertices_per_batch</td> |
| <td>500</td> |
| <td>The maximum number of vertices submitted per batch.</td> |
| </tr> |
| <tr> |
| <td>batch.max_write_ratio</td> |
| <td>50</td> |
| <td>The maximum thread ratio for batch writing, only take effect if the batch.max_write_threads is 0.</td> |
| </tr> |
| <tr> |
| <td>batch.max_write_threads</td> |
| <td>0</td> |
| <td>The maximum threads for batch writing, if the value is 0, the actual value will be set to batch.max_write_ratio * restserver.max_worker_threads.</td> |
| </tr> |
| <tr> |
| <td>auth.authenticator</td> |
| <td></td> |
| <td>The class path of authenticator implemention. e.g., com.baidu.hugegraph.auth.StandardAuthenticator, or com.baidu.hugegraph.auth.ConfigAuthenticator.</td> |
| </tr> |
| <tr> |
| <td>auth.admin_token</td> |
| <td>162f7848-0b6d-4faf-b557-3a0797869c55</td> |
| <td>Token for administrator operations, only for com.baidu.hugegraph.auth.ConfigAuthenticator.</td> |
| </tr> |
| <tr> |
| <td>auth.graph_store</td> |
| <td>hugegraph</td> |
| <td>The name of graph used to store authentication information, like users, only for com.baidu.hugegraph.auth.StandardAuthenticator.</td> |
| </tr> |
| <tr> |
| <td>auth.user_tokens</td> |
| <td>[hugegraph:9fd95c9c-711b-415b-b85f-d4df46ba5c31]</td> |
| <td>The map of user tokens with name and password, only for com.baidu.hugegraph.auth.ConfigAuthenticator.</td> |
| </tr> |
| <tr> |
| <td>auth.audit_log_rate</td> |
| <td>1000.0</td> |
| <td>The max rate of audit log output per user, default value is 1000 records per second.</td> |
| </tr> |
| <tr> |
| <td>auth.cache_capacity</td> |
| <td>10240</td> |
| <td>The max cache capacity of each auth cache item.</td> |
| </tr> |
| <tr> |
| <td>auth.cache_expire</td> |
| <td>600</td> |
| <td>The expiration time in seconds of vertex cache.</td> |
| </tr> |
| <tr> |
| <td>auth.remote_url</td> |
| <td></td> |
| <td>If the address is empty, it provide auth service, otherwise it is auth client and also provide auth service through rpc forwarding. The remote url can be set to multiple addresses, which are concat by ‘,’.</td> |
| </tr> |
| <tr> |
| <td>auth.token_expire</td> |
| <td>86400</td> |
| <td>The expiration time in seconds after token created</td> |
| </tr> |
| <tr> |
| <td>auth.token_secret</td> |
| <td>FXQXbJtbCLxODc6tGci732pkH1cyf8Qg</td> |
| <td>Secret key of HS256 algorithm.</td> |
| </tr> |
| <tr> |
| <td>exception.allow_trace</td> |
| <td>false</td> |
| <td>Whether to allow exception trace stack.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="基本配置项">基本配置项</h3> |
| <p>基本配置项及后端配置项对应配置文件：{graph-name}.properties，如<code>hugegraph.properties</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>gremlin.graph</td> |
| <td>com.baidu.hugegraph.HugeFactory</td> |
| <td>Gremlin entrance to create graph.</td> |
| </tr> |
| <tr> |
| <td>backend</td> |
| <td>rocksdb</td> |
| <td>The data store type, available values are [memory, rocksdb, cassandra, scylladb, hbase, mysql].</td> |
| </tr> |
| <tr> |
| <td>serializer</td> |
| <td>binary</td> |
| <td>The serializer for backend store, available values are [text, binary, cassandra, hbase, mysql].</td> |
| </tr> |
| <tr> |
| <td>store</td> |
| <td>hugegraph</td> |
| <td>The database name like Cassandra Keyspace.</td> |
| </tr> |
| <tr> |
| <td>store.connection_detect_interval</td> |
| <td>600</td> |
| <td>The interval in seconds for detecting connections, if the idle time of a connection exceeds this value, detect it and reconnect if needed before using, value 0 means detecting every time.</td> |
| </tr> |
| <tr> |
| <td>store.graph</td> |
| <td>g</td> |
| <td>The graph table name, which store vertex, edge and property.</td> |
| </tr> |
| <tr> |
| <td>store.schema</td> |
| <td>m</td> |
| <td>The schema table name, which store meta data.</td> |
| </tr> |
| <tr> |
| <td>store.system</td> |
| <td>s</td> |
| <td>The system table name, which store system data.</td> |
| </tr> |
| <tr> |
| <td>schema.illegal_name_regex</td> |
| <td>.<em>\s+$|~.</em></td> |
| <td>The regex specified the illegal format for schema name.</td> |
| </tr> |
| <tr> |
| <td>schema.cache_capacity</td> |
| <td>10000</td> |
| <td>The max cache size(items) of schema cache.</td> |
| </tr> |
| <tr> |
| <td>vertex.cache_type</td> |
| <td>l2</td> |
| <td>The type of vertex cache, allowed values are [l1, l2].</td> |
| </tr> |
| <tr> |
| <td>vertex.cache_capacity</td> |
| <td>10000000</td> |
| <td>The max cache size(items) of vertex cache.</td> |
| </tr> |
| <tr> |
| <td>vertex.cache_expire</td> |
| <td>600</td> |
| <td>The expire time in seconds of vertex cache.</td> |
| </tr> |
| <tr> |
| <td>vertex.check_customized_id_exist</td> |
| <td>false</td> |
| <td>Whether to check the vertices exist for those using customized id strategy.</td> |
| </tr> |
| <tr> |
| <td>vertex.default_label</td> |
| <td>vertex</td> |
| <td>The default vertex label.</td> |
| </tr> |
| <tr> |
| <td>vertex.tx_capacity</td> |
| <td>10000</td> |
| <td>The max size(items) of vertices(uncommitted) in transaction.</td> |
| </tr> |
| <tr> |
| <td>vertex.check_adjacent_vertex_exist</td> |
| <td>false</td> |
| <td>Whether to check the adjacent vertices of edges exist.</td> |
| </tr> |
| <tr> |
| <td>vertex.lazy_load_adjacent_vertex</td> |
| <td>true</td> |
| <td>Whether to lazy load adjacent vertices of edges.</td> |
| </tr> |
| <tr> |
| <td>vertex.part_edge_commit_size</td> |
| <td>5000</td> |
| <td>Whether to enable the mode to commit part of edges of vertex, enabled if commit size > 0, 0 means disabled.</td> |
| </tr> |
| <tr> |
| <td>vertex.encode_primary_key_number</td> |
| <td>true</td> |
| <td>Whether to encode number value of primary key in vertex id.</td> |
| </tr> |
| <tr> |
| <td>vertex.remove_left_index_at_overwrite</td> |
| <td>false</td> |
| <td>Whether remove left index at overwrite.</td> |
| </tr> |
| <tr> |
| <td>edge.cache_type</td> |
| <td>l2</td> |
| <td>The type of edge cache, allowed values are [l1, l2].</td> |
| </tr> |
| <tr> |
| <td>edge.cache_capacity</td> |
| <td>1000000</td> |
| <td>The max cache size(items) of edge cache.</td> |
| </tr> |
| <tr> |
| <td>edge.cache_expire</td> |
| <td>600</td> |
| <td>The expiration time in seconds of edge cache.</td> |
| </tr> |
| <tr> |
| <td>edge.tx_capacity</td> |
| <td>10000</td> |
| <td>The max size(items) of edges(uncommitted) in transaction.</td> |
| </tr> |
| <tr> |
| <td>query.page_size</td> |
| <td>500</td> |
| <td>The size of each page when querying by paging.</td> |
| </tr> |
| <tr> |
| <td>query.batch_size</td> |
| <td>1000</td> |
| <td>The size of each batch when querying by batch.</td> |
| </tr> |
| <tr> |
| <td>query.ignore_invalid_data</td> |
| <td>true</td> |
| <td>Whether to ignore invalid data of vertex or edge.</td> |
| </tr> |
| <tr> |
| <td>query.index_intersect_threshold</td> |
| <td>1000</td> |
| <td>The maximum number of intermediate results to intersect indexes when querying by multiple single index properties.</td> |
| </tr> |
| <tr> |
| <td>query.ramtable_edges_capacity</td> |
| <td>20000000</td> |
| <td>The maximum number of edges in ramtable, include OUT and IN edges.</td> |
| </tr> |
| <tr> |
| <td>query.ramtable_enable</td> |
| <td>false</td> |
| <td>Whether to enable ramtable for query of adjacent edges.</td> |
| </tr> |
| <tr> |
| <td>query.ramtable_vertices_capacity</td> |
| <td>10000000</td> |
| <td>The maximum number of vertices in ramtable, generally the largest vertex id is used as capacity.</td> |
| </tr> |
| <tr> |
| <td>query.optimize_aggregate_by_index</td> |
| <td>false</td> |
| <td>Whether to optimize aggregate query(like count) by index.</td> |
| </tr> |
| <tr> |
| <td>oltp.concurrent_depth</td> |
| <td>10</td> |
| <td>The min depth to enable concurrent oltp algorithm.</td> |
| </tr> |
| <tr> |
| <td>oltp.concurrent_threads</td> |
| <td>10</td> |
| <td>Thread number to concurrently execute oltp algorithm.</td> |
| </tr> |
| <tr> |
| <td>oltp.collection_type</td> |
| <td>EC</td> |
| <td>The implementation type of collections used in oltp algorithm.</td> |
| </tr> |
| <tr> |
| <td>rate_limit.read</td> |
| <td>0</td> |
| <td>The max rate(times/s) to execute query of vertices/edges.</td> |
| </tr> |
| <tr> |
| <td>rate_limit.write</td> |
| <td>0</td> |
| <td>The max rate(items/s) to add/update/delete vertices/edges.</td> |
| </tr> |
| <tr> |
| <td>task.wait_timeout</td> |
| <td>10</td> |
| <td>Timeout in seconds for waiting for the task to complete,such as when truncating or clearing the backend.</td> |
| </tr> |
| <tr> |
| <td>task.input_size_limit</td> |
| <td>16777216</td> |
| <td>The job input size limit in bytes.</td> |
| </tr> |
| <tr> |
| <td>task.result_size_limit</td> |
| <td>16777216</td> |
| <td>The job result size limit in bytes.</td> |
| </tr> |
| <tr> |
| <td>task.sync_deletion</td> |
| <td>false</td> |
| <td>Whether to delete schema or expired data synchronously.</td> |
| </tr> |
| <tr> |
| <td>task.ttl_delete_batch</td> |
| <td>1</td> |
| <td>The batch size used to delete expired data.</td> |
| </tr> |
| <tr> |
| <td>computer.config</td> |
| <td>/conf/computer.yaml</td> |
| <td>The config file path of computer job.</td> |
| </tr> |
| <tr> |
| <td>search.text_analyzer</td> |
| <td>ikanalyzer</td> |
| <td>Choose a text analyzer for searching the vertex/edge properties, available type are [word, ansj, hanlp, smartcn, jieba, jcseg, mmseg4j, ikanalyzer].</td> |
| </tr> |
| <tr> |
| <td>search.text_analyzer_mode</td> |
| <td>smart</td> |
| <td>Specify the mode for the text analyzer, the available mode of analyzer are {word: [MaximumMatching, ReverseMaximumMatching, MinimumMatching, ReverseMinimumMatching, BidirectionalMaximumMatching, BidirectionalMinimumMatching, BidirectionalMaximumMinimumMatching, FullSegmentation, MinimalWordCount, MaxNgramScore, PureEnglish], ansj: [BaseAnalysis, IndexAnalysis, ToAnalysis, NlpAnalysis], hanlp: [standard, nlp, index, nShort, shortest, speed], smartcn: [], jieba: [SEARCH, INDEX], jcseg: [Simple, Complex], mmseg4j: [Simple, Complex, MaxWord], ikanalyzer: [smart, max_word]}.</td> |
| </tr> |
| <tr> |
| <td>snowflake.datecenter_id</td> |
| <td>0</td> |
| <td>The datacenter id of snowflake id generator.</td> |
| </tr> |
| <tr> |
| <td>snowflake.force_string</td> |
| <td>false</td> |
| <td>Whether to force the snowflake long id to be a string.</td> |
| </tr> |
| <tr> |
| <td>snowflake.worker_id</td> |
| <td>0</td> |
| <td>The worker id of snowflake id generator.</td> |
| </tr> |
| <tr> |
| <td>raft.mode</td> |
| <td>false</td> |
| <td>Whether the backend storage works in raft mode.</td> |
| </tr> |
| <tr> |
| <td>raft.safe_read</td> |
| <td>false</td> |
| <td>Whether to use linearly consistent read.</td> |
| </tr> |
| <tr> |
| <td>raft.use_snapshot</td> |
| <td>false</td> |
| <td>Whether to use snapshot.</td> |
| </tr> |
| <tr> |
| <td>raft.endpoint</td> |
| <td>127.0.0.1:8281</td> |
| <td>The peerid of current raft node.</td> |
| </tr> |
| <tr> |
| <td>raft.group_peers</td> |
| <td>127.0.0.1:8281,127.0.0.1:8282,127.0.0.1:8283</td> |
| <td>The peers of current raft group.</td> |
| </tr> |
| <tr> |
| <td>raft.path</td> |
| <td>./raft-log</td> |
| <td>The log path of current raft node.</td> |
| </tr> |
| <tr> |
| <td>raft.use_replicator_pipeline</td> |
| <td>true</td> |
| <td>Whether to use replicator line, when turned on it multiple logs can be sent in parallel, and the next log doesn’t have to wait for the ack message of the current log to be sent.</td> |
| </tr> |
| <tr> |
| <td>raft.election_timeout</td> |
| <td>10000</td> |
| <td>Timeout in milliseconds to launch a round of election.</td> |
| </tr> |
| <tr> |
| <td>raft.snapshot_interval</td> |
| <td>3600</td> |
| <td>The interval in seconds to trigger snapshot save.</td> |
| </tr> |
| <tr> |
| <td>raft.backend_threads</td> |
| <td>current CPU vcores</td> |
| <td>The thread number used to apply task to bakcend.</td> |
| </tr> |
| <tr> |
| <td>raft.read_index_threads</td> |
| <td>8</td> |
| <td>The thread number used to execute reading index.</td> |
| </tr> |
| <tr> |
| <td>raft.apply_batch</td> |
| <td>1</td> |
| <td>The apply batch size to trigger disruptor event handler.</td> |
| </tr> |
| <tr> |
| <td>raft.queue_size</td> |
| <td>16384</td> |
| <td>The disruptor buffers size for jraft RaftNode, StateMachine and LogManager.</td> |
| </tr> |
| <tr> |
| <td>raft.queue_publish_timeout</td> |
| <td>60</td> |
| <td>The timeout in second when publish event into disruptor.</td> |
| </tr> |
| <tr> |
| <td>raft.rpc_threads</td> |
| <td>80</td> |
| <td>The rpc threads for jraft RPC layer.</td> |
| </tr> |
| <tr> |
| <td>raft.rpc_connect_timeout</td> |
| <td>5000</td> |
| <td>The rpc connect timeout for jraft rpc.</td> |
| </tr> |
| <tr> |
| <td>raft.rpc_timeout</td> |
| <td>60000</td> |
| <td>The rpc timeout for jraft rpc.</td> |
| </tr> |
| <tr> |
| <td>raft.rpc_buf_low_water_mark</td> |
| <td>10485760</td> |
| <td>The ChannelOutboundBuffer’s low water mark of netty, when buffer size less than this size, the method ChannelOutboundBuffer.isWritable() will return true, it means that low downstream pressure or good network.</td> |
| </tr> |
| <tr> |
| <td>raft.rpc_buf_high_water_mark</td> |
| <td>20971520</td> |
| <td>The ChannelOutboundBuffer’s high water mark of netty, only when buffer size exceed this size, the method ChannelOutboundBuffer.isWritable() will return false, it means that the downstream pressure is too great to process the request or network is very congestion, upstream needs to limit rate at this time.</td> |
| </tr> |
| <tr> |
| <td>raft.read_strategy</td> |
| <td>ReadOnlyLeaseBased</td> |
| <td>The linearizability of read strategy.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="rpc-server-配置">RPC server 配置</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>rpc.client_connect_timeout</td> |
| <td>20</td> |
| <td>The timeout(in seconds) of rpc client connect to rpc server.</td> |
| </tr> |
| <tr> |
| <td>rpc.client_load_balancer</td> |
| <td>consistentHash</td> |
| <td>The rpc client uses a load-balancing algorithm to access multiple rpc servers in one cluster. Default value is ‘consistentHash’, means forwording by request parameters.</td> |
| </tr> |
| <tr> |
| <td>rpc.client_read_timeout</td> |
| <td>40</td> |
| <td>The timeout(in seconds) of rpc client read from rpc server.</td> |
| </tr> |
| <tr> |
| <td>rpc.client_reconnect_period</td> |
| <td>10</td> |
| <td>The period(in seconds) of rpc client reconnect to rpc server.</td> |
| </tr> |
| <tr> |
| <td>rpc.client_retries</td> |
| <td>3</td> |
| <td>Failed retry number of rpc client calls to rpc server.</td> |
| </tr> |
| <tr> |
| <td>rpc.config_order</td> |
| <td>999</td> |
| <td>Sofa rpc configuration file loading order, the larger the more later loading.</td> |
| </tr> |
| <tr> |
| <td>rpc.logger_impl</td> |
| <td>com.alipay.sofa.rpc.log.SLF4JLoggerImpl</td> |
| <td>Sofa rpc log implementation class.</td> |
| </tr> |
| <tr> |
| <td>rpc.protocol</td> |
| <td>bolt</td> |
| <td>Rpc communication protocol, client and server need to be specified the same value.</td> |
| </tr> |
| <tr> |
| <td>rpc.remote_url</td> |
| <td></td> |
| <td>The remote urls of rpc peers, it can be set to multiple addresses, which are concat by ‘,’, empty value means not enabled.</td> |
| </tr> |
| <tr> |
| <td>rpc.server_adaptive_port</td> |
| <td>false</td> |
| <td>Whether the bound port is adaptive, if it’s enabled, when the port is in use, automatically +1 to detect the next available port. Note that this process is not atomic, so there may still be port conflicts.</td> |
| </tr> |
| <tr> |
| <td>rpc.server_host</td> |
| <td></td> |
| <td>The hosts/ips bound by rpc server to provide services, empty value means not enabled.</td> |
| </tr> |
| <tr> |
| <td>rpc.server_port</td> |
| <td>8090</td> |
| <td>The port bound by rpc server to provide services.</td> |
| </tr> |
| <tr> |
| <td>rpc.server_timeout</td> |
| <td>30</td> |
| <td>The timeout(in seconds) of rpc server execution.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="cassandra-后端配置项">Cassandra 后端配置项</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>backend</td> |
| <td></td> |
| <td>Must be set to <code>cassandra</code>.</td> |
| </tr> |
| <tr> |
| <td>serializer</td> |
| <td></td> |
| <td>Must be set to <code>cassandra</code>.</td> |
| </tr> |
| <tr> |
| <td>cassandra.host</td> |
| <td>localhost</td> |
| <td>The seeds hostname or ip address of cassandra cluster.</td> |
| </tr> |
| <tr> |
| <td>cassandra.port</td> |
| <td>9042</td> |
| <td>The seeds port address of cassandra cluster.</td> |
| </tr> |
| <tr> |
| <td>cassandra.connect_timeout</td> |
| <td>5</td> |
| <td>The cassandra driver connect server timeout(seconds).</td> |
| </tr> |
| <tr> |
| <td>cassandra.read_timeout</td> |
| <td>20</td> |
| <td>The cassandra driver read from server timeout(seconds).</td> |
| </tr> |
| <tr> |
| <td>cassandra.keyspace.strategy</td> |
| <td>SimpleStrategy</td> |
| <td>The replication strategy of keyspace, valid value is SimpleStrategy or NetworkTopologyStrategy.</td> |
| </tr> |
| <tr> |
| <td>cassandra.keyspace.replication</td> |
| <td>[3]</td> |
| <td>The keyspace replication factor of SimpleStrategy, like ‘[3]’.Or replicas in each datacenter of NetworkTopologyStrategy, like ‘[dc1:2,dc2:1]’.</td> |
| </tr> |
| <tr> |
| <td>cassandra.username</td> |
| <td></td> |
| <td>The username to use to login to cassandra cluster.</td> |
| </tr> |
| <tr> |
| <td>cassandra.password</td> |
| <td></td> |
| <td>The password corresponding to cassandra.username.</td> |
| </tr> |
| <tr> |
| <td>cassandra.compression_type</td> |
| <td>none</td> |
| <td>The compression algorithm of cassandra transport: none/snappy/lz4.</td> |
| </tr> |
| <tr> |
| <td>cassandra.jmx_port=7199</td> |
| <td>7199</td> |
| <td>The port of JMX API service for cassandra.</td> |
| </tr> |
| <tr> |
| <td>cassandra.aggregation_timeout</td> |
| <td>43200</td> |
| <td>The timeout in seconds of waiting for aggregation.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="scylladb-后端配置项">ScyllaDB 后端配置项</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>backend</td> |
| <td></td> |
| <td>Must be set to <code>scylladb</code>.</td> |
| </tr> |
| <tr> |
| <td>serializer</td> |
| <td></td> |
| <td>Must be set to <code>scylladb</code>.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>其它与 Cassandra 后端一致。</p> |
| <h3 id="rocksdb-后端配置项">RocksDB 后端配置项</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>backend</td> |
| <td></td> |
| <td>Must be set to <code>rocksdb</code>.</td> |
| </tr> |
| <tr> |
| <td>serializer</td> |
| <td></td> |
| <td>Must be set to <code>binary</code>.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.data_disks</td> |
| <td>[]</td> |
| <td>The optimized disks for storing data of RocksDB. The format of each element: <code>STORE/TABLE: /path/disk</code>.Allowed keys are [g/vertex, g/edge_out, g/edge_in, g/vertex_label_index, g/edge_label_index, g/range_int_index, g/range_float_index, g/range_long_index, g/range_double_index, g/secondary_index, g/search_index, g/shard_index, g/unique_index, g/olap]</td> |
| </tr> |
| <tr> |
| <td>rocksdb.data_path</td> |
| <td>rocksdb-data</td> |
| <td>The path for storing data of RocksDB.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.wal_path</td> |
| <td>rocksdb-data</td> |
| <td>The path for storing WAL of RocksDB.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.allow_mmap_reads</td> |
| <td>false</td> |
| <td>Allow the OS to mmap file for reading sst tables.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.allow_mmap_writes</td> |
| <td>false</td> |
| <td>Allow the OS to mmap file for writing.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.block_cache_capacity</td> |
| <td>8388608</td> |
| <td>The amount of block cache in bytes that will be used by RocksDB, 0 means no block cache.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.bloom_filter_bits_per_key</td> |
| <td>-1</td> |
| <td>The bits per key in bloom filter, a good value is 10, which yields a filter with ~ 1% false positive rate, -1 means no bloom filter.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.bloom_filter_block_based_mode</td> |
| <td>false</td> |
| <td>Use block based filter rather than full filter.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.bloom_filter_whole_key_filtering</td> |
| <td>true</td> |
| <td>True if place whole keys in the bloom filter, else place the prefix of keys.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.bottommost_compression</td> |
| <td>NO_COMPRESSION</td> |
| <td>The compression algorithm for the bottommost level of RocksDB, allowed values are none/snappy/z/bzip2/lz4/lz4hc/xpress/zstd.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.bulkload_mode</td> |
| <td>false</td> |
| <td>Switch to the mode to bulk load data into RocksDB.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.cache_index_and_filter_blocks</td> |
| <td>false</td> |
| <td>Indicating if we’d put index/filter blocks to the block cache.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.compaction_style</td> |
| <td>LEVEL</td> |
| <td>Set compaction style for RocksDB: LEVEL/UNIVERSAL/FIFO.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.compression</td> |
| <td>SNAPPY_COMPRESSION</td> |
| <td>The compression algorithm for compressing blocks of RocksDB, allowed values are none/snappy/z/bzip2/lz4/lz4hc/xpress/zstd.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.compression_per_level</td> |
| <td>[NO_COMPRESSION, NO_COMPRESSION, SNAPPY_COMPRESSION, SNAPPY_COMPRESSION, SNAPPY_COMPRESSION, SNAPPY_COMPRESSION, SNAPPY_COMPRESSION]</td> |
| <td>The compression algorithms for different levels of RocksDB, allowed values are none/snappy/z/bzip2/lz4/lz4hc/xpress/zstd.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.delayed_write_rate</td> |
| <td>16777216</td> |
| <td>The rate limit in bytes/s of user write requests when need to slow down if the compaction gets behind.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.log_level</td> |
| <td>INFO</td> |
| <td>The info log level of RocksDB.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_background_jobs</td> |
| <td>8</td> |
| <td>Maximum number of concurrent background jobs, including flushes and compactions.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.level_compaction_dynamic_level_bytes</td> |
| <td>false</td> |
| <td>Whether to enable level_compaction_dynamic_level_bytes, if it’s enabled we give max_bytes_for_level_multiplier a priority against max_bytes_for_level_base, the bytes of base level is dynamic for a more predictable LSM tree, it is useful to limit worse case space amplification. Turning this feature on/off for an existing DB can cause unexpected LSM tree structure so it’s not recommended.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_bytes_for_level_base</td> |
| <td>536870912</td> |
| <td>The upper-bound of the total size of level-1 files in bytes.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_bytes_for_level_multiplier</td> |
| <td>10.0</td> |
| <td>The ratio between the total size of level (L+1) files and the total size of level L files for all L.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_open_files</td> |
| <td>-1</td> |
| <td>The maximum number of open files that can be cached by RocksDB, -1 means no limit.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_subcompactions</td> |
| <td>4</td> |
| <td>The value represents the maximum number of threads per compaction job.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_write_buffer_number</td> |
| <td>6</td> |
| <td>The maximum number of write buffers that are built up in memory.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_write_buffer_number_to_maintain</td> |
| <td>0</td> |
| <td>The total maximum number of write buffers to maintain in memory.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.min_write_buffer_number_to_merge</td> |
| <td>2</td> |
| <td>The minimum number of write buffers that will be merged together.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.num_levels</td> |
| <td>7</td> |
| <td>Set the number of levels for this database.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.optimize_filters_for_hits</td> |
| <td>false</td> |
| <td>This flag allows us to not store filters for the last level.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.optimize_mode</td> |
| <td>true</td> |
| <td>Optimize for heavy workloads and big datasets.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.pin_l0_filter_and_index_blocks_in_cache</td> |
| <td>false</td> |
| <td>Indicating if we’d put index/filter blocks to the block cache.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.sst_path</td> |
| <td></td> |
| <td>The path for ingesting SST file into RocksDB.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.target_file_size_base</td> |
| <td>67108864</td> |
| <td>The target file size for compaction in bytes.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.target_file_size_multiplier</td> |
| <td>1</td> |
| <td>The size ratio between a level L file and a level (L+1) file.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.use_direct_io_for_flush_and_compaction</td> |
| <td>false</td> |
| <td>Enable the OS to use direct read/writes in flush and compaction.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.use_direct_reads</td> |
| <td>false</td> |
| <td>Enable the OS to use direct I/O for reading sst tables.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.write_buffer_size</td> |
| <td>134217728</td> |
| <td>Amount of data in bytes to build up in memory.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_manifest_file_size</td> |
| <td>104857600</td> |
| <td>The max size of manifest file in bytes.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.skip_stats_update_on_db_open</td> |
| <td>false</td> |
| <td>Whether to skip statistics update when opening the database, setting this flag true allows us to not update statistics.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_file_opening_threads</td> |
| <td>16</td> |
| <td>The max number of threads used to open files.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.max_total_wal_size</td> |
| <td>0</td> |
| <td>Total size of WAL files in bytes. Once WALs exceed this size, we will start forcing the flush of column families related, 0 means no limit.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.db_write_buffer_size</td> |
| <td>0</td> |
| <td>Total size of write buffers in bytes across all column families, 0 means no limit.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.delete_obsolete_files_period</td> |
| <td>21600</td> |
| <td>The periodicity in seconds when obsolete files get deleted, 0 means always do full purge.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.hard_pending_compaction_bytes_limit</td> |
| <td>274877906944</td> |
| <td>The hard limit to impose on pending compaction in bytes.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.level0_file_num_compaction_trigger</td> |
| <td>2</td> |
| <td>Number of files to trigger level-0 compaction.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.level0_slowdown_writes_trigger</td> |
| <td>20</td> |
| <td>Soft limit on number of level-0 files for slowing down writes.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.level0_stop_writes_trigger</td> |
| <td>36</td> |
| <td>Hard limit on number of level-0 files for stopping writes.</td> |
| </tr> |
| <tr> |
| <td>rocksdb.soft_pending_compaction_bytes_limit</td> |
| <td>68719476736</td> |
| <td>The soft limit to impose on pending compaction in bytes.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="hbase-后端配置项">HBase 后端配置项</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>backend</td> |
| <td></td> |
| <td>Must be set to <code>hbase</code>.</td> |
| </tr> |
| <tr> |
| <td>serializer</td> |
| <td></td> |
| <td>Must be set to <code>hbase</code>.</td> |
| </tr> |
| <tr> |
| <td>hbase.hosts</td> |
| <td>localhost</td> |
| <td>The hostnames or ip addresses of HBase zookeeper, separated with commas.</td> |
| </tr> |
| <tr> |
| <td>hbase.port</td> |
| <td>2181</td> |
| <td>The port address of HBase zookeeper.</td> |
| </tr> |
| <tr> |
| <td>hbase.threads_max</td> |
| <td>64</td> |
| <td>The max threads num of hbase connections.</td> |
| </tr> |
| <tr> |
| <td>hbase.znode_parent</td> |
| <td>/hbase</td> |
| <td>The znode parent path of HBase zookeeper.</td> |
| </tr> |
| <tr> |
| <td>hbase.zk_retry</td> |
| <td>3</td> |
| <td>The recovery retry times of HBase zookeeper.</td> |
| </tr> |
| <tr> |
| <td>hbase.aggregation_timeout</td> |
| <td>43200</td> |
| <td>The timeout in seconds of waiting for aggregation.</td> |
| </tr> |
| <tr> |
| <td>hbase.kerberos_enable</td> |
| <td>false</td> |
| <td>Is Kerberos authentication enabled for HBase.</td> |
| </tr> |
| <tr> |
| <td>hbase.kerberos_keytab</td> |
| <td></td> |
| <td>The HBase’s key tab file for kerberos authentication.</td> |
| </tr> |
| <tr> |
| <td>hbase.kerberos_principal</td> |
| <td></td> |
| <td>The HBase’s principal for kerberos authentication.</td> |
| </tr> |
| <tr> |
| <td>hbase.krb5_conf</td> |
| <td>etc/krb5.conf</td> |
| <td>Kerberos configuration file, including KDC IP, default realm, etc.</td> |
| </tr> |
| <tr> |
| <td>hbase.hbase_site</td> |
| <td>/etc/hbase/conf/hbase-site.xml</td> |
| <td>The HBase’s configuration file</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="mysql--postgresql-后端配置项">MySQL & PostgreSQL 后端配置项</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>backend</td> |
| <td></td> |
| <td>Must be set to <code>mysql</code>.</td> |
| </tr> |
| <tr> |
| <td>serializer</td> |
| <td></td> |
| <td>Must be set to <code>mysql</code>.</td> |
| </tr> |
| <tr> |
| <td>jdbc.driver</td> |
| <td>com.mysql.jdbc.Driver</td> |
| <td>The JDBC driver class to connect database.</td> |
| </tr> |
| <tr> |
| <td>jdbc.url</td> |
| <td>jdbc:mysql://127.0.0.1:3306</td> |
| <td>The url of database in JDBC format.</td> |
| </tr> |
| <tr> |
| <td>jdbc.username</td> |
| <td>root</td> |
| <td>The username to login database.</td> |
| </tr> |
| <tr> |
| <td>jdbc.password</td> |
| <td>******</td> |
| <td>The password corresponding to jdbc.username.</td> |
| </tr> |
| <tr> |
| <td>jdbc.ssl_mode</td> |
| <td>false</td> |
| <td>The SSL mode of connections with database.</td> |
| </tr> |
| <tr> |
| <td>jdbc.reconnect_interval</td> |
| <td>3</td> |
| <td>The interval(seconds) between reconnections when the database connection fails.</td> |
| </tr> |
| <tr> |
| <td>jdbc.reconnect_max_times</td> |
| <td>3</td> |
| <td>The reconnect times when the database connection fails.</td> |
| </tr> |
| <tr> |
| <td>jdbc.storage_engine</td> |
| <td>InnoDB</td> |
| <td>The storage engine of backend store database, like InnoDB/MyISAM/RocksDB for MySQL.</td> |
| </tr> |
| <tr> |
| <td>jdbc.postgresql.connect_database</td> |
| <td>template1</td> |
| <td>The database used to connect when init store, drop store or check store exist.</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="postgresql-后端配置项">PostgreSQL 后端配置项</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>config option</th> |
| <th>default value</th> |
| <th>descrition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>backend</td> |
| <td></td> |
| <td>Must be set to <code>postgresql</code>.</td> |
| </tr> |
| <tr> |
| <td>serializer</td> |
| <td></td> |
| <td>Must be set to <code>postgresql</code>.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>其它与 MySQL 后端一致。</p> |
| <blockquote> |
| <p>PostgreSQL 后端的 driver 和 url 应该设置为:</p> |
| <ul> |
| <li><code>jdbc.driver=org.postgresql.Driver</code></li> |
| <li><code>jdbc.url=jdbc:postgresql://localhost:5432/</code></li> |
| </ul> |
| </blockquote> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-7d189549d4201521c83e0d93a2474a2d">4.3 - HugeGraph 内置用户权限与扩展权限配置及使用</h1> |
| |
| <h3 id="概述">概述</h3> |
| <p>HugeGraph 为了方便不同用户场景下的鉴权使用，目前内置了两套权限模式：</p> |
| <ol> |
| <li>简单的<code>ConfigAuthenticator</code>模式，通过本地配置文件存储用户名和密码 (仅支持单 GraphServer)</li> |
| <li>完备的<code>StandardAuthenticator</code>模式，支持多用户认证、以及细粒度的权限访问控制，采用基于 “用户-用户组-操作-资源” 的 4 层设计，灵活控制用户角色与权限 (支持多 GraphServer)</li> |
| </ol> |
| <p>其中 <code>StandardAuthenticator</code> 模式的几个核心设计：</p> |
| <ul> |
| <li>初始化时创建超级管理员 (<code>admin</code>) 用户，后续通过超级管理员创建其它用户，新创建的用户被分配足够权限后，可以创建或管理更多的用户</li> |
| <li>支持动态创建用户、用户组、资源，支持动态分配或取消权限</li> |
| <li>用户可以属于一个或多个用户组，每个用户组可以拥有对任意个资源的操作权限，操作类型包括：读、写、删除、执行等种类</li> |
| <li>“资源” 描述了图数据库中的数据，比如符合某一类条件的顶点，每一个资源包括 <code>type</code>、<code>label</code>、<code>properties</code>三个要素，共有 18 种类型、任意 label、任意 properties 可组合形成的资源，一个资源的内部条件是且关系，多个资源之间的条件是或关系</li> |
| </ul> |
| <p>举例说明：</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-java" data-lang="java"><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"></span><span style="color:#000">user</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">name</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#000">xx</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#ce5c00;font-weight:bold">-</span><span style="color:#000">belong</span><span style="color:#ce5c00;font-weight:bold">-></span> <span style="color:#000">group</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">name</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#000">xx</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#ce5c00;font-weight:bold">-</span><span style="color:#000">access</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">read</span><span style="color:#ce5c00;font-weight:bold">)-></span> <span style="color:#000">target</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:#000">graph1</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">resource</span><span style="color:#ce5c00;font-weight:bold">={</span><span style="color:#000">label</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#000">person</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">city</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#000">Beijing</span><span style="color:#ce5c00;font-weight:bold">})</span> |
| </span></span></code></pre></div><h3 id="配置用户认证">配置用户认证</h3> |
| <p>HugeGraph 默认<strong>不启用</strong>用户认证功能，需通过修改配置文件来启用该功能。内置实现了<code>StandardAuthenticator</code>和<code>ConfigAuthenticator</code>两种模式，<code>StandardAuthenticator</code>模式支持多用户认证与细粒度权限控制，<code>ConfigAuthenticator</code>模式支持简单的用户权限认证。此外，开发者可以自定义实现<code>HugeAuthenticator</code>接口来对接自身的权限系统。</p> |
| <p>用户认证方式均采用 <a href="https://zh.wikipedia.org/wiki/HTTP%E5%9F%BA%E6%9C%AC%E8%AE%A4%E8%AF%81">HTTP Basic Authentication</a> ，简单说就是在发送 HTTP 请求时在 <code>Authentication</code> 设置选择 <code>Basic</code> 然后输入对应的用户名和密码，对应 HTTP 明文如下所示 :</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">GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels |
| </span></span></span><span style="display:flex;"><span><span style="color:#a40000">Authorization: Basic admin xxxx |
| </span></span></span></code></pre></div><h4 id="standardauthenticator模式">StandardAuthenticator模式</h4> |
| <p><code>StandardAuthenticator</code>模式是通过在数据库后端存储用户信息来支持用户认证和权限控制，该实现基于数据库存储的用户的名称与密码进行认证（密码已被加密），基于用户的角色来细粒度控制用户权限。下面是具体的配置流程（重启服务生效）：</p> |
| <p>在配置文件<code>gremlin-server.yaml</code>中配置<code>authenticator</code>及其<code>rest-server</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">authentication</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">authenticator</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">com.baidu.hugegraph.auth.StandardAuthenticator,</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">authenticationHandler</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">com.baidu.hugegraph.auth.WsAndHttpBasicAuthHandler,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">tokens</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">conf/rest-server.properties}</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><p>在配置文件<code>rest-server.properties</code>中配置<code>authenticator</code>及其<code>graph_store</code>信息：</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">auth.authenticator=com.baidu.hugegraph.auth.StandardAuthenticator |
| auth.graph_store=hugegraph |
| |
| # auth client config |
| # 如果是分开部署 GraphServer 和 AuthServer, 还需要指定下面的配置, 地址填写 AuthServer 的 IP:RPC 端口 |
| #auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897 |
| </code></pre><p>其中，<code>graph_store</code>配置项是指使用哪一个图来存储用户信息，如果存在多个图的话，选取任意一个均可。</p> |
| <p>在配置文件<code>hugegraph{n}.properties</code>中配置<code>gremlin.graph</code>信息：</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy |
| </code></pre><p>然后详细的权限 API 调用和说明请参考 <a href="/docs/clients/restful-api/auth">Authentication-API</a> 文档</p> |
| <h4 id="configauthenticator模式">ConfigAuthenticator模式</h4> |
| <p><code>ConfigAuthenticator</code>模式是通过预先在配置文件中设置用户信息来支持用户认证，该实现是基于配置好的静态<code>tokens</code>来验证用户是否合法。下面是具体的配置流程（重启服务生效）：</p> |
| <p>在配置文件<code>gremlin-server.yaml</code>中配置<code>authenticator</code>及其<code>rest-server</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">authentication</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">authenticator</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">com.baidu.hugegraph.auth.ConfigAuthenticator,</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">authenticationHandler</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">com.baidu.hugegraph.auth.WsAndHttpBasicAuthHandler,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">tokens</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">conf/rest-server.properties}</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><p>在配置文件<code>rest-server.properties</code>中配置<code>authenticator</code>及其<code>tokens</code>信息：</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">auth.authenticator=com.baidu.hugegraph.auth.ConfigAuthenticator |
| auth.admin_token=token-value-a |
| auth.user_tokens=[hugegraph1:token-value-1, hugegraph2:token-value-2] |
| </code></pre><p>在配置文件<code>hugegraph{n}.properties</code>中配置<code>gremlin.graph</code>信息：</p> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties">gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy |
| </code></pre><h3 id="自定义用户认证系统">自定义用户认证系统</h3> |
| <p>如果需要支持更加灵活的用户系统，可自定义authenticator进行扩展，自定义authenticator实现接口<code>com.baidu.hugegraph.auth.HugeAuthenticator</code>即可，然后修改配置文件中<code>authenticator</code>配置项指向该实现。</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-7e400260398a18d0be72b1fe5a73f419">4.4 - 配置 HugeGraphServer 使用 https 协议</h1> |
| |
| <h3 id="概述">概述</h3> |
| <p>HugeGraphServer 默认使用的是 http 协议，如果用户对请求的安全性有要求，可以配置成 https。</p> |
| <h3 id="服务端配置">服务端配置</h3> |
| <p>修改 conf/rest-server.properties 配置文件，将 restserver.url 的 schema 部分改为 https。</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-ini" data-lang="ini"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 将协议设置为 https</span> |
| </span></span><span style="display:flex;"><span><span style="color:#c4a000">restserver.url</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">https://127.0.0.1:8080</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 服务端 keystore 文件路径，当协议为 https 时该默认值自动生效，可按需修改此项</span> |
| </span></span><span style="display:flex;"><span><span style="color:#c4a000">ssl.keystore_file</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">conf/hugegraph-server.keystore</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 服务端 keystore 文件密码，当协议为 https 时该默认值自动生效，可按需修改此项</span> |
| </span></span><span style="display:flex;"><span><span style="color:#c4a000">ssl.keystore_password</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">******</span> |
| </span></span></code></pre></div><p>服务端的 conf 目录下已经给出了一个 keystore 文件<code>hugegraph-server.keystore</code>，该文件的密码为<code>hugegraph</code>， |
| 这两项都是在开启了 https 协议时的默认值，用户可以生成自己的 keystore 文件及密码，然后修改<code>ssl.keystore_file</code>和<code>ssl.keystore_password</code>的值。</p> |
| <h3 id="客户端配置">客户端配置</h3> |
| <h4 id="在-hugegraph-client-中使用-https">在 HugeGraph-Client 中使用 https</h4> |
| <p>在构造 HugeClient 时传入 https 相关的配置，代码示例：</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#000">String</span> <span style="color:#000">url</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#4e9a06">"https://localhost:8080"</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">String</span> <span style="color:#000">graphName</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">HugeClientBuilder</span> <span style="color:#000">builder</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:#000">url</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">graphName</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// 客户端 keystore 文件路径 |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">String</span> <span style="color:#000">trustStoreFilePath</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#4e9a06">"hugegraph.truststore"</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// 客户端 keystore 密码 |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">String</span> <span style="color:#000">trustStorePassword</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#4e9a06">"******"</span><span style="color:#ce5c00;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:#c4a000">configSSL</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">trustStoreFilePath</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">trustStorePassword</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><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">builder</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></code></pre></div><blockquote> |
| <p>注意：HugeGraph-Client 在 1.9.0 版本以前是直接以 new 的方式创建，并且不支持 https 协议，在 1.9.0 版本以后改成以 builder 的方式创建，并支持配置 https 协议。</p> |
| </blockquote> |
| <h4 id="在-hugegraph-loader-中使用-https">在 HugeGraph-Loader 中使用 https</h4> |
| <p>启动导入任务时，在命令行中添加如下选项：</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"># https</span> |
| </span></span><span style="display:flex;"><span>--protocol https |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 客户端证书文件路径，当指定 --protocol 为 https 时，默认值 conf/hugegraph.truststore 自动生效，可按需修改</span> |
| </span></span><span style="display:flex;"><span>--trust-store-file <span style="color:#ce5c00;font-weight:bold">{</span>file<span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 客户端证书文件密码，当指定 --protocol 为 https 时，默认值 hugegraph 自动生效，可按需修改</span> |
| </span></span><span style="display:flex;"><span>--trust-store-password <span style="color:#ce5c00;font-weight:bold">{</span>password<span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>hugegraph-loader 的 conf 目录下已经放了一个默认的客户端证书文件 hugegraph.truststore，其密码是 hugegraph。</p> |
| <h4 id="在-hugegraph-tools-中使用-https">在 HugeGraph-Tools 中使用 https</h4> |
| <p>执行命令时，在命令行中添加如下选项：</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"># 客户端证书文件路径，当 url 中使用 https 协议时，默认值 conf/hugegraph.truststore 自动生效，可按需修改</span> |
| </span></span><span style="display:flex;"><span>--trust-store-file <span style="color:#ce5c00;font-weight:bold">{</span>file<span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 客户端证书文件密码，当 url 中使用 https 协议时，默认值 hugegraph 自动生效，可按需修改</span> |
| </span></span><span style="display:flex;"><span>--trust-store-password <span style="color:#ce5c00;font-weight:bold">{</span>password<span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 执行迁移命令时，当 --target-url 中使用 https 协议时，默认值 conf/hugegraph.truststore 自动生效，可按需修改</span> |
| </span></span><span style="display:flex;"><span>--target-trust-store-file <span style="color:#ce5c00;font-weight:bold">{</span>target-file<span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"># 执行迁移命令时，当 --target-url 中使用 https 协议时，默认值 hugegraph 自动生效，可按需修改</span> |
| </span></span><span style="display:flex;"><span>--target-trust-store-password <span style="color:#ce5c00;font-weight:bold">{</span>target-password<span style="color:#ce5c00;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>hugegraph-tools 的 conf 目录下已经放了一个默认的客户端证书文件 hugegraph.truststore，其密码是 hugegraph。</p> |
| <h3 id="如何生成证书文件">如何生成证书文件</h3> |
| <p>本部分给出生成证书的示例，如果默认的证书已经够用，或者已经知晓如何生成，可跳过。</p> |
| <h4 id="服务端">服务端</h4> |
| <ol> |
| <li>⽣成服务端私钥，并且导⼊到服务端 keystore ⽂件中，server.keystore 是给服务端⽤的，其中保存着⾃⼰的私钥</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-bash" data-lang="bash"><span style="display:flex;"><span>keytool -genkey -alias serverkey -keyalg RSA -keystore server.keystore |
| </span></span></code></pre></div><p>过程中根据需求填写描述信息，默认证书的描述信息如下：</p> |
| <pre tabindex="0"><code>名字和姓⽒：hugegraph |
| 组织单位名称：hugegraph |
| 组织名称：hugegraph |
| 城市或区域名称：BJ |
| 州或省份名称：BJ |
| 国家代码：CN |
| </code></pre><ol start="2"> |
| <li>根据服务端私钥，导出服务端证书</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-bash" data-lang="bash"><span style="display:flex;"><span>keytool -export -alias serverkey -keystore server.keystore -file server.crt |
| </span></span></code></pre></div><p>server.crt 就是服务端的证书</p> |
| <h4 id="客户端">客户端</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>keytool -import -alias serverkey -file server.crt -keystore client.truststore |
| </span></span></code></pre></div><p>client.truststore 是给客户端⽤的，其中保存着受信任的证书</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-8f8368cdf9ec684d30761c6d28a34179">5 - API</h1> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style=""> |
| |
| <h1 id="pg-a809bf70d5493b5046619919800e4de6">5.1 - HugeGraph RESTful API</h1> |
| |
| <p>HugeGraph-Server通过HugeGraph-API基于HTTP协议为Client提供操作图的接口，主要包括元数据和 |
| 图数据的增删改查，遍历算法，变量，图操作及其他操作。</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-698c3217de07a8cb0dc0e93dbae29ee9">5.1.1 - Schema API</h1> |
| |
| <h3 id="11-schema">1.1 Schema</h3> |
| <p>HugeGraph 提供单一接口获取某个图的全部 Schema 信息，包括：PropertyKey、VertexLabel、EdgeLabel 和 IndexLabel。</p> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema |
| </code></pre><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"propertykeys"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">7</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aggregate_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"write_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OLTP"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.741"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">6</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"date"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aggregate_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"write_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OLTP"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.729"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aggregate_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"write_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OLTP"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.691"</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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aggregate_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"write_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OLTP"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.678"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">5</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aggregate_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"write_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OLTP"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.718"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">4</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"weight"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"DOUBLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aggregate_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"write_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OLTP"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.707"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aggregate_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"write_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OLTP"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.609"</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">"vertexlabels"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"PRIMARY_KEY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"primary_keys"</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">"name"</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">"nullable_keys"</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">"age"</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">"index_labels"</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">"personByCity"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"personByAgeAndCity"</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">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"city"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ttl"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.783"</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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"PRIMARY_KEY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"primary_keys"</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">"name"</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">"nullable_keys"</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">"price"</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">"index_labels"</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">"softwareByPrice"</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">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"price"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ttl"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.840"</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">"edgelabels"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"MULTIPLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sort_keys"</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">"date"</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">"nullable_keys"</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">"weight"</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">"index_labels"</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">"knowsByWeight"</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">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"date"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ttl"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:41.840"</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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sort_keys"</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">"nullable_keys"</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">"weight"</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">"index_labels"</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">"createdByDate"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"createdByWeight"</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">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"date"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ttl"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:41.868"</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">"indexlabels"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"personByCity"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"city"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:40.886"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">4</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"createdByDate"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"EDGE_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"date"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:41.878"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">5</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"createdByWeight"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"EDGE_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"RANGE_DOUBLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"weight"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:42.117"</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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"personByAgeAndCity"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"city"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:41.351"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"softwareByPrice"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"RANGE_INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"price"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:41.587"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">6</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knowsByWeight"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"EDGE_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"RANGE_DOUBLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"weight"</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">"status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"CREATED"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"~create_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2021-09-03 15:13:42.376"</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> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-f7f4b3b6f4b7a965f8c30675df8e56f8">5.1.2 - PropertyKey API</h1> |
| |
| <h3 id="12-propertykey">1.2 PropertyKey</h3> |
| <p>Params说明：</p> |
| <ul> |
| <li>name：属性类型名称，必填</li> |
| <li>data_type：属性类型数据类型，包括：bool、byte、int、long、float、double、string、date、uuid、blob，默认string类型</li> |
| <li>cardinality：属性类型基数，包括：single、list、set，默认single</li> |
| </ul> |
| <p>请求体字段说明：</p> |
| <ul> |
| <li>id：属性类型id值</li> |
| <li>properties：属性的属性，对于属性而言，此项为空</li> |
| <li>user_data：设置属性类型的通用信息，比如可设置age属性的取值范围，最小为0，最大为100；目前此项不做任何校验，只为后期拓展提供预留入口</li> |
| </ul> |
| <h4 id="121-创建一个-propertykey">1.2.1 创建一个 PropertyKey</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/schema/propertykeys |
| </code></pre><h5 id="request-body">Request Body</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-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">"property_key"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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></code></pre></div><h4 id="122-为已存在的-propertykey-添加或移除-userdata">1.2.2 为已存在的 PropertyKey 添加或移除 userdata</h4> |
| <h5 id="params">Params</h5> |
| <ul> |
| <li>action: 表示当前行为是添加还是移除，取值为<code>append</code>（添加）和<code>eliminate</code>（移除）</li> |
| </ul> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/schema/propertykeys/age?action=append |
| </code></pre><h5 id="request-body-1">Request Body</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-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">"property_key"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"min"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"max"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100</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">"task_id"</span> <span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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">"min"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"max"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100</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><h4 id="123-获取所有的-propertykey">1.2.3 获取所有的 PropertyKey</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema/propertykeys |
| </code></pre><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"propertykeys"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">5</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">4</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"weight"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"DOUBLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">6</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"date"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">7</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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></code></pre></div><h4 id="124-根据name获取propertykey">1.2.4 根据name获取PropertyKey</h4> |
| <h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema/propertykeys/age |
| </code></pre><p>其中，<code>age</code>为要获取的PropertyKey的名字</p> |
| <h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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></code></pre></div><h4 id="125-根据name删除propertykey">1.2.5 根据name删除PropertyKey</h4> |
| <h5 id="method--url-4">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/schema/propertykeys/age |
| </code></pre><p>其中，<code>age</code>为要获取的PropertyKey的名字</p> |
| <h5 id="response-status-4">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body-4">Response Body</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-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">"property_key"</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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"data_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"INT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"cardinality"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"user_data"</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">"task_id"</span> <span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-28cb205879be97a55ddc8cd365c4438e">5.1.3 - VertexLabel API</h1> |
| |
| <h3 id="13-vertexlabel">1.3 VertexLabel</h3> |
| <p>假设已经创建好了1.1.3中列出来的 PropertyKeys</p> |
| <p>Params说明</p> |
| <ul> |
| <li>id：顶点类型id值</li> |
| <li>name：顶点类型名称，必填</li> |
| <li>id_strategy: 顶点类型的ID策略，主键ID、自动生成、自定义字符串、自定义数字、自定义UUID，默认主键ID</li> |
| <li>properties: 顶点类型关联的属性类型</li> |
| <li>primary_keys: 主键属性，当ID策略为PRIMARY_KEY时必须有值，其他ID策略时必须为空；</li> |
| <li>enable_label_index： 是否开启类型索引，默认关闭</li> |
| <li>index_names：顶点类型创建的索引，详情见3.4</li> |
| <li>nullable_keys：可为空的属性</li> |
| <li>user_data：设置顶点类型的通用信息，作用同属性类型</li> |
| </ul> |
| <h4 id="131-创建一个vertexlabel">1.3.1 创建一个VertexLabel</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/schema/vertexlabels |
| </code></pre><h5 id="request-body">Request Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"DEFAULT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"primary_keys"</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">"name"</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">"nullable_keys"</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">"enable_label_index"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"primary_keys"</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">"name"</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">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"PRIMARY_KEY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person2"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"nullable_keys"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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></code></pre></div><p>从 hugegraph-server v0.11.2 版本开始支持顶点的 TTL 功能。顶点的 TTL 是通过 VertexLabel 来设置的。比如希望 person 类型的顶点存活时间为一天，需要在创建 person VertexLabel 的时候将 TTL 字段设置为 86400000，即单位为毫秒。</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"DEFAULT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"primary_keys"</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">"name"</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">"nullable_keys"</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">"ttl"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">86400000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"enable_label_index"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>另外，当顶点中带有"创建时间"的属性且希望以"创建时间"属性作为计算顶点存活时间的起点时，可以设置 VertexLabel 中的 ttl_start_time 字段。比如 person VertexLabel 有 createdTime 属性，且 createdTime 是 Date 类型的参数，希望 person 类型的顶点从创建开始存活一天的时间，那么创建 person VertexLabel 的 Request 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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"DEFAULT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"createdTime"</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">"primary_keys"</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">"name"</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">"nullable_keys"</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">"ttl"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">86400000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ttl_start_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"createdTime"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"enable_label_index"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="132-为已存在的vertexlabel添加properties或userdata或者移除userdata目前不支持移除properties">1.3.2 为已存在的VertexLabel添加properties或userdata，或者移除userdata（目前不支持移除properties）</h4> |
| <h5 id="params">Params</h5> |
| <ul> |
| <li>action: 表示当前行为是添加还是移除，取值为<code>append</code>（添加）和<code>eliminate</code>（移除）</li> |
| </ul> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/schema/vertexlabels/person?action=append |
| </code></pre><h5 id="request-body-1">Request Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"nullable_keys"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"city"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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">"super"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"animal"</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><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"primary_keys"</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">"name"</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">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"PRIMARY_KEY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"nullable_keys"</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">"city"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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">"super"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"animal"</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><h4 id="133-获取所有的vertexlabel">1.3.3 获取所有的VertexLabel</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels |
| </code></pre><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"vertexlabels"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"primary_keys"</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">"name"</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">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"PRIMARY_KEY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"nullable_keys"</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">"city"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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">"super"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"animal"</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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"primary_keys"</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">"name"</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">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"PRIMARY_KEY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"lang"</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">"nullable_keys"</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">"price"</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">"enable_label_index"</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">"user_data"</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></code></pre></div><h4 id="134-根据name获取vertexlabel">1.3.4 根据name获取VertexLabel</h4> |
| <h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels/person |
| </code></pre><h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"primary_keys"</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">"name"</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">"id_strategy"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"PRIMARY_KEY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"nullable_keys"</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">"city"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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">"super"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"animal"</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><h4 id="135-根据name删除vertexlabel">1.3.5 根据name删除VertexLabel</h4> |
| <p>删除 VertexLabel 会导致删除对应的顶点以及相关的索引数据，会产生一个异步任务</p> |
| <h5 id="method--url-4">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/schema/vertexlabels/person |
| </code></pre><h5 id="response-status-4">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body-4">Response Body</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-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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>注：</p> |
| <blockquote> |
| <p>可以通过<code>GET http://localhost:8080/graphs/hugegraph/tasks/1</code>（其中"1"是task_id）来查询异步任务的执行状态，更多<a href="../task">异步任务RESTful API</a></p> |
| </blockquote> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-41864d99c39fc7040549f6eaf5441daf">5.1.4 - EdgeLabel API</h1> |
| |
| <h3 id="14-edgelabel">1.4 EdgeLabel</h3> |
| <p>假设已经创建好了1.2.3中的 PropertyKeys 和 1.3.3中的 VertexLabels</p> |
| <p>Params说明</p> |
| <ul> |
| <li>name：顶点类型名称，必填</li> |
| <li>source_label: 源顶点类型的名称，必填</li> |
| <li>target_label: 目标顶点类型的名称，必填</li> |
| <li>frequency：两个点之间是否可以有多条边，可以取值SINGLE和MULTIPLE，非必填，默认值SINGLE</li> |
| <li>properties: 边类型关联的属性类型，选填</li> |
| <li>sort_keys: 当允许关联多次时，指定区分键属性列表</li> |
| <li>nullable_keys：可为空的属性，选填，默认可为空</li> |
| <li>enable_label_index： 是否开启类型索引，默认关闭</li> |
| </ul> |
| <h4 id="141-创建一个edgelabel">1.4.1 创建一个EdgeLabel</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/schema/edgelabels |
| </code></pre><h5 id="request-body">Request Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</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">"sort_keys"</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">"nullable_keys"</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">"enable_label_index"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sort_keys"</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">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"date"</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">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"nullable_keys"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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></code></pre></div><p>从 hugegraph-server v0.11.2 版本开始支持边的 TTL 功能。边的 TTL 是通过 EdgeLabel 来设置的。比如希望 knows 类型的边存活时间为一天，需要在创建 knows EdgeLabel 的时候将 TTL 字段设置为 86400000，即单位为毫秒。</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sort_keys"</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">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"createdTime"</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">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"nullable_keys"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"ttl"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">86400000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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></code></pre></div><p>另外，当边中带有"创建时间"的属性且希望以"创建时间"属性作为计算边存活时间的起点时，可以设置 EdgeLabel 中的 ttl_start_time 字段。比如 knows EdgeLabel 有 createdTime 属性，且 createdTime 是 Date 类型的参数，希望 knows 类型的边从创建开始存活一天的时间，那么创建 knows EdgeLabel 的 Request 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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sort_keys"</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">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"createdTime"</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">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"nullable_keys"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"ttl"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">86400000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ttl_start_time"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"createdTime"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_data"</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></code></pre></div><h4 id="142-为已存在的edgelabel添加properties或userdata或者移除userdata目前不支持移除properties">1.4.2 为已存在的EdgeLabel添加properties或userdata，或者移除userdata（目前不支持移除properties）</h4> |
| <h5 id="params">Params</h5> |
| <ul> |
| <li>action: 表示当前行为是添加还是移除，取值为<code>append</code>（添加）和<code>eliminate</code>（移除）</li> |
| </ul> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/schema/edgelabels/created?action=append |
| </code></pre><h5 id="request-body-1">Request Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</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">"nullable_keys"</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">"weight"</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><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"sort_keys"</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">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"weight"</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">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"nullable_keys"</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">"weight"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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></code></pre></div><h4 id="143-获取所有的edgelabel">1.4.3 获取所有的EdgeLabel</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema/edgelabels |
| </code></pre><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"edgelabels"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sort_keys"</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">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"weight"</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">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"nullable_keys"</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">"weight"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"sort_keys"</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">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"weight"</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">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"nullable_keys"</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">"enable_label_index"</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">"user_data"</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></code></pre></div><h4 id="144-根据name获取edgelabel">1.4.4 根据name获取EdgeLabel</h4> |
| <h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema/edgelabels/created |
| </code></pre><h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sort_keys"</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">"source_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_names"</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">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"weight"</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">"target_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"frequency"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SINGLE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"nullable_keys"</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">"city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"weight"</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">"enable_label_index"</span><span style="color:#000;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:#204a87;font-weight:bold">"user_data"</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></code></pre></div><h4 id="145-根据name删除edgelabel">1.4.5 根据name删除EdgeLabel</h4> |
| <p>删除 EdgeLabel 会导致删除对应的边以及相关的索引数据，会产生一个异步任务</p> |
| <h5 id="method--url-4">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/schema/edgelabels/created |
| </code></pre><h5 id="response-status-4">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body-4">Response Body</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-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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>注：</p> |
| <blockquote> |
| <p>可以通过<code>GET http://localhost:8080/graphs/hugegraph/tasks/1</code>（其中"1"是task_id）来查询异步任务的执行状态，更多<a href="../task">异步任务RESTful API</a></p> |
| </blockquote> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-7099742fb947ad5dfde9e72216c10b8a">5.1.5 - IndexLabel API</h1> |
| |
| <h3 id="15-indexlabel">1.5 IndexLabel</h3> |
| <p>假设已经创建好了1.1.3中的 PropertyKeys 、1.2.3中的 VertexLabels 以及 1.3.3中的 EdgeLabels</p> |
| <h4 id="151-创建一个indexlabel">1.5.1 创建一个IndexLabel</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/schema/indexlabels |
| </code></pre><h5 id="request-body">Request Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"personByCity"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"city"</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><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"index_label"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"personByCity"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"city"</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">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">2</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="152-获取所有的indexlabel">1.5.2 获取所有的IndexLabel</h4> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema/indexlabels |
| </code></pre><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"indexlabels"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"softwareByPrice"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"price"</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">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"RANGE"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">4</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"EDGE_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"createdByDate"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"date"</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">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"personByCity"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"city"</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">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"personByAgeAndCity"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"city"</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">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</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><h4 id="153-根据name获取indexlabel">1.5.3 根据name获取IndexLabel</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/schema/indexlabels/personByCity |
| </code></pre><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"VERTEX_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"base_value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"personByCity"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"fields"</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">"city"</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">"index_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"SECONDARY"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="154-根据name删除indexlabel">1.5.4 根据name删除IndexLabel</h4> |
| <p>删除 IndexLabel 会导致删除相关的索引数据，会产生一个异步任务</p> |
| <h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/schema/indexlabels/personByCity |
| </code></pre><h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>注：</p> |
| <blockquote> |
| <p>可以通过<code>GET http://localhost:8080/graphs/hugegraph/tasks/1</code>（其中"1"是task_id）来查询异步任务的执行状态，更多<a href="../task">异步任务RESTful API</a></p> |
| </blockquote> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-bde129922f801ad9560757fcec64d05c">5.1.6 - Rebuild API</h1> |
| |
| <h3 id="16-rebuild">1.6 Rebuild</h3> |
| <h4 id="161-重建indexlabel">1.6.1 重建IndexLabel</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/indexlabels/personByCity |
| </code></pre><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>注：</p> |
| <blockquote> |
| <p>可以通过<code>GET http://localhost:8080/graphs/hugegraph/tasks/1</code>（其中"1"是task_id）来查询异步任务的执行状态，更多<a href="../task">异步任务RESTful API</a></p> |
| </blockquote> |
| <h4 id="162-vertexlabel对应的全部索引重建">1.6.2 VertexLabel对应的全部索引重建</h4> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/vertexlabels/person |
| </code></pre><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">2</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>注：</p> |
| <blockquote> |
| <p>可以通过<code>GET http://localhost:8080/graphs/hugegraph/tasks/2</code>（其中"2"是task_id）来查询异步任务的执行状态，更多<a href="../task">异步任务RESTful API</a></p> |
| </blockquote> |
| <h4 id="163-edgelabel对应的全部索引重建">1.6.3 EdgeLabel对应的全部索引重建</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/edgelabels/created |
| </code></pre><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>注：</p> |
| <blockquote> |
| <p>可以通过<code>GET http://localhost:8080/graphs/hugegraph/tasks/3</code>（其中"3"是task_id）来查询异步任务的执行状态，更多<a href="../task">异步任务RESTful API</a></p> |
| </blockquote> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-86bf520fd6b098231f4af6590328e871">5.1.7 - Vertex API</h1> |
| |
| <h3 id="21-vertex">2.1 Vertex</h3> |
| <p>顶点类型中的 Id 策略决定了顶点的 Id 类型，其对应关系如下：</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Id_Strategy</th> |
| <th>id type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>AUTOMATIC</td> |
| <td>number</td> |
| </tr> |
| <tr> |
| <td>PRIMARY_KEY</td> |
| <td>string</td> |
| </tr> |
| <tr> |
| <td>CUSTOMIZE_STRING</td> |
| <td>string</td> |
| </tr> |
| <tr> |
| <td>CUSTOMIZE_NUMBER</td> |
| <td>number</td> |
| </tr> |
| <tr> |
| <td>CUSTOMIZE_UUID</td> |
| <td>uuid</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>顶点的 <code>GET/PUT/DELETE</code> API 中 url 的 id 部分传入的应是带有类型信息的 id 值，这个类型信息用 json 串是否带引号表示，也就是说：</p> |
| <ul> |
| <li>当 id 类型为 number 时，url 中的 id 不带引号，形如 xxx/vertices/123456</li> |
| <li>当 id 类型为 string 时，url 中的 id 带引号，形如 xxx/vertices/“123456”</li> |
| </ul> |
| <hr> |
| <p>接下来的示例均假设已经创建好了前述的各种 schema 信息</p> |
| <h4 id="211-创建一个顶点">2.1.1 创建一个顶点</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/graph/vertices |
| </code></pre><h5 id="request-body">Request Body</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-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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</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><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</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><h4 id="212-创建多个顶点">2.1.2 创建多个顶点</h4> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/graph/vertices/batch |
| </code></pre><h5 id="request-body-1">Request Body</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-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:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">199</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><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">]</span> |
| </span></span></code></pre></div><h4 id="213-更新顶点属性">2.1.3 更新顶点属性</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://127.0.0.1:8080/graphs/hugegraph/graph/vertices/"1:marko"?action=append |
| </code></pre><h5 id="request-body-2">Request Body</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-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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">30</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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><blockquote> |
| <p>注意：属性的取值是有三种类别的，分别是single、set和list。如果是single，表示增加或更新属性值；如果是set或list，则表示追加属性值。</p> |
| </blockquote> |
| <h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;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></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><h4 id="214-批量更新顶点属性">2.1.4 批量更新顶点属性</h4> |
| <h5 id="功能说明">功能说明</h5> |
| <p>批量更新顶点的属性，并支持多种更新策略，包括</p> |
| <ul> |
| <li>SUM: 数值累加</li> |
| <li>BIGGER: 两个数字/日期取更大的</li> |
| <li>SMALLER: 两个数字/日期取更小的</li> |
| <li>UNION: Set属性取并集</li> |
| <li>INTERSECTION: Set属性取交集</li> |
| <li>APPEND: List属性追加元素</li> |
| <li>ELIMINATE: List/Set属性删除元素</li> |
| <li>OVERRIDE: 覆盖已有属性，如果新属性为null，则仍然使用旧属性</li> |
| </ul> |
| <p>假设原顶点及属性为：</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">328</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Beijing"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">0.1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"hobby"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"reading"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"football"</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><h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://127.0.0.1:8080/graphs/hugegraph/graph/vertices/batch |
| </code></pre><h5 id="request-body-3">Request Body</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-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">"vertices"</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">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"c++"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">299</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">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Shanghai"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</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><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"hobby"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"swiming"</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">"update_strategies"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"BIGGER"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"OVERRIDE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"OVERRIDE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"SUM"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"hobby"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"UNION"</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">"create_if_not_exist"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"c++"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">328</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Shanghai"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"hobby"</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">"swiming"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"reading"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"football"</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><p>结果分析：</p> |
| <ul> |
| <li>lang 属性未指定更新策略，直接用新值覆盖旧值，无论新值是否为null；</li> |
| <li>price 属性指定 BIGGER 的更新策略，旧属性值为328，新属性值为299，所以仍然保留了旧属性值328；</li> |
| <li>age 属性指定 OVERRIDE 更新策略，而新属性值中未传入age，相当于age为null，所以仍然保留了原属性值32；</li> |
| <li>city 属性也指定了 OVERRIDE 更新策略，且新属性值不为null，所以覆盖了旧值；</li> |
| <li>weight 属性指定了 SUM 更新策略，旧属性值为0.1，新属性值为0.2，最后的值为0.3；</li> |
| <li>hobby 属性（基数为Set）指定了 UNION 更新策略，所以新值与旧值取了并集；</li> |
| </ul> |
| <p>其他的更新策略使用方式可以类推，不再赘述。</p> |
| <h4 id="215-删除顶点属性">2.1.5 删除顶点属性</h4> |
| <h5 id="method--url-4">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://127.0.0.1:8080/graphs/hugegraph/graph/vertices/"1:marko"?action=eliminate |
| </code></pre><h5 id="request-body-4">Request Body</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-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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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><blockquote> |
| <p>注意：这里会直接删除属性（删除key和所有value），无论其属性的取值是single、set或list。</p> |
| </blockquote> |
| <h5 id="response-status-4">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-4">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;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></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><h4 id="216-获取符合条件的顶点">2.1.6 获取符合条件的顶点</h4> |
| <h5 id="params">Params</h5> |
| <ul> |
| <li>label: 顶点类型</li> |
| <li>properties: 属性键值对(根据属性查询的前提是预先建立了索引)</li> |
| <li>limit: 查询最大数目</li> |
| <li>page: 页号</li> |
| </ul> |
| <p>以上参数都是可选的，如果提供page参数，必须提供limit参数，不允许带其他参数。<code>label, properties</code>和<code>limit</code>可以任意组合。</p> |
| <p>属性键值对由JSON格式的属性名称和属性值组成，允许多个属性键值对作为查询条件，属性值支持精确匹配和范围匹配，精确匹配时形如<code>properties={"age":29}</code>，范围匹配时形如<code>properties={"age":"P.gt(29)"}</code>,范围匹配支持的表达式如下：</p> |
| <table> |
| <thead> |
| <tr> |
| <th>表达式</th> |
| <th>说明</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>P.eq(number)</td> |
| <td>属性值等于number的顶点</td> |
| </tr> |
| <tr> |
| <td>P.neq(number)</td> |
| <td>属性值不等于number的顶点</td> |
| </tr> |
| <tr> |
| <td>P.lt(number)</td> |
| <td>属性值小于number的顶点</td> |
| </tr> |
| <tr> |
| <td>P.lte(number)</td> |
| <td>属性值小于等于number的顶点</td> |
| </tr> |
| <tr> |
| <td>P.gt(number)</td> |
| <td>属性值大于number的顶点</td> |
| </tr> |
| <tr> |
| <td>P.gte(number)</td> |
| <td>属性值大于等于number的顶点</td> |
| </tr> |
| <tr> |
| <td>P.between(number1,number2)</td> |
| <td>属性值大于等于number1且小于number2的顶点</td> |
| </tr> |
| <tr> |
| <td>P.inside(number1,number2)</td> |
| <td>属性值大于number1且小于number2的顶点</td> |
| </tr> |
| <tr> |
| <td>P.outside(number1,number2)</td> |
| <td>属性值小于number1且大于number2的顶点</td> |
| </tr> |
| <tr> |
| <td>P.within(value1,value2,value3,…)</td> |
| <td>属性值等于任何一个给定value的顶点</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>查询所有 age 为 20 且 label 为 person 的顶点</strong></p> |
| <h5 id="method--url-5">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/graph/vertices?label=person&properties={"age":29}&limit=1 |
| </code></pre><h5 id="response-status-5">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-5">Response Body</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-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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</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><p><strong>分页查询所有顶点，获取第一页（page不带参数值），限定3条</strong></p> |
| <h5 id="method--url-6">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/graph/vertices?page&limit=3 |
| </code></pre><h5 id="response-status-6">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-6">Response Body</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-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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple>price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">199</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ripple"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple>lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Hongkong"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vadas"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">27</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Shanghai"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"peter"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">35</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">"page"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"001000100853313a706574657200f07ffffffc00e797c6349be736fffc8699e8a502efe10004"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>返回的body里面是带有下一页的页号信息的，<code>"page": "001000100853313a706574657200f07ffffffc00e797c6349be736fffc8699e8a502efe10004"</code>， |
| 在查询下一页的时候将该值赋给page参数。</p> |
| <p><strong>分页查询所有顶点，获取下一页（page带上上一页返回的page值），限定3条</strong></p> |
| <h5 id="method--url-7">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/graph/vertices?page=001000100853313a706574657200f07ffffffc00e797c6349be736fffc8699e8a502efe10004&limit=3 |
| </code></pre><h5 id="response-status-7">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-7">Response Body</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-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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop>price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">328</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lop"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop>lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</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">"page"</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></code></pre></div><p>此时<code>"page": null</code>表示已经没有下一页了 (注: 后端为 Cassandra 时，为了性能考虑，返回页恰好为最后一页时，返回 <code>page</code> 值可能非空，通过该 <code>page</code> 再请求下一页数据时则返回 <code>空数据</code> 及 <code>page = null</code>，其他情况类似)</p> |
| <h4 id="217-根据id获取顶点">2.1.7 根据Id获取顶点</h4> |
| <h5 id="method--url-8">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/graph/vertices/"1:marko" |
| </code></pre><h5 id="response-status-8">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-8">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</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><h4 id="218-根据id删除顶点">2.1.8 根据Id删除顶点</h4> |
| <h5 id="params-1">Params</h5> |
| <ul> |
| <li>label: 顶点类型，可选参数</li> |
| </ul> |
| <p><strong>仅根据Id删除顶点</strong></p> |
| <h5 id="method--url-9">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/graph/vertices/"1:marko" |
| </code></pre><h5 id="response-status-9">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><p><strong>根据Label+Id删除顶点</strong></p> |
| <p>通过指定Label参数和Id来删除顶点时，一般来说其性能比仅根据Id删除会更好。</p> |
| <h5 id="method--url-10">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/graph/vertices/"1:marko"?label=person |
| </code></pre><h5 id="response-status-10">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-f40127b155ddd802d50c507ff1cf5530">5.1.8 - Edge API</h1> |
| |
| <h3 id="22-edge">2.2 Edge</h3> |
| <p>顶点 id 格式的修改也影响到了边的 Id 以及源顶点和目标顶点 id 的格式。</p> |
| <p>EdgeId是由 <code>src-vertex-id + direction + label + sort-values + tgt-vertex-id</code> 拼接而成， |
| 但是这里的顶点id类型不是通过引号区分的，而是根据前缀区分：</p> |
| <ul> |
| <li>当 id 类型为 number 时，EdgeId 的顶点 id 前有一个前缀<code>L</code> ，形如 “L123456>1»L987654”</li> |
| <li>当 id 类型为 string 时，EdgeId 的顶点 id 前有一个前缀<code>S</code> ，形如 “S1:peter>1»S2:lop”</li> |
| </ul> |
| <hr> |
| <p>接下来的示例均假设已经创建好了前述的各种schema和vertex信息</p> |
| <h4 id="221-创建一条边">2.2.1 创建一条边</h4> |
| <p>Params说明</p> |
| <ul> |
| <li>label：边类型名称，必填</li> |
| <li>outV：源顶点id，必填</li> |
| <li>inV：目标顶点id，必填</li> |
| <li>outVLabel：源顶点类型。必填</li> |
| <li>inVLabel：目标顶点类型。必填</li> |
| <li>properties: 边关联的属性，对象内部结构为： |
| <ol> |
| <li>name：属性名称</li> |
| <li>value：属性值</li> |
| </ol> |
| </li> |
| </ul> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/graph/edges |
| </code></pre><h5 id="request-body">Request Body</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-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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2017-5-18"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.2</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><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:peter>1>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2017-5-18"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.2</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><h4 id="222-创建多条边">2.2.2 创建多条边</h4> |
| <h5 id="params">Params</h5> |
| <ul> |
| <li>check_vertex: 是否检查顶点存在(true | false)，当设置为 true 而待插入边的源顶点或目标顶点不存在时会报错。</li> |
| </ul> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/graph/edges/batch |
| </code></pre><h5 id="request-body-1">Request Body</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-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:#000;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2017-5-18"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.2</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2016-01-10"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.5</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><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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:#4e9a06">"S1:peter>1>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"S1:marko>2>>S1:vadas"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">]</span> |
| </span></span></code></pre></div><h4 id="223-更新边属性">2.2.3 更新边属性</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/graph/edges/S1:peter>1>>S2:lop?action=append |
| </code></pre><h5 id="request-body-2">Request Body</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-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">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1.0</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><blockquote> |
| <p>注意：属性的取值是有三种类别的，分别是single、set和list。如果是single，表示增加或更新属性值；如果是set或list，则表示追加属性值。</p> |
| </blockquote> |
| <h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:peter>1>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2017-5-18"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</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><h4 id="224-批量更新边属性">2.2.4 批量更新边属性</h4> |
| <h5 id="功能说明">功能说明</h5> |
| <p>与批量更新顶点属性类似</p> |
| <p>假设原边及属性为：</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:josh>2>>S2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1512835200000</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:marko>1>7JooBil0>S1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1361289600000</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><h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://127.0.0.1:8080/graphs/hugegraph/graph/edges/batch |
| </code></pre><h5 id="request-body-3">Request Body</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-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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:josh>2>>S2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">0.1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1522835200000</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:marko>1>7JooBil0>S1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</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><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1301289600000</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">"update_strategies"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"SUM"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"BIGGER"</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">"check_vertex"</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">"create_if_not_exist"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:josh>2>>S2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1.1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1522835200000</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:marko>1>7JooBil0>S1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1.2</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1301289600000</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><h4 id="225-删除边属性">2.2.5 删除边属性</h4> |
| <h5 id="method--url-4">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/graph/edges/S1:peter>1>>S2:lop?action=eliminate |
| </code></pre><h5 id="request-body-4">Request Body</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-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">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1.0</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><blockquote> |
| <p>注意：这里会直接删除属性（删除key和所有value），无论其属性的取值是single、set或list。</p> |
| </blockquote> |
| <h5 id="response-status-4">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-4">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:peter>1>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20170324"</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><h4 id="226-获取符合条件的边">2.2.6 获取符合条件的边</h4> |
| <h5 id="params-1">Params</h5> |
| <ul> |
| <li>vertex_id: 顶点id</li> |
| <li>direction: 边的方向(OUT | IN | BOTH)</li> |
| <li>label: 边的标签</li> |
| <li>properties: 属性键值对(根据属性查询的前提是预先建立了索引)</li> |
| <li>offset：偏移，默认为0</li> |
| <li>limit: 查询数目，默认为100</li> |
| <li>page: 页号</li> |
| </ul> |
| <p>支持的查询有以下几种：</p> |
| <ul> |
| <li>提供vertex_id参数时，不可以使用参数page，direction、label、properties可选，offset和limit可以 |
| 限制结果范围</li> |
| <li>不提供vertex_id参数时，label和properties可选 |
| <ul> |
| <li>如果使用page参数，则：offset参数不可用（不填或者为0），direction不可用，properties最多只能有一个</li> |
| <li>如果不使用page参数，则：offset和limit可以用来限制结果范围，direction参数忽略</li> |
| </ul> |
| </li> |
| </ul> |
| <p>属性键值对由JSON格式的属性名称和属性值组成，允许多个属性键值对作为查询条件，属性值支持精确匹配和范围匹配，精确匹配时形如<code>properties={"weight":0.8}</code>，范围匹配时形如<code>properties={"age":"P.gt(0.8)"}</code>,范围匹配支持的表达式如下：</p> |
| <table> |
| <thead> |
| <tr> |
| <th>表达式</th> |
| <th>说明</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>P.eq(number)</td> |
| <td>属性值等于number的边</td> |
| </tr> |
| <tr> |
| <td>P.neq(number)</td> |
| <td>属性值不等于number的边</td> |
| </tr> |
| <tr> |
| <td>P.lt(number)</td> |
| <td>属性值小于number的边</td> |
| </tr> |
| <tr> |
| <td>P.lte(number)</td> |
| <td>属性值小于等于number的边</td> |
| </tr> |
| <tr> |
| <td>P.gt(number)</td> |
| <td>属性值大于number的边</td> |
| </tr> |
| <tr> |
| <td>P.gte(number)</td> |
| <td>属性值大于等于number的边</td> |
| </tr> |
| <tr> |
| <td>P.between(number1,number2)</td> |
| <td>属性值大于等于number1且小于number2的边</td> |
| </tr> |
| <tr> |
| <td>P.inside(number1,number2)</td> |
| <td>属性值大于number1且小于number2的边</td> |
| </tr> |
| <tr> |
| <td>P.outside(number1,number2)</td> |
| <td>属性值小于number1且大于number2的边</td> |
| </tr> |
| <tr> |
| <td>P.within(value1,value2,value3,…)</td> |
| <td>属性值等于任何一个给定value的边</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>查询与顶点 person:josh(vertex_id=“1:josh”) 相连且 label 为 created 的边</strong></p> |
| <h5 id="method--url-5">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://127.0.0.1:8080/graphs/hugegraph/graph/edges?vertex_id="1:josh"&direction=BOTH&label=created&properties={} |
| </code></pre><h5 id="response-status-5">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-5">Response Body</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-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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:josh>1>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20091111"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.4</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:josh>1>>S2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20171210"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</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><p><strong>分页查询所有边，获取第一页（page不带参数值），限定3条</strong></p> |
| <h5 id="method--url-6">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://127.0.0.1:8080/graphs/hugegraph/graph/edges?page&limit=3 |
| </code></pre><h5 id="response-status-6">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-6">Response Body</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-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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:peter>2>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</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><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20170324"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:josh>2>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</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:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20091111"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:josh>2>>S2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20171210"</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">"page"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"002500100753313a6a6f73681210010004000000020953323a726970706c65f07ffffffcf07ffffffd8460d63f4b398dd2721ed4fdb7716b420004"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>返回的body里面是带有下一页的页号信息的，<code>"page": "002500100753313a6a6f73681210010004000000020953323a726970706c65f07ffffffcf07ffffffd8460d63f4b398dd2721ed4fdb7716b420004"</code>， |
| 在查询下一页的时候将该值赋给page参数。</p> |
| <p><strong>分页查询所有边，获取下一页（page带上上一页返回的page值），限定3条</strong></p> |
| <h5 id="method--url-7">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://127.0.0.1:8080/graphs/hugegraph/graph/edges?page=002500100753313a6a6f73681210010004000000020953323a726970706c65f07ffffffcf07ffffffd8460d63f4b398dd2721ed4fdb7716b420004&limit=3 |
| </code></pre><h5 id="response-status-7">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-7">Response Body</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-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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:marko>1>20130220>S1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20130220"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:marko>1>20160110>S1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</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:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20160110"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:marko>2>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</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:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20171210"</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">"page"</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></code></pre></div><p>此时<code>"page": null</code>表示已经没有下一页了 (注: 后端为 Cassandra 时，为了性能考虑，返回页恰好为最后一页时，返回 <code>page</code> 值可能非空，通过该 <code>page</code> 再请求下一页数据时则返回 <code>空数据</code> 及 <code>page = null</code>，其他情况类似)</p> |
| <h4 id="227-根据id获取边">2.2.7 根据Id获取边</h4> |
| <h5 id="method--url-8">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/graph/edges/S1:peter>1>>S2:lop |
| </code></pre><h5 id="response-status-8">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-8">Response Body</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-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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:peter>1>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2017-5-18"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.2</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><h4 id="228-根据id删除边">2.2.8 根据Id删除边</h4> |
| <h5 id="params-2">Params</h5> |
| <ul> |
| <li>label: 边类型，可选参数</li> |
| </ul> |
| <p><strong>仅根据Id删除边</strong></p> |
| <h5 id="method--url-9">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/graph/edges/S1:peter>1>>S2:lop |
| </code></pre><h5 id="response-status-9">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><p><strong>根据Label+Id删除边</strong></p> |
| <p>通过指定Label参数和Id来删除边时，一般来说其性能比仅根据Id删除会更好。</p> |
| <h5 id="method--url-10">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/graph/edges/S1:peter>1>>S2:lop?label=person |
| </code></pre><h5 id="response-status-10">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-f0adc653be0b454ce1952bdaf0afefa6">5.1.9 - Traverser API</h1> |
| |
| <h3 id="31-traverser-api概述">3.1 traverser API概述</h3> |
| <p>HugeGraphServer为HugeGraph图数据库提供了RESTful API接口。除了顶点和边的CRUD基本操作以外，还提供了一些遍历（traverser）方法，我们称为<code>traverser API</code>。这些遍历方法实现了一些复杂的图算法，方便用户对图进行分析和挖掘。</p> |
| <p>HugeGraph支持的Traverser API包括：</p> |
| <ul> |
| <li>K-out API，根据起始顶点，查找恰好N步可达的邻居，分为基础版和高级版： |
| <ul> |
| <li>基础版使用GET方法，根据起始顶点，查找恰好N步可达的邻居</li> |
| <li>高级版使用POST方法，根据起始顶点，查找恰好N步可达的邻居，与基础版的不同在于： |
| <ul> |
| <li>支持只统计邻居数量</li> |
| <li>支持边属性过滤</li> |
| <li>支持返回到达邻居的最短路径</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li>K-neighbor API，根据起始顶点，查找N步以内可达的所有邻居，分为基础版和高级版： |
| <ul> |
| <li>基础版使用GET方法，根据起始顶点，查找N步以内可达的所有邻居</li> |
| <li>高级版使用POST方法，根据起始顶点，查找N步以内可达的所有邻居，与基础版的不同在于： |
| <ul> |
| <li>支持只统计邻居数量</li> |
| <li>支持边属性过滤</li> |
| <li>支持返回到达邻居的最短路径</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li>Same Neighbors, 查询两个顶点的共同邻居</li> |
| <li>Jaccard Similarity API，计算jaccard相似度，包括两种： |
| <ul> |
| <li>一种是使用GET方法，计算两个顶点的邻居的相似度（交并比）</li> |
| <li>一种是使用POST方法，在全图中查找与起点的jaccard similarity最高的N个点</li> |
| </ul> |
| </li> |
| <li>Shortest Path API，查找两个顶点之间的最短路径</li> |
| <li>All Shortest Paths，查找两个顶点间的全部最短路径</li> |
| <li>Weighted Shortest Path，查找起点到目标点的带权最短路径</li> |
| <li>Single Source Shortest Path，查找一个点到其他各个点的加权最短路径</li> |
| <li>Multi Node Shortest Path，查找指定顶点集之间两两最短路径</li> |
| <li>Paths API，查找两个顶点间的全部路径，分为基础版和高级版： |
| <ul> |
| <li>基础版使用GET方法，根据起点和终点，查找两个顶点间的全部路径</li> |
| <li>高级版使用POST方法，根据一组起点和一组终点，查找两个集合间符合条件的全部路径</li> |
| </ul> |
| </li> |
| <li>Customized Paths API，从一批顶点出发，按（一种）模式遍历经过的全部路径</li> |
| <li>Template Path API，指定起点和终点以及起点和终点间路径信息，查找符合的路径</li> |
| <li>Crosspoints API，查找两个顶点的交点（共同祖先或者共同子孙）</li> |
| <li>Customized Crosspoints API，从一批顶点出发，按多种模式遍历，最后一步到达的顶点的交点</li> |
| <li>Rings API，从起始顶点出发，可到达的环路路径</li> |
| <li>Rays API，从起始顶点出发，可到达边界的路径（即无环路径）</li> |
| <li>Fusiform Similarity API，查找一个顶点的梭形相似点</li> |
| <li>Vertices API |
| <ul> |
| <li>按ID批量查询顶点；</li> |
| <li>获取顶点的分区；</li> |
| <li>按分区查询顶点；</li> |
| </ul> |
| </li> |
| <li>Edges API |
| <ul> |
| <li>按ID批量查询边；</li> |
| <li>获取边的分区；</li> |
| <li>按分区查询边；</li> |
| </ul> |
| </li> |
| </ul> |
| <h3 id="32-traverser-api详解">3.2. traverser API详解</h3> |
| <p>使用方法中的例子，都是基于TinkerPop官网给出的图：</p> |
| <p><img src="http://tinkerpop.apache.org/docs/3.4.0/images/tinkerpop-modern.png" alt="tinkerpop示例图"></p> |
| <p>数据导入程序如下：</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-java" data-lang="java"><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">Loader</span> <span style="color:#ce5c00;font-weight:bold">{</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:#000">HugeClient</span> <span style="color:#000">client</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">HugeClient</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"http://127.0.0.1:8080"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#ce5c00;font-weight:bold">);</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">client</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 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">"name"</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">"age"</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">"city"</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">"weight"</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">"lang"</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">"date"</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">"price"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"name"</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">"age"</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">"software"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"name"</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">"price"</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">"personByCity"</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">"person"</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">"city"</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">"personByAgeAndCity"</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">"person"</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">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"softwareByPrice"</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">"software"</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">"price"</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">"knows"</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">multiTimes</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">"person"</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">"person"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">sortKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"date"</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">"weight"</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">"created"</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">"person"</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">"software"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"weight"</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">"createdByDate"</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">"created"</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">"date"</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">"createdByWeight"</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">"created"</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">"weight"</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">"knowsByWeight"</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">"knows"</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">"weight"</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">client</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Hongkong"</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">"software"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lop"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"josh"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</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">"software"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"peter"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Shanghai"</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">"knows"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20160110"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"knows"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20130220"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20171210"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20091111"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20171210"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20170324"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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 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><p>顶点ID为：</p> |
| <pre tabindex="0"><code>"2:ripple", |
| "1:vadas", |
| "1:peter", |
| "1:josh", |
| "1:marko", |
| "2:lop" |
| </code></pre><p>边ID为：</p> |
| <pre tabindex="0"><code>"S1:peter>2>>S2:lop", |
| "S1:josh>2>>S2:lop", |
| "S1:josh>2>>S2:ripple", |
| "S1:marko>1>20130220>S1:josh", |
| "S1:marko>1>20160110>S1:vadas", |
| "S1:marko>2>>S2:lop" |
| </code></pre><h4 id="321-k-out-apiget基础版">3.2.1 K-out API（GET，基础版）</h4> |
| <h5 id="3211-功能介绍">3.2.1.1 功能介绍</h5> |
| <p>根据起始顶点、方向、边的类型（可选）和深度depth，查找从起始顶点出发恰好depth步可达的顶点</p> |
| <h6 id="params">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>max_depth：步数，必填项</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>nearest：nearest为true时，代表起始顶点到达结果顶点的最短路径长度为depth，不存在更短的路径；nearest为false时，代表起始顶点到结果顶点有一条长度为depth的路径（未必最短且可以有环），选填项，默认为true</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的顶点的最大数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="3212-使用方法">3.2.1.2 使用方法</h5> |
| <h6 id="method--url">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/kout?source="1:marko"&max_depth=2 |
| </code></pre><h6 id="response-status">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body">Response Body</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-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">"vertices"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:peter"</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><h5 id="3213-适用场景">3.2.1.3 适用场景</h5> |
| <p>查找恰好N步关系可达的顶点。两个例子：</p> |
| <ul> |
| <li>家族关系中，查找一个人的所有孙子，person A通过连续的两条“儿子”边到达的顶点集合。</li> |
| <li>社交关系中发现潜在好友，例如：与目标用户相隔两层朋友关系的用户，可以通过连续两条“朋友”边到达的顶点。</li> |
| </ul> |
| <h4 id="322-k-out-apipost高级版">3.2.2 K-out API（POST，高级版）</h4> |
| <h5 id="3221-功能介绍">3.2.2.1 功能介绍</h5> |
| <p>根据起始顶点、步骤（包括方向、边类型和过滤属性）和深度depth，查找从起始顶点出发恰好depth步可达的顶点。</p> |
| <blockquote> |
| <p>与K-out基础版的不同在于：</p> |
| <ul> |
| <li>支持只统计邻居数量</li> |
| <li>支持边属性过滤</li> |
| <li>支持返回到达邻居的最短路径</li> |
| </ul> |
| </blockquote> |
| <h6 id="params-1">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>从起始点出发的Step，必填项，结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT,IN,BOTH），默认是BOTH</li> |
| <li>labels：边的类型列表</li> |
| <li>properties：通过属性的值过滤边</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| </ul> |
| </li> |
| <li>max_depth：步数，必填项</li> |
| <li>nearest：nearest为true时，代表起始顶点到达结果顶点的最短路径长度为depth，不存在更短的路径；nearest为false时，代表起始顶点到结果顶点有一条长度为depth的路径（未必最短且可以有环），选填项，默认为true</li> |
| <li>count_only：Boolean值，true表示只统计结果的数目，不返回具体结果；false表示返回具体的结果，默认为false</li> |
| <li>with_path：true表示返回起始点到每个邻居的最短路径，false表示不返回起始点到每个邻居的最短路径，选填项，默认为false</li> |
| <li>with_vertex，选填项，默认为false： |
| <ul> |
| <li>true表示返回结果包含完整的顶点信息（路径中的全部顶点） |
| <ul> |
| <li>with_path为true时，返回所有路径中的顶点的完整信息</li> |
| <li>with_path为false时，返回所有邻居的完整信息</li> |
| </ul> |
| </li> |
| <li>false时表示只返回顶点id</li> |
| </ul> |
| </li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的顶点的最大数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="3222-使用方法">3.2.2.2 使用方法</h5> |
| <h6 id="method--url-1">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/{graph}/traversers/kout |
| </code></pre><h6 id="request-body">Request Body</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-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">"source"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"step"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"BOTH"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"P.gt(0.1)"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000</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">"max_depth"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"nearest"</span><span style="color:#000;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:#204a87;font-weight:bold">"limit"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"with_vertex"</span><span style="color:#000;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:#204a87;font-weight:bold">"with_path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-1">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-1">Response Body</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-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">"size"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"kout"</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">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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">"paths"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:vadas"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">27</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Hongkong"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">328</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><h5 id="3223-适用场景">3.2.2.3 适用场景</h5> |
| <p>参见3.2.1.3</p> |
| <h4 id="323-k-neighborget基础版">3.2.3 K-neighbor（GET，基础版）</h4> |
| <h5 id="3231-功能介绍">3.2.3.1 功能介绍</h5> |
| <p>根据起始顶点、方向、边的类型（可选）和深度depth，查找包括起始顶点在内、depth步之内可达的所有顶点</p> |
| <blockquote> |
| <p>相当于：起始顶点、K-out(1)、K-out(2)、… 、K-out(max_depth)的并集</p> |
| </blockquote> |
| <h6 id="params-2">Params</h6> |
| <ul> |
| <li>source: 起始顶点id，必填项</li> |
| <li>direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>max_depth：步数，必填项</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>limit：返回的顶点的最大数目，也即遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="3232-使用方法">3.2.3.2 使用方法</h5> |
| <h6 id="method--url-2">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/kneighbor?source=“1:marko”&max_depth=2 |
| </code></pre><h6 id="response-status-2">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-2">Response Body</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-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">"vertices"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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><h5 id="3233-适用场景">3.2.3.3 适用场景</h5> |
| <p>查找N步以内可达的所有顶点，例如：</p> |
| <ul> |
| <li>家族关系中，查找一个人五服以内所有子孙，person A通过连续的5条“亲子”边到达的顶点集合。</li> |
| <li>社交关系中发现好友圈子，例如目标用户通过1条、2条、3条“朋友”边可到达的用户可以组成目标用户的朋友圈子</li> |
| </ul> |
| <h4 id="324-k-neighbor-apipost高级版">3.2.4 K-neighbor API（POST，高级版）</h4> |
| <h5 id="3241-功能介绍">3.2.4.1 功能介绍</h5> |
| <p>根据起始顶点、步骤（包括方向、边类型和过滤属性）和深度depth，查找从起始顶点出发depth步内可达的所有顶点。</p> |
| <blockquote> |
| <p>与K-neighbor基础版的不同在于：</p> |
| <ul> |
| <li>支持只统计邻居数量</li> |
| <li>支持边属性过滤</li> |
| <li>支持返回到达邻居的最短路径</li> |
| </ul> |
| </blockquote> |
| <h6 id="params-3">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>从起始点出发的Step，必填项，结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT,IN,BOTH），默认是BOTH</li> |
| <li>labels：边的类型列表</li> |
| <li>properties：通过属性的值过滤边</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| </ul> |
| </li> |
| <li>max_depth：步数，必填项</li> |
| <li>count_only：Boolean值，true表示只统计结果的数目，不返回具体结果；false表示返回具体的结果，默认为false</li> |
| <li>with_path：true表示返回起始点到每个邻居的最短路径，false表示不返回起始点到每个邻居的最短路径，选填项，默认为false</li> |
| <li>with_vertex，选填项，默认为false： |
| <ul> |
| <li>true表示返回结果包含完整的顶点信息（路径中的全部顶点） |
| <ul> |
| <li>with_path为true时，返回所有路径中的顶点的完整信息</li> |
| <li>with_path为false时，返回所有邻居的完整信息</li> |
| </ul> |
| </li> |
| <li>false时表示只返回顶点id</li> |
| </ul> |
| </li> |
| <li>limit：返回的顶点的最大数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="3242-使用方法">3.2.4.2 使用方法</h5> |
| <h6 id="method--url-3">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/{graph}/traversers/kneighbor |
| </code></pre><h6 id="request-body-1">Request Body</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-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">"source"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"step"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"BOTH"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"P.gt(0.1)"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000</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">"max_depth"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"limit"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"with_vertex"</span><span style="color:#000;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:#204a87;font-weight:bold">"with_path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-3">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-3">Response Body</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-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">"size"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">6</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"kneighbor"</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">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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">"paths"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</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">"objects"</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">"1:marko"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:vadas"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:peter"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">199</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">27</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Hongkong"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">35</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Shanghai"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">328</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><h5 id="3243-适用场景">3.2.4.3 适用场景</h5> |
| <p>参见3.2.3.3</p> |
| <h4 id="325-same-neighbors">3.2.5 Same Neighbors</h4> |
| <h5 id="3251-功能介绍">3.2.5.1 功能介绍</h5> |
| <p>查询两个点的共同邻居</p> |
| <h6 id="params-4">Params</h6> |
| <ul> |
| <li>vertex：一个顶点id，必填项</li> |
| <li>other：另一个顶点id，必填项</li> |
| <li>direction：顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>limit：返回的共同邻居的最大数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="3252-使用方法">3.2.5.2 使用方法</h5> |
| <h6 id="method--url-4">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/sameneighbors?vertex=“1:marko”&other="1:josh" |
| </code></pre><h6 id="response-status-4">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-4">Response Body</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-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">"same_neighbors"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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><h5 id="3253-适用场景">3.2.5.3 适用场景</h5> |
| <p>查找两个顶点的共同邻居：</p> |
| <ul> |
| <li>社交关系中发现两个用户的共同粉丝或者共同关注用户</li> |
| </ul> |
| <h4 id="326-jaccard-similarityget">3.2.6 Jaccard Similarity（GET）</h4> |
| <h5 id="3261-功能介绍">3.2.6.1 功能介绍</h5> |
| <p>计算两个顶点的jaccard similarity（两个顶点邻居的交集比上两个顶点邻居的并集）</p> |
| <h6 id="params-5">Params</h6> |
| <ul> |
| <li>vertex：一个顶点id，必填项</li> |
| <li>other：另一个顶点id，必填项</li> |
| <li>direction：顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| </ul> |
| <h5 id="3262-使用方法">3.2.6.2 使用方法</h5> |
| <h6 id="method--url-5">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/jaccardsimilarity?vertex="1:marko"&other="1:josh" |
| </code></pre><h6 id="response-status-5">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-5">Response Body</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-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">"jaccard_similarity"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.2</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="3263-适用场景">3.2.6.3 适用场景</h5> |
| <p>用于评估两个点的相似性或者紧密度</p> |
| <h4 id="327-jaccard-similaritypost">3.2.7 Jaccard Similarity（POST）</h4> |
| <h5 id="3271-功能介绍">3.2.7.1 功能介绍</h5> |
| <p>计算与指定顶点的jaccard similarity最大的N个点</p> |
| <blockquote> |
| <p>jaccard similarity的计算方式为：两个顶点邻居的交集比上两个顶点邻居的并集</p> |
| </blockquote> |
| <h6 id="params-6">Params</h6> |
| <ul> |
| <li>vertex：一个顶点id，必填项</li> |
| <li>从起始点出发的Step，必填项，结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT,IN,BOTH），默认是BOTH</li> |
| <li>labels：边的类型列表</li> |
| <li>properties：通过属性的值过滤边</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| </ul> |
| </li> |
| <li>top：返回一个起点的jaccard similarity中最大的top个，选填项，默认为100</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="3272-使用方法">3.2.7.2 使用方法</h5> |
| <h6 id="method--url-6">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/{graph}/traversers/jaccardsimilarity |
| </code></pre><h6 id="request-body-2">Request Body</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-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">"vertex"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"step"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"BOTH"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000</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">"top"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">3</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-6">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-6">Response Body</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-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">"2:ripple"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.3333333333333333</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"1:peter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.3333333333333333</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"1:josh"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.2</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="3273-适用场景">3.2.7.3 适用场景</h5> |
| <p>用于在图中找出与指定顶点相似性最高的顶点</p> |
| <h4 id="328-shortest-path">3.2.8 Shortest Path</h4> |
| <h5 id="3281-功能介绍">3.2.8.1 功能介绍</h5> |
| <p>根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度，查找一条最短路径</p> |
| <h6 id="params-7">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>target：目的顶点id，必填项</li> |
| <li>direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>max_depth：最大步数，必填项</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="3282-使用方法">3.2.8.2 使用方法</h5> |
| <h6 id="method--url-7">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/shortestpath?source="1:marko"&target="2:ripple"&max_depth=3 |
| </code></pre><h6 id="response-status-7">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-7">Response Body</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-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">"path"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</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><h5 id="3283-适用场景">3.2.8.3 适用场景</h5> |
| <p>查找两个顶点间的最短路径，例如：</p> |
| <ul> |
| <li>社交关系网中，查找两个用户有关系的最短路径，即最近的朋友关系链</li> |
| <li>设备关联网络中，查找两个设备最短的关联关系</li> |
| </ul> |
| <h4 id="329-all-shortest-paths">3.2.9 All Shortest Paths</h4> |
| <h5 id="3291-功能介绍">3.2.9.1 功能介绍</h5> |
| <p>根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度，查找两点间所有的最短路径</p> |
| <h6 id="params-8">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>target：目的顶点id，必填项</li> |
| <li>direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>max_depth：最大步数，必填项</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="3292-使用方法">3.2.9.2 使用方法</h5> |
| <h6 id="method--url-8">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/allshortestpaths?source="A"&target="Z"&max_depth=10 |
| </code></pre><h6 id="response-status-8">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-8">Response Body</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-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">"paths"</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">"objects"</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">"A"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"B"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"C"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"Z"</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">"objects"</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">"A"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"M"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"N"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"Z"</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><h5 id="3293-适用场景">3.2.9.3 适用场景</h5> |
| <p>查找两个顶点间的所有最短路径，例如：</p> |
| <ul> |
| <li>社交关系网中，查找两个用户有关系的全部最短路径，即最近的朋友关系链</li> |
| <li>设备关联网络中，查找两个设备全部的最短关联关系</li> |
| </ul> |
| <h4 id="3210-weighted-shortest-path">3.2.10 Weighted Shortest Path</h4> |
| <h5 id="32101-功能介绍">3.2.10.1 功能介绍</h5> |
| <p>根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度，查找一条带权最短路径</p> |
| <h6 id="params-9">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>target：目的顶点id，必填项</li> |
| <li>direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>weight：边的权重属性，必填项，必须是数字类型的属性</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>with_vertex：true表示返回结果包含完整的顶点信息（路径中的全部顶点），false时表示只返回顶点id，选填项，默认为false</li> |
| </ul> |
| <h5 id="32102-使用方法">3.2.10.2 使用方法</h5> |
| <h6 id="method--url-9">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/weightedshortestpath?source="1:marko"&target="2:ripple"&weight="weight"&with_vertex=true |
| </code></pre><h6 id="response-status-9">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-9">Response Body</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-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">"path"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">2.0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"vertices"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">199</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><h5 id="32103-适用场景">3.2.10.3 适用场景</h5> |
| <p>查找两个顶点间的带权最短路径，例如：</p> |
| <ul> |
| <li>交通线路中查找从A城市到B城市花钱最少的交通方式</li> |
| </ul> |
| <h4 id="3211-single-source-shortest-path">3.2.11 Single Source Shortest Path</h4> |
| <h5 id="32111-功能介绍">3.2.11.1 功能介绍</h5> |
| <p>从一个顶点出发，查找该点到图中其他顶点的最短路径（可选是否带权重）</p> |
| <h6 id="params-10">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>weight：边的权重属性，选填项，必须是数字类型的属性，如果不填或者虽然填了但是边没有该属性，则权重为1.0</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：查询到的目标顶点个数，也是返回的最短路径的条数，选填项，默认为10</li> |
| <li>with_vertex：true表示返回结果包含完整的顶点信息（路径中的全部顶点），false时表示只返回顶点id，选填项，默认为false</li> |
| </ul> |
| <h5 id="32112-使用方法">3.2.11.2 使用方法</h5> |
| <h6 id="method--url-10">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/singlesourceshortestpath?source="1:marko"&with_vertex=true |
| </code></pre><h6 id="response-status-10">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-10">Response Body</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-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">"paths"</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">"2:ripple"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">2.0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"vertices"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</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">"1:josh"</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">"weight"</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:#204a87;font-weight:bold">"vertices"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</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">"1:vadas"</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">"weight"</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:#204a87;font-weight:bold">"vertices"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:vadas"</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">"1:peter"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">2.0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"vertices"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:peter"</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">"2:lop"</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">"weight"</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:#204a87;font-weight:bold">"vertices"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">199</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">27</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Hongkong"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">35</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Shanghai"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">328</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><h5 id="32113-适用场景">3.2.11.3 适用场景</h5> |
| <p>查找从一个点出发到其他顶点的带权最短路径，比如：</p> |
| <ul> |
| <li>查找从北京出发到全国其他所有城市的耗时最短的乘车方案</li> |
| </ul> |
| <h4 id="3212-multi-node-shortest-path">3.2.12 Multi Node Shortest Path</h4> |
| <h5 id="32121-功能介绍">3.2.12.1 功能介绍</h5> |
| <p>查找指定顶点集两两之间的最短路径</p> |
| <h6 id="params-11">Params</h6> |
| <ul> |
| <li>vertices：定义起始顶点，必填项，指定方式包括： |
| <ul> |
| <li>ids：通过顶点id列表提供起始顶点</li> |
| <li>label和properties：如果没有指定ids，则使用label和properties的联合条件查询起始顶点 |
| <ul> |
| <li>label：顶点的类型</li> |
| <li>properties：通过属性的值查询起始顶点</li> |
| </ul> |
| <blockquote> |
| <p>注意：properties中的属性值可以是列表，表示只要key对应的value在列表中就可以</p> |
| </blockquote> |
| </li> |
| </ul> |
| </li> |
| <li>step：表示从起始顶点到终止顶点走过的路径，必填项，Step的结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT,IN,BOTH），默认是BOTH</li> |
| <li>labels：边的类型列表</li> |
| <li>properties：通过属性的值过滤边</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| </ul> |
| </li> |
| <li>max_depth：步数，必填项</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>with_vertex：true表示返回结果包含完整的顶点信息（路径中的全部顶点），false时表示只返回顶点id，选填项，默认为false</li> |
| </ul> |
| <h5 id="32122-使用方法">3.2.12.2 使用方法</h5> |
| <h6 id="method--url-11">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/{graph}/traversers/multinodeshortestpath |
| </code></pre><h6 id="request-body-3">Request Body</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-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">"vertices"</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">"ids"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"382:josh"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"382:vadas"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"382:peter"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"383:ripple"</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">"step"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"BOTH"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"max_depth"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"capacity"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"with_vertex"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-11">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-11">Response Body</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-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">"paths"</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">"objects"</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">"382:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:lop"</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">"objects"</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">"382:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:marko"</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">"objects"</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">"382:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:josh"</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">"objects"</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">"382:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:vadas"</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">"objects"</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">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:marko"</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">"objects"</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">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:josh"</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">"objects"</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">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:vadas"</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">"objects"</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">"382:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:ripple"</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">"objects"</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">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:josh"</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">"objects"</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">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:ripple"</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">"objects"</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">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:vadas"</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">"objects"</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">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:ripple"</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">"objects"</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">"382:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:ripple"</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">"objects"</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">"382:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:vadas"</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">"objects"</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">"382:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"382:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"383:ripple"</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"382:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Shanghai"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"383:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">328</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"382:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"382:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"382:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">27</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Hongkong"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"383:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">199</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><h5 id="32123-适用场景">3.2.12.3 适用场景</h5> |
| <p>查找多个点之间的最短路径，比如：</p> |
| <ul> |
| <li>查找多个公司和法人之间的最短路径</li> |
| </ul> |
| <h4 id="3213-paths-get基础版">3.2.13 Paths （GET，基础版）</h4> |
| <h5 id="32131-功能介绍">3.2.13.1 功能介绍</h5> |
| <p>根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度等条件查找所有路径</p> |
| <h6 id="params-12">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>target：目的顶点id，必填项</li> |
| <li>direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_depth：步数，必填项</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的路径的最大数目，选填项，默认为10</li> |
| </ul> |
| <h5 id="32132-使用方法">3.2.13.2 使用方法</h5> |
| <h6 id="method--url-12">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/paths?source="1:marko"&target="1:josh"&max_depth=5 |
| </code></pre><h6 id="response-status-12">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-12">Response Body</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-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">"paths"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</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><h5 id="32133-适用场景">3.2.13.3 适用场景</h5> |
| <p>查找两个顶点间的所有路径，例如：</p> |
| <ul> |
| <li>社交网络中，查找两个用户所有可能的关系路径</li> |
| <li>设备关联网络中，查找两个设备之间所有的关联路径</li> |
| </ul> |
| <h4 id="3214-paths-post高级版">3.2.14 Paths （POST，高级版）</h4> |
| <h5 id="32141-功能介绍">3.2.14.1 功能介绍</h5> |
| <p>根据起始顶点、目的顶点、步骤（step）和最大深度等条件查找所有路径</p> |
| <h6 id="params-13">Params</h6> |
| <ul> |
| <li>sources：定义起始顶点，必填项，指定方式包括： |
| <ul> |
| <li>ids：通过顶点id列表提供起始顶点</li> |
| <li>label和properties：如果没有指定ids，则使用label和properties的联合条件查询起始顶点 |
| <ul> |
| <li>label：顶点的类型</li> |
| <li>properties：通过属性的值查询起始顶点</li> |
| </ul> |
| <blockquote> |
| <p>注意：properties中的属性值可以是列表，表示只要key对应的value在列表中就可以</p> |
| </blockquote> |
| </li> |
| </ul> |
| </li> |
| <li>targets：定义终止顶点，必填项，指定方式包括： |
| <ul> |
| <li>ids：通过顶点id列表提供终止顶点</li> |
| <li>label和properties：如果没有指定ids，则使用label和properties的联合条件查询终止顶点 |
| <ul> |
| <li>label：顶点的类型</li> |
| <li>properties：通过属性的值查询终止顶点</li> |
| </ul> |
| <blockquote> |
| <p>注意：properties中的属性值可以是列表，表示只要key对应的value在列表中就可以</p> |
| </blockquote> |
| </li> |
| </ul> |
| </li> |
| <li>step：表示从起始顶点到终止顶点走过的路径，必填项，Step的结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT,IN,BOTH），默认是BOTH</li> |
| <li>labels：边的类型列表</li> |
| <li>properties：通过属性的值过滤边</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| </ul> |
| </li> |
| <li>max_depth：步数，必填项</li> |
| <li>nearest：nearest为true时，代表起始顶点到达结果顶点的最短路径长度为depth，不存在更短的路径；nearest为false时，代表起始顶点到结果顶点有一条长度为depth的路径（未必最短且可以有环），选填项，默认为true</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的路径的最大数目，选填项，默认为10</li> |
| <li>with_vertex：true表示返回结果包含完整的顶点信息（路径中的全部顶点），false时表示只返回顶点id，选填项，默认为false</li> |
| </ul> |
| <h5 id="32142-使用方法">3.2.14.2 使用方法</h5> |
| <h6 id="method--url-13">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/{graph}/traversers/paths |
| </code></pre><h6 id="request-body-4">Request Body</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-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">"sources"</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">"ids"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"1:marko"</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">"targets"</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">"ids"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"1:peter"</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">"step"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"BOTH"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"P.gt(0.01)"</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">"max_depth"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">"capacity"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">"limit"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">"with_vertex"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">false</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-13">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-13">Response Body</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-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">"paths"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:peter"</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">"objects"</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">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:peter"</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><h5 id="32143-适用场景">3.2.14.3 适用场景</h5> |
| <p>查找两个顶点间的所有路径，例如：</p> |
| <ul> |
| <li>社交网络中，查找两个用户所有可能的关系路径</li> |
| <li>设备关联网络中，查找两个设备之间所有的关联路径</li> |
| </ul> |
| <h4 id="3215-customized-paths">3.2.15 Customized Paths</h4> |
| <h5 id="32151-功能介绍">3.2.15.1 功能介绍</h5> |
| <p>根据一批起始顶点、边规则（包括方向、边的类型和属性过滤）和最大深度等条件查找符合条件的所有的路径</p> |
| <h6 id="params-14">Params</h6> |
| <ul> |
| <li>sources：定义起始顶点，必填项，指定方式包括： |
| <ul> |
| <li>ids：通过顶点id列表提供起始顶点</li> |
| <li>label和properties：如果没有指定ids，则使用label和properties的联合条件查询起始顶点 |
| <ul> |
| <li>label：顶点的类型</li> |
| <li>properties：通过属性的值查询起始顶点</li> |
| </ul> |
| <blockquote> |
| <p>注意：properties中的属性值可以是列表，表示只要key对应的value在列表中就可以</p> |
| </blockquote> |
| </li> |
| </ul> |
| </li> |
| <li>steps：表示从起始顶点走过的路径规则，是一组Step的列表。必填项。每个Step的结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT,IN,BOTH），默认是BOTH</li> |
| <li>labels：边的类型列表</li> |
| <li>properties：通过属性的值过滤边</li> |
| <li>weight_by：根据指定的属性计算边的权重，sort_by不为NONE时有效，与default_weight互斥</li> |
| <li>default_weight：当边没有属性作为权重计算值时，采取的默认权重，sort_by不为NONE时有效，与weight_by互斥</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>sample：当需要对某个step的符合条件的边进行采样时设置，-1表示不采样，默认为采样100</li> |
| </ul> |
| </li> |
| <li>sort_by：根据路径的权重排序，选填项，默认为NONE： |
| <ul> |
| <li>NONE表示不排序，默认值</li> |
| <li>INCR表示按照路径权重的升序排序</li> |
| <li>DECR表示按照路径权重的降序排序</li> |
| </ul> |
| </li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的路径的最大数目，选填项，默认为10</li> |
| <li>with_vertex：true表示返回结果包含完整的顶点信息（路径中的全部顶点），false时表示只返回顶点id，选填项，默认为false</li> |
| </ul> |
| <h5 id="32152-使用方法">3.2.15.2 使用方法</h5> |
| <h6 id="method--url-14">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/{graph}/traversers/customizedpaths |
| </code></pre><h6 id="request-body-5">Request Body</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-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">"sources"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ids"</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:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"name"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"marko"</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">"steps"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"OUT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"knows"</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">"weight_by"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"weight"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"max_degree"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</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">"direction"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"OUT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"created"</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">"default_weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"max_degree"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sample"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1</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">"sort_by"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"INCR"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"with_vertex"</span><span style="color:#000;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:#204a87;font-weight:bold">"capacity"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"limit"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-14">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-14">Response Body</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-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">"paths"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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">"weights"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#0000cf;font-weight:bold">8</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">29</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"josh"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">32</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">328</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"lop"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"java"</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><h5 id="32153-适用场景">3.2.15.3 适用场景</h5> |
| <p>适合查找各种复杂的路径集合，例如：</p> |
| <ul> |
| <li>社交网络中，查找看过张艺谋所导演的电影的用户关注的大V的路径（张艺谋—>电影—->用户—>大V）</li> |
| <li>风控网络中，查找多个高风险用户的直系亲属的朋友的路径（高风险用户—>直系亲属—>朋友）</li> |
| </ul> |
| <h4 id="3216-template-paths">3.2.16 Template Paths</h4> |
| <h5 id="32161-功能介绍">3.2.16.1 功能介绍</h5> |
| <p>根据一批起始顶点、边规则（包括方向、边的类型和属性过滤）和最大深度等条件查找符合条件的所有的路径</p> |
| <h6 id="params-15">Params</h6> |
| <ul> |
| <li>sources：定义起始顶点，必填项，指定方式包括： |
| <ul> |
| <li>ids：通过顶点id列表提供起始顶点</li> |
| <li>label和properties：如果没有指定ids，则使用label和properties的联合条件查询起始顶点 |
| <ul> |
| <li>label：顶点的类型</li> |
| <li>properties：通过属性的值查询起始顶点</li> |
| </ul> |
| <blockquote> |
| <p>注意：properties中的属性值可以是列表，表示只要key对应的value在列表中就可以</p> |
| </blockquote> |
| </li> |
| </ul> |
| </li> |
| <li>targets：定义终止顶点，必填项，指定方式包括： |
| <ul> |
| <li>ids：通过顶点id列表提供终止顶点</li> |
| <li>label和properties：如果没有指定ids，则使用label和properties的联合条件查询终止顶点 |
| <ul> |
| <li>label：顶点的类型</li> |
| <li>properties：通过属性的值查询终止顶点</li> |
| </ul> |
| <blockquote> |
| <p>注意：properties中的属性值可以是列表，表示只要key对应的value在列表中就可以</p> |
| </blockquote> |
| </li> |
| </ul> |
| </li> |
| <li>steps：表示从起始顶点走过的路径规则，是一组Step的列表。必填项。每个Step的结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT,IN,BOTH），默认是BOTH</li> |
| <li>labels：边的类型列表</li> |
| <li>properties：通过属性的值过滤边</li> |
| <li>max_times：当前step可以重复的次数，当为N时，表示从起始顶点可以经过当前step 1-N 次</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| </ul> |
| </li> |
| <li>with_ring：Boolean值，true表示包含环路；false表示不包含环路，默认为false</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的路径的最大数目，选填项，默认为10</li> |
| <li>with_vertex：true表示返回结果包含完整的顶点信息（路径中的全部顶点），false时表示只返回顶点id，选填项，默认为false</li> |
| </ul> |
| <h5 id="32162-使用方法">3.2.16.2 使用方法</h5> |
| <h6 id="method--url-15">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/{graph}/traversers/templatepaths |
| </code></pre><h6 id="request-body-6">Request Body</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-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">"sources"</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">"ids"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vadas"</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">"targets"</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">"ids"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ripple"</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">"steps"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"IN"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OUT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"IN"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000</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">"direction"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OUT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"skip_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">100000</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">"capacity"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"limit"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"with_vertex"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-15">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-15">Response Body</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-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">"paths"</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">"objects"</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">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">199</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">32</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"age"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">27</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Hongkong"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"lang"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"java"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">328</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><h5 id="32163-适用场景">3.2.16.3 适用场景</h5> |
| <p>适合查找各种复杂的模板路径，比如personA -(朋友)-> personB -(同学)-> personC，其中"朋友"和"同学"边可以分别是最多3层和4层的情况</p> |
| <h4 id="3217-crosspoints">3.2.17 Crosspoints</h4> |
| <h5 id="32171-功能介绍">3.2.17.1 功能介绍</h5> |
| <p>根据起始顶点、目的顶点、方向、边的类型（可选）和最大深度等条件查找相交点</p> |
| <h6 id="params-16">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>target：目的顶点id，必填项</li> |
| <li>direction：起始顶点到目的顶点的方向, 目的点到起始点是反方向，BOTH时不考虑方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_depth：步数，必填项</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的交点的最大数目，选填项，默认为10</li> |
| </ul> |
| <h5 id="32172-使用方法">3.2.17.2 使用方法</h5> |
| <h6 id="method--url-16">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/crosspoints?source="2:lop"&target="2:ripple"&max_depth=5&direction=IN |
| </code></pre><h6 id="response-status-16">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-16">Response Body</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-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">"crosspoints"</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">"crosspoint"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</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><h5 id="32173-适用场景">3.2.17.3 适用场景</h5> |
| <p>查找两个顶点的交点及其路径，例如：</p> |
| <ul> |
| <li>社交网络中，查找两个用户共同关注的话题或者大V</li> |
| <li>家族关系中，查找共同的祖先</li> |
| </ul> |
| <h4 id="3218-customized-crosspoints">3.2.18 Customized Crosspoints</h4> |
| <h5 id="32181-功能介绍">3.2.18.1 功能介绍</h5> |
| <p>根据一批起始顶点、多种边规则（包括方向、边的类型和属性过滤）和最大深度等条件查找符合条件的所有的路径终点的交集</p> |
| <h6 id="params-17">Params</h6> |
| <ul> |
| <li> |
| <p>sources：定义起始顶点，必填项，指定方式包括：</p> |
| <ul> |
| <li>ids：通过顶点id列表提供起始顶点</li> |
| <li>label和properties：如果没有指定ids，则使用label和properties的联合条件查询起始顶点 |
| <ul> |
| <li>label：顶点的类型</li> |
| <li>properties：通过属性的值查询起始顶点</li> |
| </ul> |
| <blockquote> |
| <p>注意：properties中的属性值可以是列表，表示只要key对应的value在列表中就可以</p> |
| </blockquote> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <p>path_patterns：表示从起始顶点走过的路径规则，是一组规则的列表。必填项。每个规则是一个PathPattern</p> |
| <ul> |
| <li>每个PathPattern是一组Step列表，每个Step结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT,IN,BOTH），默认是BOTH</li> |
| <li>labels：边的类型列表</li> |
| <li>properties：通过属性的值过滤边</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>skip_degree：用于设置查询过程中舍弃超级顶点的最小边数，即当某个顶点的邻接边数目大于 skip_degree 时，完全舍弃该顶点。选填项，如果开启时，需满足 <code>skip_degree >= max_degree</code> 约束，默认为0 (不启用)，表示不跳过任何点 (注意: 开启此配置后，遍历时会尝试访问一个顶点的 skip_degree 条边，而不仅仅是 max_degree 条边，这样有额外的遍历开销，对查询性能影响可能有较大影响，请确认理解后再开启)</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <p>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</p> |
| </li> |
| <li> |
| <p>limit：返回的路径的最大数目，选填项，默认为10</p> |
| </li> |
| <li> |
| <p>with_path：true表示返回交点所在的路径，false表示不返回交点所在的路径，选填项，默认为false</p> |
| </li> |
| <li> |
| <p>with_vertex，选填项，默认为false：</p> |
| <ul> |
| <li>true表示返回结果包含完整的顶点信息（路径中的全部顶点） |
| <ul> |
| <li>with_path为true时，返回所有路径中的顶点的完整信息</li> |
| <li>with_path为false时，返回所有交点的完整信息</li> |
| </ul> |
| </li> |
| <li>false时表示只返回顶点id</li> |
| </ul> |
| </li> |
| </ul> |
| <h5 id="32182-使用方法">3.2.18.2 使用方法</h5> |
| <h6 id="method--url-17">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/{graph}/traversers/customizedcrosspoints |
| </code></pre><h6 id="request-body-7">Request Body</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-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">"sources"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ids"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</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">"path_patterns"</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">"steps"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"IN"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"created"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</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">"with_path"</span><span style="color:#000;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:#204a87;font-weight:bold">"with_vertex"</span><span style="color:#000;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:#204a87;font-weight:bold">"capacity"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"limit"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-17">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-17">Response Body</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-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">"crosspoints"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</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">"paths"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple>price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">199</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"ripple"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple>lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"java"</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"josh"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">32</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">328</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"lop"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"java"</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><h5 id="32183-适用场景">3.2.18.3 适用场景</h5> |
| <p>查询一组顶点通过多种路径在终点有交集的情况。例如：</p> |
| <ul> |
| <li>在商品图谱中，多款手机、学习机、游戏机通过不同的低级别的类目路径，最终都属于一级类目的电子设备</li> |
| </ul> |
| <h4 id="3219-rings">3.2.19 Rings</h4> |
| <h5 id="32191-功能介绍">3.2.19.1 功能介绍</h5> |
| <p>根据起始顶点、方向、边的类型（可选）和最大深度等条件查找可达的环路</p> |
| <p>例如：1 -> 25 -> 775 -> 14690 -> 25, 其中环路为 25 -> 775 -> 14690 -> 25</p> |
| <h6 id="params-18">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>direction：起始顶点发出的边的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_depth：步数，必填项</li> |
| <li>source_in_ring：环路是否包含起点，选填项，默认为true</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的可达环路的最大数目，选填项，默认为10</li> |
| </ul> |
| <h5 id="32192-使用方法">3.2.19.2 使用方法</h5> |
| <h6 id="method--url-18">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/rings?source="1:marko"&max_depth=2 |
| </code></pre><h6 id="response-status-18">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-18">Response Body</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-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">"rings"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</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><h5 id="32193-适用场景">3.2.19.3 适用场景</h5> |
| <p>查询起始顶点可达的环路，例如：</p> |
| <ul> |
| <li>风控项目中，查询一个用户可达的循环担保的人或者设备</li> |
| <li>设备关联网络中，发现一个设备周围的循环引用的设备</li> |
| </ul> |
| <h4 id="3220-rays">3.2.20 Rays</h4> |
| <h5 id="32201-功能介绍">3.2.20.1 功能介绍</h5> |
| <p>根据起始顶点、方向、边的类型（可选）和最大深度等条件查找发散到边界顶点的路径</p> |
| <p>例如：1 -> 25 -> 775 -> 14690 -> 2289 -> 18379, 其中 18379 为边界顶点，即没有从 18379 发出的边</p> |
| <h6 id="params-19">Params</h6> |
| <ul> |
| <li>source：起始顶点id，必填项</li> |
| <li>direction：起始顶点发出的边的方向（OUT,IN,BOTH），选填项，默认是BOTH</li> |
| <li>label：边的类型，选填项，默认代表所有edge label</li> |
| <li>max_depth：步数，必填项</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</li> |
| <li>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| <li>limit：返回的非环路的最大数目，选填项，默认为10</li> |
| </ul> |
| <h5 id="32202-使用方法">3.2.20.2 使用方法</h5> |
| <h6 id="method--url-19">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/traversers/rays?source="1:marko"&max_depth=2&direction=OUT |
| </code></pre><h6 id="response-status-19">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-19">Response Body</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-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">"rays"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:vadas"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:ripple"</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">"objects"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"2:lop"</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><h5 id="32203-适用场景">3.2.20.3 适用场景</h5> |
| <p>查找起始顶点到某种关系的边界顶点的路径，例如：</p> |
| <ul> |
| <li>家族关系中，查找一个人到所有还没有孩子的子孙的路径</li> |
| <li>设备关联网络中，找到某个设备到终端设备的路径</li> |
| </ul> |
| <h4 id="3221-fusiform-similarity">3.2.21 Fusiform Similarity</h4> |
| <h5 id="32211-功能介绍">3.2.21.1 功能介绍</h5> |
| <p>按照条件查询一批顶点对应的"梭形相似点"。当两个顶点跟很多共同的顶点之间有某种关系的时候，我们认为这两个点为"梭形相似点"。举个例子说明"梭形相似点"：“读者A"读了100本书，可以定义读过这100本书中的80本以上的读者，是"读者A"的"梭形相似点”</p> |
| <h6 id="params-20">Params</h6> |
| <ul> |
| <li> |
| <p>sources：定义起始顶点，必填项，指定方式包括：</p> |
| <ul> |
| <li>ids：通过顶点id列表提供起始顶点</li> |
| <li>label和properties：如果没有指定ids，则使用label和properties的联合条件查询起始顶点 |
| <ul> |
| <li>label：顶点的类型</li> |
| <li>properties：通过属性的值查询起始顶点</li> |
| </ul> |
| <blockquote> |
| <p>注意：properties中的属性值可以是列表，表示只要key对应的value在列表中就可以</p> |
| </blockquote> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <p>label：边的类型，选填项，默认代表所有edge label</p> |
| </li> |
| <li> |
| <p>direction：起始顶点向外发散的方向（OUT,IN,BOTH），选填项，默认是BOTH</p> |
| </li> |
| <li> |
| <p>min_neighbors：最少邻居数目，邻居数目少于这个阈值时，认为起点不具备"梭形相似点"。比如想要找一个"读者A"读过的书的"梭形相似点"，那么<code>min_neighbors</code>为100时，表示"读者A"至少要读过100本书才可以有"梭形相似点"，必填项</p> |
| </li> |
| <li> |
| <p>alpha：相似度，代表：起点与"梭形相似点"的共同邻居数目占起点的全部邻居数目的比例，必填项</p> |
| </li> |
| <li> |
| <p>min_similars：“梭形相似点"的最少个数，只有当起点的"梭形相似点"数目大于或等于该值时，才会返回起点及其"梭形相似点”，选填项，默认值为1</p> |
| </li> |
| <li> |
| <p>top：返回一个起点的"梭形相似点"中相似度最高的top个，必填项，0表示全部</p> |
| </li> |
| <li> |
| <p>group_property：与<code>min_groups</code>一起使用，当起点跟其所有的"梭形相似点"某个属性的值有至少<code>min_groups</code>个不同值时，才会返回该起点及其"梭形相似点"。比如为"读者A"推荐"异地"书友时，需要设置<code>group_property</code>为读者的"城市"属性，<code>min_group</code>至少为2，选填项，不填代表不需要根据属性过滤</p> |
| </li> |
| <li> |
| <p>min_groups：与<code>group_property</code>一起使用，只有<code>group_property</code>设置时才有意义</p> |
| </li> |
| <li> |
| <p>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，选填项，默认为10000</p> |
| </li> |
| <li> |
| <p>capacity：遍历过程中最大的访问的顶点数目，选填项，默认为10000000</p> |
| </li> |
| <li> |
| <p>limit：返回的结果数目上限（一个起点及其"梭形相似点"算一个结果），选填项，默认为10</p> |
| </li> |
| <li> |
| <p>with_intermediary：是否返回起点及其"梭形相似点"共同关联的中间点，默认为false</p> |
| </li> |
| <li> |
| <p>with_vertex，选填项，默认为false：</p> |
| <ul> |
| <li>true表示返回结果包含完整的顶点信息</li> |
| <li>false时表示只返回顶点id</li> |
| </ul> |
| </li> |
| </ul> |
| <h5 id="32212-使用方法">3.2.21.2 使用方法</h5> |
| <h6 id="method--url-20">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/traversers/fusiformsimilarity |
| </code></pre><h6 id="request-body-8">Request Body</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-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">"sources"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"ids"</span><span style="color:#000;font-weight:bold">:[],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"p1"</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">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"read"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"direction"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"OUT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"min_neighbors"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"alpha"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">0.75</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"min_similars"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"top"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_property"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"min_group"</span><span style="color:#000;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:#204a87;font-weight:bold">"max_degree"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"capacity"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">-1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"limit"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">-1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"with_intermediary"</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">"with_vertex"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-20">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-20">Response Body</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-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">"similars"</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">"3:p1"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3:p2"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"score"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.8888888888888888</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"intermediaries"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3:p3"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"score"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.7777777777777778</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"intermediaries"</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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3:p1"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"p1"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3:p2"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"p2"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Shanghai"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3:p3"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"p3"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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><h5 id="32213-适用场景">3.2.21.3 适用场景</h5> |
| <p>查询一组顶点相似度很高的顶点。例如：</p> |
| <ul> |
| <li>跟一个读者有类似书单的读者</li> |
| <li>跟一个玩家玩类似游戏的玩家</li> |
| </ul> |
| <h4 id="3222-vertices">3.2.22 Vertices</h4> |
| <h5 id="32221-根据顶点的id列表批量查询顶点">3.2.22.1 根据顶点的id列表，批量查询顶点</h5> |
| <h6 id="params-21">Params</h6> |
| <ul> |
| <li>ids：要查询的顶点id列表</li> |
| </ul> |
| <h6 id="method--url-21">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/traversers/vertices?ids="1:marko"&ids="2:lop" |
| </code></pre><h6 id="response-status-21">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-21">Response Body</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-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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">29</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">328</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"lop"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"java"</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><h5 id="32222-获取顶点-shard-信息">3.2.22.2 获取顶点 Shard 信息</h5> |
| <p>通过指定的分片大小split_size，获取顶点分片信息（可以与 3.2.21.3 中的 Scan 配合使用来获取顶点）。</p> |
| <h6 id="params-22">Params</h6> |
| <ul> |
| <li>split_size：分片大小，必填项</li> |
| </ul> |
| <h6 id="method--url-22">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/traversers/vertices/shards?split_size=67108864 |
| </code></pre><h6 id="response-status-22">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-22">Response Body</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-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">"shards"</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"0"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2165893"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2165893"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"4331786"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"4331786"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"6497679"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"6497679"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"8663572"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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:#a40000">......</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><h5 id="32223-根据shard信息批量获取顶点">3.2.22.3 根据Shard信息批量获取顶点</h5> |
| <p>通过指定的分片信息批量查询顶点（Shard信息的获取参见 3.2.21.2 Shard）。</p> |
| <h6 id="params-23">Params</h6> |
| <ul> |
| <li>start：分片起始位置，必填项</li> |
| <li>end：分片结束位置，必填项</li> |
| <li>page：分页位置，选填项，默认为null，不分页；当page为“”时表示分页的第一页，从start指示的位置开始</li> |
| <li>page_limit：分页获取顶点时，一页中顶点数目的上限，选填项，默认为100000</li> |
| </ul> |
| <h6 id="method--url-23">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/traversers/vertices/scan?start=0&end=4294967295 |
| </code></pre><h6 id="response-status-23">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-23">Response Body</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-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">"vertices"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple>price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">199</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"ripple"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple>lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"java"</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:vadas>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Hongkong"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:vadas>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vadas"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:vadas>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">27</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:peter>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Shanghai"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:peter>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"peter"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:peter>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">35</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"josh"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">32</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">29</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:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"price"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>price"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">328</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"lop"</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">"lang"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop>lang"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"java"</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><h5 id="32224-适用场景">3.2.22.4 适用场景</h5> |
| <ul> |
| <li>按id列表查询顶点，可用于批量查询顶点，比如在path查询到多条路径之后，可以进一步查询某条路径的所有顶点属性。</li> |
| <li>获取分片和按分片查询顶点，可以用来遍历全部顶点</li> |
| </ul> |
| <h4 id="3223-edges">3.2.23 Edges</h4> |
| <h5 id="32231-根据边的id列表批量查询边">3.2.23.1 根据边的id列表，批量查询边</h5> |
| <h6 id="params-24">Params</h6> |
| <ul> |
| <li>ids：要查询的边id列表</li> |
| </ul> |
| <h6 id="method--url-24">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/traversers/edges?ids="S1:josh>1>>S2:lop"&ids="S1:josh>1>>S2:ripple" |
| </code></pre><h6 id="response-status-24">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-24">Response Body</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-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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:josh>1>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20091111"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.4</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:josh>1>>S2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20171210"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</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><h5 id="32232-获取边-shard-信息">3.2.23.2 获取边 Shard 信息</h5> |
| <p>通过指定的分片大小split_size，获取边分片信息（可以与 3.2.22.3 中的 Scan 配合使用来获取边）。</p> |
| <h6 id="params-25">Params</h6> |
| <ul> |
| <li>split_size：分片大小，必填项</li> |
| </ul> |
| <h6 id="method--url-25">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/traversers/edges/shards?split_size=4294967295 |
| </code></pre><h6 id="response-status-25">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-25">Response Body</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-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">"shards"</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"0"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1073741823"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1073741823"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2147483646"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2147483646"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3221225469"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3221225469"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"4294967292"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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">"start"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"4294967292"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"end"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"4294967295"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"length"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</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><h5 id="32233-根据-shard-信息批量获取边">3.2.23.3 根据 Shard 信息批量获取边</h5> |
| <p>通过指定的分片信息批量查询边（Shard信息的获取参见 3.2.22.2）。</p> |
| <h6 id="params-26">Params</h6> |
| <ul> |
| <li>start：分片起始位置，必填项</li> |
| <li>end：分片结束位置，必填项</li> |
| <li>page：分页位置，选填项，默认为null，不分页；当page为“”时表示分页的第一页，从start指示的位置开始</li> |
| <li>page_limit：分页获取边时，一页中边数目的上限，选填项，默认为100000</li> |
| </ul> |
| <h6 id="method--url-26">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/traversers/edges/scan?start=0&end=3221225469 |
| </code></pre><h6 id="response-status-26">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-26">Response Body</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-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">"edges"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:peter>2>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:peter"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</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><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"20170324"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:josh>2>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</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:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"20091111"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:josh>2>>S2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:ripple"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"20171210"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:marko>1>20130220>S1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:josh"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"20130220"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:marko>1>20160110>S1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"knows"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:vadas"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</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:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"20160110"</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">"id"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"S1:marko>2>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</span><span style="color:#000;font-weight:bold">:{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"weight"</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:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"20171210"</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><h5 id="32234-适用场景">3.2.23.4 适用场景</h5> |
| <ul> |
| <li>按id列表查询边，可用于批量查询边</li> |
| <li>获取分片和按分片查询边，可以用来遍历全部边</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-ced5167413a6606a537e40b18f6fec3e">5.1.10 - Rank API</h1> |
| |
| <h3 id="41-rank-api-概述">4.1 rank API 概述</h3> |
| <p>HugeGraphServer 除了上一节提到的遍历（traverser）方法，还提供了一类专门做推荐的方法，我们称为<code>rank API</code>， |
| 可在图中为一个点推荐与其关系密切的其它点。</p> |
| <h3 id="42-rank-api-详解">4.2 rank API 详解</h3> |
| <h4 id="421-personal-rank-api">4.2.1 Personal Rank API</h4> |
| <p>Personal Rank 算法典型场景是用于推荐应用中, 根据某个点现有的出边, 推荐具有相近 / 相同关系的其他点, |
| 比如根据某个人的阅读记录 / 习惯, 向它推荐其他可能感兴趣的书, 或潜在的书友, 举例如下:</p> |
| <ol> |
| <li>假设给定 1个 Person 点 是 tom, 它喜欢 <code>a,b,c,d,e</code> 5本书, 我们的想给 tom 推荐一些书友, 以及一些书, 最容易的想法就是看看还有哪些人喜欢过这些书 (共同兴趣)</li> |
| <li>那么此时, 需要有其它的 Person 点比如 neo, 他喜欢 <code>b,d,f</code> 3本书, 以及 jay, 它喜欢 <code>c,d,e,g</code> 4本书, lee 它喜欢 <code>a,d,e,f</code> 4本书</li> |
| <li>由于 tom 已经看过的书不需要重复推荐, 所以返回结果里应该期望推荐有共同喜好的其他书友看过, 但 tom 没看过的书, 比如推荐 “f” 和 “g” 书, 且优先级 f > g</li> |
| <li>此时再计算 tom 的个性化 rank 值, 就会返回排序后 TopN 推荐的 书友 + 书 的结果了 (如果只需要推荐的书, 选择 OTHER_LABEL 即可)</li> |
| </ol> |
| <h5 id="4210-数据准备">4.2.1.0 数据准备</h5> |
| <p>上面是一个简单的例子, 这里再提供一个公开的 1MB 测试数据集 <a href="https://grouplens.org/datasets/movielens/">MovieLens</a> 为例， |
| 用户需下载该数据集，然后使用 HugeGraph-Loader 导入到 HugeGraph 中，简单起见，数据中顶点 user |
| 和 movie 的属性都忽略，仅使用 id 字段即可，边 rating 的具体评分值也忽略。loader 使用的元数据 |
| 文件和输入源映射文件内容如下：</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">//////////////////////////////////////////////////////////// |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// UserID::Gender::Age::Occupation::Zip-code |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// MovieID::Title::Genres |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// UserID::MovieID::Rating::Timestamp |
| </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"></span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// Define schema |
| </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">"id"</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">"rate"</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">"user"</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">"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:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"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:#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 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">"movie"</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">"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:#c4a000">primaryKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"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:#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">"rating"</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">"user"</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">"movie"</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">"rate"</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></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-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">"vertices"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"user"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"users.dat"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"delimiter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"::"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"UserID"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Gender"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Age"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Occupation"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Zip-code"</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">"ignored"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"Gender"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Age"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Occupation"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Zip-code"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"mapping"</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">"UserID"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"id"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"movie"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"movies.dat"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"delimiter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"::"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"MovieID"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Title"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Genres"</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">"ignored"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"Title"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Genres"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"mapping"</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">"MovieID"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"id"</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">"edges"</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">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"rating"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"source"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"UserID"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"MovieID"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"input"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"file"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"path"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ratings.dat"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"format"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"TEXT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"delimiter"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"::"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"header"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"UserID"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"MovieID"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Rating"</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#4e9a06">"Timestamp"</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">"ignored"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">"Timestamp"</span><span style="color:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"mapping"</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">"UserID"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"id"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"MovieID"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"id"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"Rating"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"rate"</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><blockquote> |
| <p>注意将映射文件中<code>input.path</code>的值修改为自己本地的路径。</p> |
| </blockquote> |
| <h5 id="4211-功能介绍">4.2.1.1 功能介绍</h5> |
| <p>适用于二分图，给出所有源顶点相关的其他顶点及其相关性组成的列表。</p> |
| <blockquote> |
| <p>二分图：也称二部图，是图论里的一种特殊模型，也是一种特殊的网络流。其最大的特点在于，可以将图里的顶点分为两个集合，两个集合之间的点有边相连，但集合内的点之间没有直接关联。</p> |
| </blockquote> |
| <p>假设有一个用户和物品的二分图，基于随机游走的 PersonalRank 算法步骤如下：</p> |
| <ol> |
| <li>选定一个起点用户 u，其初始权重为 1.0，从 Vu 开始游走（有 alpha 的概率走到邻居点，1 - alpha 的概率停留）；</li> |
| <li>如果决定向外游走, 那么会选取某一个类型的出边, 例如 <code>rating</code> 来查找共同的打分人： |
| <ol> |
| <li>那就从当前节点的邻居节点中按照均匀分布随机选择一个，并且按照均匀分布划分权重值；</li> |
| <li>给源顶点补偿权重 1 - alpha；</li> |
| <li>重复步骤2；</li> |
| </ol> |
| </li> |
| <li>达到一定步数或达到精度后收敛，得到推荐列表。</li> |
| </ol> |
| <h6 id="params">Params</h6> |
| <p><strong>必填项</strong>:</p> |
| <ul> |
| <li>source: 源顶点 id</li> |
| <li>label: 源点出发的某类边 label，须连接两类不同顶点</li> |
| </ul> |
| <p><strong>选填项</strong>:</p> |
| <ul> |
| <li>alpha：每轮迭代时从某个点往外走的概率，与 PageRank 算法中的 alpha 类似，取值区间为 (0, 1], 默认值 <code>0.85</code></li> |
| <li>max_degree: 查询过程中，单个顶点遍历的最大邻接边数目，默认为 <code>10000</code></li> |
| <li>max_depth: 迭代次数，取值区间为 [2, 50], 默认值 <code>5</code></li> |
| <li>with_label：筛选结果中保留哪些结果，可选以下三类, 默认为 <code>BOTH_LABEL</code> |
| <ul> |
| <li>SAME_LABEL：仅保留与源顶点相同类别的顶点</li> |
| <li>OTHER_LABEL：仅保留与源顶点不同类别（二分图的另一端）的顶点</li> |
| <li>BOTH_LABEL：同时保留与源顶点相同和相反类别的顶点</li> |
| </ul> |
| </li> |
| <li>limit: 返回的顶点的最大数目，默认为 <code>100</code></li> |
| <li>max_diff: 提前收敛的精度差, 默认为 <code>0.0001</code> (<em>后续实现</em>)</li> |
| <li>sorted：返回的结果是否根据 rank 排序，为 true 时降序排列，反之不排序，默认为 <code>true</code></li> |
| </ul> |
| <h5 id="4212-使用方法">4.2.1.2 使用方法</h5> |
| <h6 id="method--url">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/traversers/personalrank |
| </code></pre><h6 id="request-body">Request Body</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-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">"source"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:1"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"rating"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"alpha"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.6</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"max_depth"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">15</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"with_label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"OTHER_LABEL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"sorted"</span><span style="color:#000;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:#204a87;font-weight:bold">"limit"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">10</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body">Response Body</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-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">"2:2858"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.0005014026017816927</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:1196"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.0004336708357653617</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:1210"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.0004128083140214213</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:593"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.00038117341069881513</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:480"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.00037005373269728036</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:1198"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.000366641614652057</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:2396"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.0003622362410538888</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:2571"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.0003593312457300953</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:589"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.00035922123055598566</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"2:110"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.0003466135844390885</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="4213-适用场景">4.2.1.3 适用场景</h5> |
| <p>两类不同顶点连接形成的二分图中，给某个点推荐相关性最高的其他顶点，例如：</p> |
| <ul> |
| <li>阅读推荐: 找出优先给某人推荐的其他<strong>书籍</strong>, 也可以同时推荐共同喜好最高的<strong>书友</strong> (例: 微信 “你的好友也在看 xx 文章” 功能)</li> |
| <li>社交推荐: 找出拥有相同关注话题的其他<strong>博主</strong>, 也可以推荐可能感兴趣的<strong>新闻/消息</strong> (例: Weibo 中的 “热点推荐” 功能)</li> |
| <li>商品推荐: 通过某人现在的购物习惯, 找出应优先推给它的<strong>商品列表</strong>, 也可以给它推荐<strong>带货</strong>播主 (例: TaoBao 的 “猜你喜欢” 功能)</li> |
| </ul> |
| <h4 id="422-neighbor-rank-api">4.2.2 Neighbor Rank API</h4> |
| <h5 id="4220-数据准备">4.2.2.0 数据准备</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">public</span> <span style="color:#204a87;font-weight:bold">class</span> <span style="color:#000">Loader</span> <span style="color:#ce5c00;font-weight:bold">{</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:#000">HugeClient</span> <span style="color:#000">client</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">HugeClient</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"http://127.0.0.1:8080"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#ce5c00;font-weight:bold">);</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">client</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">"name"</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></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">"person"</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">"name"</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">useCustomizeStringId</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">"movie"</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">"name"</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">useCustomizeStringId</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">"follow"</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">"person"</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">"person"</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">"like"</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">"person"</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">"movie"</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">"directedBy"</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">"movie"</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">"person"</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">client</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">O</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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"O"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"O"</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">A</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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"A"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"A"</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">B</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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"B"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"B"</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">C</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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"C"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"C"</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">D</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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"D"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"D"</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">E</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">"movie"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"E"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"E"</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">F</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">"movie"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"F"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"F"</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">G</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">"movie"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"G"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"G"</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">H</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">"movie"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"H"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"H"</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">I</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">"movie"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"I"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"I"</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">J</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">"movie"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"J"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"J"</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">K</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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"K"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"K"</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">L</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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"L"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"L"</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">M</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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"M"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"M"</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">O</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">"follow"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">A</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">O</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">"follow"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">B</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">O</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">"follow"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">C</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">D</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">"follow"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">O</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">A</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">"follow"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">B</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">A</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">"like"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">E</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">A</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">"like"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">F</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">B</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">"like"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">G</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">B</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">"like"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">H</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">C</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">"like"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">I</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">C</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">"like"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">J</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">E</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">"directedBy"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">K</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">F</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">"directedBy"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">B</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">F</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">"directedBy"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">L</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">G</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">"directedBy"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">M</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="4221-功能介绍">4.2.2.1 功能介绍</h5> |
| <p>在一般图结构中，找出每一层与给定起点相关性最高的前 N 个顶点及其相关度，用图的语义理解就是：从起点往外走， |
| 走到各层各个顶点的概率。</p> |
| <h6 id="params-1">Params</h6> |
| <ul> |
| <li>source: 源顶点 id，必填项</li> |
| <li>alpha：每轮迭代时从某个点往外走的概率，与 PageRank 算法中的 alpha 类似，必填项，取值区间为 (0, 1]</li> |
| <li>steps: 表示从起始顶点走过的路径规则，是一组 Step 的列表，每个 Step 对应结果中的一层，必填项。每个 Step 的结构如下： |
| <ul> |
| <li>direction：表示边的方向（OUT, IN, BOTH），默认是 BOTH</li> |
| <li>labels：边的类型列表，多个边类型取并集</li> |
| <li>max_degree：查询过程中，单个顶点遍历的最大邻接边数目，默认为 10000 (注: 0.12版之前 step 内仅支持 degree 作为参数名, 0.12开始统一使用 max_degree, 并向下兼容 degree 写法)</li> |
| <li>top：在结果中每一层只保留权重最高的前 N 个结果，默认为 100，最大值为 1000</li> |
| </ul> |
| </li> |
| <li>capacity: 遍历过程中最大的访问的顶点数目，选填项，默认为10000000</li> |
| </ul> |
| <h5 id="4222-使用方法">4.2.2.2 使用方法</h5> |
| <h6 id="method--url-1">Method & Url</h6> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/traversers/neighborrank |
| </code></pre><h6 id="request-body-1">Request Body</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-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">"source"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"O"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"steps"</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">"direction"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"OUT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"follow"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"top"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">100</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">"direction"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"OUT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"follow"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"like"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"top"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">100</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">"direction"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#4e9a06">"OUT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"labels"</span><span style="color:#000;font-weight:bold">:[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"directedBy"</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">"max_degree"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"top"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">100</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">"alpha"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">0.9</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"capacity"</span><span style="color:#000;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">-1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h6 id="response-status-1">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-1">Response Body</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-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">"ranks"</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">"O"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</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">"B"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.4305</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"A"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.3</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"C"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.3</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">"G"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.17550000000000002</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"H"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.17550000000000002</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"I"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.135</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"J"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.135</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"E"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.09000000000000001</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"F"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.09000000000000001</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">"M"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.15795</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"K"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.08100000000000002</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"L"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0.04050000000000001</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><h5 id="4223-适用场景">4.2.2.3 适用场景</h5> |
| <p>为给定的起点在不同的层中找到最应该推荐的顶点。</p> |
| <ul> |
| <li>比如：在观众、朋友、电影、导演的四层图结构中，根据某个观众的朋友们喜欢的电影，为这个观众推荐电影；或者根据这些电影是谁拍的，为其推荐导演。</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-32aff6fa72d51caa846c2a72e5771c5d">5.1.11 - Variable API</h1> |
| |
| <h3 id="51-variables">5.1 Variables</h3> |
| <p>Variables可以用来存储有关整个图的数据，数据按照键值对的方式存取</p> |
| <h4 id="511-创建或者更新某个键值对">5.1.1 创建或者更新某个键值对</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/variables/name |
| </code></pre><h5 id="request-body">Request Body</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-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">"data"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"tom"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"tom"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="512-列出全部键值对">5.1.2 列出全部键值对</h4> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/variables |
| </code></pre><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"tom"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="513-列出某个键值对">5.1.3 列出某个键值对</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/variables/name |
| </code></pre><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"tom"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="514-删除某个键值对">5.1.4 删除某个键值对</h4> |
| <h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/variables/name |
| </code></pre><h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-3d75cf337650cd90a617c3ef7e9dca87">5.1.12 - Graphs API</h1> |
| |
| <h3 id="61-graphs">6.1 Graphs</h3> |
| <h4 id="611-列出数据库中全部的图">6.1.1 列出数据库中全部的图</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs |
| </code></pre><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"graphs"</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">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"hugegraph1"</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><h4 id="612-查看某个图的信息">6.1.2 查看某个图的信息</h4> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph |
| </code></pre><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"backend"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"cassandra"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="613-清空某个图的全部数据包括schemavertexedge和index等该操作需要管理员权限">6.1.3 清空某个图的全部数据，包括schema、vertex、edge和index等，<strong>该操作需要管理员权限</strong></h4> |
| <h5 id="params">Params</h5> |
| <p>由于清空图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：</p> |
| <ul> |
| <li>confirm_message: 默认为<code>I'm sure to delete all data</code></li> |
| </ul> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data |
| </code></pre><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><h3 id="62-conf">6.2 Conf</h3> |
| <h4 id="621-查看某个图的配置该操作需要管理员权限">6.2.1 查看某个图的配置，<strong>该操作需要管理员权限</strong></h4> |
| <h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/conf |
| </code></pre><h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</h5> |
| <pre tabindex="0"><code class="language-properties" data-lang="properties"># gremlin entrence to create graph |
| gremlin.graph=com.baidu.hugegraph.HugeFactory |
| |
| # cache config |
| #schema.cache_capacity=1048576 |
| #graph.cache_capacity=10485760 |
| #graph.cache_expire=600 |
| |
| # schema illegal name template |
| #schema.illegal_name_regex=\s+|~.* |
| |
| #vertex.default_label=vertex |
| |
| backend=cassandra |
| serializer=cassandra |
| |
| store=hugegraph |
| ... |
| </code></pre><h3 id="63-mode">6.3 Mode</h3> |
| <p>合法的图模式包括：NONE，RESTORING，MERGING，LOADING</p> |
| <ul> |
| <li>None 模式（默认），元数据和图数据的写入属于正常状态。特别的： |
| <ul> |
| <li>元数据（schema）创建时不允许指定 ID</li> |
| <li>图数据（vertex）在 id strategy 为 Automatic 时，不允许指定 ID</li> |
| </ul> |
| </li> |
| <li>LOADING：批量导入数据时自动启用，特别的： |
| <ul> |
| <li>添加顶点/边时，不会检查必填属性是否传入</li> |
| </ul> |
| </li> |
| </ul> |
| <p>Restore 时存在两种不同的模式： Restoring 和 Merging</p> |
| <ul> |
| <li>Restoring 模式，恢复到一个新图中，特别的： |
| <ul> |
| <li>元数据（schema）创建时允许指定 ID</li> |
| <li>图数据（vertex）在 id strategy 为 Automatic 时，允许指定 ID</li> |
| </ul> |
| </li> |
| <li>Merging 模式，合并到一个已存在元数据和图数据的图中，特别的： |
| <ul> |
| <li>元数据（schema）创建时不允许指定 ID</li> |
| <li>图数据（vertex）在 id strategy 为 Automatic 时，允许指定 ID</li> |
| </ul> |
| </li> |
| </ul> |
| <p>正常情况下，图模式为 None，当需要 Restore 图时，需要根据需要临时修改图模式为 Restoring 模式或者 Merging 模式，并在完成 Restore 时，恢复图模式为 None。</p> |
| <h4 id="631-查看某个图的模式-该操作需要管理员权限">6.3.1 查看某个图的模式. <strong>该操作需要管理员权限</strong></h4> |
| <h5 id="method--url-4">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/mode |
| </code></pre><h5 id="response-status-4">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"mode"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><blockquote> |
| <p>合法的图模式包括：NONE，RESTORING，MERGING</p> |
| </blockquote> |
| <h4 id="632-设置某个图的模式-该操作需要管理员权限">6.3.2 设置某个图的模式. <strong>该操作需要管理员权限</strong></h4> |
| <h5 id="method--url-5">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/mode |
| </code></pre><h5 id="request-body">Request Body</h5> |
| <pre tabindex="0"><code>"RESTORING" |
| </code></pre><blockquote> |
| <p>合法的图模式包括：NONE，RESTORING，MERGING</p> |
| </blockquote> |
| <h5 id="response-status-5">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-4">Response Body</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-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">"mode"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"RESTORING"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-d9de752e44e3a8a709d187e4101fd818">5.1.13 - Task API</h1> |
| |
| <h3 id="71-task">7.1 Task</h3> |
| <h4 id="711-列出某个图中全部的异步任务">7.1.1 列出某个图中全部的异步任务</h4> |
| <h5 id="params">Params</h5> |
| <ul> |
| <li>status: 异步任务的状态</li> |
| <li>limit：返回异步任务数目上限</li> |
| </ul> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/tasks?status=success |
| </code></pre><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"tasks"</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">"task_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph.traversal().V()"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_progress"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1532943976585</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"success"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1532943976736</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_result"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"0"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_retries"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"task_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"gremlin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_callable"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"com.baidu.hugegraph.api.job.GremlinAPI$GremlinJob"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_input"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"{\"gremlin\":\"hugegraph.traversal().V()\",\"bindings\":{},\"language\":\"gremlin-groovy\",\"aliases\":{\"hugegraph\":\"graph\"}}"</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><h4 id="712-查看某个异步任务的信息">7.1.2 查看某个异步任务的信息</h4> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/tasks/2 |
| </code></pre><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"task_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph.traversal().V()"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_progress"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1532943976585</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_status"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"success"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1532943976736</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_result"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"0"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_retries"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">0</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;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:#204a87;font-weight:bold">"task_type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"gremlin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_callable"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"com.baidu.hugegraph.api.job.GremlinAPI$GremlinJob"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"task_input"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"{\"gremlin\":\"hugegraph.traversal().V()\",\"bindings\":{},\"language\":\"gremlin-groovy\",\"aliases\":{\"hugegraph\":\"graph\"}}"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="713-删除某个异步任务信息不删除异步任务本身">7.1.3 删除某个异步任务信息，<strong>不删除异步任务本身</strong></h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/tasks/2 |
| </code></pre><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><h4 id="714-取消某个异步任务该异步任务必须具有处理中断的能力">7.1.4 取消某个异步任务，<strong>该异步任务必须具有处理中断的能力</strong></h4> |
| <p>假设已经通过<a href="../gremlin">Gremlin API</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-groovy" data-lang="groovy"><span style="display:flex;"><span><span style="color:#4e9a06">"for (int i = 0; i < 10; i++) {"</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"hugegraph.addVertex(T.label, 'man');"</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"hugegraph.tx().commit();"</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"try {"</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"sleep(1000);"</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"} catch (InterruptedException e) {"</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"break;"</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"}"</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span><span style="color:#4e9a06">"}"</span> |
| </span></span></code></pre></div><h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/tasks/2?action=cancel |
| </code></pre><blockquote> |
| <p>请保证在10秒内发送该请求，如果超过10秒发送，任务可能已经执行完成，无法取消。</p> |
| </blockquote> |
| <h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">202</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"cancelled"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#204a87;font-weight:bold">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>此时查询 label 为 man 的顶点数目，一定是小于 10 的。</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-e84b0f106294b580ca64918b72cc71d1">5.1.14 - Gremlin API</h1> |
| |
| <h3 id="81-gremlin">8.1 Gremlin</h3> |
| <h4 id="811-向hugegraphserver发送gremlin语句get同步执行">8.1.1 向HugeGraphServer发送gremlin语句（GET），同步执行</h4> |
| <h5 id="params">Params</h5> |
| <ul> |
| <li>gremlin: 要发送给<code>HugeGraphServer</code>执行的<code>gremlin</code>语句</li> |
| <li>bindings: 用来绑定参数，key是字符串，value是绑定的值（只能是字符串或者数字），功能类似于MySQL的 Prepared Statement，用于加速语句执行</li> |
| <li>language: 发送语句的语言类型，默认为<code>gremlin-groovy</code></li> |
| <li>aliases: 为存在于图空间的已有变量添加别名</li> |
| </ul> |
| <p><strong>查询顶点</strong></p> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://127.0.0.1:8080/gremlin?gremlin=hugegraph.traversal().V('1:marko') |
| </code></pre><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"requestId"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"c6ef47a8-b634-4b07-9d38-6b3b69a3a556"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"status"</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">"message"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">""</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"code"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">200</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"attributes"</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">"result"</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">"data"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</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">"meta"</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></code></pre></div><h4 id="812-向hugegraphserver发送gremlin语句post同步执行">8.1.2 向HugeGraphServer发送gremlin语句（POST），同步执行</h4> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/gremlin |
| </code></pre><p><strong>查询顶点</strong></p> |
| <h5 id="request-body">Request Body</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-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">"gremlin"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph.traversal().V('1:marko')"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"bindings"</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">"language"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"gremlin-groovy"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aliases"</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></code></pre></div><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-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">"requestId"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"c6ef47a8-b634-4b07-9d38-6b3b69a3a556"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"status"</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">"message"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">""</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"code"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">200</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"attributes"</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">"result"</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">"data"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"vertex"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"city"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>city"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"Beijing"</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">"name"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>name"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"marko"</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">"age"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko>age"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"value"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">29</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">"meta"</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></code></pre></div><p>注意：</p> |
| <blockquote> |
| <p>这里是直接使用图对象（hugegraph），先获取其遍历器（traversal()），再获取顶点。 |
| 不能直接写成<code>graph.traversal().V()</code>或<code>g.V()</code>，可以通过<code>"aliases": {"graph": "hugegraph", "g": "__g_hugegraph"}</code> |
| 为图和遍历器添加别名后使用别名操作。其中，<code>hugegraph</code>是原生存在的变量，<code>__g_hugegraph</code>是<code>HugeGraphServer</code>额外添加的变量， |
| 每个图都会存在一个对应的这样格式（_<em>g</em>${graph}）的遍历器对象。</p> |
| </blockquote> |
| <blockquote> |
| <p>响应体的结构与其他 Vertex 或 Edge 的 RESTful API的结构有区别，用户可能需要自行解析。</p> |
| </blockquote> |
| <p><strong>查询边</strong></p> |
| <h5 id="request-body-1">Request Body</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-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">"gremlin"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"g.E('S1:marko>2>>S2:lop')"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"bindings"</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">"language"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"gremlin-groovy"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aliases"</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">"graph"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"g"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"__g_hugegraph"</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><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</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-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">"requestId"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3f117cd4-eedc-4e08-a106-ee01d7bb8249"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"status"</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">"message"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">""</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"code"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">200</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"attributes"</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">"result"</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">"data"</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">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S1:marko>2>>S2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"created"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"edge"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"software"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outVLabel"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"person"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"inV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2:lop"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"outV"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"1:marko"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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">"weight"</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:#204a87;font-weight:bold">"date"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"20171210"</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">"meta"</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></code></pre></div><h4 id="813-向hugegraphserver发送gremlin语句post异步执行">8.1.3 向HugeGraphServer发送gremlin语句（POST），异步执行</h4> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/jobs/gremlin |
| </code></pre><p><strong>查询顶点</strong></p> |
| <h5 id="request-body-2">Request Body</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-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">"gremlin"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"g.V('1:marko')"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"bindings"</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">"language"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"gremlin-groovy"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aliases"</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></code></pre></div><p>注意：</p> |
| <blockquote> |
| <p>异步执行Gremlin语句暂不支持aliases，可以使用 <code>graph</code> 代表要操作的图，也可以直接使用图的名字， 例如 <code>hugegraph</code>; |
| 另外<code>g</code>代表 traversal，等价于 <code>graph.traversal()</code> 或者 <code>hugegraph.traversal()</code></p> |
| </blockquote> |
| <h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>注：</p> |
| <blockquote> |
| <p>可以通过<code>GET http://localhost:8080/graphs/hugegraph/tasks/1</code>（其中"1"是task_id）来查询异步任务的执行状态，更多<a href="../task">异步任务RESTful API</a></p> |
| </blockquote> |
| <p><strong>查询边</strong></p> |
| <h5 id="request-body-3">Request Body</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-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">"gremlin"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"g.E('S1:marko>2>>S2:lop')"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"bindings"</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">"language"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"gremlin-groovy"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"aliases"</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></code></pre></div><h5 id="response-status-4">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body-4">Response Body</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-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">"task_id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">2</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><p>注：</p> |
| <blockquote> |
| <p>可以通过<code>GET http://localhost:8080/graphs/hugegraph/tasks/2</code>（其中"2"是task_id）来查询异步任务的执行状态，更多<a href="../task">异步任务RESTful API</a></p> |
| </blockquote> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-a3b125f257052209fcb98300d5c066a7">5.1.15 - Authentication API</h1> |
| |
| <h3 id="91-用户认证与权限控制">9.1 用户认证与权限控制</h3> |
| <blockquote> |
| <p>开启权限及相关配置请先参考 <a href="/docs/config/config-authentication/">权限配置</a> 文档</p> |
| </blockquote> |
| <h5 id="用户认证与权限控制概述">用户认证与权限控制概述：</h5> |
| <p>HugeGraph支持多用户认证、以及细粒度的权限访问控制，采用基于“用户-用户组-操作-资源”的4层设计，灵活控制用户角色与权限。 |
| 资源描述了图数据库中的数据，比如符合某一类条件的顶点，每一个资源包括type、label、properties三个要素，共有18种type、 |
| 任意label、任意properties的组合形成的资源，一个资源的内部条件是且关系，多个资源之间的条件是或关系。用户可以属于一个或多个用户组， |
| 每个用户组可以拥有对任意个资源的操作权限，操作类型包括：读、写、删除、执行等种类。 HugeGraph支持动态创建用户、用户组、资源， |
| 支持动态分配或取消权限。初始化数据库时超级管理员用户被创建，后续可通过超级管理员创建各类角色用户，新创建的用户如果被分配足够权限后，可以由其创建或管理更多的用户。</p> |
| <h5 id="举例说明">举例说明：</h5> |
| <p>user(name=boss) -belong-> group(name=all) -access(read)-> target(graph=graph1, resource={label: person, |
| city: Beijing})<br> |
| 描述：用户’boss’拥有对’graph1’图中北京人的读权限。</p> |
| <h5 id="接口说明">接口说明：</h5> |
| <p>用户认证与权限控制接口包括5类：UserAPI、GroupAPI、TargetAPI、BelongAPI、AccessAPI。</p> |
| <h3 id="92-用户userapi">9.2 用户（User）API</h3> |
| <p>用户接口包括：创建用户，删除用户，修改用户，和查询用户相关信息接口。</p> |
| <h4 id="921-创建用户">9.2.1 创建用户</h4> |
| <h5 id="params">Params</h5> |
| <ul> |
| <li>user_name: 用户名称</li> |
| <li>user_password: 用户密码</li> |
| <li>user_phone: 用户手机号</li> |
| <li>user_email: 用户邮箱</li> |
| </ul> |
| <p>其中 user_name 和 user_password 为必填。</p> |
| <h5 id="request-body">Request Body</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-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">"user_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"boss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_password"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"******"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_phone"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"182****9088"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_email"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"123@xx.com"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/auth/users |
| </code></pre><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</h5> |
| <p>返回报文中，密码为加密后的密文</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_password"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"******"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_email"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"123@xx.com"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-17 14:31:07.833"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"boss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_phone"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"182****9088"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:boss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-17 14:31:07.833"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="922-删除用户">9.2.2 删除用户</h4> |
| <h5 id="params-1">Params</h5> |
| <ul> |
| <li>id: 需要删除的用户 Id</li> |
| </ul> |
| <h5 id="method--url-1">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/auth/users/-63:test |
| </code></pre><h5 id="response-status-1">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><h5 id="response-body-1">Response Body</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span></code></pre></div><h4 id="923-修改用户">9.2.3 修改用户</h4> |
| <h5 id="params-2">Params</h5> |
| <ul> |
| <li>id: 需要修改的用户 Id</li> |
| </ul> |
| <h5 id="method--url-2">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/auth/users/-63:test |
| </code></pre><h5 id="request-body-1">Request Body</h5> |
| <p>修改user_name、user_password和user_phone</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"test"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_password"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"******"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_phone"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"183****9266"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status-2">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-2">Response Body</h5> |
| <p>返回结果是包含修改过的内容在内的整个用户组对象</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_password"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"******"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 10:29:30.455"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"test"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_phone"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"183****9266"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:test"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 10:27:13.601"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="924-查询用户列表">9.2.4 查询用户列表</h4> |
| <h5 id="params-3">Params</h5> |
| <ul> |
| <li>limit: 返回结果条数的上限</li> |
| </ul> |
| <h5 id="method--url-3">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/users |
| </code></pre><h5 id="response-status-3">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-3">Response Body</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-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">"users"</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">"user_password"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"******"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 11:41:12.254"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"system"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 11:41:12.254"</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><h4 id="925-查询某个用户">9.2.5 查询某个用户</h4> |
| <h5 id="params-4">Params</h5> |
| <ul> |
| <li>id: 需要查询的用户 Id</li> |
| </ul> |
| <h5 id="method--url-4">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/users/-63:admin |
| </code></pre><h5 id="response-status-4">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-4">Response Body</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-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">"users"</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">"user_password"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"******"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 11:41:12.254"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"system"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 11:41:12.254"</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><h4 id="926-查询某个用户的角色">9.2.6 查询某个用户的角色</h4> |
| <h5 id="method--url-5">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/users/-63:boss/role |
| </code></pre><h5 id="response-status-5">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-5">Response Body</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-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">"roles"</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">"hugegraph"</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">"READ"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ALL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"*"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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:#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><h3 id="93-用户组groupapi">9.3 用户组（Group）API</h3> |
| <p>用户组会赋予相应的资源权限，用户会被分配不同的用户组，即可拥有不同的资源权限。<br> |
| 用户组接口包括：创建用户组，删除用户组，修改用户组，和查询用户组相关信息接口。</p> |
| <h4 id="931-创建用户组">9.3.1 创建用户组</h4> |
| <h5 id="params-5">Params</h5> |
| <ul> |
| <li>group_name: 用户组名称</li> |
| <li>group_description: 用户组描述</li> |
| </ul> |
| <h5 id="request-body-2">Request Body</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-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">"group_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"group can do anything"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="method--url-6">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/auth/groups |
| </code></pre><h5 id="response-status-6">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body-6">Response Body</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-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">"group_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:46:08.791"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:46:08.791"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"group can do anything"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="932-删除用户组">9.3.2 删除用户组</h4> |
| <h5 id="params-6">Params</h5> |
| <ul> |
| <li>id: 需要删除的用户组 Id</li> |
| </ul> |
| <h5 id="method--url-7">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/auth/groups/-69:grant |
| </code></pre><h5 id="response-status-7">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><h5 id="response-body-7">Response Body</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span></code></pre></div><h4 id="933-修改用户组">9.3.3 修改用户组</h4> |
| <h5 id="params-7">Params</h5> |
| <ul> |
| <li>id: 需要修改的用户组 Id</li> |
| </ul> |
| <h5 id="method--url-8">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/auth/groups/-69:grant |
| </code></pre><h5 id="request-body-3">Request Body</h5> |
| <p>修改group_description</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"grant"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"grant"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status-8">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-8">Response Body</h5> |
| <p>返回结果是包含修改过的内容在内的整个用户组对象</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"grant"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 09:50:58.458"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 09:57:58.155"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:grant"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"grant"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="934-查询用户组列表">9.3.4 查询用户组列表</h4> |
| <h5 id="params-8">Params</h5> |
| <ul> |
| <li>limit: 返回结果条数的上限</li> |
| </ul> |
| <h5 id="method--url-9">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/groups |
| </code></pre><h5 id="response-status-9">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-9">Response Body</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-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">"groups"</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">"group_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:46:08.791"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:46:08.791"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"group can do anything"</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><h4 id="935-查询某个用户组">9.3.5 查询某个用户组</h4> |
| <h5 id="params-9">Params</h5> |
| <ul> |
| <li>id: 需要查询的用户组 Id</li> |
| </ul> |
| <h5 id="method--url-10">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/groups/-69:all |
| </code></pre><h5 id="response-status-10">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-10">Response Body</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-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">"group_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:46:08.791"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:46:08.791"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"group can do anything"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h3 id="94-资源targetapi">9.4 资源（Target）API</h3> |
| <p>资源描述了图数据库中的数据，比如符合某一类条件的顶点，每一个资源包括type、label、properties三个要素，共有18种type、 |
| 任意label、任意properties的组合形成的资源，一个资源的内部条件是且关系，多个资源之间的条件是或关系。<br> |
| 资源接口包括：资源的创建、删除、修改和查询。</p> |
| <h4 id="941-创建资源">9.4.1 创建资源</h4> |
| <h5 id="params-10">Params</h5> |
| <ul> |
| <li>target_name: 资源名称</li> |
| <li>target_graph: 资源图</li> |
| <li>target_url: 资源地址</li> |
| <li>target_resources: 资源定义(列表)</li> |
| </ul> |
| <p>target_resources可以包括多个target_resource，以列表的形式存储。<br> |
| 每个target_resource包含：</p> |
| <ul> |
| <li>type：可选值 VERTEX, EDGE等, 可填ALL，则表示可以是顶点或边；</li> |
| <li>label：可选值，⼀个顶点或边类型的名称，可填*，则表示任意类型；</li> |
| <li>properties：map类型，可包含多个属性的键值对，必须匹配所有属性值，属性值⽀持填条件范围（age: |
| P.gte(18)），properties如果为null表示任意属性均可，如果属性名和属性值均为‘*ʼ也表示任意属性均可。</li> |
| </ul> |
| <p>如精细资源：“target_resources”: [{“type”:“VERTEX”,“label”:“person”,“properties”:{“city”:“Beijing”,“age”:“P.gte(20)”}}]**<br> |
| 资源定义含义：类型是’person’的顶点，且城市属性是’Beijing’，年龄属性大于等于20。</p> |
| <h5 id="request-body-4">Request Body</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-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">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_graph"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_url"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"127.0.0.1:8080"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_resources"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ALL"</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><h5 id="method--url-11">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/auth/targets |
| </code></pre><h5 id="response-status-11">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body-11">Response Body</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-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">"target_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_url"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"127.0.0.1:8080"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_graph"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:32:01.192"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_resources"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ALL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"*"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:32:01.192"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="942-删除资源">9.4.2 删除资源</h4> |
| <h5 id="params-11">Params</h5> |
| <ul> |
| <li>id: 需要删除的资源 Id</li> |
| </ul> |
| <h5 id="method--url-12">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/auth/targets/-77:gremlin |
| </code></pre><h5 id="response-status-12">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><h5 id="response-body-12">Response Body</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span></code></pre></div><h4 id="943-修改资源">9.4.3 修改资源</h4> |
| <h5 id="params-12">Params</h5> |
| <ul> |
| <li>id: 需要修改的资源 Id</li> |
| </ul> |
| <h5 id="method--url-13">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/auth/targets/-77:gremlin |
| </code></pre><h5 id="request-body-5">Request Body</h5> |
| <p>修改资源定义中的type</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"gremlin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_graph"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_url"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"127.0.0.1:8080"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_resources"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</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><h5 id="response-status-13">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-13">Response Body</h5> |
| <p>返回结果是包含修改过的内容在内的整个用户组对象</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"gremlin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_url"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"127.0.0.1:8080"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_graph"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 09:34:13.848"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_resources"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"*"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:gremlin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 09:37:12.780"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="944-查询资源列表">9.4.4 查询资源列表</h4> |
| <h5 id="params-13">Params</h5> |
| <ul> |
| <li>limit: 返回结果条数的上限</li> |
| </ul> |
| <h5 id="method--url-14">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/targets |
| </code></pre><h5 id="response-status-14">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-14">Response Body</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-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">"targets"</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">"target_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_url"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"127.0.0.1:8080"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_graph"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:32:01.192"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_resources"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"ALL"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"*"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:32:01.192"</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">"target_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"grant"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_url"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"127.0.0.1:8080"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_graph"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:43:24.841"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_resources"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"GRANT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"*"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:grant"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:43:24.841"</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><h4 id="945-查询某个资源">9.4.5 查询某个资源</h4> |
| <h5 id="params-14">Params</h5> |
| <ul> |
| <li>id: 需要查询的资源 Id</li> |
| </ul> |
| <h5 id="method--url-15">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/targets/-77:grant |
| </code></pre><h5 id="response-status-15">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-15">Response Body</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-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">"target_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_name"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"grant"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_url"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"127.0.0.1:8080"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_graph"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"hugegraph"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:43:24.841"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_resources"</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">"type"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"GRANT"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"label"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"*"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"properties"</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:#000;font-weight:bold">],</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:grant"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:43:24.841"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h3 id="95-关联角色belongapi">9.5 关联角色（Belong）API</h3> |
| <p>关联用户和用户组的关系，一个用户可以关联一个或者多个用户组。用户组拥有相关资源的权限，不同用户组的资源权限可以理解为不同的角色。即给用户关联角色。<br> |
| 关联角色接口包括：用户关联角色的创建、删除、修改和查询。</p> |
| <h4 id="951-创建用户的关联角色">9.5.1 创建用户的关联角色</h4> |
| <h5 id="params-15">Params</h5> |
| <ul> |
| <li>user: 用户 Id</li> |
| <li>group: 用户组 Id</li> |
| <li>belong_description: 描述</li> |
| </ul> |
| <h5 id="request-body-6">Request Body</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-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">"user"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:boss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="method--url-16">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/auth/belongs |
| </code></pre><h5 id="response-status-16">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body-16">Response Body</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-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">"belong_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 16:19:35.422"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 16:19:35.422"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S-63:boss>-82>>S-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:boss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="952-删除关联角色">9.5.2 删除关联角色</h4> |
| <h5 id="params-16">Params</h5> |
| <ul> |
| <li>id: 需要删除的关联角色 Id</li> |
| </ul> |
| <h5 id="method--url-17">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:grant |
| </code></pre><h5 id="response-status-17">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><h5 id="response-body-17">Response Body</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span></code></pre></div><h4 id="953-修改关联角色">9.5.3 修改关联角色</h4> |
| <p>关联角色只能修改描述，不能修改 user 和 group 属性，如果需要修改关联角色，需要删除原来关联关系，新增关联角色。</p> |
| <h5 id="params-17">Params</h5> |
| <ul> |
| <li>id: 需要修改的关联角色 Id</li> |
| </ul> |
| <h5 id="method--url-18">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:grant |
| </code></pre><h5 id="request-body-7">Request Body</h5> |
| <p>修改belong_description</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"update test"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status-18">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-18">Response Body</h5> |
| <p>返回结果是包含修改过的内容在内的整个用户组对象</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"update test"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 10:40:21.720"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 10:42:47.265"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S-63:boss>-82>>S-69:grant"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:boss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:grant"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="954-查询关联角色列表">9.5.4 查询关联角色列表</h4> |
| <h5 id="params-18">Params</h5> |
| <ul> |
| <li>limit: 返回结果条数的上限</li> |
| </ul> |
| <h5 id="method--url-19">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/belongs |
| </code></pre><h5 id="response-status-19">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-19">Response Body</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-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">"belongs"</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">"belong_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 16:19:35.422"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 16:19:35.422"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S-63:boss>-82>>S-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:boss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</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><h4 id="955-查看某个关联角色">9.5.5 查看某个关联角色</h4> |
| <h5 id="params-19">Params</h5> |
| <ul> |
| <li>id: 需要查询的关联角色 Id</li> |
| </ul> |
| <h5 id="method--url-20">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/belongs/S-63:boss>-82>>S-69:all |
| </code></pre><h5 id="response-status-20">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-20">Response Body</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-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">"belong_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 16:19:35.422"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"belong_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 16:19:35.422"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S-63:boss>-82>>S-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"user"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-63:boss"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h3 id="96-赋权accessapi">9.6 赋权（Access）API</h3> |
| <p>给用户组赋予资源的权限，主要包含：读操作(READ)、写操作(WRITE)、删除操作(DELETE)、执行操作(EXECUTE)等。<br> |
| 赋权接口包括：赋权的创建、删除、修改和查询。</p> |
| <h4 id="961-创建赋权用户组赋予资源的权限">9.6.1 创建赋权(用户组赋予资源的权限)</h4> |
| <h5 id="params-20">Params</h5> |
| <ul> |
| <li>group: 用户组 Id</li> |
| <li>target: 资源 Id</li> |
| <li>access_permission: 权限许可</li> |
| <li>access_description: 赋权描述</li> |
| </ul> |
| <p>access_permission：</p> |
| <ul> |
| <li>READ：读操作，所有的查询，包括查询Schema、查顶点/边，查询顶点和边的数量VERTEX_AGGR/EDGE_AGGR，也包括读图的状态STATUS、变量VAR、任务TASK等；</li> |
| <li>WRITE：写操作，所有的创建、更新操作，包括给Schema增加property key，给顶点增加或更新属性等；</li> |
| <li>DELETE：删除操作，包括删除元数据、删除顶点/边；</li> |
| <li>EXECUTE：执⾏操作，包括执⾏Gremlin语句、执⾏Task、执⾏metadata函数；</li> |
| </ul> |
| <h5 id="request-body-8">Request Body</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-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">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_permission"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"READ"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="method--url-21">Method & Url</h5> |
| <pre tabindex="0"><code>POST http://localhost:8080/graphs/hugegraph/auth/accesses |
| </code></pre><h5 id="response-status-21">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">201</span> |
| </span></span></code></pre></div><h5 id="response-body-21">Response Body</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-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">"access_permission"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"READ"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:54:54.008"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S-69:all>-88>11>S-77:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:54:54.008"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:all"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="962-删除赋权">9.6.2 删除赋权</h4> |
| <h5 id="params-21">Params</h5> |
| <ul> |
| <li>id: 需要删除的赋权 Id</li> |
| </ul> |
| <h5 id="method--url-22">Method & Url</h5> |
| <pre tabindex="0"><code>DELETE http://localhost:8080/graphs/hugegraph/auth/accesses/S-69:all>-88>12>S-77:all |
| </code></pre><h5 id="response-status-22">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> |
| </span></span></code></pre></div><h5 id="response-body-22">Response Body</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">1</span> |
| </span></span></code></pre></div><h4 id="963-修改赋权">9.6.3 修改赋权</h4> |
| <p>赋权只能修改描述，不能修改用户组、资源和权限许可，如果需要修改赋权的关系，可以删除原来的赋权关系，新增赋权。</p> |
| <h5 id="params-22">Params</h5> |
| <ul> |
| <li>id: 需要修改的赋权 Id</li> |
| </ul> |
| <h5 id="method--url-23">Method & Url</h5> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/hugegraph/auth/accesses/S-69:all>-88>12>S-77:all |
| </code></pre><h5 id="request-body-9">Request Body</h5> |
| <p>修改access_description</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"test"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h5 id="response-status-23">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-23">Response Body</h5> |
| <p>返回结果是包含修改过的内容在内的整个用户组对象</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></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_description"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"test"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_permission"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"WRITE"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 10:12:03.074"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S-69:all>-88>12>S-77:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-12 10:16:18.637"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:all"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><h4 id="964-查询赋权列表">9.6.4 查询赋权列表</h4> |
| <h5 id="params-23">Params</h5> |
| <ul> |
| <li>limit: 返回结果条数的上限</li> |
| </ul> |
| <h5 id="method--url-24">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/accesses |
| </code></pre><h5 id="response-status-24">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-24">Response Body</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-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">"accesses"</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">"access_permission"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"READ"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:54:54.008"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S-69:all>-88>11>S-77:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:54:54.008"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:all"</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><h4 id="965-查询某个赋权">9.6.5 查询某个赋权</h4> |
| <h5 id="params-24">Params</h5> |
| <ul> |
| <li>id: 需要查询的赋权 Id</li> |
| </ul> |
| <h5 id="method--url-25">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/hugegraph/auth/accesses/S-69:all>-88>11>S-77:all |
| </code></pre><h5 id="response-status-25">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body-25">Response Body</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-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">"access_permission"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"READ"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_create"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:54:54.008"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"id"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"S-69:all>-88>11>S-77:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_update"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"2020-11-11 15:54:54.008"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"access_creator"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"admin"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"group"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-69:all"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"target"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"-77:all"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-8e126d4f2f7317a1268d7edb65cd4fcc">5.1.16 - Other API</h1> |
| |
| <h3 id="101-other">10.1 Other</h3> |
| <h4 id="1011-查看hugegraph的版本信息">10.1.1 查看HugeGraph的版本信息</h4> |
| <h5 id="method--url">Method & Url</h5> |
| <pre tabindex="0"><code>GET http://localhost:8080/versions |
| </code></pre><h5 id="response-status">Response Status</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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h5 id="response-body">Response Body</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-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">"versions"</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">"version"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"v1"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"core"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"0.4.5.1"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"gremlin"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"3.2.5"</span><span style="color:#000;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">"api"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"0.13.2.0"</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> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-3457a7585a93814fdbb1a44b68edc0d3">5.2 - HugeGraph Java Client</h1> |
| |
| <p>本文的代码都是<code>java</code>语言写的，但其风格与<code>gremlin(groovy)</code>是非常类似的。用户只需要把代码中的变量声明替换成<code>def</code>或直接去掉， |
| 就能将<code>java</code>代码转变为<code>groovy</code>；另外就是每一行语句最后可以不加分号，<code>groovy</code>认为一行就是一条语句。 |
| 用户在<code>HugeGraph-Studio</code>中编写的<code>gremlin(groovy)</code>可以参考本文的<code>java</code>代码，下面会举出几个例子。</p> |
| <h3 id="1-hugegraph-client">1 HugeGraph-Client</h3> |
| <p>HugeGraph-Client 是操作 graph 的总入口，用户必须先创建出 HugeGraph-Client 对象，与 HugeGraph-Server 建立连接（伪连接）后，才能获取到 schema、graph 以及 gremlin 的操作入口对象。</p> |
| <p>目前 HugeGraph-Client 只允许连接服务端已存在的图，无法自定义图进行创建。其创建方法如下：</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// HugeGraphServer地址："http://localhost:8080" |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// 图的名称："hugegraph" |
| </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">"http://localhost:8080"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"hugegraph"</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">configTimeout</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">20</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#8f5902;font-style:italic">// 默认 20s 超时 |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">configUser</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"**"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"**"</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#8f5902;font-style:italic">// 默认未开启用户权限 |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></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></code></pre></div><p>上述创建 HugeClient 的过程如果失败会抛出异常，用户需要try-catch。如果成功则继续获取 schema、graph 以及 gremlin 的 manager。</p> |
| <p>在<code>HugeGraph - Hubble / Studio</code>中通过<code>gremlin</code>来操作时，不需要使用<code>HugeClient</code>，可以忽略。</p> |
| <h3 id="2-元数据">2 元数据</h3> |
| <h4 id="21-schemamanager">2.1 SchemaManager</h4> |
| <p>SchemaManager 用于管理 HugeGraph 中的四种元数据，分别是PropertyKey（属性类型）、VertexLabel（顶点类型）、EdgeLabel（边类型）和 IndexLabel（索引标签）。在定义元数据信息之前必须先创建 SchemaManager 对象。</p> |
| <p>用户可使用如下方法获得SchemaManager对象：</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-java" data-lang="java"><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></code></pre></div><p>在<code>HugeGraph-Studio</code>中通过<code>gremlin</code>创建<code>schema</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:#000">schema</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">schema</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><p>下面分别对三种元数据的定义过程进行介绍。</p> |
| <h4 id="22-propertykey">2.2 PropertyKey</h4> |
| <h5 id="221-接口及参数介绍">2.2.1 接口及参数介绍</h5> |
| <p>PropertyKey 用来规范顶点和边的属性的约束，暂不支持定义属性的属性。</p> |
| <p>PropertyKey 允许定义的约束信息包括：name、datatype、cardinality、userdata，下面逐一介绍。</p> |
| <ul> |
| <li>name: 属性的名字，用来区分不同的 PropertyKey，不允许有同名的属性；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>param</th> |
| <th>must set</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>propertyKey(String name)</td> |
| <td>name</td> |
| <td>y</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>datatype：属性值类型，必须从下表中选择符合具体业务场景的一项显式设置；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>Java Class</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>asText()</td> |
| <td>String</td> |
| </tr> |
| <tr> |
| <td>asInt()</td> |
| <td>Integer</td> |
| </tr> |
| <tr> |
| <td>asDate()</td> |
| <td>Date</td> |
| </tr> |
| <tr> |
| <td>asUuid()</td> |
| <td>UUID</td> |
| </tr> |
| <tr> |
| <td>asBoolean()</td> |
| <td>Boolean</td> |
| </tr> |
| <tr> |
| <td>asByte()</td> |
| <td>Byte</td> |
| </tr> |
| <tr> |
| <td>asBlob()</td> |
| <td>Byte[]</td> |
| </tr> |
| <tr> |
| <td>asDouble()</td> |
| <td>Double</td> |
| </tr> |
| <tr> |
| <td>asFloat()</td> |
| <td>Float</td> |
| </tr> |
| <tr> |
| <td>asLong()</td> |
| <td>Long</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>cardinality：属性值是单值还是多值，多值的情况下又分为允许有重复值和不允许有重复值，该项默认为 single，如有必要可从下表中选择一项设置；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>cardinality</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>valueSingle()</td> |
| <td>single</td> |
| <td>single value</td> |
| </tr> |
| <tr> |
| <td>valueList()</td> |
| <td>list</td> |
| <td>multi-values that allow duplicate value</td> |
| </tr> |
| <tr> |
| <td>valueSet()</td> |
| <td>set</td> |
| <td>multi-values that not allow duplicate value</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>userdata：用户可以自己添加一些约束或额外信息，然后自行检查传入的属性是否满足约束，或者必要的时候提取出额外信息</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>userdata(String key, Object value)</td> |
| <td>The same key, the latter will cover the former</td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="222-创建-propertykey">2.2.2 创建 PropertyKey</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:#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">"name"</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">valueSet</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><p>在<code>HugeGraph-Studio</code>中通过<code>gremlin</code>创建上述<code>PropertyKey</code>对象的语法完全一致，如果用户没有定义出<code>schema</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:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">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">"name"</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">valueSet</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><p>以下的示例中，<code>gremlin</code>与<code>java</code>的语法完全一致，不再赘述。</p> |
| <ul> |
| <li>ifNotExist()：为 create 添加判断机制，若当前 PropertyKey 已经存在则不再创建，否则创建该属性。若不添加判断，在 properkey 已存在的情况下会抛出异常信息，下同，不再赘述。</li> |
| </ul> |
| <h5 id="223-删除-propertykey">2.2.3 删除 PropertyKey</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:#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">"name"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">remove</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><h5 id="224-查询-propertykey">2.2.4 查询 PropertyKey</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:#8f5902;font-style:italic">// 获取PropertyKey对象 |
| </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">getPropertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"name"</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">// 获取PropertyKey属性 |
| </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">getPropertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">cardinality</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">getPropertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">dataType</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">getPropertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">name</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">getPropertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">userdata</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><h4 id="23-vertexlabel">2.3 VertexLabel</h4> |
| <h5 id="231-接口及参数介绍">2.3.1 接口及参数介绍</h5> |
| <p>VertexLabel 用来定义顶点类型，描述顶点的约束信息：</p> |
| <p>VertexLabel 允许定义的约束信息包括：name、idStrategy、properties、primaryKeys和 nullableKeys，下面逐一介绍。</p> |
| <ul> |
| <li>name: 属性的名字，用来区分不同的 VertexLabel，不允许有同名的属性；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>param</th> |
| <th>must set</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>vertexLabel(String name)</td> |
| <td>name</td> |
| <td>y</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>idStrategy: 每一个 VertexLabel 都可以选择自己的 Id 策略，目前有三种策略供选择，即 Automatic（自动生成）、Customize（用户传入）和 PrimaryKey（主属性键）。其中 Automatic 使用 Snowflake 算法生成 Id，Customize 需要用户自行传入字符串或数字类型的 Id，PrimaryKey 则允许用户从 VertexLabel 的属性中选择若干主属性作为区分的依据，HugeGraph 内部会根据主属性的值拼接生成 Id。idStrategy 默认使用 Automatic的，但如果用户没有显式设置 idStrategy 又调用了 primaryKeys(…) 方法设置了主属性，则 idStrategy 将自动使用 PrimaryKey；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>idStrategy</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>useAutomaticId</td> |
| <td>AUTOMATIC</td> |
| <td>generate id automaticly by Snowflake algorithom</td> |
| </tr> |
| <tr> |
| <td>useCustomizeStringId</td> |
| <td>CUSTOMIZE_STRING</td> |
| <td>passed id by user, must be string type</td> |
| </tr> |
| <tr> |
| <td>useCustomizeNumberId</td> |
| <td>CUSTOMIZE_NUMBER</td> |
| <td>passed id by user, must be number type</td> |
| </tr> |
| <tr> |
| <td>usePrimaryKeyId</td> |
| <td>PRIMARY_KEY</td> |
| <td>choose some important prop as primary key to splice id</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>properties: 定义顶点的属性，传入的参数是 PropertyKey 的 name</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>properties(String… properties)</td> |
| <td>allow to pass multi props</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>primaryKeys: 当用户选择了 PrimaryKey 的 Id 策略时，需要从 VertexLabel 的属性中选择若干主属性作为区分的依据；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>primaryKeys(String… keys)</td> |
| <td>allow to choose multi prop as primaryKeys</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>需要注意的是，Id 策略的选择与 primaryKeys 的设置有一些相互约束，不能随意调用，约束关系见下表：</p> |
| <table> |
| <thead> |
| <tr> |
| <th></th> |
| <th>useAutomaticId</th> |
| <th>useCustomizeStringId</th> |
| <th>useCustomizeNumberId</th> |
| <th>usePrimaryKeyId</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>unset primaryKeys</td> |
| <td>AUTOMATIC</td> |
| <td>CUSTOMIZE_STRING</td> |
| <td>CUSTOMIZE_NUMBER</td> |
| <td>ERROR</td> |
| </tr> |
| <tr> |
| <td>set primaryKeys</td> |
| <td>ERROR</td> |
| <td>ERROR</td> |
| <td>ERROR</td> |
| <td>PRIMARY_KEY</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>nullableKeys: 对于通过 properties(…) 方法设置过的属性，默认全都是不可为空的，也就是在创建顶点时该属性必须赋值，这样可能对用户数据提出了太过严格的完整性要求。为避免这样的强约束，用户可以通过 |
| 本方法设置若干属性为可空的，这样添加顶点时该属性可以不赋值。</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>nullableKeys(String… properties)</td> |
| <td>allow to pass multi props</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>注意：primaryKeys 和 nullableKeys 不能有交集，因为一个属性不能既作为主属性，又是可空的。</p> |
| <ul> |
| <li>enableLabelIndex：用户可以指定是否需要为label创建索引。不创建则无法全局搜索指定label的顶点和边，创建则可以全局搜索，做类似于<code>g.V().hasLabel('person'), g.E().has('label', 'person')</code>这样的查询， |
| 但是插入数据时性能上会更加慢，并且需要占用更多的存储空间。此项默认为 true。</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>enableLabelIndex(boolean enable)</td> |
| <td>Whether to create a label index</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>userdata：用户可以自己添加一些约束或额外信息，然后自行检查传入的属性是否满足约束，或者必要的时候提取出额外信息</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>userdata(String key, Object value)</td> |
| <td>The same key, the latter will cover the former</td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="232-创建-vertexlabel">2.3.2 创建 VertexLabel</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:#8f5902;font-style:italic">// 使用 Automatic 的 Id 策略 |
| </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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">useAutomaticId</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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">// 使用 Customize_String 的 Id 策略 |
| </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">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">useCustomizeStringId</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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">// 使用 Customize_Number 的 Id 策略 |
| </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">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">useCustomizeNumberId</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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">// 使用 PrimaryKey 的 Id 策略 |
| </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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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">"name"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">usePrimaryKeyId</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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">"name"</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><h5 id="233-追加-vertexlabel">2.3.3 追加 VertexLabel</h5> |
| <p>VertexLabel 是可以追加约束的，不过仅限 properties 和 nullableKeys，而且追加的属性也必须添加到 nullableKeys 集合中。</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-java" data-lang="java"><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">"person"</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">"price"</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">"price"</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></code></pre></div><h5 id="234-删除-vertexlabel">2.3.4 删除 VertexLabel</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:#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">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">remove</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span></code></pre></div><h5 id="235-查询-vertexlabel">2.3.5 查询 VertexLabel</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:#8f5902;font-style:italic">// 获取VertexLabel对象 |
| </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">getVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"name"</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">// 获取property key属性 |
| </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">getVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">idStrategy</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">getVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">primaryKeys</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">getVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">name</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">getVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">properties</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">getVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">nullableKeys</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">getVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"person"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">userdata</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><h4 id="24-edgelabel">2.4 EdgeLabel</h4> |
| <h5 id="241-接口及参数介绍">2.4.1 接口及参数介绍</h5> |
| <p>EdgeLabel 用来定义边类型，描述边的约束信息。</p> |
| <p>EdgeLabel 允许定义的约束信息包括：name、sourceLabel、targetLabel、frequency、properties、sortKeys 和 nullableKeys，下面逐一介绍。</p> |
| <ul> |
| <li>name: 属性的名字，用来区分不同的 EdgeLabel，不允许有同名的属性；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>param</th> |
| <th>must set</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>edgeLabel(String name)</td> |
| <td>name</td> |
| <td>y</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li> |
| <p>sourceLabel: 边连接的源顶点类型名，只允许设置一个；</p> |
| </li> |
| <li> |
| <p>targetLabel: 边连接的目标顶点类型名，只允许设置一个；</p> |
| </li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>param</th> |
| <th>must set</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>sourceLabel(String label)</td> |
| <td>label</td> |
| <td>y</td> |
| </tr> |
| <tr> |
| <td>targetLabel(String label)</td> |
| <td>label</td> |
| <td>y</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>frequency: 字面意思是频率，表示在两个具体的顶点间某个关系出现的次数，可以是单次（single）或多次（frequency），默认为single；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>frequency</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>singleTime()</td> |
| <td>single</td> |
| <td>a relationship can only occur once</td> |
| </tr> |
| <tr> |
| <td>multiTimes()</td> |
| <td>multiple</td> |
| <td>a relationship can occur many times</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>properties: 定义边的属性</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>properties(String… properties)</td> |
| <td>allow to pass multi props</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>sortKeys: 当 EdgeLabel 的 frequency 为 multiple 时，需要某些属性来区分这多次的关系，故引入了 sortKeys（排序键）；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>sortKeys(String… keys)</td> |
| <td>allow to choose multi prop as sortKeys</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>nullableKeys: 与顶点中的 nullableKeys 概念一致，不再赘述</li> |
| </ul> |
| <p>注意：sortKeys 和 nullableKeys也不能有交集。</p> |
| <ul> |
| <li> |
| <p>enableLabelIndex：与顶点中的 enableLabelIndex 概念一致，不再赘述</p> |
| </li> |
| <li> |
| <p>userdata：用户可以自己添加一些约束或额外信息，然后自行检查传入的属性是否满足约束，或者必要的时候提取出额外信息</p> |
| </li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>userdata(String key, Object value)</td> |
| <td>The same key, the latter will cover the former</td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="242-创建-edgelabel">2.4.2 创建 EdgeLabel</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:#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">"knows"</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"person"</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">"date"</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">"created"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">multiTimes</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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"software"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">sortKeys</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"date"</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><h5 id="243-追加-edgelabel">2.4.3 追加 EdgeLabel</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:#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">"knows"</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">"price"</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">"price"</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></code></pre></div><h5 id="244-删除-edgelabel">2.4.4 删除 EdgeLabel</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:#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">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">remove</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span></code></pre></div><h5 id="245-查询-edgelabel">2.4.5 查询 EdgeLabel</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:#8f5902;font-style:italic">// 获取EdgeLabel对象 |
| </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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</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">// 获取property key属性 |
| </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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">frequency</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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">sourceLabel</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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">targetLabel</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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">sortKeys</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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">name</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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">properties</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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">nullableKeys</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">getEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">userdata</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><h4 id="25-indexlabel">2.5 IndexLabel</h4> |
| <h5 id="251-接口及参数介绍">2.5.1 接口及参数介绍</h5> |
| <p>IndexLabel 用来定义索引类型，描述索引的约束信息，主要是为了方便查询。</p> |
| <p>IndexLabel 允许定义的约束信息包括：name、baseType、baseValue、indexFeilds、indexType，下面逐一介绍。</p> |
| <ul> |
| <li>name: 属性的名字，用来区分不同的 IndexLabel，不允许有同名的属性；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>param</th> |
| <th>must set</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>indexLabel(String name)</td> |
| <td>name</td> |
| <td>y</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li> |
| <p>baseType: 表示要为 VertexLabel 还是 EdgeLabel 建立索引, 与下面的 baseValue 配合使用；</p> |
| </li> |
| <li> |
| <p>baseValue: 指定要建立索引的 VertexLabel 或 EdgeLabel 的名称；</p> |
| </li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>param</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>onV(String baseValue)</td> |
| <td>baseValue</td> |
| <td>build index for VertexLabel: ‘baseValue’</td> |
| </tr> |
| <tr> |
| <td>onE(String baseValue)</td> |
| <td>baseValue</td> |
| <td>build index for EdgeLabel: ‘baseValue’</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>indexFeilds: 要在哪些属性上建立索引，可以是为多列建立联合索引；</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>param</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>by(String… fields)</td> |
| <td>files</td> |
| <td>allow to build index for multi fields for secondary index</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>indexType: 建立的索引类型，目前支持五种，即 Secondary、Range、Search、Shard 和 Unique。 |
| <ul> |
| <li>Secondary 支持精确匹配的二级索引，允许建立联合索引，联合索引支持索引前缀搜索 |
| <ul> |
| <li>单个属性，支持相等查询，比如：person顶点的city属性的二级索引，可以用<code>g.V().has("city", "北京") </code>查询"city属性值是北京"的全部顶点</li> |
| <li>联合索引，支持前缀查询和相等查询，比如：person顶点的city和street属性的联合索引，可以用<code>g.V().has ("city", "北京").has('street', '中关村街道') </code>查询"city属性值是北京且street属性值是中关村"的全部顶点，或者<code>g.V() .has("city", "北京")</code>查询"city属性值是北京"的全部顶点</li> |
| </ul> |
| <blockquote> |
| <p>secondary index的查询都是基于"是"或者"相等"的查询条件，不支持"部分匹配"</p> |
| </blockquote> |
| </li> |
| <li>Range 支持数值类型的范围查询 |
| <ul> |
| <li>必须是单个数字或者日期属性，比如：person顶点的age属性的范围索引，可以用<code>g.V().has("age", P.gt(18)) </code>查询"age属性值大于18"的顶点。除了<code>P.gt()</code>以外，还支持<code>P.gte()</code>, <code>P.lte()</code>, <code>P.lt()</code>, |
| <code>P.eq()</code>, <code>P.between()</code>, <code>P.inside()</code>和<code>P.outside()</code>等</li> |
| </ul> |
| </li> |
| <li>Search 支持全文检索的索引 |
| <ul> |
| <li>必须是单个文本属性，比如：person顶点的address属性的全文索引，可以用<code>g.V().has("address", Text .contains('大厦')</code>查询"address属性中包含大厦"的全部顶点</li> |
| </ul> |
| <blockquote> |
| <p>search index的查询是基于"是"或者"包含"的查询条件</p> |
| </blockquote> |
| </li> |
| <li>Shard 支持前缀匹配 + 数字范围查询的索引 |
| <ul> |
| <li>N个属性的分片索引，支持前缀相等情况下的范围查询，比如：person顶点的city和age属性的分片索引，可以用<code>g.V().has ("city", "北京").has("age", P.between(18, 30)) </code>查询"city属性是北京且年龄大于等于18小于30"的全部顶点</li> |
| <li>shard index N个属性全是文本属性时，等价于secondary index</li> |
| <li>shard index只有单个数字或者日期属性时，等价于range index</li> |
| </ul> |
| <blockquote> |
| <p>shard index可以有任意数字或者日期属性，但是查询时最多只能提供一个范围查找条件，且该范围查找条件的属性的前缀属性都是相等查询条件</p> |
| </blockquote> |
| </li> |
| <li>Unique 支持属性值唯一性约束，即可以限定属性的值不重复，允许联合索引，但不支持查询 |
| <ul> |
| <li>单个或者多个属性的唯一性索引，不可用来查询，只可对属性的值进行限定，当出现重复值时将报错</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>interface</th> |
| <th>indexType</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>secondary()</td> |
| <td>Secondary</td> |
| <td>support prefix search</td> |
| </tr> |
| <tr> |
| <td>range()</td> |
| <td>Range</td> |
| <td>support range(numeric or date type) search</td> |
| </tr> |
| <tr> |
| <td>search()</td> |
| <td>Search</td> |
| <td>support full text search</td> |
| </tr> |
| <tr> |
| <td>shard()</td> |
| <td>Shard</td> |
| <td>support prefix + range(numeric or date type) search</td> |
| </tr> |
| <tr> |
| <td>unique()</td> |
| <td>Unique</td> |
| <td>support unique props value, not support search</td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="252-创建-indexlabel">2.5.2 创建 IndexLabel</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:#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">"personByAge"</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">"person"</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">"age"</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">"createdByDate"</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">"created"</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">"date"</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">"personByLived"</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">"person"</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">"lived"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">search</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">"personByCityAndAge"</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">"person"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">shard</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">"personById"</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">"person"</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">"id"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">unique</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><h5 id="253-删除-indexlabel">2.5.3 删除 IndexLabel</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:#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">"personByAge"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">remove</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><h5 id="254-查询-indexlabel">2.5.4 查询 IndexLabel</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:#8f5902;font-style:italic">// 获取IndexLabel对象 |
| </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">getIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"personByAge"</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">// 获取property key属性 |
| </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">getIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"personByAge"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">baseType</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">getIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"personByAge"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">baseValue</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">getIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"personByAge"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">indexFields</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">getIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"personByAge"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">indexType</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">getIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"personByAge"</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">name</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><h3 id="3-图数据">3 图数据</h3> |
| <h4 id="31-vertex">3.1 Vertex</h4> |
| <p>顶点是构成图的最基本元素，一个图中可以有非常多的顶点。下面给出一个添加顶点的例子：</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-java" data-lang="java"><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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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">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">"software"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lop"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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></code></pre></div><ul> |
| <li>添加顶点的关键是顶点属性，添加顶点函数的参数个数必须为偶数，且满足<code>key1 -> val1, key2 -> val2 ···</code>的顺序排列，键值对之间的顺序是自由的。</li> |
| <li>参数中必须包含一对特殊的键值对，就是<code>T.label -> "val"</code>，用来定义该顶点的类别，以便于程序从缓存或后端获取到该VertexLabel的schema定义，然后做后续的约束检查。例子中的label定义为person。</li> |
| <li>如果顶点类型的 Id 策略为 <code>AUTOMATIC</code>，则不允许用户传入 id 键值对。</li> |
| <li>如果顶点类型的 Id 策略为 <code>CUSTOMIZE_STRING</code>，则用户需要自己传入 String 类型 id 的值，键值对形如：<code>"T.id", "123456"</code>。</li> |
| <li>如果顶点类型的 Id 策略为 <code>CUSTOMIZE_NUMBER</code>，则用户需要自己传入 Number 类型 id 的值，键值对形如：<code>"T.id", 123456</code>。</li> |
| <li>如果顶点类型的 Id 策略为 <code>PRIMARY_KEY</code>，参数还必须全部包含该<code>primaryKeys</code>对应属性的名和值，如果不设置会抛出异常。比如之前<code>person</code>的<code>primaryKeys</code>是<code>name</code>，例子中就设置了<code>name</code>的值为<code>marko</code>。</li> |
| <li>对于非 nullableKeys 的属性，必须要赋值。</li> |
| <li>剩下的参数就是顶点其他属性的设置，但并非必须。</li> |
| <li>调用<code>addVertex</code>方法后，顶点会立刻被插入到后端存储系统中。</li> |
| </ul> |
| <h4 id="32-edge">3.2 Edge</h4> |
| <p>有了点，还需要边才能构成完整的图。下面给出一个添加边的例子：</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#000">Edge</span> <span style="color:#000">knows1</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">addEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</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">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span></code></pre></div><ul> |
| <li>由（源）顶点来调用添加边的函数，函数第一个参数为边的label，第二个参数是目标顶点，这两个参数的位置和顺序是固定的。后续的参数就是<code>key1 -> val1, key2 -> val2 ···</code>的顺序排列，设置边的属性，键值对顺序自由。</li> |
| <li>源顶点和目标顶点必须符合 EdgeLabel 中 sourcelabel 和 targetlabel 的定义，不能随意添加。</li> |
| <li>对于非 nullableKeys 的属性，必须要赋值。</li> |
| </ul> |
| <p><strong>注意：当frequency为multiple时必须要设置sortKeys对应属性类型的值。</strong></p> |
| <h3 id="4-简单示例">4 简单示例</h3> |
| <p>简单示例见<a href="/docs/quickstart/hugegraph-client">HugeGraph-Client</a></p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-1ebf9ecb86d8a6b8536fd581e696ce8c">5.3 - Gremlin-Console</h1> |
| |
| <p>Gremlin-Console是由Tinkerpop自己开发的一个交互式客户端，用户可以使用该客户端对Graph做各种操作，主要有两种使用模式：</p> |
| <ul> |
| <li>单机离线调用模式；</li> |
| <li>Client/Server请求模式；</li> |
| </ul> |
| <h3 id="1-单机离线调用模式">1 单机离线调用模式</h3> |
| <p>由于lib目录下已经包含了HugeCore的jar包，且HugeGraph已经作为插件注册到Console中，用户可以直接写groovy脚本调用HugeGraph-Core的代码，然后交由Gremlin-Console内的解析引擎执行，就能在不启动Server的情况下操作图。</p> |
| <p>这种模式便于用户快速上手体验，但是不适合大量数据插入和查询的场景。下面给一个示例：</p> |
| <p>在script目录下有一个示例脚本：example.groovy</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:#204a87;font-weight:bold">import</span> <span style="color:#000">com.baidu.hugegraph.HugeFactory</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">com.baidu.hugegraph.dist.RegisterUtil</span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.tinkerpop.gremlin.structure.T</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">RegisterUtil</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">registerCassandra</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">RegisterUtil</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">registerScyllaDB</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">conf</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#4e9a06">"conf/hugegraph.properties"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">graph</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">HugeFactory</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">open</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">conf</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:#000">graph</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">"name"</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">"age"</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">"city"</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">"weight"</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">"lang"</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">"date"</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">"price"</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">"person"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"name"</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">"software"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</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">"name"</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">"personByName"</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">"person"</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">"name"</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">"personByCity"</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">"person"</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">"city"</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">"personByAgeAndCity"</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">"person"</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">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"softwareByPrice"</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">"software"</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">"price"</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">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"knows"</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">"person"</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">"person"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"created"</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">"person"</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">"software"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</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">"createdByDate"</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">"created"</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">"date"</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">"createdByWeight"</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">"created"</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">"weight"</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">"knowsByWeight"</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">"knows"</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">"weight"</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">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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">29</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"vadas"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">27</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Hongkong"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><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">"software"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lop"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">328</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:#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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"josh"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">32</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><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">"software"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"ripple"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lang"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"price"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">199</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:#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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"peter"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">35</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Shanghai"</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">"knows"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20160110"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">0.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">"knows"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20130220"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">1.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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20171210"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">0.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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20091111"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">0.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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20171210"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">1.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">"created"</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">"date"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"20170324"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"weight"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">0.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">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">tx</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">commit</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">g</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">traversal</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">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">">>>> query all vertices: size="</span> <span style="color:#ce5c00;font-weight:bold">+</span> <span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">toList</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">size</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">">>>> query all edges: size="</span> <span style="color:#ce5c00;font-weight:bold">+</span> <span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">E</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">toList</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">size</span><span style="color:#ce5c00;font-weight:bold">());</span> |
| </span></span></code></pre></div><p>其实这一段groovy脚本几乎就是Java代码，不同之处仅在于变量的定义可以不写类型声明，以及每一行末尾的分号可以去掉。</p> |
| <blockquote> |
| <p>g.V() 是获取所有的顶点，g.E() 是获取所有的边，toList() 是把结果存到一个 List 中，参考<a href="http://tinkerpop.apache.org/docs/current/reference/#terminal-steps">TinkerPop Terminal Steps</a>。</p> |
| </blockquote> |
| <p>下面进入gremlin-console，并传入该脚本令其执行：</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/gremlin-console.sh scripts/example.groovy |
| </span></span><span style="display:flex;"><span>objc<span style="color:#ce5c00;font-weight:bold">[</span>5038<span style="color:#ce5c00;font-weight:bold">]</span>: Class JavaLaunchHelper is implemented in both /Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/bin/java <span style="color:#ce5c00;font-weight:bold">(</span>0x10137a4c0<span style="color:#ce5c00;font-weight:bold">)</span> and /Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/libinstrument.dylib <span style="color:#ce5c00;font-weight:bold">(</span>0x102bbb4e0<span style="color:#ce5c00;font-weight:bold">)</span>. One of the two will be used. Which one is undefined. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">\,</span>,,/ |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">(</span>o o<span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span>-----oOOo-<span style="color:#ce5c00;font-weight:bold">(</span>3<span style="color:#ce5c00;font-weight:bold">)</span>-oOOo----- |
| </span></span><span style="display:flex;"><span>plugin activated: com.baidu.hugegraph |
| </span></span><span style="display:flex;"><span>plugin activated: tinkerpop.server |
| </span></span><span style="display:flex;"><span>plugin activated: tinkerpop.utilities |
| </span></span><span style="display:flex;"><span>plugin activated: tinkerpop.tinkergraph |
| </span></span><span style="display:flex;"><span>2018-01-15 14:36:19 <span style="color:#0000cf;font-weight:bold">7516</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>WARN <span style="color:#ce5c00;font-weight:bold">]</span> com.baidu.hugegraph.config.HugeConfig <span style="color:#ce5c00;font-weight:bold">[]</span> - The config option <span style="color:#4e9a06">'rocksdb.data_path'</span> is redundant, please ensure it has been registered |
| </span></span><span style="display:flex;"><span>2018-01-15 14:36:19 <span style="color:#0000cf;font-weight:bold">7523</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>WARN <span style="color:#ce5c00;font-weight:bold">]</span> com.baidu.hugegraph.config.HugeConfig <span style="color:#ce5c00;font-weight:bold">[]</span> - The config option <span style="color:#4e9a06">'rocksdb.wal_path'</span> is redundant, please ensure it has been registered |
| </span></span><span style="display:flex;"><span>2018-01-15 14:36:19 <span style="color:#0000cf;font-weight:bold">7604</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> com.baidu.hugegraph.HugeGraph <span style="color:#ce5c00;font-weight:bold">[]</span> - Opening backend store <span style="color:#4e9a06">'cassandra'</span> <span style="color:#204a87;font-weight:bold">for</span> graph <span style="color:#4e9a06">'hugegraph'</span> |
| </span></span><span style="display:flex;"><span>>>>> query all vertices: <span style="color:#000">size</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#0000cf;font-weight:bold">6</span> |
| </span></span><span style="display:flex;"><span>>>>> query all edges: <span style="color:#000">size</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#0000cf;font-weight:bold">6</span> |
| </span></span></code></pre></div><p>可以看到，插入了6个顶点、6条边，并查询出来了。进入console之后，还可继续输入groovy语句对图做操作：</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:#000">gremlin</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</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:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">2</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:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">1</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:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">1</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 style="color:#ce5c00;font-weight:bold">==></span><span style="color:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">1</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:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">1</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:#ce5c00;font-weight:bold">==></span><span style="color:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">2</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">gremlin</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">E</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:#000">e</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#f57900">S1:</span><span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#0000cf;font-weight:bold">2</span><span style="color:#ce5c00;font-weight:bold">>></span><span style="color:#f57900">S2:</span><span style="color:#000">ripple</span><span style="color:#ce5c00;font-weight:bold">][</span><span style="color:#0000cf;font-weight:bold">1</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:#000">created</span><span style="color:#ce5c00;font-weight:bold">-></span><span style="color:#0000cf;font-weight:bold">2</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:#000">e</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#f57900">S1:</span><span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#0000cf;font-weight:bold">20160110</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#f57900">S1:</span><span style="color:#000">vadas</span><span style="color:#ce5c00;font-weight:bold">][</span><span style="color:#0000cf;font-weight:bold">1</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:#000">knows</span><span style="color:#ce5c00;font-weight:bold">-></span><span style="color:#0000cf;font-weight:bold">1</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:#000">e</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#f57900">S1:</span><span style="color:#000">peter</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#0000cf;font-weight:bold">2</span><span style="color:#ce5c00;font-weight:bold">>></span><span style="color:#f57900">S2:</span><span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">][</span><span style="color:#0000cf;font-weight:bold">1</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:#000">created</span><span style="color:#ce5c00;font-weight:bold">-></span><span style="color:#0000cf;font-weight:bold">2</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:#000">e</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#f57900">S1:</span><span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#0000cf;font-weight:bold">2</span><span style="color:#ce5c00;font-weight:bold">>></span><span style="color:#f57900">S2:</span><span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">][</span><span style="color:#0000cf;font-weight:bold">1</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:#000">created</span><span style="color:#ce5c00;font-weight:bold">-></span><span style="color:#0000cf;font-weight:bold">2</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:#000">e</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#f57900">S1:</span><span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#0000cf;font-weight:bold">20130220</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#f57900">S1:</span><span style="color:#000">josh</span><span style="color:#ce5c00;font-weight:bold">][</span><span style="color:#0000cf;font-weight:bold">1</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:#000">knows</span><span style="color:#ce5c00;font-weight:bold">-></span><span style="color:#0000cf;font-weight:bold">1</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:#000">e</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#f57900">S1:</span><span style="color:#000">marko</span><span style="color:#ce5c00;font-weight:bold">></span><span style="color:#0000cf;font-weight:bold">2</span><span style="color:#ce5c00;font-weight:bold">>></span><span style="color:#f57900">S2:</span><span style="color:#000">lop</span><span style="color:#ce5c00;font-weight:bold">][</span><span style="color:#0000cf;font-weight:bold">1</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:#000">created</span><span style="color:#ce5c00;font-weight:bold">-></span><span style="color:#0000cf;font-weight:bold">2</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></code></pre></div><p>更多的Gremlin语句请参考<a href="http://tinkerpop.apache.org/docs/current/reference/">Tinkerpop官网</a></p> |
| <h3 id="2-clientserver请求模式">2 Client/Server请求模式</h3> |
| <p>因为Gremlin-Console只能通过WebSocket连接HugeGraph-Server，默认HugeGraph-Server是对外提供HTTP连接的，所以先修改gremlin-server的配置。</p> |
| <p><em>注意：将连接方式修改为WebSocket后，HugeGraph-Client、HugeGraph-Loader、HugeGraph-Studio等配套工具都不能使用了。</em></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:#8f5902;font-style:italic"># vim conf/gremlin-server.yaml</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">host</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">127.0.0.1</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">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">8182</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">scriptEvaluationTimeout</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">30000</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"># If you want to start gremlin-server for gremlin-console(web-socket),</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"># please change `HttpChannelizer` to `WebSocketChannelizer` or comment this line.</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">channelizer</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer</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">graphs</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">conf/hugegraph.properties,</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">hugegraph1</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">conf/hugegraph1.properties</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:#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">plugins</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">com.baidu.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">scriptEngines</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">gremlin-groovy</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">imports</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:#000">java.lang.Math],</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">staticImports</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:#000">java.lang.Math.PI],</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">scripts</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:#000">scripts/empty-sample.groovy]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></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">serializers</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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GryoLiteMessageSerializerV1d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GryoMessageSerializerV1d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">true</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerGremlinV1d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerGremlinV2d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV1d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </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">metrics</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">consoleReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">180000</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">csvReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: true, interval: 180000, fileName</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">/tmp/gremlin-server-metrics.csv},</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">jmxReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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">slf4jReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">180000</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">gangliaReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval: 180000, addressingMode</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">MULTICAST},</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">graphiteReporter</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>{<span style="color:#204a87;font-weight:bold">enabled: false, interval</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">180000</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:#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">maxInitialLineLength</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">4096</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">maxHeaderSize</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">8192</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">maxChunkSize</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">8192</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">maxContentLength</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">65536</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">maxAccumulationBufferComponents</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1024</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">resultIterationBatchSize</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">64</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">writeBufferLowWaterMark</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">32768</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">writeBufferHighWaterMark</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">65536</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">ssl</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">enabled</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">false</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span></code></pre></div><p>将<code>channelizer: org.apache.tinkerpop.gremlin.server.channel.HttpChannelizer</code>修改成<code>channelizer: org.apache.tinkerpop.gremlin.server.channel.WebSocketChannelizer</code>或直接注释，然后按照步骤启动Server。</p> |
| <p>然后进入gremlin-console</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/gremlin-console.sh |
| </span></span><span style="display:flex;"><span>objc<span style="color:#ce5c00;font-weight:bold">[</span>5761<span style="color:#ce5c00;font-weight:bold">]</span>: Class JavaLaunchHelper is implemented in both /Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/bin/java <span style="color:#ce5c00;font-weight:bold">(</span>0x10ec584c0<span style="color:#ce5c00;font-weight:bold">)</span> and /Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/libinstrument.dylib <span style="color:#ce5c00;font-weight:bold">(</span>0x10ecdc4e0<span style="color:#ce5c00;font-weight:bold">)</span>. One of the two will be used. Which one is undefined. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">\,</span>,,/ |
| </span></span><span style="display:flex;"><span> <span style="color:#ce5c00;font-weight:bold">(</span>o o<span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span>-----oOOo-<span style="color:#ce5c00;font-weight:bold">(</span>3<span style="color:#ce5c00;font-weight:bold">)</span>-oOOo----- |
| </span></span><span style="display:flex;"><span>plugin activated: com.baidu.hugegraph |
| </span></span><span style="display:flex;"><span>plugin activated: tinkerpop.server |
| </span></span><span style="display:flex;"><span>plugin activated: tinkerpop.utilities |
| </span></span><span style="display:flex;"><span>plugin activated: tinkerpop.tinkergraph |
| </span></span></code></pre></div><p>连接server，需在配置文件中指定连接参数，在conf目录下有一个默认的remote.yaml</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:#8f5902;font-style:italic"># cat conf/remote.yaml</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">hosts</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:#000">localhost]</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">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">8182</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">serializer</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">className</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">org.apache.tinkerpop.gremlin.driver.ser.GryoMessageSerializerV1d0,</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">config</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">serializeResultToString</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">true</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">ioRegistries</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:#000">com.baidu.hugegraph.io.HugeGraphIoRegistry]</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:#f8f8f8;text-decoration:underline"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"></span>}<span style="color:#f8f8f8;text-decoration:underline"> |
| </span></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-groovy" data-lang="groovy"><span style="display:flex;"><span><span style="color:#000">gremlin</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#000">remote</span> <span style="color:#000">connect</span> <span style="color:#000">tinkerpop</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">server</span> <span style="color:#000">conf</span><span style="color:#4e9a06">/remote.yaml |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">2018-01-15 15:30:31 11528 [main] [INFO ] org.apache.tinkerpop.gremlin.driver.Connection [] - Created new connection for ws://localhost:8182/</span><span style="color:#000">gremlin</span> |
| </span></span><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">2018</span><span style="color:#ce5c00;font-weight:bold">-</span><span style="color:#0000cf;font-weight:bold">01</span><span style="color:#ce5c00;font-weight:bold">-</span><span style="color:#0000cf;font-weight:bold">15</span> <span style="color:#0000cf;font-weight:bold">15</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">30</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">31</span> <span style="color:#0000cf;font-weight:bold">11538</span> <span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#000">main</span><span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#000">INFO</span> <span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#000">org</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">apache</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">tinkerpop</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:#c4a000">driver</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">Connection</span> <span style="color:#ce5c00;font-weight:bold">[]</span> <span style="color:#ce5c00;font-weight:bold">-</span> <span style="color:#000">Created</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">connection</span> <span style="color:#204a87;font-weight:bold">for</span> <span style="color:#f57900">ws:</span><span style="color:#8f5902;font-style:italic">//localhost:8182/gremlin |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#0000cf;font-weight:bold">2018</span><span style="color:#ce5c00;font-weight:bold">-</span><span style="color:#0000cf;font-weight:bold">01</span><span style="color:#ce5c00;font-weight:bold">-</span><span style="color:#0000cf;font-weight:bold">15</span> <span style="color:#0000cf;font-weight:bold">15</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">30</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">31</span> <span style="color:#0000cf;font-weight:bold">11538</span> <span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#000">main</span><span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#000">INFO</span> <span style="color:#ce5c00;font-weight:bold">]</span> <span style="color:#000">org</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">apache</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">tinkerpop</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:#c4a000">driver</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">ConnectionPool</span> <span style="color:#ce5c00;font-weight:bold">[]</span> <span style="color:#ce5c00;font-weight:bold">-</span> <span style="color:#000">Opening</span> <span style="color:#000">connection</span> <span style="color:#000">pool</span> <span style="color:#000">on</span> <span style="color:#000">Host</span><span style="color:#ce5c00;font-weight:bold">{</span><span style="color:#000">address</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#000">localhost</span><span style="color:#4e9a06">/127.0.0.1:8182, hostUri=ws://localhost:8182/</span><span style="color:#000">gremlin</span><span style="color:#ce5c00;font-weight:bold">}</span> <span style="color:#000">with</span> <span style="color:#000">core</span> <span style="color:#000">size</span> <span style="color:#000">of</span> <span style="color:#0000cf;font-weight:bold">2</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">==></span><span style="color:#000">Configured</span> <span style="color:#000">localhost</span><span style="color:#ce5c00;font-weight:bold">/</span><span style="color:#0000cf;font-weight:bold">127.0</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#0000cf;font-weight:bold">0.1</span><span style="color:#ce5c00;font-weight:bold">:</span><span style="color:#0000cf;font-weight:bold">8182</span> |
| </span></span></code></pre></div><p>连接成功之后，在console的上下文中能使用的变量只有hugegraph和hugegraph1两个图对象（在gremlin-server.yaml中配置），如果想拥有更多的变量，可以在<code>scripts/empty-sample.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:#204a87;font-weight:bold">import</span> <span style="color:#000">org.apache.tinkerpop.gremlin.server.util.LifeCycleHook</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// an init script that returns a Map allows explicit setting of global bindings. |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#204a87;font-weight:bold">def</span> <span style="color:#000">globals</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></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// defines a sample LifeCycleHook that prints some output to the Gremlin Server console. |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// note that the name of the key in the "global" map is unimportant. |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">globals</span> <span style="color:#ce5c00;font-weight:bold"><<</span> <span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#f57900">hook:</span> <span style="color:#ce5c00;font-weight:bold">[</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">onStartUp</span> <span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#ce5c00;font-weight:bold">{</span> <span style="color:#000">ctx</span> <span style="color:#ce5c00;font-weight:bold">-></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">ctx</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">logger</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">info</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"Executed once at startup of Gremlin Server."</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:#f57900">onShutDown:</span> <span style="color:#ce5c00;font-weight:bold">{</span> <span style="color:#000">ctx</span> <span style="color:#ce5c00;font-weight:bold">-></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">ctx</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">logger</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">info</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"Executed once at shutdown of Gremlin Server."</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">as</span> <span style="color:#000">LifeCycleHook</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">// define schema manger for hugegraph |
| </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:#000">hugegraph</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 style="color:#8f5902;font-style:italic">// define the default TraversalSource to bind queries to - this one will be named "g". |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">g</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">hugegraph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">traversal</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span></code></pre></div><p>这样在console中便可以直接使用schema和g这两个对象，做元数据的管理和图的查询了。</p> |
| <p>不定义了也没关系，因为所有的对象都可以通过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-groovy" data-lang="groovy"><span style="display:flex;"><span><span style="color:#000">gremlin</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#ce5c00;font-weight:bold">:></span> <span style="color:#000">hugegraph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">traversal</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">V</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:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">2</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:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">1</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:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">1</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 style="color:#ce5c00;font-weight:bold">==></span><span style="color:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">1</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:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">1</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:#ce5c00;font-weight:bold">==></span><span style="color:#000">v</span><span style="color:#ce5c00;font-weight:bold">[</span><span style="color:#0000cf;font-weight:bold">2</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></code></pre></div><p>在Client/Server模式下，所有跟Server有关的操作都要加上<code>:> </code>，如果不加，表示在console本地操作。</p> |
| <p>还可以把多条语句放在一个字符串变量中，然后一次性发给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-groovy" data-lang="groovy"><span style="display:flex;"><span><span style="color:#000">gremlin</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#000">script</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#4e9a06">""" |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">graph = hugegraph; |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">marko = graph.addVertex(T.label, "person", "name", "marko", "age", 29, "city", "Beijing"); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">vadas = graph.addVertex(T.label, "person", "name", "vadas", "age", 27, "city", "Hongkong"); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">lop = graph.addVertex(T.label, "software", "name", "lop", "lang", "java", "price", 328); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">josh = graph.addVertex(T.label, "person", "name", "josh", "age", 32, "city", "Beijing"); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">ripple = graph.addVertex(T.label, "software", "name", "ripple", "lang", "java", "price", 199); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">peter = graph.addVertex(T.label, "person", "name", "peter", "age", 35, "city", "Shanghai"); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">marko.addEdge("knows", vadas, "date", "20160110", "weight", 0.5); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">marko.addEdge("knows", josh, "date", "20130220", "weight", 1.0); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">marko.addEdge("created", lop, "date", "20171210", "weight", 0.4); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">josh.addEdge("created", lop, "date", "20091111", "weight", 0.4); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">josh.addEdge("created", ripple, "date", "20171210", "weight", 1.0); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">peter.addEdge("created", lop, "date", "20170324", "weight", 0.2); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">graph.tx().commit(); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">g = graph.traversal(); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">g.V().toList().size(); |
| </span></span></span><span style="display:flex;"><span><span style="color:#4e9a06">"""</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">gremlin</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#ce5c00;font-weight:bold">:></span> <span style="color:#5c35cc;font-weight:bold">@script</span> |
| </span></span><span style="display:flex;"><span><span style="color:#ce5c00;font-weight:bold">==></span><span style="color:#0000cf;font-weight:bold">6</span> |
| </span></span></code></pre></div><p>更多关于gremlin-console的使用，请参考<a href="http://tinkerpop.apache.org/docs/current/reference/">Tinkerpop官网</a></p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-d2c6535126cca927d2a9c893abde92a0">6 - GUIDES</h1> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style=""> |
| |
| <h1 id="pg-dcb89d888ea6f4146ace522d76fe2776">6.1 - HugeGraph Architecture Overview</h1> |
| |
| <h3 id="1-概述">1 概述</h3> |
| <p>作为一款通用的图数据库产品，HugeGraph需具备图数据的基本功能，如下图所示。HugeGraph包括三个层次的功能，分别是存储层、计算层和用户接口层。 HugeGraph支持OLTP和OLAP两种图计算类型，其中OLTP实现了<a href="https://tinkerpop.apache.org">Apache TinkerPop3</a>框架，并支持<a href="https://tinkerpop.apache.org/gremlin.html">Gremlin</a>查询语言。 OLAP计算是基于SparkGraphX实现。</p> |
| <center> |
| <img src="/docs/images/design/architectural-overview.png" alt="image"> |
| </center> |
| <h3 id="2-组件">2 组件</h3> |
| <p>HugeGraph的主要功能分为HugeCore、ApiServer、HugeGraph-Client、HugeGraph-Loader和HugeGraph-Studio等组件构成，各组件之间的通信关系如下图所示。</p> |
| <center> |
| <img src="/docs/images/design/architectural-component.png" alt="image"> |
| </center> |
| <ul> |
| <li>HugeCore ：HugeGraph的核心模块，TinkerPop的接口主要在该模块中实现。HugeCore的功能涵盖包括OLTP和OLAP两个部分。</li> |
| <li>ApiServer ：提供RESTFul Api接口，对外提供Graph Api、Schema Api和Gremlin Api等接口服务。</li> |
| <li>HugeGraph-Client：基于Java客户端驱动程序。HugeGraph-Client是Java版本客户端驱动程序，后续可根据需要提供Python、Go、C++等多语言支持。</li> |
| <li>HugeGraph-Loader：数据导入模块。HugeGraph-Loader可以扫描并分析现有数据，自动生成Graph Schema创建语言，通过批量方式快速导入数据。</li> |
| <li>HugeGraph-Studio：基于Web的可视化IDE环境。以Notebook方式记录Gremlin查询，可视化展示Graph的关联关系。HugeGraph-Studio也是本系统推荐的工具。</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-3d0f9ef831ef5d7d11acfb09140359fa">6.2 - HugeGraph Design Concepts</h1> |
| |
| <h3 id="1-property-graph">1. Property Graph</h3> |
| <p>常见的图数据表示模型有两种，分别是RDF（Resource Description Framework）模型和属性图（Property Graph）模型。 |
| RDF和Property Graph都是最基础、最有名的图表示模式，都能够表示各种图的实体关系建模。 |
| RDF是W3C标准，而Property Graph是工业标准，受到广大图数据库厂商的广泛支持。HugeGraph目前采用Property Graph。</p> |
| <p>HugeGraph对应的存储概念模型也是参考Property Graph而设计的，具体示例详见下图：（<em>此图为旧版设计已过时，请忽略它，后续更新</em>）</p> |
| <p><img src="/docs/images/design/PropertyGraph.png" alt="image"></p> |
| <p>在HugeGraph内部，每个顶点 / 边由唯一的 VertexId / EdgeId 标识，属性存储在对应点 / 边内部。而顶点与顶点之间的关系 / 映射则是通过边来存储的。</p> |
| <p>顶点属性值通过边指针方式存储时，如果要更新一个顶点特定的属性值直接通过覆盖写入即可，其弊端是冗余存储了VertexId； |
| 如果要更新关系的属性需要通过read-and-modify方式，先读取所有属性，修改部分属性，然后再写入存储系统，更新效率较低。 |
| 从经验来看顶点属性的修改需求较多，而边的属性修改需求较少，例如PageRank和Graph Cluster等计算都需要频繁修改顶点的属性值。</p> |
| <h3 id="2-图分区方案">2. 图分区方案</h3> |
| <p>对于分布式图数据库而言，图的分区存储方式有两种：分别是边分割存储（Edge Cut）和点分割存储（Vertex Cut），如下图所示。 |
| 使用Edge Cut方式存储图时，任何一个顶点只会出现在一台机器上，而边可能分布在不同机器上，这种存储方式有可能导致边多次存储。 |
| 使用Vertex Cut方式存储图时，任何一条边只会出现在一台机器上，而每相同的一个点可能分布到不同机器上，这种存储方式可能会导致顶点多次存储。</p> |
| <p><img src="/docs/images/design/GraphCut.png" alt="image"></p> |
| <p>采用EdgeCut分区方案可以支持高性能的插入和更新操作，而VertexCut分区方案更适合静态图查询分析，因此EdgeCut适合OLTP图查询，VertexCut更适合OLAP的图查询。 |
| HugeGraph目前采用EdgeCut的分区方案。</p> |
| <h3 id="3-vertexid-策略">3. VertexId 策略</h3> |
| <p>HugeGraph的Vertex支持三种ID策略，在同一个图数据库中不同的VertexLabel可以使用不同的Id策略，目前HugeGraph支持的Id策略分别是：</p> |
| <ul> |
| <li>自动生成（AUTOMATIC）：使用Snowflake算法自动生成全局唯一Id，Long类型；</li> |
| <li>主键（PRIMARY_KEY）：通过VertexLabel+PrimaryKeyValues生成Id，String类型；</li> |
| <li>自定义（CUSTOMIZE_STRING|CUSTOMIZE_NUMBER）：用户自定义Id，分为String和Long类型两种，需自己保证Id的唯一性；</li> |
| </ul> |
| <p>默认的Id策略是AUTOMATIC，如果用户调用primaryKeys()方法并设置了正确的PrimaryKeys，则自动启用PRIMARY_KEY策略。 |
| 启用PRIMARY_KEY策略后HugeGraph能根据PrimaryKeys实现数据去重。</p> |
| <ol> |
| <li>AUTOMATIC ID策略</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-java" data-lang="java"><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">"person"</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">useAutomaticId</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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 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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">18</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span></code></pre></div><ol start="2"> |
| <li>PRIMARY_KEY ID策略</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-java" data-lang="java"><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">"person"</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">usePrimaryKeyId</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</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 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">"person"</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">18</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span></code></pre></div><ol start="3"> |
| <li>CUSTOMIZE_STRING ID策略</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-java" data-lang="java"><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">"person"</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">useCustomizeStringId</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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 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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"123456"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">18</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span></code></pre></div><ol start="4"> |
| <li>CUSTOMIZE_NUMBER ID策略</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-java" data-lang="java"><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">"person"</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">useCustomizeNumberId</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</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 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">"person"</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">id</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">123456</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"marko"</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">18</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"city"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Beijing"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span></code></pre></div><p>如果用户需要Vertex去重，有三种方案分别是：</p> |
| <ol> |
| <li>采用PRIMARY_KEY策略，自动覆盖，适合大数据量批量插入，用户无法知道是否发生了覆盖行为</li> |
| <li>采用AUTOMATIC策略，read-and-modify，适合小数据量插入，用户可以明确知道是否发生覆盖</li> |
| <li>采用CUSTOMIZE_STRING或CUSTOMIZE_NUMBER策略，用户自己保证唯一</li> |
| </ol> |
| <h3 id="4-edgeid-策略">4. EdgeId 策略</h3> |
| <p>HugeGraph的EdgeId是由<code>srcVertexId</code>+<code>edgeLabel</code>+<code>sortKey</code>+<code>tgtVertexId</code>四部分组合而成。其中<code>sortKey</code>是HugeGraph的一个重要概念。 |
| 在Edge中加入<code>sortKey</code>作为Edge的唯一标识的原因有两个：</p> |
| <ol> |
| <li>如果两个顶点之间存在多条相同Label的边可通过<code>sortKey</code>来区分</li> |
| <li>对于SuperNode的节点，可以通过<code>sortKey</code>来排序截断。</li> |
| </ol> |
| <p>由于EdgeId是由<code>srcVertexId</code>+<code>edgeLabel</code>+<code>sortKey</code>+<code>tgtVertexId</code>四部分组合，多次插入相同的Edge时HugeGraph会自动覆盖以实现去重。 |
| 需要注意的是如果批量插入模式下Edge的属性也将会覆盖。</p> |
| <p>另外由于HugeGraph的EdgeId采用自动去重策略，对于self-loop（一个顶点存在一条指向自身的边）的情况下HugeGraph认为仅有一条边，对于采用AUTOMATIC策略的图数据库（例如TitianDB |
| ）则会认为该图存在两条边。</p> |
| <blockquote> |
| <p>HugeGraph的边仅支持有向边，无向边可以创建Out和In两条边来实现。</p> |
| </blockquote> |
| <h3 id="5-hugegraph-transaction-overview">5. HugeGraph transaction overview</h3> |
| <h5 id="tinkerpop事务概述">TinkerPop事务概述</h5> |
| <p>TinkerPop transaction事务是指对数据库执行操作的工作单元，一个事务内的一组操作要么执行成功，要么全部失败。 |
| 详细介绍请参考TinkerPop官方文档：http://tinkerpop.apache.org/docs/current/reference/#transactions</p> |
| <h5 id="tinkerpop事务操作接口">TinkerPop事务操作接口</h5> |
| <ul> |
| <li>open 打开事务</li> |
| <li>commit 提交事务</li> |
| <li>rollback 回滚事务</li> |
| <li>close 关闭事务</li> |
| </ul> |
| <h5 id="tinkerpop事务规范">TinkerPop事务规范</h5> |
| <ul> |
| <li>事务必须显式提交后才可生效（未提交时修改操作只有本事务内查询可看到）</li> |
| <li>事务必须打开之后才可提交或回滚</li> |
| <li>如果事务设置自动打开则无需显式打开（默认方式），如果设置手动打开则必须显式打开</li> |
| <li>可设置事务关闭时：自动提交、自动回滚（默认方式）、手动（禁止显式关闭）等3种模式</li> |
| <li>事务在提交或回滚后必须是关闭状态</li> |
| <li>事务在查询后必须是打开状态</li> |
| <li>事务（非threaded tx）必须线程隔离，多线程操作同一事务互不影响</li> |
| </ul> |
| <p>更多事务规范用例见：<a href="https://github.com/apache/tinkerpop/blob/master/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/TransactionTest.java">Transaction Test</a></p> |
| <h5 id="hugegraph事务实现">HugeGraph事务实现</h5> |
| <ul> |
| <li>一个事务中所有的操作要么成功要么失败</li> |
| <li>一个事务只能读取到另外一个事务已提交的内容（Read committed）</li> |
| <li>所有未提交的操作均能在本事务中查询出来，包括： |
| <ul> |
| <li>增加顶点能够查询出该顶点</li> |
| <li>删除顶点能够过滤掉该顶点</li> |
| <li>删除顶点能够过滤掉该顶点相关边</li> |
| <li>增加边能够查询出该边</li> |
| <li>删除边能够过滤掉该边</li> |
| <li>增加/修改（顶点、边）属性能够在查询时生效</li> |
| <li>删除（顶点、边）属性能够在查询时生效</li> |
| </ul> |
| </li> |
| <li>所有未提交的操作在事务回滚后均失效，包括： |
| <ul> |
| <li>顶点、边的增加、删除</li> |
| <li>属性的增加/修改、删除</li> |
| </ul> |
| </li> |
| </ul> |
| <p>示例：一个事务无法读取另一个事务未提交的内容</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-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">static</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">testUncommittedTx</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">final</span> <span style="color:#000">HugeGraph</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">)</span> <span style="color:#204a87;font-weight:bold">throws</span> <span style="color:#000">InterruptedException</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">final</span> <span style="color:#000">CountDownLatch</span> <span style="color:#000">latchUncommit</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">CountDownLatch</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">1</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">final</span> <span style="color:#000">CountDownLatch</span> <span style="color:#000">latchRollback</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">CountDownLatch</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">1</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">Thread</span> <span style="color:#000">thread</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">Thread</span><span style="color:#ce5c00;font-weight:bold">(()</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">// this is a new transaction in the new thread |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">tx</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">open</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">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">"current transaction operations"</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">james</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">"author"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"id"</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:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"James Gosling"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">62</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"lived"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"Canadian"</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">java</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">"language"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"java"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"versions"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">Arrays</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">asList</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">6</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">7</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">8</span><span style="color:#ce5c00;font-weight:bold">));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">james</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">"created"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">java</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">// we can query the uncommitted records in the current transaction |
| </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:#4e9a06">"current transaction assert"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">assert</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">vertices</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasNext</span><span style="color:#ce5c00;font-weight:bold">()</span> <span style="color:#ce5c00;font-weight:bold">==</span> <span style="color:#204a87;font-weight:bold">true</span><span style="color:#ce5c00;font-weight:bold">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">assert</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">edges</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasNext</span><span style="color:#ce5c00;font-weight:bold">()</span> <span style="color:#ce5c00;font-weight:bold">==</span> <span style="color:#204a87;font-weight:bold">true</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">latchUncommit</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">countDown</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">try</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">latchRollback</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">await</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">catch</span> <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">InterruptedException</span> <span style="color:#000">e</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:#204a87;font-weight:bold">throw</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">RuntimeException</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">e</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">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">"current transaction rollback"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">tx</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">rollback</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">thread</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">start</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">// query none result in other transaction when not commit() |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#000">latchUncommit</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">await</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">"other transaction assert for uncommitted"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">assert</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">vertices</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasNext</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">assert</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">edges</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasNext</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">latchRollback</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">countDown</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">thread</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">join</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">// query none result in other transaction after rollback() |
| </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:#4e9a06">"other transaction assert for rollback"</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">assert</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">vertices</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasNext</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">assert</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">edges</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasNext</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="事务实现原理">事务实现原理</h5> |
| <ul> |
| <li>服务端内部通过将事务与线程绑定实现隔离（ThreadLocal）</li> |
| <li>本事务未提交的内容按照时间顺序覆盖老数据以供本事务查询最新版本数据</li> |
| <li>底层依赖后端数据库保证事务原子性操作（如Cassandra/RocksDB的batch接口均保证原子性）</li> |
| </ul> |
| <h6 id="注意"><em>注意</em></h6> |
| <blockquote> |
| <p>RESTful API暂时未暴露事务接口</p> |
| </blockquote> |
| <blockquote> |
| <p>TinkerPop API允许打开事务，请求完成时会自动关闭(Gremlin Server强制关闭)</p> |
| </blockquote> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-96a920d19e01666d95eded506d502ab4">6.3 - HugeGraph Plugin机制及插件扩展流程</h1> |
| |
| <h3 id="背景">背景</h3> |
| <ol> |
| <li>HugeGraph不仅开源开放，而且要做到简单易用，一般用户无需更改源码也能轻松增加插件扩展功能。</li> |
| <li>HugeGraph支持多种内置存储后端，也允许用户无需更改现有源码的情况下扩展自定义后端。</li> |
| <li>HugeGraph支持全文检索，全文检索功能涉及到各语言分词，目前已内置8种中文分词器，也允许用户无需更改现有源码的情况下扩展自定义分词器。</li> |
| </ol> |
| <h3 id="可扩展维度">可扩展维度</h3> |
| <p>目前插件方式提供如下几个维度的扩展项：</p> |
| <ul> |
| <li>后端存储</li> |
| <li>序列化器</li> |
| <li>自定义配置项</li> |
| <li>分词器</li> |
| </ul> |
| <h3 id="插件实现机制">插件实现机制</h3> |
| <ol> |
| <li>HugeGraph提供插件接口HugeGraphPlugin，通过Java SPI机制支持插件化</li> |
| <li>HugeGraph提供了4个扩展项注册函数：<code>registerOptions()</code>、<code>registerBackend()</code>、<code>registerSerializer()</code>、<code>registerAnalyzer()</code></li> |
| <li>插件实现者实现相应的Options、Backend、Serializer或Analyzer的接口</li> |
| <li>插件实现者实现HugeGraphPlugin接口的<code>register()</code>方法，在该方法中注册上述第3点所列的具体实现类，并打成jar包</li> |
| <li>插件使用者将jar包放在HugeGraph Server安装目录的<code>plugins</code>目录下，修改相关配置项为插件自定义值，重启即可生效</li> |
| </ol> |
| <h3 id="插件实现流程实例">插件实现流程实例</h3> |
| <h4 id="1-新建一个maven项目">1 新建一个maven项目</h4> |
| <h5 id="11-项目名称取名hugegraph-plugin-demo">1.1 项目名称取名：hugegraph-plugin-demo</h5> |
| <h5 id="12-添加hugegraph-core-jar包依赖">1.2 添加<code>hugegraph-core</code> Jar包依赖</h5> |
| <p>maven pom.xml详细内容如下：</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"><?xml version="1.0" encoding="UTF-8"?></span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold"><project</span> <span style="color:#c4a000">xmlns=</span><span style="color:#4e9a06">"http://maven.apache.org/POM/4.0.0"</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#c4a000">xmlns:xsi=</span><span style="color:#4e9a06">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#c4a000">xsi:schemaLocation=</span><span style="color:#4e9a06">"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"</span><span style="color:#204a87;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"><modelVersion></span>4.0.0<span style="color:#204a87;font-weight:bold"></modelVersion></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><groupId></span>com.baidu.hugegraph<span style="color:#204a87;font-weight:bold"></groupId></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><artifactId></span>hugegraph-plugin-demo<span style="color:#204a87;font-weight:bold"></artifactId></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><version></span>1.0.0<span style="color:#204a87;font-weight:bold"></version></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><packaging></span>jar<span style="color:#204a87;font-weight:bold"></packaging></span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><name></span>hugegraph-plugin-demo<span style="color:#204a87;font-weight:bold"></name></span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><dependencies></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><dependency></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><groupId></span>com.baidu.hugegraph<span style="color:#204a87;font-weight:bold"></groupId></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><artifactId></span>hugegraph-core<span style="color:#204a87;font-weight:bold"></artifactId></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"><version></span>${project.version}<span style="color:#204a87;font-weight:bold"></version></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"></dependency></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold"></dependencies></span> |
| </span></span><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold"></project></span> |
| </span></span></code></pre></div><h4 id="2-实现扩展功能">2 实现扩展功能</h4> |
| <h5 id="21-扩展自定义后端">2.1 扩展自定义后端</h5> |
| <h6 id="211-实现接口backendstoreprovider">2.1.1 实现接口BackendStoreProvider</h6> |
| <ul> |
| <li>可实现接口：<code>com.baidu.hugegraph.backend.store.BackendStoreProvider</code></li> |
| <li>或者继承抽象类：<code>com.baidu.hugegraph.backend.store.AbstractBackendStoreProvider</code></li> |
| </ul> |
| <p>以RocksDB后端RocksDBStoreProvider为例：</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-java" data-lang="java"><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">RocksDBStoreProvider</span> <span style="color:#204a87;font-weight:bold">extends</span> <span style="color:#000">AbstractBackendStoreProvider</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">protected</span> <span style="color:#000">String</span> <span style="color:#000">database</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:#204a87;font-weight:bold">return</span> <span style="color:#204a87;font-weight:bold">this</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">graph</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">toLowerCase</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:#5c35cc;font-weight:bold">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">protected</span> <span style="color:#000">BackendStore</span> <span style="color:#000">newSchemaStore</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">String</span> <span style="color:#000">store</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:#204a87;font-weight:bold">return</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">RocksDBSchemaStore</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">this</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">this</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">database</span><span style="color:#ce5c00;font-weight:bold">(),</span> <span style="color:#000">store</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:#5c35cc;font-weight:bold">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">protected</span> <span style="color:#000">BackendStore</span> <span style="color:#000">newGraphStore</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">String</span> <span style="color:#000">store</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:#204a87;font-weight:bold">return</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">RocksDBGraphStore</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87;font-weight:bold">this</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">this</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">database</span><span style="color:#ce5c00;font-weight:bold">(),</span> <span style="color:#000">store</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:#5c35cc;font-weight:bold">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">String</span> <span style="color:#000">type</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:#204a87;font-weight:bold">return</span> <span style="color:#4e9a06">"rocksdb"</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:#5c35cc;font-weight:bold">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">String</span> <span style="color:#000">version</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:#204a87;font-weight:bold">return</span> <span style="color:#4e9a06">"1.0"</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><h6 id="212-实现接口backendstore">2.1.2 实现接口BackendStore</h6> |
| <p>BackendStore接口定义如下：</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">interface</span> <span style="color:#000">BackendStore</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#8f5902;font-style:italic">// Store name |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">String</span> <span style="color:#000">store</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">// Database name |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">String</span> <span style="color:#000">database</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 the parent provider |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendStoreProvider</span> <span style="color:#000">provider</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">// Open/close database |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">open</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeConfig</span> <span style="color:#000">config</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">close</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">// Initialize/clear database |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">init</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">clear</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">// Add/delete data |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">mutate</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">BackendMutation</span> <span style="color:#000">mutation</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">// Query data |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">Iterator</span><span style="color:#ce5c00;font-weight:bold"><</span><span style="color:#000">BackendEntry</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#000">query</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">Query</span> <span style="color:#000">query</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">// Transaction |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">beginTx</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">commitTx</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">rollbackTx</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 metadata by key |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#ce5c00;font-weight:bold"><</span><span style="color:#000">R</span><span style="color:#ce5c00;font-weight:bold">></span> <span style="color:#000">R</span> <span style="color:#000">metadata</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeType</span> <span style="color:#000">type</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">String</span> <span style="color:#000">meta</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:#000">args</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">// Backend features |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendFeatures</span> <span style="color:#000">features</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">// Generate an id for a specific type |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">Id</span> <span style="color:#000">nextId</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeType</span> <span style="color:#000">type</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><h6 id="213-扩展自定义序列化器">2.1.3 扩展自定义序列化器</h6> |
| <p>序列化器必须继承抽象类：<code>com.baidu.hugegraph.backend.serializer.AbstractSerializer</code>(<code>implements GraphSerializer, SchemaSerializer</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">interface</span> <span style="color:#000">GraphSerializer</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeVertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeVertex</span> <span style="color:#000">vertex</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeVertexProperty</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeVertexProperty</span><span style="color:#ce5c00;font-weight:bold"><?></span> <span style="color:#000">prop</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">HugeVertex</span> <span style="color:#000">readVertex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeGraph</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">entry</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeEdge</span> <span style="color:#000">edge</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeEdgeProperty</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeEdgeProperty</span><span style="color:#ce5c00;font-weight:bold"><?></span> <span style="color:#000">prop</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">HugeEdge</span> <span style="color:#000">readEdge</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeGraph</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">entry</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeIndex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeIndex</span> <span style="color:#000">index</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">HugeIndex</span> <span style="color:#000">readIndex</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeGraph</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">ConditionQuery</span> <span style="color:#000">query</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">entry</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeId</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeType</span> <span style="color:#000">type</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">Id</span> <span style="color:#000">id</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">Query</span> <span style="color:#000">writeQuery</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">Query</span> <span style="color:#000">query</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:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">interface</span> <span style="color:#000">SchemaSerializer</span> <span style="color:#ce5c00;font-weight:bold">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">VertexLabel</span> <span style="color:#000">vertexLabel</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">VertexLabel</span> <span style="color:#000">readVertexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeGraph</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">entry</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">EdgeLabel</span> <span style="color:#000">edgeLabel</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">EdgeLabel</span> <span style="color:#000">readEdgeLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeGraph</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">entry</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writePropertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">PropertyKey</span> <span style="color:#000">propertyKey</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">PropertyKey</span> <span style="color:#000">readPropertyKey</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeGraph</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">entry</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">writeIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">IndexLabel</span> <span style="color:#000">indexLabel</span><span style="color:#ce5c00;font-weight:bold">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">IndexLabel</span> <span style="color:#000">readIndexLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">HugeGraph</span> <span style="color:#000">graph</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">BackendEntry</span> <span style="color:#000">entry</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><h6 id="214-扩展自定义配置项">2.1.4 扩展自定义配置项</h6> |
| <p>增加自定义后端时，可能需要增加新的配置项，实现流程主要包括：</p> |
| <ul> |
| <li>增加配置项容器类，并实现接口<code>com.baidu.hugegraph.config.OptionHolder</code></li> |
| <li>提供单例方法<code>public static OptionHolder instance()</code>，并在对象初始化时调用方法<code>OptionHolder.registerOptions()</code></li> |
| <li>增加配置项声明，单值配置项类型为<code>ConfigOption</code>、多值配置项类型为<code>ConfigListOption</code></li> |
| </ul> |
| <p>以RocksDB配置项定义为例：</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-java" data-lang="java"><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">RocksDBOptions</span> <span style="color:#204a87;font-weight:bold">extends</span> <span style="color:#000">OptionHolder</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">private</span> <span style="color:#000">RocksDBOptions</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:#204a87;font-weight:bold">super</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:#204a87;font-weight:bold">private</span> <span style="color:#204a87;font-weight:bold">static</span> <span style="color:#204a87;font-weight:bold">volatile</span> <span style="color:#000">RocksDBOptions</span> <span style="color:#000">instance</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">synchronized</span> <span style="color:#000">RocksDBOptions</span> <span style="color:#000">instance</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:#204a87;font-weight:bold">if</span> <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">instance</span> <span style="color:#ce5c00;font-weight:bold">==</span> <span style="color:#204a87;font-weight:bold">null</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">instance</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">RocksDBOptions</span><span style="color:#ce5c00;font-weight:bold">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">instance</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">registerOptions</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:#204a87;font-weight:bold">return</span> <span style="color:#000">instance</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:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">static</span> <span style="color:#204a87;font-weight:bold">final</span> <span style="color:#000">ConfigOption</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">DATA_PATH</span> <span style="color:#ce5c00;font-weight:bold">=</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">ConfigOption</span><span style="color:#ce5c00;font-weight:bold"><>(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"rocksdb.data_path"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"The path for storing data of RocksDB."</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">disallowEmpty</span><span style="color:#ce5c00;font-weight:bold">(),</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"rocksdb-data"</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:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">static</span> <span style="color:#204a87;font-weight:bold">final</span> <span style="color:#000">ConfigOption</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">WAL_PATH</span> <span style="color:#ce5c00;font-weight:bold">=</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">ConfigOption</span><span style="color:#ce5c00;font-weight:bold"><>(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"rocksdb.wal_path"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"The path for storing WAL of RocksDB."</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">disallowEmpty</span><span style="color:#ce5c00;font-weight:bold">(),</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"rocksdb-data"</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:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">static</span> <span style="color:#204a87;font-weight:bold">final</span> <span style="color:#000">ConfigListOption</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">DATA_DISKS</span> <span style="color:#ce5c00;font-weight:bold">=</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">ConfigListOption</span><span style="color:#ce5c00;font-weight:bold"><>(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"rocksdb.data_disks"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><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:#4e9a06">"The optimized disks for storing data of RocksDB. "</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"The format of each element: `STORE/TABLE: /path/to/disk`."</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"Allowed keys are [graph/vertex, graph/edge_out, graph/edge_in, "</span> <span style="color:#ce5c00;font-weight:bold">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">"graph/secondary_index, graph/range_index]"</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">null</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">String</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">class</span><span style="color:#ce5c00;font-weight:bold">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#000">ImmutableList</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">of</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="22-扩展自定义分词器">2.2 扩展自定义分词器</h5> |
| <p>分词器需要实现接口<code>com.baidu.hugegraph.analyzer.Analyzer</code>，以实现一个SpaceAnalyzer空格分词器为例。</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">package</span> <span style="color:#000">com.baidu.hugegraph.plugin</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">java.util.Arrays</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.HashSet</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.Set</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">com.baidu.hugegraph.analyzer.Analyzer</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">SpaceAnalyzer</span> <span style="color:#204a87;font-weight:bold">implements</span> <span style="color:#000">Analyzer</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:#5c35cc;font-weight:bold">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">Set</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">segment</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">String</span> <span style="color:#000">text</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:#204a87;font-weight:bold">return</span> <span style="color:#204a87;font-weight:bold">new</span> <span style="color:#000">HashSet</span><span style="color:#ce5c00;font-weight:bold"><>(</span><span style="color:#000">Arrays</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">asList</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">text</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">split</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">" "</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><h4 id="3-实现插件接口并进行注册">3 实现插件接口，并进行注册</h4> |
| <p>插件注册入口为<code>HugeGraphPlugin.register()</code>，自定义插件必须实现该接口方法，在其内部注册上述定义好的扩展项。 |
| 接口<code>com.baidu.hugegraph.plugin.HugeGraphPlugin</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">interface</span> <span style="color:#000">HugeGraphPlugin</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:#000">String</span> <span style="color:#000">name</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">void</span> <span style="color:#000">register</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:#000">String</span> <span style="color:#000">supportsMinVersion</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:#000">String</span> <span style="color:#000">supportsMaxVersion</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><p>并且HugeGraphPlugin提供了4个静态方法用于注册扩展项：</p> |
| <ul> |
| <li>registerOptions(String name, String classPath)：注册配置项</li> |
| <li>registerBackend(String name, String classPath)：注册后端（BackendStoreProvider）</li> |
| <li>registerSerializer(String name, String classPath)：注册序列化器</li> |
| <li>registerAnalyzer(String name, String classPath)：注册分词器</li> |
| </ul> |
| <p>下面以注册SpaceAnalyzer分词器为例：</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#204a87;font-weight:bold">package</span> <span style="color:#000">com.baidu.hugegraph.plugin</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">DemoPlugin</span> <span style="color:#204a87;font-weight:bold">implements</span> <span style="color:#000">HugeGraphPlugin</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:#5c35cc;font-weight:bold">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#000">String</span> <span style="color:#000">name</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:#204a87;font-weight:bold">return</span> <span style="color:#4e9a06">"demo"</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:#5c35cc;font-weight:bold">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">public</span> <span style="color:#204a87;font-weight:bold">void</span> <span style="color:#000">register</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">HugeGraphPlugin</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">registerAnalyzer</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">"demo"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">SpaceAnalyzer</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">class</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">getName</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><h4 id="4-配置spi入口">4 配置SPI入口</h4> |
| <ol> |
| <li>确保services目录存在：hugegraph-plugin-demo/resources/META-INF/services</li> |
| <li>在services目录下建立文本文件：com.baidu.hugegraph.plugin.HugeGraphPlugin</li> |
| <li>文件内容如下：com.baidu.hugegraph.plugin.DemoPlugin</li> |
| </ol> |
| <h4 id="5-打jar包">5 打Jar包</h4> |
| <p>通过maven打包，在项目目录下执行命令<code>mvn package</code>，在target目录下会生成Jar包文件。 |
| 使用时将该Jar包拷到<code>plugins</code>目录，重启服务即可生效。</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-2c9db416c8d78f898d52c91ec12535d4">6.4 - Backup Restore</h1> |
| |
| <h2 id="描述">描述</h2> |
| <p>Backup 和 Restore 是备份图和恢复图的功能。备份和恢复的数据包括元数据（schema）和图数据（vertex 和 edge）。</p> |
| <h4 id="backup">Backup</h4> |
| <p>将 HugeGraph 系统中的一张图的元数据和图数据以 JSON 格式导出。</p> |
| <h4 id="restore">Restore</h4> |
| <p>将 Backup 导出的JSON格式的数据，重新导入到 HugeGraph 系统中的一个图中。</p> |
| <p>Restore 有两种模式：</p> |
| <ul> |
| <li>Restoring 模式，将 Backup 导出的元数据和图数据原封不动的恢复到 HugeGraph 系统中。可用于图的备份和恢复，一般目标图是新图（没有元数据和图数据）。比如： |
| <ul> |
| <li>系统升级，先备份图，然后升级系统，最后将图恢复到新的系统中</li> |
| <li>图迁移，从一个 HugeGraph 系统中，使用 Backup 功能将图导出，然后使用 Restore 功能将图导入另一个 HugeGraph 系统中</li> |
| </ul> |
| </li> |
| <li>Merging 模式，将 Backup 导出的元数据和图数据导入到另一个已经存在元数据或者图数据的图中，过程中元数据的 ID 可能发生改变，顶点和边的 ID 也会发生相应变化。 |
| <ul> |
| <li>可用于合并图</li> |
| </ul> |
| </li> |
| </ul> |
| <h2 id="使用方法">使用方法</h2> |
| <p>可以使用<a href="/docs/quickstart/hugegraph-tools">hugegraph-tools</a>进行图的备份和恢复。</p> |
| <h4 id="backup-1">Backup</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/hugegraph backup -t all -d data |
| </span></span></code></pre></div><p>该命令将 http://127.0.0.1 的 hugegraph 图的全部元数据和图数据备份到data目录下。</p> |
| <blockquote> |
| <p>Backup 在三种图模式下都可以正常工作</p> |
| </blockquote> |
| <h4 id="restore-1">Restore</h4> |
| <p>Restore 有两种模式： RESTORING 和 MERGING，备份之前首先要根据需要设置图模式。</p> |
| <h5 id="步骤1查看并设置图模式">步骤1：查看并设置图模式</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>bin/hugegraph graph-mode-get |
| </span></span></code></pre></div><p>该命令用于查看当前图模式，包括：NONE、RESTORING、MERGING。</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 graph-mode-set -m RESTORING |
| </span></span></code></pre></div><p>该命令用于设置图模式，Restore 之前可以设置成 RESTORING 或者 MERGING 模式，例子中设置成 RESTORING。</p> |
| <h5 id="步骤2restore-数据">步骤2：Restore 数据</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>bin/hugegraph restore -t all -d data |
| </span></span></code></pre></div><p>该命令将data目录下的全部元数据和图数据重新导入到 http://127.0.0.1 的 hugegraph 图中。</p> |
| <h5 id="步骤3恢复图模式">步骤3：恢复图模式</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>bin/hugegraph graph-mode-set -m NONE |
| </span></span></code></pre></div><p>该命令用于恢复图模式为 NONE。</p> |
| <p>至此，一次完整的图备份和图恢复流程结束。</p> |
| <h4 id="帮助">帮助</h4> |
| <p>备份和恢复命令的详细使用方式可以参考<a href="/docs/quickstart/hugegraph-tools">hugegraph-tools文档</a>。</p> |
| <h2 id="backuprestore使用和实现的api说明">Backup/Restore使用和实现的API说明</h2> |
| <h4 id="backup-2">Backup</h4> |
| <p>Backup 使用<code>元数据</code>和<code>图数据</code>的相应的 list(GET) API 导出，并未增加新的 API。</p> |
| <h4 id="restore-2">Restore</h4> |
| <p>Restore 使用<code>元数据</code>和<code>图数据</code>的相应的 create(POST) API 导入，并未增加新的 API。</p> |
| <p>Restore 时存在两种不同的模式： Restoring 和 Merging，另外，还有常规模式 NONE(默认)，区别如下：</p> |
| <ul> |
| <li>None 模式，元数据和图数据的写入属于正常状态，可参见功能说明。特别的： |
| <ul> |
| <li>元数据（schema）创建时不允许指定 ID</li> |
| <li>图数据（vertex）在 id strategy 为 Automatic 时，不允许指定 ID</li> |
| </ul> |
| </li> |
| <li>Restoring 模式，恢复到一个新图中，特别的： |
| <ul> |
| <li>元数据（schema）创建时允许指定 ID</li> |
| <li>图数据（vertex）在 id strategy 为 Automatic 时，允许指定 ID</li> |
| </ul> |
| </li> |
| <li>Merging 模式，合并到一个已存在元数据和图数据的图中，特别的： |
| <ul> |
| <li>元数据（schema）创建时不允许指定 ID</li> |
| <li>图数据（vertex）在 id strategy 为 Automatic 时，允许指定 ID</li> |
| </ul> |
| </li> |
| </ul> |
| <p>正常情况下，图模式为 None，当需要 Restore 图时，需要根据需要临时修改图模式为 Restoring 模式或者 Merging 模式，并在完成 Restore 时，恢复图模式为 None。</p> |
| <p>实现的设置图模式的 RESTful API 如下：</p> |
| <h5 id="查看某个图的模式-该操作需要管理员权限">查看某个图的模式. <strong>该操作需要管理员权限</strong></h5> |
| <h6 id="method--url">Method & Url</h6> |
| <pre tabindex="0"><code>GET http://localhost:8080/graphs/{graph}/mode |
| </code></pre><h6 id="response-status">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body">Response Body</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-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">"mode"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"NONE"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div><blockquote> |
| <p>合法的图模式包括：NONE，RESTORING，MERGING</p> |
| </blockquote> |
| <h5 id="设置某个图的模式-该操作需要管理员权限">设置某个图的模式. <strong>该操作需要管理员权限</strong></h5> |
| <h6 id="method--url-1">Method & Url</h6> |
| <pre tabindex="0"><code>PUT http://localhost:8080/graphs/{graph}/mode |
| </code></pre><h6 id="request-body">Request Body</h6> |
| <pre tabindex="0"><code>"RESTORING" |
| </code></pre><blockquote> |
| <p>合法的图模式包括：NONE，RESTORING，MERGING</p> |
| </blockquote> |
| <h6 id="response-status-1">Response 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-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> |
| </span></span></code></pre></div><h6 id="response-body-1">Response Body</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-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">"mode"</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">"RESTORING"</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> |
| </span></span></code></pre></div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-3465b699399f48689cdc6b5e59a10d69">6.5 - FAQ</h1> |
| |
| <ul> |
| <li> |
| <p>如何选择后端存储? 选 RocksDB 还是 Cassandra 还是 Hbase 还是 Mysql?</p> |
| <p>根据你的具体需要来判断, 一般单机或数据量 < 100 亿推荐 RocksDB, 其他推荐使用分布式存储的后端集群</p> |
| </li> |
| <li> |
| <p>启动服务时提示：<code>xxx (core dumped) xxx</code></p> |
| <p>请检查JDK版本是否为1.8</p> |
| </li> |
| <li> |
| <p>启动服务成功了，但是操作图时有类似于"无法连接到后端或连接未打开"的提示</p> |
| <p>第一次启动服务前，需要先使用<code>init-store</code>初始化后端，后续版本会将提示得更清晰直接。</p> |
| </li> |
| <li> |
| <p>所有的后端在使用前都需要执行<code>init-store</code>吗，序列化的选择可以随意填写么?</p> |
| <p>除了<code>memory</code>不需要，其他后端均需要，如：<code>cassandra</code>、<code>hbase</code>和<code>rocksdb</code>等，序列化需一一对应不可随意填写。</p> |
| </li> |
| <li> |
| <p>执行<code>init-store</code>报错：<code>Exception in thread "main" java.lang.UnsatisfiedLinkError: /tmp/librocksdbjni3226083071221514754.so: /usr/lib64/libstdc++.so.6: version `GLIBCXX_3.4.10' not found (required by /tmp/librocksdbjni3226083071221514754.so)</code></p> |
| <p>RocksDB需要 gcc 4.3.0 (GLIBCXX_3.4.10) 及以上版本</p> |
| </li> |
| <li> |
| <p>执行<code>init-store.sh</code>时报错：<code>NoHostAvailableException</code></p> |
| <p><code>NoHostAvailableException</code> 是指无法连接到<code>Cassandra</code>服务，如果确定是要使用<code>cassandra</code>后端，请先安装并启动这个服务。至于这个提示本身可能不够直白，我们会更新到文档进行说明的。</p> |
| </li> |
| <li> |
| <p><code>bin</code>目录下包含<code>start-hugegraph.sh</code>、<code>start-restserver.sh</code>和<code>start-gremlinserver.sh</code>三个似乎与启动有关的脚本，到底该使用哪个</p> |
| <p>自0.3.3版本以来，已经把 GremlinServer 和 RestServer 合并为 HugeGraphServer 了，使用<code>start-hugegraph.sh</code>启动即可，后两个在后续版本会被删掉。</p> |
| </li> |
| <li> |
| <p>配置了两个图，名字是<code>hugegraph</code>和<code>hugegraph1</code>，而启动服务的命令是<code>start-hugegraph.sh</code>，是只打开了<code>hugegraph</code>这个图吗</p> |
| <p><code>start-hugegraph.sh</code>会打开所有<code>gremlin-server.yaml</code>的<code>graphs</code>下的图，这二者并无名字上的直接关系</p> |
| </li> |
| <li> |
| <p>服务启动成功后，使用<code>curl</code>查询所有顶点时返回乱码</p> |
| <p>服务端返回的批量顶点/边是压缩（gzip）过的，可以使用管道重定向至gunzip进行解压（<code>curl http://example | gunzip</code>），也可以用<code>Firefox</code>的<code>postman</code>或者<code>Chrome</code>浏览器的<code>restlet</code>插件发请求，会自动解压缩响应数据。</p> |
| </li> |
| <li> |
| <p>使用顶点Id通过<code>RESTful API</code>查询顶点时返回空，但是顶点确实是存在的</p> |
| <p>检查顶点Id的类型，如果是字符串类型，<code>API</code>的<code>url</code>中的id部分需要加上双引号，数字类型则不用加。</p> |
| </li> |
| <li> |
| <p>已经根据需要给顶点Id加上了双引号，但是通过<code>RESTful API</code>查询顶点时仍然返回空</p> |
| <p>检查顶点id中是否包含<code>+</code>、<code>空格</code>、<code>/</code>、<code>?</code>、<code>%</code>、<code>&</code>和<code>=</code>这些URL的保留字符，如果存在则需要进行编码。下表给出了编码值：</p> |
| <pre tabindex="0"><code>特殊字符 | 编码值 |
| --------| ---- |
| + | %2B |
| 空格 | %20 |
| / | %2F |
| ? | %3F |
| % | %25 |
| # | %23 |
| & | %26 |
| = | %3D |
| </code></pre></li> |
| <li> |
| <p>查询某一类别的顶点或边（<code>query by label</code>）时提示超时</p> |
| <p>由于属于某一label的数据量可能比较多，请加上limit限制。</p> |
| </li> |
| <li> |
| <p>通过<code>RESTful API</code>操作图是可以的，但是发送<code>Gremlin</code>语句就报错：<code>Request Failed(500)</code></p> |
| <p>可能是<code>GremlinServer</code>的配置有误，检查<code>gremlin-server.yaml</code>的<code>host</code>、<code>port</code>是否与<code>rest-server.properties</code>的<code>gremlinserver.url</code>匹配，如不匹配则修改，然后重启服务。</p> |
| </li> |
| <li> |
| <p>使用<code>Loader</code>导数据出现<code>Socket Timeout</code>异常，然后导致<code>Loader</code>中断</p> |
| <p>持续地导入数据会使<code>Server</code>的压力过大，然后导致有些请求超时。可以通过调整<code>Loader</code>的参数来适当缓解<code>Server</code>压力（如：重试次数，重试间隔，错误容忍数等），降低该问题出现频率。</p> |
| </li> |
| <li> |
| <p>如何删除全部的顶点和边，RESTful API中没有这样的接口，调用<code>gremlin</code>的<code>g.V().drop()</code>会报错<code>Vertices in transaction have reached capacity xxx</code></p> |
| <p>目前确实没有好办法删除全部的数据，用户如果是自己部署的<code>Server</code>和后端，可以直接清空数据库，重启<code>Server</code>。可以使用paging API或scan API先获取所有数据，再逐条删除。</p> |
| </li> |
| <li> |
| <p>清空了数据库，并且执行了<code>init-store</code>，但是添加<code>schema</code>时提示"xxx has existed"</p> |
| <p><code>HugeGraphServer</code>内是有缓存的，清空数据库的同时是需要重启<code>Server</code>的，否则残留的缓存会产生不一致。</p> |
| </li> |
| <li> |
| <p>插入顶点或边的过程中报错：<code>Id max length is 128, but got xxx {yyy}</code> 或 <code>Big id max length is 32768, but got xxx</code></p> |
| <p>为了保证查询性能，目前的后端存储对id列的长度做了限制，顶点id不能超过128字节，边id长度不能超过32768字节，索引id不能超过128字节。</p> |
| </li> |
| <li> |
| <p>是否支持嵌套属性，如果不支持，是否有什么替代方案</p> |
| <p>嵌套属性目前暂不支持。替代方案：可以把嵌套属性作为单独的顶点拿出来，然后用边连接起来。</p> |
| </li> |
| <li> |
| <p>一个<code>EdgeLabel</code>是否可以连接多对<code>VertexLabel</code>，比如"投资"关系，可以是"个人"投资"企业"，也可以是"企业"投资"企业"</p> |
| <p>一个<code>EdgeLabel</code>不支持连接多对<code>VertexLabel</code>，需要用户将<code>EdgeLabel</code>拆分得更细一点，如：“个人投资”，“企业投资”。</p> |
| </li> |
| <li> |
| <p>通过<code>RestAPI</code>发送请求时提示<code>HTTP 415 Unsupported Media Type</code></p> |
| <p>请求头中需要指定<code>Content-Type:application/json</code></p> |
| </li> |
| </ul> |
| <p>其他问题可以在对应项目的 issue 区搜索，例如 <a href="https://github.com/hugegraph/hugegraph/issues">Server-Issues</a> / <a href="https://github.com/hugegraph/hugegraph-loader/issues">Loader Issues</a></p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-3ed7a32fc6a58bb9d03dcd00dc874ba8">7 - QUERY LANGUAGE</h1> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style=""> |
| |
| <h1 id="pg-2696905b5b6cbdf2ad7f78085bd6baa9">7.1 - HugeGraph Gremlin</h1> |
| |
| <h3 id="概述">概述</h3> |
| <p>HugeGraph支持<a href="https://tinkerpop.apache.org">Apache TinkerPop3</a>的图形遍历查询语言<a href="https://tinkerpop.apache.org/gremlin.html">Gremlin</a>。 SQL是关系型数据库查询语言，而Gremlin是一种通用的图数据库查询语言，Gremlin可用于创建图的实体（Vertex和Edge）、修改实体内部属性、删除实体，也可执行图的查询操作。</p> |
| <p>Gremlin可用于创建图的实体（Vertex和Edge）、修改实体内部属性、删除实体，更主要的是可用于执行图的查询及分析操作。</p> |
| <h3 id="tinkerpop-features">TinkerPop Features</h3> |
| <p>HugeGraph实现了TinkerPop框架，但是并没有实现TinkerPop所有的特性。</p> |
| <p>下表列出HugeGraph对TinkerPop各种特性的支持情况：</p> |
| <h3 id="graph-features">Graph Features</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| <th>Support</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Computer</td> |
| <td>Determines if the {@code Graph} implementation supports {@link GraphComputer} based processing</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>Transactions</td> |
| <td>Determines if the {@code Graph} implementations supports transactions.</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>Persistence</td> |
| <td>Determines if the {@code Graph} implementation supports persisting it’s contents natively to disk.This feature does not refer to every graph’s ability to write to disk via the Gremlin IO packages(.e.g. GraphML), unless the graph natively persists to disk via those options somehow. For example,TinkerGraph does not support this feature as it is a pure in-sideEffects graph.</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>ThreadedTransactions</td> |
| <td>Determines if the {@code Graph} implementation supports threaded transactions which allow a transactionto be executed across multiple threads via {@link Transaction#createThreadedTx()}.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>ConcurrentAccess</td> |
| <td>Determines if the {@code Graph} implementation supports more than one connection to the same instance at the same time. For example, Neo4j embedded does not support this feature because concurrent access to the same database files by multiple instances is not possible. However, Neo4j HA could support this feature as each new {@code Graph} instance coordinates with the Neo4j cluster allowing multiple instances to operate on the same database.</td> |
| <td>false</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="vertex-features">Vertex Features</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| <th>Support</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>UserSuppliedIds</td> |
| <td>Determines if an {@link Element} can have a user defined identifier. Implementation that do not support this feature will be expected to auto-generate unique identifiers. In other words, if the {@link Graph} allows {@code graph.addVertex(id,x)} to work and thus set the identifier of the newly added {@link Vertex} to the value of {@code x} then this feature should return true. In this case, {@code x} is assumed to be an identifier datat ype that the {@link Graph} will accept.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>NumericIds</td> |
| <td>Determines if an {@link Element} has numeric identifiers as their internal representation. In other words,if the value returned from {@link Element#id()} is a numeric value then this method should be return {@code true}. Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>StringIds</td> |
| <td>Determines if an {@link Element} has string identifiers as their internal representation. In other words, if the value returned from {@link Element#id()} is a string value then this method should be return {@code true}. Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>UuidIds</td> |
| <td>Determines if an {@link Element} has UUID identifiers as their internal representation. In other words,if the value returned from {@link Element#id()} is a {@link UUID} value then this method should be return {@code true}.Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>CustomIds</td> |
| <td>Determines if an {@link Element} has a specific custom object as their internal representation.In other words, if the value returned from {@link Element#id()} is a type defined by the graph implementations, such as OrientDB’s {@code Rid}, then this method should be return {@code true}.Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>AnyIds</td> |
| <td>Determines if an {@link Element} any Java object is a suitable identifier. TinkerGraph is a good example of a {@link Graph} that can support this feature, as it can use any {@link Object} as a value for the identifier. Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite. This setting should only return {@code true} if {@link #supportsUserSuppliedIds()} is {@code true}.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>AddProperty</td> |
| <td>Determines if an {@link Element} allows properties to be added. This feature is set independently from supporting “data types” and refers to support of calls to {@link Element#property(String, Object)}.</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>RemoveProperty</td> |
| <td>Determines if an {@link Element} allows properties to be removed.</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>AddVertices</td> |
| <td>Determines if a {@link Vertex} can be added to the {@code Graph}.</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>MultiProperties</td> |
| <td>Determines if a {@link Vertex} can support multiple properties with the same key.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>DuplicateMultiProperties</td> |
| <td>Determines if a {@link Vertex} can support non-unique values on the same key. For this valueto be {@code true}, then {@link #supportsMetaProperties()} must also return true. By default this method, just returns what {@link #supportsMultiProperties()} returns.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>MetaProperties</td> |
| <td>Determines if a {@link Vertex} can support properties on vertex properties. It is assumed that a graph will support all the same data types for meta-properties that are supported for regular properties.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>RemoveVertices</td> |
| <td>Determines if a {@link Vertex} can be removed from the {@code Graph}.</td> |
| <td>true</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="edge-features">Edge Features</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| <th>Support</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>UserSuppliedIds</td> |
| <td>Determines if an {@link Element} can have a user defined identifier. Implementation that do not support this feature will be expected to auto-generate unique identifiers. In other words, if the {@link Graph} allows {@code graph.addVertex(id,x)} to work and thus set the identifier of the newly added {@link Vertex} to the value of {@code x} then this feature should return true. In this case, {@code x} is assumed to be an identifier datat ype that the {@link Graph} will accept.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>NumericIds</td> |
| <td>Determines if an {@link Element} has numeric identifiers as their internal representation. In other words,if the value returned from {@link Element#id()} is a numeric value then this method should be return {@code true}. Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>StringIds</td> |
| <td>Determines if an {@link Element} has string identifiers as their internal representation. In other words, if the value returned from {@link Element#id()} is a string value then this method should be return {@code true}. Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>UuidIds</td> |
| <td>Determines if an {@link Element} has UUID identifiers as their internal representation. In other words,if the value returned from {@link Element#id()} is a {@link UUID} value then this method should be return {@code true}.Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>CustomIds</td> |
| <td>Determines if an {@link Element} has a specific custom object as their internal representation.In other words, if the value returned from {@link Element#id()} is a type defined by the graph implementations, such as OrientDB’s {@code Rid}, then this method should be return {@code true}.Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>AnyIds</td> |
| <td>Determines if an {@link Element} any Java object is a suitable identifier. TinkerGraph is a good example of a {@link Graph} that can support this feature, as it can use any {@link Object} as a value for the identifier. Note that this feature is most generally used for determining the appropriate tests to execute in the Gremlin Test Suite. This setting should only return {@code true} if {@link #supportsUserSuppliedIds()} is {@code true}.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>AddProperty</td> |
| <td>Determines if an {@link Element} allows properties to be added. This feature is set independently from supporting “data types” and refers to support of calls to {@link Element#property(String, Object)}.</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>RemoveProperty</td> |
| <td>Determines if an {@link Element} allows properties to be removed.</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>AddEdges</td> |
| <td>Determines if an {@link Edge} can be added to a {@code Vertex}.</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>RemoveEdges</td> |
| <td>Determines if an {@link Edge} can be removed from a {@code Vertex}.</td> |
| <td>true</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="data-type-features">Data Type Features</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| <th>Support</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>BooleanValues</td> |
| <td></td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>ByteValues</td> |
| <td></td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>DoubleValues</td> |
| <td></td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>FloatValues</td> |
| <td></td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>IntegerValues</td> |
| <td></td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>LongValues</td> |
| <td></td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>MapValues</td> |
| <td>Supports setting of a {@code Map} value. The assumption is that the {@code Map} can containarbitrary serializable values that may or may not be defined as a feature itself</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>MixedListValues</td> |
| <td>Supports setting of a {@code List} value. The assumption is that the {@code List} can containarbitrary serializable values that may or may not be defined as a feature itself. As this{@code List} is “mixed” it does not need to contain objects of the same type.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>BooleanArrayValues</td> |
| <td></td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>ByteArrayValues</td> |
| <td></td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>DoubleArrayValues</td> |
| <td></td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>FloatArrayValues</td> |
| <td></td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>IntegerArrayValues</td> |
| <td></td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>LongArrayValues</td> |
| <td></td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>SerializableValues</td> |
| <td></td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>StringArrayValues</td> |
| <td></td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td>StringValues</td> |
| <td></td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>UniformListValues</td> |
| <td>Supports setting of a {@code List} value. The assumption is that the {@code List} can containarbitrary serializable values that may or may not be defined as a feature itself. As this{@code List} is “uniform” it must contain objects of the same type.</td> |
| <td>false</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="gremlin的步骤">Gremlin的步骤</h3> |
| <p>HugeGraph支持Gremlin的所有步骤。有关Gremlin的完整参考信息，请参与<a href="http://tinkerpop.apache.org/docs/current/reference/">Gremlin官网</a>。</p> |
| <table> |
| <thead> |
| <tr> |
| <th>步骤</th> |
| <th>说明</th> |
| <th>文档</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>addE</td> |
| <td>在两个顶点之间添加边</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#addedge-step">addE step</a></td> |
| </tr> |
| <tr> |
| <td>addV</td> |
| <td>将顶点添加到图形</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#addvertex-step">addV step</a></td> |
| </tr> |
| <tr> |
| <td>and</td> |
| <td>确保所有遍历都返回值</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#add-step">and step</a></td> |
| </tr> |
| <tr> |
| <td>as</td> |
| <td>用于向步骤的输出分配变量的步骤调制器</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#as-step">as step</a></td> |
| </tr> |
| <tr> |
| <td>by</td> |
| <td>与<code>group</code>和<code>order</code>配合使用的步骤调制器</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#by-step">by step</a></td> |
| </tr> |
| <tr> |
| <td>coalesce</td> |
| <td>返回第一个返回结果的遍历</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#coalesce-step">coalesce step</a></td> |
| </tr> |
| <tr> |
| <td>constant</td> |
| <td>返回常量值。 与<code>coalesce</code>配合使用</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#constant-step">constant step</a></td> |
| </tr> |
| <tr> |
| <td>count</td> |
| <td>从遍历返回计数</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#addedge-step">count step</a></td> |
| </tr> |
| <tr> |
| <td>dedup</td> |
| <td>返回已删除重复内容的值</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#dedup-step">dedup step</a></td> |
| </tr> |
| <tr> |
| <td>drop</td> |
| <td>丢弃值（顶点/边缘）</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#drop-step">drop step</a></td> |
| </tr> |
| <tr> |
| <td>fold</td> |
| <td>充当用于计算结果聚合值的屏障</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#fold-step">fold step</a></td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>根据指定的标签将值分组</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#group-step">group step</a></td> |
| </tr> |
| <tr> |
| <td>has</td> |
| <td>用于筛选属性、顶点和边缘。 支持<code>hasLabel</code>、<code>hasId</code>、<code>hasNot</code> 和 <code>has</code> 变体</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#has-step">has step</a></td> |
| </tr> |
| <tr> |
| <td>inject</td> |
| <td>将值注入流中</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#inject-step">inject step</a></td> |
| </tr> |
| <tr> |
| <td>is</td> |
| <td>用于通过布尔表达式执行筛选器</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#is-step">is step</a></td> |
| </tr> |
| <tr> |
| <td>limit</td> |
| <td>用于限制遍历中的项数</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#limit-step">limit step</a></td> |
| </tr> |
| <tr> |
| <td>local</td> |
| <td>本地包装遍历的某个部分，类似于子查询</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#local-step">local step</a></td> |
| </tr> |
| <tr> |
| <td>not</td> |
| <td>用于生成筛选器的求反结果</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#not-step">not step</a></td> |
| </tr> |
| <tr> |
| <td>optional</td> |
| <td>如果生成了某个结果，则返回指定遍历的结果，否则返回调用元素</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#optional-step">optional step</a></td> |
| </tr> |
| <tr> |
| <td>or</td> |
| <td>确保至少有一个遍历会返回值</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#or-step">or step</a></td> |
| </tr> |
| <tr> |
| <td>order</td> |
| <td>按指定的排序顺序返回结果</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#order-step">order step</a></td> |
| </tr> |
| <tr> |
| <td>path</td> |
| <td>返回遍历的完整路径</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#addedge-step">path step</a></td> |
| </tr> |
| <tr> |
| <td>project</td> |
| <td>将属性投影为映射</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#project-step">project step</a></td> |
| </tr> |
| <tr> |
| <td>properties</td> |
| <td>返回指定标签的属性</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#properties-step">properties step</a></td> |
| </tr> |
| <tr> |
| <td>range</td> |
| <td>根据指定的值范围进行筛选</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#range-step">range step</a></td> |
| </tr> |
| <tr> |
| <td>repeat</td> |
| <td>将步骤重复指定的次数。 用于循环</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#repeat-step">repeat step</a></td> |
| </tr> |
| <tr> |
| <td>sample</td> |
| <td>用于对遍历返回的结果采样</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#sample-step">sample step</a></td> |
| </tr> |
| <tr> |
| <td>select</td> |
| <td>用于投影遍历返回的结果</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#select-step">select step</a></td> |
| </tr> |
| <tr> |
| <td>store</td> |
| <td>用于遍历返回的非阻塞聚合</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#store-step">store step</a></td> |
| </tr> |
| <tr> |
| <td>tree</td> |
| <td>将顶点中的路径聚合到树中</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#tree-step">tree step</a></td> |
| </tr> |
| <tr> |
| <td>unfold</td> |
| <td>将迭代器作为步骤展开</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#unfold-step">unfold step</a></td> |
| </tr> |
| <tr> |
| <td>union</td> |
| <td>合并多个遍历返回的结果</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#union-step">union step</a></td> |
| </tr> |
| <tr> |
| <td>V</td> |
| <td>包括顶点与边之间的遍历所需的步骤：<code>V</code>、<code>E</code>、<code>out</code>、<code>in</code>、<code>both</code>、<code>outE</code>、<code>inE</code>、<code>bothE</code>、<code>outV</code>、<code>inV</code>、<code>bothV</code> 和 <code>otherV</code></td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#vertex-steps">order step</a></td> |
| </tr> |
| <tr> |
| <td>where</td> |
| <td>用于筛选遍历返回的结果。 支持 <code>eq</code>、<code>neq</code>、<code>lt</code>、<code>lte</code>、<code>gt</code>、<code>gte</code> 和 <code>between</code> 运算符</td> |
| <td><a href="http://tinkerpop.apache.org/docs/current/reference/#where-step">where step</a></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-29164f631ea2ad7e883c0ba00a843508">7.2 - HugeGraph Examples</h1> |
| |
| <h3 id="1-概述">1 概述</h3> |
| <p>本示例将<a href="http://s3.thinkaurelius.com/docs/titan/1.0.0/getting-started.html">TitanDB Getting Started</a> 为模板来演示HugeGraph的使用方法。通过对比HugeGraph和TitanDB，了解HugeGraph和TitanDB的差异。</p> |
| <h4 id="11-hugegraph与titandb的异同">1.1 HugeGraph与TitanDB的异同</h4> |
| <p>HugeGraph和TitanDB都是基于<a href="https://tinkerpop.apache.org">Apache TinkerPop3</a>框架的图数据库，均支持[Gremlin](<a href="https://tinkerpop.apache">https://tinkerpop.apache</a> |
| .org/gremlin.html)图查询语言，在使用方法和接口方面具有很多相似的地方。然而HugeGraph是全新设计开发的，其代码结构清晰，功能较为丰富，接口更为友好等特点。</p> |
| <p>HugeGraph相对于TitanDB而言，其主要特点如下：</p> |
| <ul> |
| <li>HugeGraph目前有HugeGraph-API、HugeGraph-Client、HugeGraph-Loader、HugeGraph-Studio、HugeGraph-Spark等完善的工具组件，可以完成系统集成、数据载入、图可视化查询、Spark 连接等功能；</li> |
| <li>HugeGraph具有Server和Client的概念，第三方系统可以通过jar引用、client、api等多种方式接入，而TitanDB仅支持jar引用方式接入。</li> |
| <li>HugeGraph的Schema需要显式定义，所有的插入和查询均需要通过严格的schema校验，目前暂不支持schema的隐式创建。</li> |
| <li>HugeGraph充分利用后端存储系统的特点来实现数据高效存取，而TitanDB以统一的Kv结构无视后端的差异性。</li> |
| <li>HugeGraph的更新操作可以实现按需操作（例如：更新某个属性）性能更好。TitanDB的更新是read and update方式。</li> |
| <li>HugeGraph的VertexId和EdgeId均支持拼接，可实现自动去重，同时查询性能更好。TitanDB的所有Id均是自动生成，查询需要经索引。</li> |
| </ul> |
| <h4 id="12-人物关系图谱">1.2 人物关系图谱</h4> |
| <p>本示例通过Property Graph Model图数据模型来描述希腊神话中各人物角色的关系（也被成为人物关系图谱），具体关系详见下图。</p> |
| <center> |
| <img src="/docs/images/graph-of-gods.png" alt="image"> |
| </center> |
| <p>其中，圆形节点代表实体(Vertex)，箭头代表关系（Edge），方框的内容为属性。</p> |
| <p>该关系图谱中有两类顶点，分别是人物（character）和位置（location）如下表：</p> |
| <table> |
| <thead> |
| <tr> |
| <th>名称</th> |
| <th>类型</th> |
| <th>属性</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>character</td> |
| <td>vertex</td> |
| <td>name,age,type</td> |
| </tr> |
| <tr> |
| <td>location</td> |
| <td>vertex</td> |
| <td>name</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>有六种关系，分别是父子（father）、母子（mother）、兄弟（brother）、战斗（battled）、居住(lives)、拥有宠物（pet） 关于关系图谱的具体信息如下：</p> |
| <table> |
| <thead> |
| <tr> |
| <th>名称</th> |
| <th>类型</th> |
| <th>source vertex label</th> |
| <th>target vertex label</th> |
| <th>属性</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>father</td> |
| <td>edge</td> |
| <td>character</td> |
| <td>character</td> |
| <td>-</td> |
| </tr> |
| <tr> |
| <td>mother</td> |
| <td>edge</td> |
| <td>character</td> |
| <td>character</td> |
| <td>-</td> |
| </tr> |
| <tr> |
| <td>brother</td> |
| <td>edge</td> |
| <td>character</td> |
| <td>character</td> |
| <td>-</td> |
| </tr> |
| <tr> |
| <td>pet</td> |
| <td>edge</td> |
| <td>character</td> |
| <td>character</td> |
| <td>-</td> |
| </tr> |
| <tr> |
| <td>lives</td> |
| <td>edge</td> |
| <td>character</td> |
| <td>location</td> |
| <td>reason</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>在HugeGraph中，每个edge label只能作用于一对source vertex label和target vertex label。也就是说，如果一个图内定义了一种关系father连接character和character，那farther就不能再连接其他的vertex labels。</p> |
| <p>因此本例子将原TitanDB中的monster, god, human, demigod均使用相同的<code>vertex label: character</code>来表示, 同时增加属性type来标识人物的类型。<code>edge label</code>与原TitanDB保持一致。当然为了满足<code>edge label</code>约束，也可以通过调整<code>edge label</code>的<code>name</code>来实现。</p> |
| <h3 id="2-graph-schema-and-data-ingest-examples">2 Graph Schema and Data Ingest Examples</h3> |
| <p>HugeGraph需要显示创建Schema，因此需要依次创建PropertyKey、VertexLabel、EdgeLabel，如果有需要索引还需要创建IndexLabel。</p> |
| <h4 id="21-graph-schema">2.1 Graph Schema</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-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:#000">hugegraph</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">"name"</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">"age"</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">"time"</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">"reason"</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">"type"</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></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">"character"</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">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</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">"name"</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">"age"</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">"location"</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">"name"</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">"name"</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">"father"</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"character"</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">"mother"</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"character"</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">"battled"</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"character"</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">"time"</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">"lives"</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"location"</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">"reason"</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">"reason"</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">"pet"</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"character"</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">"brother"</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"character"</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><h4 id="22-graph-data">2.2 Graph Data</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-groovy" data-lang="groovy"><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// add vertices |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">Vertex</span> <span style="color:#000">saturn</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"saturn"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">10000</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"titan"</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">sky</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">"location"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"sky"</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">sea</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">"location"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"sea"</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">jupiter</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"jupiter"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">5000</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"god"</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">neptune</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"neptune"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">4500</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"god"</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">hercules</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"hercules"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">30</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"demigod"</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">alcmene</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"alcmene"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">45</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"human"</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">pluto</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"pluto"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"age"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">4000</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"god"</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">nemean</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"nemean"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"monster"</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">hydra</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"hydra"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"monster"</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">cerberus</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">"character"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"cerberus"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"type"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"monster"</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">tartarus</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">"location"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"name"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"tartarus"</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">// add edges |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">jupiter</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">"father"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">saturn</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">jupiter</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">"lives"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">sky</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"reason"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"loves fresh breezes"</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">jupiter</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">"brother"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">neptune</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">jupiter</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">"brother"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">pluto</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">neptune</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">"lives"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">sea</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"reason"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"loves waves"</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">neptune</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">"brother"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">jupiter</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">neptune</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">"brother"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">pluto</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">hercules</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">"father"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">jupiter</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">hercules</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">"mother"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">alcmene</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">hercules</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">"battled"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">nemean</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"time"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">hercules</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">"battled"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">hydra</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"time"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">2</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">hercules</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">"battled"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">cerberus</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"time"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#0000cf;font-weight:bold">12</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">pluto</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">"brother"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">jupiter</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">pluto</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">"brother"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">neptune</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">pluto</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">"lives"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">tartarus</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"reason"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">"no fear of death"</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">pluto</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">"pet"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">cerberus</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">cerberus</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">"lives"</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#000">tartarus</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><h4 id="23-indices">2.3 Indices</h4> |
| <p>HugeGraph默认是自动生成Id，如果用户通过<code>primaryKeys</code>指定<code>VertexLabel</code>的<code>primaryKeys</code>字段列表后，<code>VertexLabel</code>的Id策略将会自动切换到<code>primaryKeys</code>策略。 启用<code>primaryKeys</code>策略后,HugeGraph通过<code>vertexLabel+primaryKeys</code>拼接生成<code>VertexId</code> ，可实现自动去重，同时无需额外创建索引即可以使用<code>primaryKeys</code>中的属性进行快速查询。 例如 “character” 和 “location” 都有<code>primaryKeys("name")</code>属性，因此在不额外创建索引的情况下可以通过<code>g.V().hasLabel('character') .has('name','hercules')</code>查询vertex 。</p> |
| <h3 id="3-graph-traversal-examples">3 Graph Traversal Examples</h3> |
| <h4 id="31-traversal-query">3.1 Traversal Query</h4> |
| <p><strong>1. Find the grand father of hercules</strong></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:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'character'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">has</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">'hercules'</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:#4e9a06">'father'</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:#4e9a06">'father'</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p>也可以通过<code>repeat</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:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'character'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">has</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">'hercules'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">repeat</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">__</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:#4e9a06">'father'</span><span style="color:#ce5c00;font-weight:bold">)).</span><span style="color:#c4a000">times</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">2</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p><strong>2. Find the name of hercules’s father</strong></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:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'character'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">has</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">'hercules'</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:#4e9a06">'father'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">value</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p><strong>3. Find the characters with age > 100</strong></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:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'character'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">has</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'age'</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#000">gt</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#0000cf;font-weight:bold">100</span><span style="color:#ce5c00;font-weight:bold">))</span> |
| </span></span></code></pre></div><p><strong>4. Find who are pluto’s cohabitants</strong></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:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'character'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">has</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">'pluto'</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:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">in</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">values</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p><strong>5. Find pluto can’t be his own cohabitant</strong></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:#000">pluto</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'character'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">has</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">'pluto'</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">pluto</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:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">in</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">where</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">is</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">neq</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">pluto</span><span style="color:#ce5c00;font-weight:bold">)).</span><span style="color:#c4a000">values</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</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">// use 'as' |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'character'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">has</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">'pluto'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">as</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'x'</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:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">in</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">where</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">neq</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'x'</span><span style="color:#ce5c00;font-weight:bold">)).</span><span style="color:#c4a000">values</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p><strong>6. Pluto’s Brothers</strong></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:#000">pluto</span> <span style="color:#ce5c00;font-weight:bold">=</span> <span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">().</span><span style="color:#c4a000">hasLabel</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'character'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">has</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</span><span style="color:#ce5c00;font-weight:bold">,</span> <span style="color:#4e9a06">'pluto'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">next</span><span style="color:#ce5c00;font-weight:bold">()</span> |
| </span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic">// where do pluto's brothers live? |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">pluto</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:#4e9a06">'brother'</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:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">values</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'name'</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">// which brother lives in which place? |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">pluto</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:#4e9a06">'brother'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">as</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'god'</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:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">as</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'place'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">select</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'god'</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">'place'</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">// what is the name of the brother and the name of the place? |
| </span></span></span><span style="display:flex;"><span><span style="color:#8f5902;font-style:italic"></span><span style="color:#000">g</span><span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#c4a000">V</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#000">pluto</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:#4e9a06">'brother'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">as</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'god'</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:#4e9a06">'lives'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">as</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'place'</span><span style="color:#ce5c00;font-weight:bold">).</span><span style="color:#c4a000">select</span><span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">'god'</span><span style="color:#ce5c00;font-weight:bold">,</span><span style="color:#4e9a06">'place'</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">'name'</span><span style="color:#ce5c00;font-weight:bold">)</span> |
| </span></span></code></pre></div><p>推荐使用<a href="/docs/quickstart/hugegraph-studio">HugeGraph-Studio</a> 通过可视化的方式来执行上述代码。另外也可以通过HugeGraph-Client、HugeApi、GremlinConsole和GremlinDriver等多种方式执行上述代码。</p> |
| <h4 id="32-总结">3.2 总结</h4> |
| <p>HugeGraph 目前支持 <code>Gremlin</code> 的语法，用户可以通过 <code>Gremlin / REST-API</code> 实现各种查询需求。</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-f0a22a813c843322c0d360d952e434ce">8 - PERFORMANCE</h1> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style=""> |
| |
| <h1 id="pg-63f6d63db3ee3a5270fc1ca0a0c0e181">8.1 - HugeGraph BenchMark Performance</h1> |
| |
| <h3 id="1-测试环境">1 测试环境</h3> |
| <h4 id="11-硬件信息">1.1 硬件信息</h4> |
| <table> |
| <thead> |
| <tr> |
| <th>CPU</th> |
| <th>Memory</th> |
| <th>网卡</th> |
| <th>磁盘</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>48 Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz</td> |
| <td>128G</td> |
| <td>10000Mbps</td> |
| <td>750GB SSD</td> |
| </tr> |
| </tbody> |
| </table> |
| <h4 id="12-软件信息">1.2 软件信息</h4> |
| <h5 id="121-测试用例">1.2.1 测试用例</h5> |
| <p>测试使用<a href="https://github.com/socialsensor/graphdb-benchmarks">graphdb-benchmark</a>，一个图数据库测试集。该测试集主要包含4类测试：</p> |
| <ul> |
| <li> |
| <p>Massive Insertion，批量插入顶点和边，一定数量的顶点或边一次性提交</p> |
| </li> |
| <li> |
| <p>Single Insertion，单条插入，每个顶点或者每条边立即提交</p> |
| </li> |
| <li> |
| <p>Query，主要是图数据库的基本查询操作：</p> |
| <ul> |
| <li>Find Neighbors，查询所有顶点的邻居</li> |
| <li>Find Adjacent Nodes，查询所有边的邻接顶点</li> |
| <li>Find Shortest Path，查询第一个顶点到100个随机顶点的最短路径</li> |
| </ul> |
| </li> |
| <li> |
| <p>Clustering，基于Louvain Method的社区发现算法</p> |
| </li> |
| </ul> |
| <h5 id="122-测试数据集">1.2.2 测试数据集</h5> |
| <p>测试使用人造数据和真实数据</p> |
| <ul> |
| <li> |
| <p>MIW、SIW和QW使用SNAP数据集</p> |
| <ul> |
| <li> |
| <p><a href="http://snap.stanford.edu/data/email-Enron.html">Enron Dataset</a></p> |
| </li> |
| <li> |
| <p><a href="http://snap.stanford.edu/data/amazon0601.html">Amazon dataset</a></p> |
| </li> |
| <li> |
| <p><a href="http://snap.stanford.edu/data/com-Youtube.html">Youtube dataset</a></p> |
| </li> |
| <li> |
| <p><a href="http://snap.stanford.edu/data/com-LiveJournal.html">LiveJournal dataset</a></p> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <p>CW使用<a href="https://sites.google.com/site/andrealancichinetti/files">LFR-Benchmark generator</a>生成的人造数据</p> |
| </li> |
| </ul> |
| <h6 id="本测试用到的数据集规模">本测试用到的数据集规模</h6> |
| <table> |
| <thead> |
| <tr> |
| <th>名称</th> |
| <th>vertex数目</th> |
| <th>edge数目</th> |
| <th>文件大小</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>email-enron.txt</td> |
| <td>36,691</td> |
| <td>367,661</td> |
| <td>4MB</td> |
| </tr> |
| <tr> |
| <td>com-youtube.ungraph.txt</td> |
| <td>1,157,806</td> |
| <td>2,987,624</td> |
| <td>38.7MB</td> |
| </tr> |
| <tr> |
| <td>amazon0601.txt</td> |
| <td>403,393</td> |
| <td>3,387,388</td> |
| <td>47.9MB</td> |
| </tr> |
| <tr> |
| <td>com-lj.ungraph.txt</td> |
| <td>3997961</td> |
| <td>34681189</td> |
| <td>479MB</td> |
| </tr> |
| </tbody> |
| </table> |
| <h4 id="13-服务配置">1.3 服务配置</h4> |
| <ul> |
| <li> |
| <p>HugeGraph版本：0.5.6，RestServer和Gremlin Server和backends都在同一台服务器上</p> |
| <ul> |
| <li>RocksDB版本：rocksdbjni-5.8.6</li> |
| </ul> |
| </li> |
| <li> |
| <p>Titan版本：0.5.4, 使用thrift+Cassandra模式</p> |
| <ul> |
| <li>Cassandra版本：cassandra-3.10，commitlog和data共用SSD</li> |
| </ul> |
| </li> |
| <li> |
| <p>Neo4j版本：2.0.1</p> |
| </li> |
| </ul> |
| <blockquote> |
| <p>graphdb-benchmark适配的Titan版本为0.5.4</p> |
| </blockquote> |
| <h3 id="2-测试结果">2 测试结果</h3> |
| <h4 id="21-batch插入性能">2.1 Batch插入性能</h4> |
| <table> |
| <thead> |
| <tr> |
| <th>Backend</th> |
| <th>email-enron(30w)</th> |
| <th>amazon0601(300w)</th> |
| <th>com-youtube.ungraph(300w)</th> |
| <th>com-lj.ungraph(3000w)</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>HugeGraph</td> |
| <td>0.629</td> |
| <td>5.711</td> |
| <td>5.243</td> |
| <td>67.033</td> |
| </tr> |
| <tr> |
| <td>Titan</td> |
| <td>10.15</td> |
| <td>108.569</td> |
| <td>150.266</td> |
| <td>1217.944</td> |
| </tr> |
| <tr> |
| <td>Neo4j</td> |
| <td>3.884</td> |
| <td>18.938</td> |
| <td>24.890</td> |
| <td>281.537</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>表头"（）“中数据是数据规模，以边为单位</li> |
| <li>表中数据是批量插入的时间，单位是s</li> |
| <li>例如，HugeGraph使用RocksDB插入amazon0601数据集的300w条边，花费5.711s</li> |
| </ul> |
| <h5 id="结论">结论</h5> |
| <ul> |
| <li>批量插入性能 HugeGraph(RocksDB) > Neo4j > Titan(thrift+Cassandra)</li> |
| </ul> |
| <h4 id="22-遍历性能">2.2 遍历性能</h4> |
| <h5 id="221-术语说明">2.2.1 术语说明</h5> |
| <ul> |
| <li>FN(Find Neighbor), 遍历所有vertex, 根据vertex查邻接edge, 通过edge和vertex查other vertex</li> |
| <li>FA(Find Adjacent), 遍历所有edge，根据edge获得source vertex和target vertex</li> |
| </ul> |
| <h5 id="222-fn性能">2.2.2 FN性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>Backend</th> |
| <th>email-enron(3.6w)</th> |
| <th>amazon0601(40w)</th> |
| <th>com-youtube.ungraph(120w)</th> |
| <th>com-lj.ungraph(400w)</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>HugeGraph</td> |
| <td>4.072</td> |
| <td>45.118</td> |
| <td>66.006</td> |
| <td>609.083</td> |
| </tr> |
| <tr> |
| <td>Titan</td> |
| <td>8.084</td> |
| <td>92.507</td> |
| <td>184.543</td> |
| <td>1099.371</td> |
| </tr> |
| <tr> |
| <td>Neo4j</td> |
| <td>2.424</td> |
| <td>10.537</td> |
| <td>11.609</td> |
| <td>106.919</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>表头”（）“中数据是数据规模，以顶点为单位</li> |
| <li>表中数据是遍历顶点花费的时间，单位是s</li> |
| <li>例如，HugeGraph使用RocksDB后端遍历amazon0601的所有顶点，并查找邻接边和另一顶点，总共耗时45.118s</li> |
| </ul> |
| <h5 id="223-fa性能">2.2.3 FA性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>Backend</th> |
| <th>email-enron(30w)</th> |
| <th>amazon0601(300w)</th> |
| <th>com-youtube.ungraph(300w)</th> |
| <th>com-lj.ungraph(3000w)</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>HugeGraph</td> |
| <td>1.540</td> |
| <td>10.764</td> |
| <td>11.243</td> |
| <td>151.271</td> |
| </tr> |
| <tr> |
| <td>Titan</td> |
| <td>7.361</td> |
| <td>93.344</td> |
| <td>169.218</td> |
| <td>1085.235</td> |
| </tr> |
| <tr> |
| <td>Neo4j</td> |
| <td>1.673</td> |
| <td>4.775</td> |
| <td>4.284</td> |
| <td>40.507</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>表头”（）“中数据是数据规模，以边为单位</li> |
| <li>表中数据是遍历边花费的时间，单位是s</li> |
| <li>例如，HugeGraph使用RocksDB后端遍历amazon0601的所有边，并查询每条边的两个顶点，总共耗时10.764s</li> |
| </ul> |
| <h6 id="结论-1">结论</h6> |
| <ul> |
| <li>遍历性能 Neo4j > HugeGraph(RocksDB) > Titan(thrift+Cassandra)</li> |
| </ul> |
| <h4 id="23-hugegraph-图常用分析方法性能">2.3 HugeGraph-图常用分析方法性能</h4> |
| <h5 id="术语说明">术语说明</h5> |
| <ul> |
| <li>FS(Find Shortest Path), 寻找最短路径</li> |
| <li>K-neighbor，从起始vertex出发，通过K跳边能够到达的所有顶点, 包括1, 2, 3…(K-1), K跳边可达vertex</li> |
| <li>K-out, 从起始vertex出发，恰好经过K跳out边能够到达的顶点</li> |
| </ul> |
| <h5 id="fs性能">FS性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>Backend</th> |
| <th>email-enron(30w)</th> |
| <th>amazon0601(300w)</th> |
| <th>com-youtube.ungraph(300w)</th> |
| <th>com-lj.ungraph(3000w)</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>HugeGraph</td> |
| <td>0.494</td> |
| <td>0.103</td> |
| <td>3.364</td> |
| <td>8.155</td> |
| </tr> |
| <tr> |
| <td>Titan</td> |
| <td>11.818</td> |
| <td>0.239</td> |
| <td>377.709</td> |
| <td>575.678</td> |
| </tr> |
| <tr> |
| <td>Neo4j</td> |
| <td>1.719</td> |
| <td>1.800</td> |
| <td>1.956</td> |
| <td>8.530</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>表头”（）“中数据是数据规模，以边为单位</li> |
| <li>表中数据是找到<strong>从第一个顶点出发到达随机选择的100个顶点的最短路径</strong>的时间，单位是s</li> |
| <li>例如，HugeGraph使用RocksDB后端在图amazon0601中查找第一个顶点到100个随机顶点的最短路径，总共耗时0.103s</li> |
| </ul> |
| <h6 id="结论-2">结论</h6> |
| <ul> |
| <li>在数据规模小或者顶点关联关系少的场景下，HugeGraph性能优于Neo4j和Titan</li> |
| <li>随着数据规模增大且顶点的关联度增高，HugeGraph与Neo4j性能趋近，都远高于Titan</li> |
| </ul> |
| <h5 id="k-neighbor性能">K-neighbor性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>顶点</th> |
| <th>深度</th> |
| <th>一度</th> |
| <th>二度</th> |
| <th>三度</th> |
| <th>四度</th> |
| <th>五度</th> |
| <th>六度</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>v1</td> |
| <td>时间</td> |
| <td>0.031s</td> |
| <td>0.033s</td> |
| <td>0.048s</td> |
| <td>0.500s</td> |
| <td>11.27s</td> |
| <td>OOM</td> |
| </tr> |
| <tr> |
| <td>v111</td> |
| <td>时间</td> |
| <td>0.027s</td> |
| <td>0.034s</td> |
| <td>0.115</td> |
| <td>1.36s</td> |
| <td>OOM</td> |
| <td>–</td> |
| </tr> |
| <tr> |
| <td>v1111</td> |
| <td>时间</td> |
| <td>0.039s</td> |
| <td>0.027s</td> |
| <td>0.052s</td> |
| <td>0.511s</td> |
| <td>10.96s</td> |
| <td>OOM</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>HugeGraph-Server的JVM内存设置为32GB，数据量过大时会出现OOM</li> |
| </ul> |
| <h5 id="k-out性能">K-out性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>顶点</th> |
| <th>深度</th> |
| <th>一度</th> |
| <th>二度</th> |
| <th>三度</th> |
| <th>四度</th> |
| <th>五度</th> |
| <th>六度</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>v1</td> |
| <td>时间</td> |
| <td>0.054s</td> |
| <td>0.057s</td> |
| <td>0.109s</td> |
| <td>0.526s</td> |
| <td>3.77s</td> |
| <td>OOM</td> |
| </tr> |
| <tr> |
| <td>度</td> |
| <td>10</td> |
| <td>133</td> |
| <td>2453</td> |
| <td>50,830</td> |
| <td>1,128,688</td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>v111</td> |
| <td>时间</td> |
| <td>0.032s</td> |
| <td>0.042s</td> |
| <td>0.136s</td> |
| <td>1.25s</td> |
| <td>20.62s</td> |
| <td>OOM</td> |
| </tr> |
| <tr> |
| <td>度</td> |
| <td>10</td> |
| <td>211</td> |
| <td>4944</td> |
| <td>113150</td> |
| <td>2,629,970</td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>v1111</td> |
| <td>时间</td> |
| <td>0.039s</td> |
| <td>0.045s</td> |
| <td>0.053s</td> |
| <td>1.10s</td> |
| <td>2.92s</td> |
| <td>OOM</td> |
| </tr> |
| <tr> |
| <td>度</td> |
| <td>10</td> |
| <td>140</td> |
| <td>2555</td> |
| <td>50825</td> |
| <td>1,070,230</td> |
| <td></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>HugeGraph-Server的JVM内存设置为32GB，数据量过大时会出现OOM</li> |
| </ul> |
| <h6 id="结论-3">结论</h6> |
| <ul> |
| <li>FS场景，HugeGraph性能优于Neo4j和Titan</li> |
| <li>K-neighbor和K-out场景，HugeGraph能够实现在5度范围内秒级返回结果</li> |
| </ul> |
| <h4 id="24-图综合性能测试-cw">2.4 图综合性能测试-CW</h4> |
| <table> |
| <thead> |
| <tr> |
| <th>数据库</th> |
| <th>规模1000</th> |
| <th>规模5000</th> |
| <th>规模10000</th> |
| <th>规模20000</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>HugeGraph(core)</td> |
| <td>20.804</td> |
| <td>242.099</td> |
| <td>744.780</td> |
| <td>1700.547</td> |
| </tr> |
| <tr> |
| <td>Titan</td> |
| <td>45.790</td> |
| <td>820.633</td> |
| <td>2652.235</td> |
| <td>9568.623</td> |
| </tr> |
| <tr> |
| <td>Neo4j</td> |
| <td>5.913</td> |
| <td>50.267</td> |
| <td>142.354</td> |
| <td>460.880</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>“规模"以顶点为单位</li> |
| <li>表中数据是社区发现完成需要的时间，单位是s，例如HugeGraph使用RocksDB后端在规模10000的数据集，社区聚合不再变化，需要耗时744.780s</li> |
| <li>CW测试是CRUD的综合评估</li> |
| <li>该测试中HugeGraph跟Titan一样，没有通过client，直接对core操作</li> |
| </ul> |
| <h5 id="结论-4">结论</h5> |
| <ul> |
| <li>社区聚类算法性能 Neo4j > HugeGraph > Titan</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-699ebe5daed825049424b7539aad30f9">8.2 - HugeGraph-API Performance</h1> |
| |
| <p>HugeGraph API性能测试主要测试HugeGraph-Server对RESTful API请求的并发处理能力，包括：</p> |
| <ul> |
| <li>顶点/边的单条插入</li> |
| <li>顶点/边的批量插入</li> |
| <li>顶点/边的查询</li> |
| </ul> |
| <p>HugeGraph的每个发布版本的RESTful API的性能测试情况可以参考：</p> |
| <ul> |
| <li><a href="/docs/performance/api-preformance/hugegraph-api-0.5.6-rocksdb/">v0.5.6 stand-alone</a></li> |
| <li><a href="/docs/performance/api-preformance/hugegraph-api-0.5.6-cassandra/">v0.5.6 cluster</a></li> |
| <li><a href="/docs/performance/api-preformance/hugegraph-api-0.4.4/">v0.4.4</a></li> |
| <li><a href="/docs/performance/api-preformance/hugegraph-api-0.2/">v0.2</a></li> |
| </ul> |
| <blockquote> |
| <p>之前的版本只提供HugeGraph所支持的后端种类中性能最好的API性能测试，从0.5.6版本开始，分别提供了单机和集群的性能情况</p> |
| </blockquote> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-dbfafc29a5e930415f78f72c47ee67f2">8.2.1 - v0.5.6 Stand-alone(RocksDB)</h1> |
| |
| <h3 id="1-测试环境">1 测试环境</h3> |
| <p>被压机器信息</p> |
| <table> |
| <thead> |
| <tr> |
| <th>CPU</th> |
| <th>Memory</th> |
| <th>网卡</th> |
| <th>磁盘</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>48 Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz</td> |
| <td>128G</td> |
| <td>10000Mbps</td> |
| <td>750GB SSD,2.7T HDD</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>起压力机器信息：与被压机器同配置</li> |
| <li>测试工具：apache-Jmeter-2.5.1</li> |
| </ul> |
| <p>注：起压机器和被压机器在同一机房</p> |
| <h3 id="2-测试说明">2 测试说明</h3> |
| <h4 id="21-名词定义时间的单位均为ms">2.1 名词定义（时间的单位均为ms）</h4> |
| <ul> |
| <li>Samples – 本次场景中一共完成了多少个线程</li> |
| <li>Average – 平均响应时间</li> |
| <li>Median – 统计意义上面的响应时间的中值</li> |
| <li>90% Line – 所有线程中90%的线程的响应时间都小于xx</li> |
| <li>Min – 最小响应时间</li> |
| <li>Max – 最大响应时间</li> |
| <li>Error – 出错率</li> |
| <li>Throughput – 吞吐量</li> |
| <li>KB/sec – 以流量做衡量的吞吐量</li> |
| </ul> |
| <h4 id="22-底层存储">2.2 底层存储</h4> |
| <p>后端存储使用RocksDB，HugeGraph与RocksDB都在同一机器上启动，server相关的配置文件除主机和端口有修改外，其余均保持默认。</p> |
| <h3 id="3-性能结果总结">3 性能结果总结</h3> |
| <ol> |
| <li>HugeGraph单条插入顶点和边的速度在每秒1w左右</li> |
| <li>顶点和边的批量插入速度远大于单条插入速度</li> |
| <li>按id查询顶点和边的并发度可达到13000以上，且请求的平均延时小于50ms</li> |
| </ol> |
| <h3 id="4-测试结果及分析">4 测试结果及分析</h3> |
| <h4 id="41-batch插入">4.1 batch插入</h4> |
| <h5 id="411-压力上限测试">4.1.1 压力上限测试</h5> |
| <h6 id="测试方法">测试方法</h6> |
| <p>不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数">压力参数</h6> |
| <p>持续时间：5min</p> |
| <h6 id="顶点的最大插入速度">顶点的最大插入速度：</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/rocksdb/vertex_batch.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发2200，顶点的吞吐量是2026.8，每秒可处理的数据：2026.8*200=405360/s</li> |
| </ul> |
| <h6 id="边的最大插入速度">边的最大插入速度</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/rocksdb/edge_batch.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发900，边的吞吐量是776.9，每秒可处理的数据：776.9*500=388450/s</li> |
| </ul> |
| <h4 id="42-single插入">4.2 single插入</h4> |
| <h5 id="421-压力上限测试">4.2.1 压力上限测试</h5> |
| <h6 id="测试方法-1">测试方法</h6> |
| <p>不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数-1">压力参数</h6> |
| <ul> |
| <li>持续时间：5min</li> |
| <li>服务异常标志：错误率大于0.00%</li> |
| </ul> |
| <h6 id="顶点的单条插入">顶点的单条插入</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/rocksdb/vertex_single.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发11500，吞吐量为10730，顶点的单条插入并发能力为11500</li> |
| </ul> |
| <h6 id="边的单条插入">边的单条插入</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/rocksdb/edge_single.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发9000，吞吐量是8418，边的单条插入并发能力为9000</li> |
| </ul> |
| <h4 id="43-按id查询">4.3 按id查询</h4> |
| <h5 id="431-压力上限测试">4.3.1 压力上限测试</h5> |
| <h6 id="测试方法-2">测试方法</h6> |
| <p>不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数-2">压力参数</h6> |
| <ul> |
| <li>持续时间：5min</li> |
| <li>服务异常标志：错误率大于0.00%</li> |
| </ul> |
| <h6 id="顶点的按id查询">顶点的按id查询</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/rocksdb/vertex_id_query.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发14000，吞吐量是12663，顶点的按id查询的并发能力为14000，平均延时为44ms</li> |
| </ul> |
| <h6 id="边的按id查询">边的按id查询</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/rocksdb/edge_id_query.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发13000，吞吐量是12225，边的按id查询的并发能力为13000，平均延时为12ms</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-fd5b165e28a07f1c35ab177b10e15dc8">8.2.2 - v0.5.6 Cluster(Cassandra)</h1> |
| |
| <h3 id="1-测试环境">1 测试环境</h3> |
| <p>被压机器信息</p> |
| <table> |
| <thead> |
| <tr> |
| <th>CPU</th> |
| <th>Memory</th> |
| <th>网卡</th> |
| <th>磁盘</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>48 Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz</td> |
| <td>128G</td> |
| <td>10000Mbps</td> |
| <td>750GB SSD,2.7T HDD</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>起压力机器信息：与被压机器同配置</li> |
| <li>测试工具：apache-Jmeter-2.5.1</li> |
| </ul> |
| <p>注：起压机器和被压机器在同一机房</p> |
| <h3 id="2-测试说明">2 测试说明</h3> |
| <h4 id="21-名词定义时间的单位均为ms">2.1 名词定义（时间的单位均为ms）</h4> |
| <ul> |
| <li>Samples – 本次场景中一共完成了多少个线程</li> |
| <li>Average – 平均响应时间</li> |
| <li>Median – 统计意义上面的响应时间的中值</li> |
| <li>90% Line – 所有线程中90%的线程的响应时间都小于xx</li> |
| <li>Min – 最小响应时间</li> |
| <li>Max – 最大响应时间</li> |
| <li>Error – 出错率</li> |
| <li>Throughput – 吞吐量</li> |
| <li>KB/sec – 以流量做衡量的吞吐量</li> |
| </ul> |
| <h4 id="22-底层存储">2.2 底层存储</h4> |
| <p>后端存储使用15节点Cassandra集群，HugeGraph与Cassandra集群位于不同的服务器，server相关的配置文件除主机和端口有修改外，其余均保持默认。</p> |
| <h3 id="3-性能结果总结">3 性能结果总结</h3> |
| <ol> |
| <li>HugeGraph单条插入顶点和边的速度分别为9000和4500</li> |
| <li>顶点和边的批量插入速度分别为5w/s和15w/s，远大于单条插入速度</li> |
| <li>按id查询顶点和边的并发度可达到12000以上，且请求的平均延时小于70ms</li> |
| </ol> |
| <h3 id="4-测试结果及分析">4 测试结果及分析</h3> |
| <h4 id="41-batch插入">4.1 batch插入</h4> |
| <h5 id="411-压力上限测试">4.1.1 压力上限测试</h5> |
| <h6 id="测试方法">测试方法</h6> |
| <p>不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数">压力参数</h6> |
| <p>持续时间：5min</p> |
| <h6 id="顶点的最大插入速度">顶点的最大插入速度：</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/cassandra/vertex_batch.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发3500，顶点的吞吐量是261，每秒可处理的数据：261*200=52200/s</li> |
| </ul> |
| <h6 id="边的最大插入速度">边的最大插入速度</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/cassandra/edge_batch.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发1000，边的吞吐量是323，每秒可处理的数据：323*500=161500/s</li> |
| </ul> |
| <h4 id="42-single插入">4.2 single插入</h4> |
| <h5 id="421-压力上限测试">4.2.1 压力上限测试</h5> |
| <h6 id="测试方法-1">测试方法</h6> |
| <p>不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数-1">压力参数</h6> |
| <ul> |
| <li>持续时间：5min</li> |
| <li>服务异常标志：错误率大于0.00%</li> |
| </ul> |
| <h6 id="顶点的单条插入">顶点的单条插入</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/cassandra/vertex_single.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发9000，吞吐量为8400，顶点的单条插入并发能力为9000</li> |
| </ul> |
| <h6 id="边的单条插入">边的单条插入</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/cassandra/edge_single.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发4500，吞吐量是4160，边的单条插入并发能力为4500</li> |
| </ul> |
| <h4 id="43-按id查询">4.3 按id查询</h4> |
| <h5 id="431-压力上限测试">4.3.1 压力上限测试</h5> |
| <h6 id="测试方法-2">测试方法</h6> |
| <p>不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数-2">压力参数</h6> |
| <ul> |
| <li>持续时间：5min</li> |
| <li>服务异常标志：错误率大于0.00%</li> |
| </ul> |
| <h6 id="顶点的按id查询">顶点的按id查询</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/cassandra/vertex_id_query.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发14500，吞吐量是13576，顶点的按id查询的并发能力为14500，平均延时为11ms</li> |
| </ul> |
| <h6 id="边的按id查询">边的按id查询</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.5.6/cassandra/edge_id_query.png" alt="image"> |
| </center> |
| <p>####### 结论：</p> |
| <ul> |
| <li>并发12000，吞吐量是10688，边的按id查询的并发能力为12000，平均延时为63ms</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-0005aca20e30ef2795411939ccbf0fd9">8.2.3 - v0.4.4</h1> |
| |
| <h3 id="1-测试环境">1 测试环境</h3> |
| <p>被压机器信息</p> |
| <table> |
| <thead> |
| <tr> |
| <th>机器编号</th> |
| <th>CPU</th> |
| <th>Memory</th> |
| <th>网卡</th> |
| <th>磁盘</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>1</td> |
| <td>24 Intel(R) Xeon(R) CPU E5-2620 v2 @ 2.10GHz</td> |
| <td>61G</td> |
| <td>1000Mbps</td> |
| <td>1.4T HDD</td> |
| </tr> |
| <tr> |
| <td>2</td> |
| <td>48 Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz</td> |
| <td>128G</td> |
| <td>10000Mbps</td> |
| <td>750GB SSD,2.7T HDD</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>起压力机器信息：与编号 1 机器同配置</li> |
| <li>测试工具：apache-Jmeter-2.5.1</li> |
| </ul> |
| <p>注：起压机器和被压机器在同一机房</p> |
| <h3 id="2-测试说明">2 测试说明</h3> |
| <h4 id="21-名词定义时间的单位均为ms">2.1 名词定义（时间的单位均为ms）</h4> |
| <ul> |
| <li>Samples – 本次场景中一共完成了多少个线程</li> |
| <li>Average – 平均响应时间</li> |
| <li>Median – 统计意义上面的响应时间的中值</li> |
| <li>90% Line – 所有线程中90%的线程的响应时间都小于xx</li> |
| <li>Min – 最小响应时间</li> |
| <li>Max – 最大响应时间</li> |
| <li>Error – 出错率</li> |
| <li>Throughput – 吞吐量</li> |
| <li>KB/sec – 以流量做衡量的吞吐量</li> |
| </ul> |
| <h4 id="22-底层存储">2.2 底层存储</h4> |
| <p>后端存储使用RocksDB，HugeGraph与RocksDB都在同一机器上启动，server相关的配置文件除主机和端口有修改外，其余均保持默认。</p> |
| <h3 id="3-性能结果总结">3 性能结果总结</h3> |
| <ol> |
| <li>HugeGraph每秒能够处理的请求数目上限是7000</li> |
| <li>批量插入速度远大于单条插入，在服务器上测试结果达到22w edges/s，37w vertices/s</li> |
| <li>后端是RocksDB，增大CPU数目和内存大小可以增大批量插入的性能。CPU和内存扩大一倍，性能增加45%-60%</li> |
| <li>批量插入场景，使用SSD替代HDD，性能提升较小，只有3%-5%</li> |
| </ol> |
| <h3 id="4-测试结果及分析">4 测试结果及分析</h3> |
| <h4 id="41-batch插入">4.1 batch插入</h4> |
| <h5 id="411-压力上限测试">4.1.1 压力上限测试</h5> |
| <h6 id="测试方法">测试方法</h6> |
| <p>不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数">压力参数</h6> |
| <p>持续时间：5min</p> |
| <h6 id="顶点和边的最大插入速度高性能服务器使用ssd存储rocksdb数据">顶点和边的最大插入速度（高性能服务器，使用SSD存储RocksDB数据）：</h6> |
| <center> |
| <img src="/docs/images/API-perf/v0.4.4/best.png" alt="image"> |
| </center> |
| <h6 id="结论">结论：</h6> |
| <ul> |
| <li>并发1000，边的吞吐量是是451，每秒可处理的数据：451*500条=225500/s</li> |
| <li>并发2000，顶点的吞吐量是1842.4，每秒可处理的数据：1842.4*200=368480/s</li> |
| </ul> |
| <p><strong>1. CPU和内存对插入性能的影响（服务器都使用HDD存储RocksDB数据，批量插入）</strong></p> |
| <center> |
| <img src="/docs/images/API-perf/v0.4.4/cpu-memory.png" alt="image"> |
| </center> |
| <h6 id="结论-1">结论：</h6> |
| <ul> |
| <li>同样使用HDD硬盘，CPU和内存增加了1倍</li> |
| <li>边：吞吐量从268提升至426，性能提升了约60%</li> |
| <li>顶点：吞吐量从1263.8提升至1842.4，性能提升了约45%</li> |
| </ul> |
| <p><strong>2. SSD和HDD对插入性能的影响（高性能服务器，批量插入）</strong></p> |
| <center> |
| <img src="/docs/images/API-perf/v0.4.4/ssd.png" alt="image"> |
| </center> |
| <h6 id="结论-2">结论：</h6> |
| <ul> |
| <li>边：使用SSD吞吐量451.7,使用HDD吞吐量426.6，性能提升5%</li> |
| <li>顶点：使用SSD吞吐量1842.4，使用HDD吞吐量1794，性能提升约3%</li> |
| </ul> |
| <p><strong>3. 不同并发线程数对插入性能的影响（普通服务器，使用HDD存储RocksDB数据）</strong></p> |
| <center> |
| <img src="/docs/images/API-perf/v0.4.4/threads-batch.png" alt="image"> |
| </center> |
| <h6 id="结论-3">结论：</h6> |
| <ul> |
| <li>顶点：1000并发，响应时间7ms和1500并发响应时间1028ms差距悬殊，且吞吐量一直保持在1300左右，因此拐点数据应该在1300 ，且并发1300时，响应时间已达到22ms，在可控范围内，相比HugeGraph 0.2（1000并发：平均响应时间8959ms），处理能力出现质的飞跃；</li> |
| <li>边：从1000并发到2000并发，处理时间过长，超过3s，且吞吐量几乎在270左右浮动，因此继续增大并发线程数吞吐量不会再大幅增长，270 是一个拐点，跟HugeGraph 0.2版本（1000并发：平均响应时间31849ms）相比较，处理能力提升非常明显；</li> |
| </ul> |
| <h4 id="42-single插入">4.2 single插入</h4> |
| <h5 id="421-压力上限测试">4.2.1 压力上限测试</h5> |
| <h6 id="测试方法-1">测试方法</h6> |
| <p>不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数-1">压力参数</h6> |
| <ul> |
| <li>持续时间：5min</li> |
| <li>服务异常标志：错误率大于0.00%</li> |
| </ul> |
| <center> |
| <img src="/docs/images/API-perf/v0.4.4/threads-single.png" alt="image"> |
| </center> |
| <h6 id="结论-4">结论：</h6> |
| <ul> |
| <li>顶点： |
| <ul> |
| <li>4000并发：正常，无错误率，平均耗时小于1ms， 6000并发无错误，平均耗时5ms，在可接受范围内；</li> |
| <li>8000并发：存在0.01%的错误，已经无法处理，出现connection timeout错误，顶峰应该在7000左右</li> |
| </ul> |
| </li> |
| <li>边： |
| <ul> |
| <li>4000并发：响应时间1ms，6000并发无任何异常，平均响应时间8ms，主要差异在于 IO network recv和send以及CPU）；</li> |
| <li>8000并发：存在0.01%的错误率，平均耗15ms，拐点应该在7000左右，跟顶点结果匹配；</li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-d4233a3feb070643ef5d54a6f9c12cab">8.2.4 - v0.2</h1> |
| |
| <h3 id="1-测试环境">1 测试环境</h3> |
| <h4 id="11-软硬件信息">1.1 软硬件信息</h4> |
| <p>起压和被压机器配置相同，基本参数如下：</p> |
| <table> |
| <thead> |
| <tr> |
| <th>CPU</th> |
| <th>Memory</th> |
| <th>网卡</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>24 Intel(R) Xeon(R) CPU E5-2620 v2 @ 2.10GHz</td> |
| <td>61G</td> |
| <td>1000Mbps</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>测试工具：apache-Jmeter-2.5.1</p> |
| <h4 id="12-服务配置">1.2 服务配置</h4> |
| <ul> |
| <li>HugeGraph版本：0.2</li> |
| <li>后端存储：使用服务内嵌的cassandra-3.10，单点部署；</li> |
| <li>后端配置修改：修改了cassandra.yaml文件中的以下两个属性，其余选项均保持默认</li> |
| </ul> |
| <pre tabindex="0"><code> batch_size_warn_threshold_in_kb: 1000 |
| batch_size_fail_threshold_in_kb: 1000 |
| </code></pre><ul> |
| <li>HugeGraphServer 与 HugeGremlinServer 与cassandra都在同一机器上启动，server 相关的配置文件除主机和端口有修改外，其余均保持默认。</li> |
| </ul> |
| <h4 id="13-名词解释">1.3 名词解释</h4> |
| <ul> |
| <li>Samples – 本次场景中一共完成了多少个线程</li> |
| <li>Average – 平均响应时间</li> |
| <li>Median – 统计意义上面的响应时间的中值</li> |
| <li>90% Line – 所有线程中90%的线程的响应时间都小于xx</li> |
| <li>Min – 最小响应时间</li> |
| <li>Max – 最大响应时间</li> |
| <li>Error – 出错率</li> |
| <li>Troughput – 吞吐量Â</li> |
| <li>KB/sec – 以流量做衡量的吞吐量</li> |
| </ul> |
| <p><em>注：时间的单位均为ms</em></p> |
| <h3 id="2-测试结果">2 测试结果</h3> |
| <h4 id="21-schema">2.1 schema</h4> |
| <table> |
| <thead> |
| <tr> |
| <th>Label</th> |
| <th>Samples</th> |
| <th>Average</th> |
| <th>Median</th> |
| <th>90%Line</th> |
| <th>Min</th> |
| <th>Max</th> |
| <th>Error%</th> |
| <th>Throughput</th> |
| <th>KB/sec</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>property_keys</td> |
| <td>331000</td> |
| <td>1</td> |
| <td>1</td> |
| <td>2</td> |
| <td>0</td> |
| <td>172</td> |
| <td>0.00%</td> |
| <td>920.7/sec</td> |
| <td>178.1</td> |
| </tr> |
| <tr> |
| <td>vertex_labels</td> |
| <td>331000</td> |
| <td>1</td> |
| <td>2</td> |
| <td>2</td> |
| <td>1</td> |
| <td>126</td> |
| <td>0.00%</td> |
| <td>920.7/sec</td> |
| <td>193.4</td> |
| </tr> |
| <tr> |
| <td>edge_labels</td> |
| <td>331000</td> |
| <td>2</td> |
| <td>2</td> |
| <td>3</td> |
| <td>1</td> |
| <td>158</td> |
| <td>0.00%</td> |
| <td>920.7/sec</td> |
| <td>242.8</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>结论：schema的接口，在1000并发持续5分钟的压力下，平均响应时间1-2ms，无压力</p> |
| <h4 id="22-single-插入">2.2 single 插入</h4> |
| <h5 id="221-插入速率测试">2.2.1 插入速率测试</h5> |
| <h6 id="压力参数">压力参数</h6> |
| <p>测试方法：固定并发量，测试server和后端的处理速率</p> |
| <ul> |
| <li>并发量：1000</li> |
| <li>持续时间：5min</li> |
| </ul> |
| <h6 id="性能指标">性能指标</h6> |
| <table> |
| <thead> |
| <tr> |
| <th>Label</th> |
| <th>Samples</th> |
| <th>Average</th> |
| <th>Median</th> |
| <th>90%Line</th> |
| <th>Min</th> |
| <th>Max</th> |
| <th>Error%</th> |
| <th>Throughput</th> |
| <th>KB/sec</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>single_insert_vertices</td> |
| <td>331000</td> |
| <td>0</td> |
| <td>1</td> |
| <td>1</td> |
| <td>0</td> |
| <td>21</td> |
| <td>0.00%</td> |
| <td>920.7/sec</td> |
| <td>234.4</td> |
| </tr> |
| <tr> |
| <td>single_insert_edges</td> |
| <td>331000</td> |
| <td>2</td> |
| <td>2</td> |
| <td>3</td> |
| <td>1</td> |
| <td>53</td> |
| <td>0.00%</td> |
| <td>920.7/sec</td> |
| <td>309.1</td> |
| </tr> |
| </tbody> |
| </table> |
| <h6 id="结论">结论</h6> |
| <ul> |
| <li>顶点：平均响应时间1ms，每个请求插入一条数据，平均每秒处理920个请求，则每秒平均总共处理的数据为1*920约等于920条数据；</li> |
| <li>边：平均响应时间1ms，每个请求插入一条数据，平均每秒处理920个请求，则每秒平均总共处理的数据为1*920约等于920条数据；</li> |
| </ul> |
| <h5 id="222-压力上限测试">2.2.2 压力上限测试</h5> |
| <p>测试方法：不断提升并发量，测试server仍能正常提供服务的压力上限</p> |
| <h6 id="压力参数-1">压力参数</h6> |
| <ul> |
| <li>持续时间：5min</li> |
| <li>服务异常标志：错误率大于0.00%</li> |
| </ul> |
| <h6 id="性能指标-1">性能指标</h6> |
| <table> |
| <thead> |
| <tr> |
| <th>Concurrency</th> |
| <th>Samples</th> |
| <th>Average</th> |
| <th>Median</th> |
| <th>90%Line</th> |
| <th>Min</th> |
| <th>Max</th> |
| <th>Error%</th> |
| <th>Throughput</th> |
| <th>KB/sec</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>2000(vertex)</td> |
| <td>661916</td> |
| <td>1</td> |
| <td>1</td> |
| <td>1</td> |
| <td>0</td> |
| <td>3012</td> |
| <td>0.00%</td> |
| <td>1842.9/sec</td> |
| <td>469.1</td> |
| </tr> |
| <tr> |
| <td>4000(vertex)</td> |
| <td>1316124</td> |
| <td>13</td> |
| <td>1</td> |
| <td>14</td> |
| <td>0</td> |
| <td>9023</td> |
| <td>0.00%</td> |
| <td>3673.1/sec</td> |
| <td>935.0</td> |
| </tr> |
| <tr> |
| <td>5000(vertex)</td> |
| <td>1468121</td> |
| <td>1010</td> |
| <td>1135</td> |
| <td>1227</td> |
| <td>0</td> |
| <td>9223</td> |
| <td>0.06%</td> |
| <td>4095.6/sec</td> |
| <td>1046.0</td> |
| </tr> |
| <tr> |
| <td>7000(vertex)</td> |
| <td>1378454</td> |
| <td>1617</td> |
| <td>1708</td> |
| <td>1886</td> |
| <td>0</td> |
| <td>9361</td> |
| <td>0.08%</td> |
| <td>3860.3/sec</td> |
| <td>987.1</td> |
| </tr> |
| <tr> |
| <td>2000(edge)</td> |
| <td>629399</td> |
| <td>953</td> |
| <td>1043</td> |
| <td>1113</td> |
| <td>1</td> |
| <td>9001</td> |
| <td>0.00%</td> |
| <td>1750.3/sec</td> |
| <td>587.6</td> |
| </tr> |
| <tr> |
| <td>3000(edge)</td> |
| <td>648364</td> |
| <td>2258</td> |
| <td>2404</td> |
| <td>2500</td> |
| <td>2</td> |
| <td>9001</td> |
| <td>0.00%</td> |
| <td>1810.7/sec</td> |
| <td>607.9</td> |
| </tr> |
| <tr> |
| <td>4000(edge)</td> |
| <td>649904</td> |
| <td>1992</td> |
| <td>2112</td> |
| <td>2211</td> |
| <td>1</td> |
| <td>9001</td> |
| <td>0.06%</td> |
| <td>1812.5/sec</td> |
| <td>608.5</td> |
| </tr> |
| </tbody> |
| </table> |
| <h6 id="结论-1">结论</h6> |
| <ul> |
| <li>顶点： |
| <ul> |
| <li>4000并发：正常，无错误率，平均耗时13ms；</li> |
| <li>5000并发：每秒处理5000个数据的插入，就会存在0.06%的错误，应该已经处理不了了，顶峰应该在4000</li> |
| </ul> |
| </li> |
| <li>边： |
| <ul> |
| <li>1000并发：响应时间2ms，跟2000并发的响应时间相差较多，主要是 IO network rec和send以及CPU几乎增加了一倍）；</li> |
| <li>2000并发：每秒处理2000个数据的插入，平均耗时953ms，平均每秒处理1750个请求；</li> |
| <li>3000并发：每秒处理3000个数据的插入，平均耗时2258ms，平均每秒处理1810个请求；</li> |
| <li>4000并发：每秒处理4000个数据的插入，平均每秒处理1812个请求；</li> |
| </ul> |
| </li> |
| </ul> |
| <h4 id="23-batch-插入">2.3 batch 插入</h4> |
| <h5 id="231-插入速率测试">2.3.1 插入速率测试</h5> |
| <h6 id="压力参数-2">压力参数</h6> |
| <p>测试方法：固定并发量，测试server和后端的处理速率</p> |
| <ul> |
| <li>并发量：1000</li> |
| <li>持续时间：5min</li> |
| </ul> |
| <h6 id="性能指标-2">性能指标</h6> |
| <table> |
| <thead> |
| <tr> |
| <th>Label</th> |
| <th>Samples</th> |
| <th>Average</th> |
| <th>Median</th> |
| <th>90%Line</th> |
| <th>Min</th> |
| <th>Max</th> |
| <th>Error%</th> |
| <th>Throughput</th> |
| <th>KB/sec</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>batch_insert_vertices</td> |
| <td>37162</td> |
| <td>8959</td> |
| <td>9595</td> |
| <td>9704</td> |
| <td>17</td> |
| <td>9852</td> |
| <td>0.00%</td> |
| <td>103.4/sec</td> |
| <td>393.3</td> |
| </tr> |
| <tr> |
| <td>batch_insert_edges</td> |
| <td>10800</td> |
| <td>31849</td> |
| <td>34544</td> |
| <td>35132</td> |
| <td>435</td> |
| <td>35747</td> |
| <td>0.00%</td> |
| <td>28.8/sec</td> |
| <td>814.9</td> |
| </tr> |
| </tbody> |
| </table> |
| <h6 id="结论-2">结论</h6> |
| <ul> |
| <li>顶点：平均响应时间为8959ms，处理时间过长。每个请求插入199条数据，平均每秒处理103个请求，则每秒平均总共处理的数据为199*131约等于2w条数据；</li> |
| <li>边：平均响应时间31849ms，处理时间过长。每个请求插入499个数据，平均每秒处理28个请求，则每秒平均总共处理的数据为28*499约等于13900条数据；</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-8e73cd18ae7e460700391440de46c404">8.3 - HugeGraph-Loader Performance</h1> |
| |
| <h2 id="使用场景">使用场景</h2> |
| <p>当要批量插入的图数据（包括顶点和边）条数为billion级别及以下，或者总数据量小于TB时，可以采用<a href="/docs/quickstart/hugegraph-loader">HugeGraph-Loader</a>工具持续、高速导入图数据</p> |
| <h2 id="性能">性能</h2> |
| <blockquote> |
| <p>测试均采用网址数据的边数据</p> |
| </blockquote> |
| <h3 id="rocksdb单机性能">RocksDB单机性能</h3> |
| <ul> |
| <li>关闭label index，22.8w edges/s</li> |
| <li>开启label index，15.3w edges/s</li> |
| </ul> |
| <h3 id="cassandra集群性能">Cassandra集群性能</h3> |
| <ul> |
| <li>默认开启label index，6.3w edges/s</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-0b6ebbdbce17d47f26fcb874226e5edc">8.4 - </h1> |
| |
| <h3 id="1-测试环境">1 测试环境</h3> |
| <h4 id="11-硬件信息">1.1 硬件信息</h4> |
| <table> |
| <thead> |
| <tr> |
| <th>CPU</th> |
| <th>Memory</th> |
| <th>网卡</th> |
| <th>磁盘</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>48 Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz</td> |
| <td>128G</td> |
| <td>10000Mbps</td> |
| <td>750GB SSD</td> |
| </tr> |
| </tbody> |
| </table> |
| <h4 id="12-软件信息">1.2 软件信息</h4> |
| <h5 id="121-测试用例">1.2.1 测试用例</h5> |
| <p>测试使用<a href="https://github.com/socialsensor/graphdb-benchmarks">graphdb-benchmark</a>，一个图数据库测试集。该测试集主要包含4类测试：</p> |
| <ul> |
| <li> |
| <p>Massive Insertion，批量插入顶点和边，一定数量的顶点或边一次性提交</p> |
| </li> |
| <li> |
| <p>Single Insertion，单条插入，每个顶点或者每条边立即提交</p> |
| </li> |
| <li> |
| <p>Query，主要是图数据库的基本查询操作：</p> |
| <ul> |
| <li>Find Neighbors，查询所有顶点的邻居</li> |
| <li>Find Adjacent Nodes，查询所有边的邻接顶点</li> |
| <li>Find Shortest Path，查询第一个顶点到100个随机顶点的最短路径</li> |
| </ul> |
| </li> |
| <li> |
| <p>Clustering，基于Louvain Method的社区发现算法</p> |
| </li> |
| </ul> |
| <h5 id="122-测试数据集">1.2.2 测试数据集</h5> |
| <p>测试使用人造数据和真实数据</p> |
| <ul> |
| <li> |
| <p>MIW、SIW和QW使用SNAP数据集</p> |
| <ul> |
| <li> |
| <p><a href="http://snap.stanford.edu/data/email-Enron.html">Enron Dataset</a></p> |
| </li> |
| <li> |
| <p><a href="http://snap.stanford.edu/data/amazon0601.html">Amazon dataset</a></p> |
| </li> |
| <li> |
| <p><a href="http://snap.stanford.edu/data/com-Youtube.html">Youtube dataset</a></p> |
| </li> |
| <li> |
| <p><a href="http://snap.stanford.edu/data/com-LiveJournal.html">LiveJournal dataset</a></p> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <p>CW使用<a href="https://sites.google.com/site/andrealancichinetti/files">LFR-Benchmark generator</a>生成的人造数据</p> |
| </li> |
| </ul> |
| <h6 id="本测试用到的数据集规模">本测试用到的数据集规模</h6> |
| <table> |
| <thead> |
| <tr> |
| <th>名称</th> |
| <th>vertex数目</th> |
| <th>edge数目</th> |
| <th>文件大小</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>email-enron.txt</td> |
| <td>36,691</td> |
| <td>367,661</td> |
| <td>4MB</td> |
| </tr> |
| <tr> |
| <td>com-youtube.ungraph.txt</td> |
| <td>1,157,806</td> |
| <td>2,987,624</td> |
| <td>38.7MB</td> |
| </tr> |
| <tr> |
| <td>amazon0601.txt</td> |
| <td>403,393</td> |
| <td>3,387,388</td> |
| <td>47.9MB</td> |
| </tr> |
| </tbody> |
| </table> |
| <h4 id="13-服务配置">1.3 服务配置</h4> |
| <ul> |
| <li>HugeGraph版本：0.4.4，RestServer和Gremlin Server和backends都在同一台服务器上</li> |
| <li>Cassandra版本：cassandra-3.10，commitlog和data共用SSD</li> |
| <li>RocksDB版本：rocksdbjni-5.8.6</li> |
| <li>Titan版本：0.5.4, 使用thrift+Cassandra模式</li> |
| </ul> |
| <blockquote> |
| <p>graphdb-benchmark适配的Titan版本为0.5.4</p> |
| </blockquote> |
| <h3 id="2-测试结果">2 测试结果</h3> |
| <h4 id="21-batch插入性能">2.1 Batch插入性能</h4> |
| <table> |
| <thead> |
| <tr> |
| <th>Backend</th> |
| <th>email-enron(30w)</th> |
| <th>amazon0601(300w)</th> |
| <th>com-youtube.ungraph(300w)</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Titan</td> |
| <td>9.516</td> |
| <td>88.123</td> |
| <td>111.586</td> |
| </tr> |
| <tr> |
| <td>RocksDB</td> |
| <td>2.345</td> |
| <td>14.076</td> |
| <td>16.636</td> |
| </tr> |
| <tr> |
| <td>Cassandra</td> |
| <td>11.930</td> |
| <td>108.709</td> |
| <td>101.959</td> |
| </tr> |
| <tr> |
| <td>Memory</td> |
| <td>3.077</td> |
| <td>15.204</td> |
| <td>13.841</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>表头"（）“中数据是数据规模，以边为单位</li> |
| <li>表中数据是批量插入的时间，单位是s</li> |
| <li>例如，HugeGraph使用RocksDB插入amazon0601数据集的300w条边，花费14.076s，速度约为21w edges/s</li> |
| </ul> |
| <h5 id="结论">结论</h5> |
| <ul> |
| <li>RocksDB和Memory后端插入性能优于Cassandra</li> |
| <li>HugeGraph和Titan同样使用Cassandra作为后端的情况下，插入性能接近</li> |
| </ul> |
| <h4 id="22-遍历性能">2.2 遍历性能</h4> |
| <h5 id="221-术语说明">2.2.1 术语说明</h5> |
| <ul> |
| <li>FN(Find Neighbor), 遍历所有vertex, 根据vertex查邻接edge, 通过edge和vertex查other vertex</li> |
| <li>FA(Find Adjacent), 遍历所有edge，根据edge获得source vertex和target vertex</li> |
| </ul> |
| <h5 id="222-fn性能">2.2.2 FN性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>Backend</th> |
| <th>email-enron(3.6w)</th> |
| <th>amazon0601(40w)</th> |
| <th>com-youtube.ungraph(120w)</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Titan</td> |
| <td>7.724</td> |
| <td>70.935</td> |
| <td>128.884</td> |
| </tr> |
| <tr> |
| <td>RocksDB</td> |
| <td>8.876</td> |
| <td>65.852</td> |
| <td>63.388</td> |
| </tr> |
| <tr> |
| <td>Cassandra</td> |
| <td>13.125</td> |
| <td>126.959</td> |
| <td>102.580</td> |
| </tr> |
| <tr> |
| <td>Memory</td> |
| <td>22.309</td> |
| <td>207.411</td> |
| <td>165.609</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>表头”（）“中数据是数据规模，以顶点为单位</li> |
| <li>表中数据是遍历顶点花费的时间，单位是s</li> |
| <li>例如，HugeGraph使用RocksDB后端遍历amazon0601的所有顶点，并查找邻接边和另一顶点，总共耗时65.852s</li> |
| </ul> |
| <h5 id="223-fa性能">2.2.3 FA性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>Backend</th> |
| <th>email-enron(30w)</th> |
| <th>amazon0601(300w)</th> |
| <th>com-youtube.ungraph(300w)</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Titan</td> |
| <td>7.119</td> |
| <td>63.353</td> |
| <td>115.633</td> |
| </tr> |
| <tr> |
| <td>RocksDB</td> |
| <td>6.032</td> |
| <td>64.526</td> |
| <td>52.721</td> |
| </tr> |
| <tr> |
| <td>Cassandra</td> |
| <td>9.410</td> |
| <td>102.766</td> |
| <td>94.197</td> |
| </tr> |
| <tr> |
| <td>Memory</td> |
| <td>12.340</td> |
| <td>195.444</td> |
| <td>140.89</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>表头”（）“中数据是数据规模，以边为单位</li> |
| <li>表中数据是遍历边花费的时间，单位是s</li> |
| <li>例如，HugeGraph使用RocksDB后端遍历amazon0601的所有边，并查询每条边的两个顶点，总共耗时64.526s</li> |
| </ul> |
| <h6 id="结论-1">结论</h6> |
| <ul> |
| <li>HugeGraph RocksDB > Titan thrift+Cassandra > HugeGraph Cassandra > HugeGraph Memory</li> |
| </ul> |
| <h4 id="23-hugegraph-图常用分析方法性能">2.3 HugeGraph-图常用分析方法性能</h4> |
| <h5 id="术语说明">术语说明</h5> |
| <ul> |
| <li>FS(Find Shortest Path), 寻找最短路径</li> |
| <li>K-neighbor，从起始vertex出发，通过K跳边能够到达的所有顶点, 包括1, 2, 3…(K-1), K跳边可达vertex</li> |
| <li>K-out, 从起始vertex出发，恰好经过K跳out边能够到达的顶点</li> |
| </ul> |
| <h5 id="fs性能">FS性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>Backend</th> |
| <th>email-enron(30w)</th> |
| <th>amazon0601(300w)</th> |
| <th>com-youtube.ungraph(300w)</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Titan</td> |
| <td>11.333</td> |
| <td>0.313</td> |
| <td>376.06</td> |
| </tr> |
| <tr> |
| <td>RocksDB</td> |
| <td>44.391</td> |
| <td>2.221</td> |
| <td>268.792</td> |
| </tr> |
| <tr> |
| <td>Cassandra</td> |
| <td>39.845</td> |
| <td>3.337</td> |
| <td>331.113</td> |
| </tr> |
| <tr> |
| <td>Memory</td> |
| <td>35.638</td> |
| <td>2.059</td> |
| <td>388.987</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>表头”（）“中数据是数据规模，以边为单位</li> |
| <li>表中数据是找到<strong>从第一个顶点出发到达随机选择的100个顶点的最短路径</strong>的时间，单位是s</li> |
| <li>例如，HugeGraph使用RocksDB查找第一个顶点到100个随机顶点的最短路径，总共耗时2.059s</li> |
| </ul> |
| <h6 id="结论-2">结论</h6> |
| <ul> |
| <li>在数据规模小或者顶点关联关系少的场景下，Titan最短路径性能优于HugeGraph</li> |
| <li>随着数据规模增大且顶点的关联度增高，HugeGraph最短路径性能优于Titan</li> |
| </ul> |
| <h5 id="k-neighbor性能">K-neighbor性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>顶点</th> |
| <th>深度</th> |
| <th>一度</th> |
| <th>二度</th> |
| <th>三度</th> |
| <th>四度</th> |
| <th>五度</th> |
| <th>六度</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>v1</td> |
| <td>时间</td> |
| <td>0.031s</td> |
| <td>0.033s</td> |
| <td>0.048s</td> |
| <td>0.500s</td> |
| <td>11.27s</td> |
| <td>OOM</td> |
| </tr> |
| <tr> |
| <td>v111</td> |
| <td>时间</td> |
| <td>0.027s</td> |
| <td>0.034s</td> |
| <td>0.115</td> |
| <td>1.36s</td> |
| <td>OOM</td> |
| <td>–</td> |
| </tr> |
| <tr> |
| <td>v1111</td> |
| <td>时间</td> |
| <td>0.039s</td> |
| <td>0.027s</td> |
| <td>0.052s</td> |
| <td>0.511s</td> |
| <td>10.96s</td> |
| <td>OOM</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>HugeGraph-Server的JVM内存设置为32GB，数据量过大时会出现OOM</li> |
| </ul> |
| <h5 id="k-out性能">K-out性能</h5> |
| <table> |
| <thead> |
| <tr> |
| <th>顶点</th> |
| <th>深度</th> |
| <th>一度</th> |
| <th>二度</th> |
| <th>三度</th> |
| <th>四度</th> |
| <th>五度</th> |
| <th>六度</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>v1</td> |
| <td>时间</td> |
| <td>0.054s</td> |
| <td>0.057s</td> |
| <td>0.109s</td> |
| <td>0.526s</td> |
| <td>3.77s</td> |
| <td>OOM</td> |
| </tr> |
| <tr> |
| <td>度</td> |
| <td>10</td> |
| <td>133</td> |
| <td>2453</td> |
| <td>50,830</td> |
| <td>1,128,688</td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>v111</td> |
| <td>时间</td> |
| <td>0.032s</td> |
| <td>0.042s</td> |
| <td>0.136s</td> |
| <td>1.25s</td> |
| <td>20.62s</td> |
| <td>OOM</td> |
| </tr> |
| <tr> |
| <td>度</td> |
| <td>10</td> |
| <td>211</td> |
| <td>4944</td> |
| <td>113150</td> |
| <td>2,629,970</td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>v1111</td> |
| <td>时间</td> |
| <td>0.039s</td> |
| <td>0.045s</td> |
| <td>0.053s</td> |
| <td>1.10s</td> |
| <td>2.92s</td> |
| <td>OOM</td> |
| </tr> |
| <tr> |
| <td>度</td> |
| <td>10</td> |
| <td>140</td> |
| <td>2555</td> |
| <td>50825</td> |
| <td>1,070,230</td> |
| <td></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>HugeGraph-Server的JVM内存设置为32GB，数据量过大时会出现OOM</li> |
| </ul> |
| <h6 id="结论-3">结论</h6> |
| <ul> |
| <li>FS场景，HugeGraph性能优于Titan</li> |
| <li>K-neighbor和K-out场景，HugeGraph能够实现在5度范围内秒级返回结果</li> |
| </ul> |
| <h4 id="24-图综合性能测试-cw">2.4 图综合性能测试-CW</h4> |
| <table> |
| <thead> |
| <tr> |
| <th>数据库</th> |
| <th>规模1000</th> |
| <th>规模5000</th> |
| <th>规模10000</th> |
| <th>规模20000</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Titan</td> |
| <td>45.943</td> |
| <td>849.168</td> |
| <td>2737.117</td> |
| <td>9791.46</td> |
| </tr> |
| <tr> |
| <td>Memory(core)</td> |
| <td>41.077</td> |
| <td>1825.905</td> |
| <td>*</td> |
| <td>*</td> |
| </tr> |
| <tr> |
| <td>Cassandra（core）</td> |
| <td>39.783</td> |
| <td>862.744</td> |
| <td>2423.136</td> |
| <td>6564.191</td> |
| </tr> |
| <tr> |
| <td>RcoksDB（core）</td> |
| <td>33.383</td> |
| <td>199.894</td> |
| <td>763.869</td> |
| <td>1677.813</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><em>说明</em></p> |
| <ul> |
| <li>“规模"以顶点为单位</li> |
| <li>表中数据是社区发现完成需要的时间，单位是s，例如HugeGraph使用RocksDB后端在规模10000的数据集，社区聚合不再变化，需要耗时763.869s</li> |
| <li>“*“表示超过10000s未完成</li> |
| <li>CW测试是CRUD的综合评估</li> |
| <li>后三者分别是HugeGraph的不同后端，该测试中HugeGraph跟Titan一样，没有通过client，直接对core操作</li> |
| </ul> |
| <h5 id="结论-4">结论</h5> |
| <ul> |
| <li>HugeGraph在使用Cassandra后端时，性能略优于Titan，随着数据规模的增大，优势越来越明显，数据规模20000时，比Titan快30%</li> |
| <li>HugeGraph在使用RocksDB后端时，性能远高于Titan和HugeGraph的Cassandra后端，分别比两者快了6倍和4倍</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-d9ec0777c4f7a8a41476a65f2ecca6f7">9 - CHANGELOGS</h1> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style=""> |
| |
| <h1 id="pg-6b37a0af49c5e6b45aeac03f2a71eab6">9.1 - HugeGraph 0.12 Release Notes</h1> |
| |
| <h3 id="api--client">API & Client</h3> |
| <h4 id="接口更新">接口更新</h4> |
| <ul> |
| <li>支持 https + auth 模式连接图服务 （hugegraph-client #109 #110）</li> |
| <li>统一 kout/kneighbor 等 OLTP 接口的参数命名及默认值（hugegraph-client #122 #123）</li> |
| <li>支持 RESTful 接口利用 P.textcontains() 进行属性全文检索（hugegraph #1312）</li> |
| <li>增加 graph_read_mode API 接口，以切换 OLTP、OLAP 读模式（hugegraph #1332）</li> |
| <li>支持 list/set 类型的聚合属性 aggregate property（hugegraph #1332）</li> |
| <li>权限接口增加 METRICS 资源类型（hugegraph #1355、hugegraph-client #114）</li> |
| <li>权限接口增加 SCHEMA 资源类型（hugegraph #1362、hugegraph-client #117）</li> |
| <li>增加手动 compact API 接口，支持 rocksdb/cassandra/hbase 后端（hugegraph #1378）</li> |
| <li>权限接口增加 login/logout API，支持颁发或回收 Token（hugegraph #1500、hugegraph-client #125）</li> |
| <li>权限接口增加 project API（hugegraph #1504、hugegraph-client #127）</li> |
| <li>增加 OLAP 回写接口，支持 cassandra/rocksdb 后端（hugegraph #1506、hugegraph-client #129）</li> |
| <li>增加返回一个图的所有 Schema 的 API 接口（hugegraph #1567、hugegraph-client #134）</li> |
| <li>变更 property key 创建与更新 API 的 HTTP 返回码为 202（hugegraph #1584）</li> |
| <li>增强 Text.contains() 支持3种格式：“word”、"(word)"、"(word1|word2|word3)"（hugegraph #1652）</li> |
| <li>统一了属性中特殊字符的行为（hugegraph #1670 #1684）</li> |
| <li>支持动态创建图实例、克隆图实例、删除图实例（hugegraph-client #135）</li> |
| </ul> |
| <h4 id="其它修改">其它修改</h4> |
| <ul> |
| <li>修复在恢复 index label 时 IndexLabelV56 id 丢失的问题（hugegraph-client #118）</li> |
| <li>为 Edge 类增加 name() 方法（hugegraph-client #121）</li> |
| </ul> |
| <h3 id="core--server">Core & Server</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>支持动态创建图实例（hugegraph #1065）</li> |
| <li>支持通过 Gremlin 调用 OLTP 算法（hugegraph #1289）</li> |
| <li>支持多集群使用同一个图权限服务，以共享权限信息（hugegraph #1350）</li> |
| <li>支持跨多节点的 Cache 缓存同步（hugegraph #1357）</li> |
| <li>支持 OLTP 算法使用原生集合以降低 GC 压力提升性能（hugegraph #1409）</li> |
| <li>支持对新增的 Raft 节点打快照或恢复快照（hugegraph #1439）</li> |
| <li>支持对集合属性建立二级索引 Secondary Index（hugegraph #1474）</li> |
| <li>支持审计日志，及其压缩、限速等功能（hugegraph #1492 #1493）</li> |
| <li>支持 OLTP 算法使用高性能并行无锁原生集合以提升性能（hugegraph #1552）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>修复带权最短路径算法（weighted shortest path）NPE问题 （hugegraph #1250）</li> |
| <li>增加 Raft 相关的安全操作白名单（hugegraph #1257）</li> |
| <li>修复 RocksDB 实例未正确关闭的问题（hugegraph #1264）</li> |
| <li>在清空数据 truncate 操作之后，显示的发起写快照 Raft Snapshot（hugegraph #1275）</li> |
| <li>修复 Raft Leader 在收到 Follower 转发请求时未更新缓存的问题（hugegraph #1279）</li> |
| <li>修复带权最短路径算法（weighted shortest path）结果不稳定的问题（hugegraph #1280）</li> |
| <li>修复 rays 算法 limit 参数不生效问题（hugegraph #1284）</li> |
| <li>修复 neighborrank 算法 capacity 参数未检查的问题（hugegraph #1290）</li> |
| <li>修复 PostgreSQL 因为不存在与用户同名的数据库而初始化失败的问题（hugegraph #1293）</li> |
| <li>修复 HBase 后端当启用 Kerberos 时初始化失败的问题（hugegraph #1294）</li> |
| <li>修复 HBase/RocksDB 后端 shard 结束判断错误问题（hugegraph #1306）</li> |
| <li>修复带权最短路径算法（weighted shortest path）未检查目标顶点存在的问题（hugegraph #1307）</li> |
| <li>修复 personalrank/neighborrank 算法中非 String 类型 id 的问题（hugegraph #1310）</li> |
| <li>检查必须是 master 节点才允许调度 gremlin job（hugegraph #1314）</li> |
| <li>修复 g.V().hasLabel().limit(n) 因为索引覆盖导致的部分结果不准确问题（hugegraph #1316）</li> |
| <li>修复 jaccardsimilarity 算法当并集为空时报 NaN 错误的问题（hugegraph #1324）</li> |
| <li>修复 Raft Follower 节点操作 Schema 多节点之间数据不同步问题（hugegraph #1325）</li> |
| <li>修复因为 tx 未关闭导致的 TTL 不生效问题（hugegraph #1330）</li> |
| <li>修复 gremlin job 的执行结果大于 Cassandra 限制但小于任务限制时的异常处理（hugegraph #1334）</li> |
| <li>检查权限接口 auth-delete 和 role-get API 操作时图必须存在（hugegraph #1338）</li> |
| <li>修复异步任务结果中包含 path/tree 时系列化不正常的问题（hugegraph #1351）</li> |
| <li>修复初始化 admin 用户时的 NPE 问题（hugegraph #1360）</li> |
| <li>修复异步任务原子性操作问题，确保 update/get fields 及 re-schedule 的原子性（hugegraph #1361）</li> |
| <li>修复权限 NONE 资源类型的问题（hugegraph #1362）</li> |
| <li>修复启用权限后，truncate 操作报错 SecurityException 及管理员信息丢失问题（hugegraph #1365）</li> |
| <li>修复启用权限后，解析数据忽略了权限异常的问题（hugegraph #1380）</li> |
| <li>修复 AuthManager 在初始化时会尝试连接其它节点的问题（hugegraph #1381）</li> |
| <li>修复特定的 shard 信息导致 base64 解码错误的问题（hugegraph #1383）</li> |
| <li>修复启用权限后，使用 consistent-hash LB 在校验权限时，creator 为空的问题（hugegraph #1385）</li> |
| <li>改进权限中 VAR 资源不再依赖于 VERTEX 资源（hugegraph #1386）</li> |
| <li>规范启用权限后，Schema 操作仅依赖具体的资源（hugegraph #1387）</li> |
| <li>规范启用权限后，部分操作由依赖 STATUS 资源改为依赖 ANY 资源（hugegraph #1391）</li> |
| <li>规范启用权限后，禁止初始化管理员密码为空（hugegraph #1400）</li> |
| <li>检查创建用户时 username/password 不允许为空（hugegraph #1402）</li> |
| <li>修复更新 Label 时，PrimaryKey 或 SortKey 被设置为可空属性的问题（hugegraph #1406）</li> |
| <li>修复 ScyllaDB 丢失分页结果问题（hugegraph #1407）</li> |
| <li>修复带权最短路径算法（weighted shortest path）权重属性强制转换为 double 的问题（hugegraph #1432）</li> |
| <li>统一 OLTP 算法中的 degree 参数命名（hugegraph #1433）</li> |
| <li>修复 fusiformsimilarity 算法当 similars 为空的时候返回所有的顶点问题（hugegraph #1434）</li> |
| <li>改进 paths 算法，当起始点与目标点相同时应该返回空路径（hugegraph #1435）</li> |
| <li>修改 kout/kneighbor 的 limit 参数默认值 10 为 10000000（hugegraph #1436）</li> |
| <li>修复分页信息中的 ‘+’ 被 URL 编码为空格的问题（hugegraph #1437）</li> |
| <li>改进边更新接口的错误提示信息（hugegraph #1443）</li> |
| <li>修复 kout 算法 degree 未在所有 label 范围生效的问题（hugegraph #1459）</li> |
| <li>改进 kneighbor/kout 算法，起始点不允许出现在结果集中（hugegraph #1459 #1463）</li> |
| <li>统一 kout/kneighbor 的 Get 和 Post 版本行为（hugegraph #1470）</li> |
| <li>改进创建边时顶点类型不匹配的错误提示信息（hugegraph #1477）</li> |
| <li>修复 Range Index 的残留索引问题（hugegraph #1498）</li> |
| <li>修复权限操作未失效缓存的问题（hugegraph #1528）</li> |
| <li>修复 sameneighbor 的 limit 参数默认值 10 为 10000000（hugegraph #1530）</li> |
| <li>修复 clear API 不应该所有后端都调用 create snapshot 的问题（hugegraph #1532）</li> |
| <li>修复当 loading 模式时创建 Index Label 阻塞问题（hugegraph #1548）</li> |
| <li>修复增加图到 project 或从 project 移除图的问题（hugegraph #1562）</li> |
| <li>改进权限操作的一些错误提示信息（hugegraph #1563）</li> |
| <li>支持浮点属性设置为 Infinity/NaN 的值（hugegraph #1578)</li> |
| <li>修复 Raft 启用 safe_read 时的 quorum read 问题（hugegraph #1618)</li> |
| <li>修复 token 过期时间配置的单位问题（hugegraph #1625）</li> |
| <li>修复 MySQL Statement 资源泄露问题（hugegraph #1627）</li> |
| <li>修复竞争条件下 Schema.getIndexLabel 获取不到数据的问题（hugegraph #1629）</li> |
| <li>修复 HugeVertex4Insert 无法系列化问题（hugegraph #1630）</li> |
| <li>修复 MySQL count Statement 未关闭问题（hugegraph #1640）</li> |
| <li>修复当删除 Index Label 异常时，导致状态不同步问题（hugegraph #1642）</li> |
| <li>修复 MySQL 执行 gremlin timeout 导致的 statement 未关闭问题（hugegraph #1643）</li> |
| <li>改进 Search Index 以兼容特殊 Unicode 字符：\u0000 to \u0003（hugegraph #1659）</li> |
| <li>修复 #1659 引入的 Char 未转化为 String 的问题（hugegraph #1664）</li> |
| <li>修复 has() + within() 查询时结果异常问题（hugegraph #1680）</li> |
| <li>升级 Log4j 版本到 2.17 以修复安全漏洞（hugegraph #1686 #1698 #1702）</li> |
| <li>修复 HBase 后端 shard scan 中 startkey 包含空串时 NPE 问题（hugegraph #1691）</li> |
| <li>修复 paths 算法在深层环路遍历时性能下降问题 （hugegraph #1694）</li> |
| <li>改进 personalrank 算法的参数默认值及错误检查（hugegraph #1695）</li> |
| <li>修复 RESTful 接口 P.within 条件不生效问题（hugegraph #1704）</li> |
| <li>修复启用权限时无法动态创建图的问题（hugegraph #1708）</li> |
| </ul> |
| <h4 id="配置项修改">配置项修改：</h4> |
| <ul> |
| <li>共享 SSL 相关配置项命名（hugegraph #1260）</li> |
| <li>支持 RocksDB 配置项 rocksdb.level_compaction_dynamic_level_bytes（hugegraph #1262）</li> |
| <li>去除 RESFful Server 服务协议配置项 restserver.protocol，自动提取 URL 中的 Schema（hugegraph #1272）</li> |
| <li>增加 PostgreSQL 配置项 jdbc.postgresql.connect_database（hugegraph #1293）</li> |
| <li>增加针对顶点主键是否编码的配置项 vertex.encode_primary_key_number（hugegraph #1323）</li> |
| <li>增加针对聚合查询是否启用索引优化的配置项 query.optimize_aggregate_by_index（hugegraph #1549）</li> |
| <li>修改 cache_type 的默认值 l1 为 l2（hugegraph #1681）</li> |
| <li>增加 JDBC 强制重连配置项 jdbc.forced_auto_reconnect（hugegraph #1710）</li> |
| </ul> |
| <h4 id="其它修改-1">其它修改</h4> |
| <ul> |
| <li>增加默认的 SSL Certificate 文件（hugegraph #1254）</li> |
| <li>OLTP 并行请求共享线程池，而非每个请求使用单独的线程池（hugegraph #1258）</li> |
| <li>修复 Example 的问题（hugegraph #1308）</li> |
| <li>使用 jraft 版本 1.3.5（hugegraph #1313）</li> |
| <li>如果启用了 Raft 模式时，关闭 RocksDB 的 WAL（hugegraph #1318）</li> |
| <li>使用 TarLz4Util 来提升快照 Snapshot 压缩的性能（hugegraph #1336）</li> |
| <li>升级存储的版本号（store version），因为 property key 增加了 read frequency（hugegraph #1341）</li> |
| <li>顶点/边 vertex/edge 的 Get API 使用 queryVertex/queryEdge 方法来替代 iterator 方法（hugegraph #1345）</li> |
| <li>支持 BFS 优化的多度查询（hugegraph #1359)</li> |
| <li>改进 RocksDB deleteRange() 带来的查询性能问题（hugegraph #1375）</li> |
| <li>修复 travis-ci cannot find symbol Namifiable 问题（hugegraph #1376）</li> |
| <li>确保 RocksDB 快照的磁盘与 data path 指定的一致（hugegraph #1392）</li> |
| <li>修复 MacOS 空闲内存 free_memory 计算不准确问题（hugegraph #1396）</li> |
| <li>增加 Raft onBusy 回调来配合限速（hugegraph #1401）</li> |
| <li>升级 netty-all 版本 4.1.13.Final 到 4.1.42.Final（hugegraph #1403）</li> |
| <li>支持 TaskScheduler 暂停当设置为 loading 模式时（hugegraph #1414）</li> |
| <li>修复 raft-tools 脚本的问题（hugegraph #1416）</li> |
| <li>修复 license params 问题（hugegraph #1420）</li> |
| <li>提升写权限日志的性能，通过 batch flush & async write 方式改进（hugegraph #1448）</li> |
| <li>增加 MySQL 连接 URL 的日志记录（hugegraph #1451）</li> |
| <li>提升用户信息校验性能（hugegraph# 1460）</li> |
| <li>修复 TTL 因为起始时间问题导致的错误（hugegraph #1478）</li> |
| <li>支持日志配置的热加载及对审计日志的压缩（hugegraph #1492）</li> |
| <li>支持针对用户级别的审计日志的限速（hugegraph #1493）</li> |
| <li>缓存 RamCache 支持用户自定义的过期时间（hugegraph #1494）</li> |
| <li>在 auth client 端缓存 login role 以避免重复的 RPC 调用（hugegraph #1507）</li> |
| <li>修复 IdSet.contains() 未复写 AbstractCollection.contains() 问题（hugegraph #1511）</li> |
| <li>修复当 commitPartOfEdgeDeletions() 失败时，未回滚 rollback 的问题（hugegraph #1513）</li> |
| <li>提升 Cache metrics 性能（hugegraph #1515）</li> |
| <li>当发生 license 操作错误时，增加打印异常日志（hugegraph #1522）</li> |
| <li>改进 SimilarsMap 实现（hugegraph #1523）</li> |
| <li>使用 tokenless 方式来更新 coverage（hugegraph #1529）</li> |
| <li>改进 project update 接口的代码（hugegraph #1537）</li> |
| <li>允许从 option() 访问 GRAPH_STORE（hugegraph #1546）</li> |
| <li>优化 kout/kneighbor 的 count 查询以避免拷贝集合（hugegraph #1550）</li> |
| <li>优化 shortestpath 遍历方式，以数据量少的一端优先遍历（hugegraph #1569）</li> |
| <li>完善 rocksdb.data_disks 配置项的 allowed keys 提示信息（hugegraph #1585）</li> |
| <li>为 number id 优化 OLTP 遍历中的 id2code 方法性能（hugegraph #1623）</li> |
| <li>优化 HugeElement.getProperties() 返回 Collection<Property>（hugegraph #1624）</li> |
| <li>增加 APACHE PROPOSAL 文件（hugegraph #1644）</li> |
| <li>改进 close tx 的流程（hugegraph #1655）</li> |
| <li>当 reset() 时为 MySQL close 捕获所有类型异常（hugegraph #1661）</li> |
| <li>改进 OLAP property 模块代码（hugegraph #1675）</li> |
| <li>改进查询模块的执行性能（hugegraph #1711）</li> |
| </ul> |
| <h3 id="loader">Loader</h3> |
| <ul> |
| <li>支持导入 Parquet 格式文件（hugegraph-loader #174）</li> |
| <li>支持 HDFS Kerberos 权限验证（hugegraph-loader #176）</li> |
| <li>支持 HTTPS 协议连接到服务端导入数据（hugegraph-loader #183）</li> |
| <li>修复 trust store file 路径问题（hugegraph-loader #186）</li> |
| <li>处理 loading mode 重置的异常（hugegraph-loader #187）</li> |
| <li>增加在插入数据时对非空属性的检查（hugegraph-loader #190）</li> |
| <li>修复客户端与服务端时区不同导致的时间判断问题（hugegraph-loader #192）</li> |
| <li>优化数据解析性能（hugegraph-loader #194）</li> |
| <li>当用户指定了文件头时，检查其必须不为空（hugegraph-loader #195）</li> |
| <li>修复示例程序中 MySQL struct.json 格式问题（hugegraph-loader #198）</li> |
| <li>修复顶点边导入速度不精确的问题（hugegraph-loader #200 #205）</li> |
| <li>当导入启用 check-vertex 时，确保先导入顶点再导入边（hugegraph-loader #206）</li> |
| <li>修复边 Json 数据导入格式不统一时数组溢出的问题（hugegraph-loader #211）</li> |
| <li>修复因边 mapping 文件不存在导致的 NPE 问题（hugegraph-loader #213）</li> |
| <li>修复读取时间可能出现负数的问题（hugegraph-loader #215)</li> |
| <li>改进目录文件的日志打印（hugegraph-loader #223)</li> |
| <li>改进 loader 的的 Schema 处理流程（hugegraph-loader #230)</li> |
| </ul> |
| <h3 id="tools">Tools</h3> |
| <ul> |
| <li>支持 HTTPS 协议（hugegraph-tools #71）</li> |
| <li>移除 –protocol 参数，直接从URL中自动提取（hugegraph-tools #72）</li> |
| <li>支持将数据 dump 到 HDFS 文件系统（hugegraph-tools #73）</li> |
| <li>修复 trust store file 路径问题（hugegraph-tools #75）</li> |
| <li>支持权限信息的备份恢复（hugegraph-tools #76）</li> |
| <li>支持无参数的 Printer 打印（hugegraph-tools #79）</li> |
| <li>修复 MacOS free_memory 计算问题（hugegraph-tools #82）</li> |
| <li>支持备份恢复时指定线程数hugegraph-tools #83）</li> |
| <li>支持动态创建图、克隆图、删除图等命令（hugegraph-tools #95)</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-8ae4f43f2b0af1988d9f0a8cb3b1c073">9.2 - HugeGraph 0.11 Release Notes</h1> |
| |
| <h3 id="api--client">API & Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>支持梭形相似度算法（hugegraph #671，hugegraph-client #62）</li> |
| <li>支持创建 Schema 时，记录创建的时间（hugegraph #746，hugegraph-client #69）</li> |
| <li>支持 RESTful API 中基于属性的范围查询顶点/边（hugegraph #782，hugegraph-client #73）</li> |
| <li>支持顶点和边的 TTL （hugegraph #794，hugegraph-client #83）</li> |
| <li>统一 RESTful API Server 和 Gremlin Server 的日期格式为字符串（hugegraph #1014，hugegraph-client #82）</li> |
| <li>支持共同邻居，Jaccard 相似度，全部最短路径，带权最短路径和单源最短路径5种遍历算法（hugegraph #936，hugegraph-client #80）</li> |
| <li>支持用户认证和细粒度权限控制（hugegraph #749，hugegraph #985，hugegraph-client #81）</li> |
| <li>支持遍历 API 的顶点计数功能（hugegraph #995，hugegraph-client #84）</li> |
| <li>支持 HTTPS 协议（hugegrap #1036，hugegraph-client #85）</li> |
| <li>支持创建索引时控制是否重建索引（hugegraph #1106，hugegraph-client #91）</li> |
| <li>支持定制的 kout/kneighbor，多点最短路径，最相似 Jaccard 点和模板路径5种遍历算法（hugegraph #1174，hugegraph-client #100，hugegraph-client #106）</li> |
| </ul> |
| <h4 id="内部修改">内部修改</h4> |
| <ul> |
| <li>启动 HugeGraphServer 出现异常时快速失败（hugegraph #748）</li> |
| <li>定义 LOADING 模式来加速导入（hugegraph-client #101）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>支持多属性顶点/边的分页查询（hugegraph #759）</li> |
| <li>支持聚合运算的性能优化（hugegraph #813）</li> |
| <li>支持堆外缓存（hugegraph #846）</li> |
| <li>支持属性权限管理（hugegraph #971）</li> |
| <li>支持 MySQL 和 Memory 后端分片，并改进 HBase 分片方法（hugegraph #974）</li> |
| <li>支持基于 Raft 的分布式一致性协议（hugegraph #1020）</li> |
| <li>支持元数据拷贝功能（hugegraph #1024）</li> |
| <li>支持集群的异步任务调度功能（hugegraph #1030）</li> |
| <li>支持发生 OOM 时打印堆信息功能（hugegraph #1093）</li> |
| <li>支持 Raft 状态机更新缓存（hugegraph #1119）</li> |
| <li>支持 Raft 节点管理功能（hugegraph #1137）</li> |
| <li>支持限制查询请求速率的功能（hugegraph #1158）</li> |
| <li>支持顶点/边的属性默认值功能（hugegraph #1182）</li> |
| <li>支持插件化查询加速机制 RamTable（hugegraph #1183）</li> |
| <li>支持索引重建失败时设置为 INVALID 状态（hugegraph #1226）</li> |
| <li>支持 HBase 启用 Kerberos 认证（hugegraph #1234）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>修复配置权限时 start-hugegraph.sh 的超时问题（hugegraph #761）</li> |
| <li>修复在 studio 执行 gremlin 时的 MySQL 连接失败问题（hugegraph #765）</li> |
| <li>修复 HBase 后端 truncate 时出现的 TableNotFoundException（hugegraph #771）</li> |
| <li>修复限速配置项值未检查的问题（hugegraph #773）</li> |
| <li>修复唯一索引（Unique Index）的返回的异常信息不准确问题（hugegraph #797）</li> |
| <li>修复 RocksDB 后端执行 g.V().hasLabel().count() 时 OOM 问题 （hugegraph-798）</li> |
| <li>修复 traverseByLabel() 分页设置错误问题（hugegraph #805）</li> |
| <li>修复根据 ID 和 SortKeys 更新边属性时误创建边的问题（hugegraph #819）</li> |
| <li>修复部分存储后端的覆盖写问题（hugegraph #820）</li> |
| <li>修复保存执行失败的异步任务时无法取消的问题（hugegraph #827）</li> |
| <li>修复 MySQL 后端在 SSL 模式下无法打开数据库的问题（hugegraph #842）</li> |
| <li>修复索引查询时 offset 无效问题（hugegraph #866）</li> |
| <li>修复 Gremlin 中绝对路径泄露的安全问题（hugegraph #871）</li> |
| <li>修复 reconnectIfNeeded() 方法的 NPE 问题（hugegraph #874）</li> |
| <li>修复 PostgreSQL 的 JDBC_URL 配置没有"/“前缀的问题（hugegraph #891）</li> |
| <li>修复 RocksDB 内存统计问题（hugegraph #937）</li> |
| <li>修复环路检测的两点成环无法检测的问题（hugegraph #939）</li> |
| <li>修复梭形算法计算结束后没有清理计数的问题（hugegraph #947）</li> |
| <li>修复 gremlin-console 无法工作的问题（hugegraph #1027）</li> |
| <li>修复限制数目的按条件过滤邻接边问题（hugegraph #1057）</li> |
| <li>修复 MySQL 执行 SQL 时的 auto-commit 问题（hugegraph #1064）</li> |
| <li>修复通过两个索引查询时发生超时 80w 限制的问题（hugegraph #1088）</li> |
| <li>修复范围索引检查规则错误（hugegraph #1090）</li> |
| <li>修复删除残留索引的错误（hugegraph #1101）</li> |
| <li>修复当前线程为 task-worker 时关闭事务卡住的问题（hugegraph #1111）</li> |
| <li>修复最短路径查询出现 NoSuchElementException 的问题（hugegraph #1116）</li> |
| <li>修复异步任务有时提交两次的问题（hugegraph #1130）</li> |
| <li>修复值很小的 date 反序列化的问题（hugegraph #1152）</li> |
| <li>修复遍历算法未检查起点或者终点是否存在的问题（hugegraph #1156）</li> |
| <li>修复 bin/start-hugegraph.sh 参数解析错误的问题（hugegraph #1178）</li> |
| <li>修复 gremlin-console 运行时的 log4j 错误信息的问题（hugegraph #1229）</li> |
| </ul> |
| <h4 id="内部修改-1">内部修改</h4> |
| <ul> |
| <li>延迟检查非空属性（hugegraph #756）</li> |
| <li>为存储后端增加查看集群节点信息的功能 （hugegraph #821）</li> |
| <li>为 RocksDB 后端增加 compaction 高级配置项（hugegraph #825）</li> |
| <li>增加 vertex.check_adjacent_vertex_exist 配置项（hugegraph #837）</li> |
| <li>检查主键属性不允许为空（hugegraph #847）</li> |
| <li>增加图名字的合法性检查（hugegraph #854）</li> |
| <li>增加对非预期的 SysProp 的查询（hugegraph #862）</li> |
| <li>使用 disableTableAsync 加速 HBase 后端的数据清除（hugegraph #868）</li> |
| <li>允许 Gremlin 环境触发系统异步任务（hugegraph #892）</li> |
| <li>编码字符类型索引中的类型 ID（hugegraph #894）</li> |
| <li>安全模块允许 Cassandra 在执行 CQL 时按需创建线程（hugegraph #896）</li> |
| <li>将 GremlinServer 的默认通道设置为 WsAndHttpChannelizer（hugegraph #903）</li> |
| <li>将 Direction 和遍历算法的类导出到 Gremlin 环境（hugegraph #904）</li> |
| <li>增加顶点属性缓存限制（hugegraph #941，hugegraph #942）</li> |
| <li>优化列表属性的读（hugegraph #943）</li> |
| <li>增加缓存的 L1 和 L2 配置（hugegraph #945）</li> |
| <li>优化 EdgeId.asString() 方法（hugegraph #946）</li> |
| <li>优化当顶点没有属性时跳过后端存储查询（hugegraph #951）</li> |
| <li>创建名字相同但属性不同的元数据时抛出 ExistedException（hugegraph #1009）</li> |
| <li>查询顶点和边后按需关闭事务（hugegraph #1039）</li> |
| <li>当图关闭时清空缓存（hugegraph #1078）</li> |
| <li>关闭图时加锁避免竞争问题（hugegraph #1104）</li> |
| <li>优化顶点和边的删除效率，当提供 Label+ID 删除时免去查询（hugegraph #1150）</li> |
| <li>使用 IntObjectMap 优化元数据缓存效率（hugegraph #1185）</li> |
| <li>使用单个 Raft 节点管理目前的三个 store（hugegraph #1187）</li> |
| <li>在重建索引时提前释放索引删除的锁（hugegraph #1193）</li> |
| <li>在压缩和解压缩异步任务的结果时，使用 LZ4 替代 Gzip（hugegraph #1198）</li> |
| <li>实现 RocksDB 删除 CF 操作的排他性来避免竞争（hugegraph #1202）</li> |
| <li>修改 CSV reporter 的输出目录，并默认设置为不输出（hugegraph #1233）</li> |
| </ul> |
| <h4 id="其它">其它</h4> |
| <ul> |
| <li>cherry-pick 0.10.4 版本的 bug 修复代码（hugegraph #785，hugegraph #1047）</li> |
| <li>Jackson 升级到 2.10.2 版本（hugegraph #859）</li> |
| <li>Thanks 信息中增加对 Titan 的感谢（hugegraph #906）</li> |
| <li>适配 TinkerPop 测试（hugegraph #1048）</li> |
| <li>修改允许输出的日志最低等级为 TRACE（hugegraph #1050）</li> |
| <li>增加 IDEA 的格式配置文件（hugegraph #1060）</li> |
| <li>修复 Travis CI 太多错误信息的问题（hugegraph #1098）</li> |
| </ul> |
| <h3 id="loader">Loader</h3> |
| <h4 id="功能更新-2">功能更新</h4> |
| <ul> |
| <li>支持读取 Hadoop 配置文件（hugegraph-loader #105）</li> |
| <li>支持指定 Date 属性的时区（hugegraph-loader #107）</li> |
| <li>支持从 ORC 压缩文件导入数据（hugegraph-loader #113）</li> |
| <li>支持单条边插入时设置是否检查顶点（hugegraph-loader #117）</li> |
| <li>支持从 Snappy-raw 压缩文件导入数据（hugegraph-loader #119）</li> |
| <li>支持导入映射文件 2.0 版本（hugegraph-loader #121）</li> |
| <li>增加一个将 utf8-bom 转换为 utf8 的命令行工具（hugegraph-loader #128）</li> |
| <li>支持导入任务开始前清理元数据信息的功能（hugegraph-loader #140）</li> |
| <li>支持 id 列作为属性存储（hugegraph-loader #143）</li> |
| <li>支持导入任务配置 username（hugegraph-loader #146）</li> |
| <li>支持从 Parquet 文件导入数据（hugegraph-loader #153）</li> |
| <li>支持指定读取文件的最大行数（hugegraph-loader #159）</li> |
| <li>支持 HTTPS 协议（hugegraph-loader #161）</li> |
| <li>支持时间戳作为日期格式（hugegraph-loader #164）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>修复行的 retainAll() 方法没有修改 names 和 values 数组（hugegraph-loader #110）</li> |
| <li>修复 JSON 文件重新加载时的 NPE 问题（hugegraph-loader #112）</li> |
| </ul> |
| <h4 id="内部修改-2">内部修改</h4> |
| <ul> |
| <li>只打印一次插入错误信息，以避免过多的错误信息（hugegraph-loader #118）</li> |
| <li>拆分批量插入和单条插入的线程（hugegraph-loader #120）</li> |
| <li>CSV 的解析器改为 SimpleFlatMapper（hugegraph-loader #124）</li> |
| <li>编码主键中的数字和日期字段（hugegraph-loader #136）</li> |
| <li>确保主键列合法或者存在映射（hugegraph-loader #141）</li> |
| <li>跳过主键属性全部为空的顶点（hugegraph-loader #166）</li> |
| <li>在导入任务开始前设置为 LOADING 模式，并在导入完成后恢复原来模式（hugegraph-loader #169）</li> |
| <li>改进停止导入任务的实现（hugegraph-loader #170）</li> |
| </ul> |
| <h3 id="tools">Tools</h3> |
| <h4 id="功能更新-3">功能更新</h4> |
| <ul> |
| <li>支持 Memory 后端的备份功能 （hugegraph-tools #53）</li> |
| <li>支持 HTTPS 协议（hugegraph-tools #58）</li> |
| <li>支持 migrate 子命令配置用户名和密码（hugegraph-tools #61）</li> |
| <li>支持备份顶点和边时指定类型和过滤属性信息（hugegraph-tools #63）</li> |
| </ul> |
| <h4 id="bug修复-2">BUG修复</h4> |
| <ul> |
| <li>修复 dump 命令的 NPE 问题（hugegraph-tools #49）</li> |
| </ul> |
| <h4 id="内部修改-3">内部修改</h4> |
| <ul> |
| <li>在 backup/dump 之前清除分片文件（hugegraph-tools #53）</li> |
| <li>改进 HugeGraph-tools 的报错信息（hugegraph-tools #67）</li> |
| <li>改进 migrate 子命令，删除掉不支持的子配置（hugegraph-tools #68）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-55638b919c2ec7668f5d3de2de0842d7">9.3 - HugeGraph 0.10 Release Notes</h1> |
| |
| <h3 id="api--client">API & Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>支持 HugeGraphServer 服务端内存紧张时返回错误拒绝请求 （hugegraph #476）</li> |
| <li>支持 API 白名单和 HugeGraphServer GC 频率控制功能 （hugegraph #522）</li> |
| <li>支持 Rings API 的 source_in_ring 参数 （hugegraph #528，hugegraph-client #48）</li> |
| <li>支持批量按策略更新属性接口 （hugegraph #493，hugegraph-client #46）</li> |
| <li>支持 Shard Index 前缀与范围检索索引 （hugegraph #574，hugegraph-client #56）</li> |
| <li>支持顶点的 UUID ID 类型 （hugegraph #618，hugegraph-client #59）</li> |
| <li>支持唯一性约束索引（Unique Index） （hugegraph #636，hugegraph-client #60）</li> |
| <li>支持 API 请求超时功能 （hugegraph #674）</li> |
| <li>支持根据名称列表查询 schema （hugegraph #686，hugegraph-client #63）</li> |
| <li>支持按分页方式获取异步任务 （hugegraph #720）</li> |
| </ul> |
| <h4 id="内部修改">内部修改</h4> |
| <ul> |
| <li>保持 traverser 的参数与 server 端一致 （hugegraph-client #44）</li> |
| <li>支持在 Shard 内使用分页方式遍历顶点或者边的方法 （hugegraph-client #47）</li> |
| <li>支持 Gremlin 查询结果持有 GraphManager （hugegraph-client #49）</li> |
| <li>改进 RestClient 的连接参数 （hugegraph-client #52）</li> |
| <li>增加 Date 类型属性的测试 （hugegraph-client #55）</li> |
| <li>适配 HugeGremlinException 异常 （hugegraph-client #57）</li> |
| <li>增加新功能的版本匹配检查 （hugegraph-client #66）</li> |
| <li>适配 UUID 的序列化 （hugegraph-client #67）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>支持 PostgreSQL 和 CockroachDB 存储后端 （hugegraph #484）</li> |
| <li>支持负数索引 （hugegraph #513）</li> |
| <li>支持边的 Vertex + SortKeys 的前缀范围查询 （hugegraph #574）</li> |
| <li>支持顶点的邻接边按分页方式查询 （hugegraph #659）</li> |
| <li>禁止通过 Gremlin 进行敏感操作 （hugegraph #176）</li> |
| <li>支持 Lic 校验功能 （hugegraph #645）</li> |
| <li>支持 Search Index 查询结果按匹配度排序的功能 （hugegraph #653）</li> |
| <li>升级 tinkerpop 至版本 3.4.3 （hugegraph #648）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>修复按分页方式查询边时剩余数目（remaining count）错误 （hugegraph #515）</li> |
| <li>修复清空后端时边缓存未清空的问题 （hugegraph #488）</li> |
| <li>修复无法插入 List<Date> 类型的属性问题 （hugegraph #534）</li> |
| <li>修复 PostgreSQL 后端的 existDatabase(), clearBackend() 和 rollback()功能 （hugegraph #531）</li> |
| <li>修复程序关闭时 HugeGraphServer 和 GremlinServer 残留问题 （hugegraph #554）</li> |
| <li>修复在 LockTable 中重复抓锁的问题 （hugegraph #566）</li> |
| <li>修复从 Edge 中获取的 Vertex 没有属性的问题 （hugegraph #604）</li> |
| <li>修复交叉关闭 RocksDB 的连接池问题 （hugegraph #598）</li> |
| <li>修复在超级点查询时 limit 失效问题 （hugegraph #607）</li> |
| <li>修复使用 Equal 条件和分页的情况下查询 Range Index 只返回第一页的问题 （hugegraph #614）</li> |
| <li>修复查询 limit 在删除部分数据后失效的问题 （hugegraph #610）</li> |
| <li>修复 Example1 的查询错误 （hugegraph #638）</li> |
| <li>修复 HBase 的批量提交部分错误问题 （hugegraph #634）</li> |
| <li>修复索引搜索时 compareNumber() 方法的空指针问题 （hugegraph #629）</li> |
| <li>修复更新属性值为已经删除的顶点或边的属性时失败问题 （hugegraph #679）</li> |
| <li>修复 system 类型残留索引无法清除问题 （hugegraph #675）</li> |
| <li>修复 HBase 在 Metrics 信息中的单位问题 （hugegraph #713）</li> |
| <li>修复存储后端未初始化问题 （hugegraph #708）</li> |
| <li>修复按 Label 删除边时导致的 IN 边残留问题 （hugegraph #727）</li> |
| <li>修复 init-store 会生成多份 backend_info 问题 （hugegraph #723）</li> |
| </ul> |
| <h4 id="内部修改-1">内部修改</h4> |
| <ul> |
| <li>抑制因 PostgreSQL 后端 database 不存在时的报警信息 （hugegraph #527）</li> |
| <li>删除 PostgreSQL 后端的无用配置项 （hugegraph #533）</li> |
| <li>改进错误信息中的 HugeType 为易读字符串 （hugegraph #546）</li> |
| <li>增加 jdbc.storage_engine 配置项指定存储引擎 （hugegraph #555）</li> |
| <li>增加使用后端链接时按需重连功能 （hugegraph #562）</li> |
| <li>避免打印空的查询条件 （hugegraph #583）</li> |
| <li>缩减 Variable 的字符串长度 （hugegraph #581）</li> |
| <li>增加 RocksDB 后端的 cache 配置项 （hugegraph #567）</li> |
| <li>改进异步任务的异常信息 （hugegraph #596）</li> |
| <li>将 Range Index 拆分成 INT，LONG，FLOAT，DOUBLE 四个表存储 （hugegraph #574）</li> |
| <li>改进顶点和边 API 的 Metrics 名字 （hugegraph #631）</li> |
| <li>增加 G1GC 和 GC Log 的配置项 （hugegraph #616）</li> |
| <li>拆分顶点和边的 Label Index 表 （hugegraph #635）</li> |
| <li>减少顶点和边的属性存储空间 （hugegraph #650）</li> |
| <li>支持对 Secondary Index 和 Primary Key 中的数字进行编码 （hugegraph #676）</li> |
| <li>减少顶点和边的 ID 存储空间 （hugegraph #661）</li> |
| <li>支持 Cassandra 后端存储的二进制序列化存储 （hugegraph #680）</li> |
| <li>放松对最小内存的限制 （hugegraph #689）</li> |
| <li>修复 RocksDB 后端批量写时的 Invalid column family 问题 （hugegraph #701）</li> |
| <li>更新异步任务状态时删除残留索引 （hugegraph #719）</li> |
| <li>删除 ScyllaDB 的 Label Index 表 （hugegraph #717）</li> |
| <li>启动时使用多线程方式打开 RocksDB 后端存储多个数据目录 （hugegraph #721）</li> |
| <li>RocksDB 版本从 v5.17.2 升级至 v6.3.6 （hugegraph #722）</li> |
| </ul> |
| <h4 id="其它">其它</h4> |
| <ul> |
| <li>增加 API tests 到 codecov 统计中 （hugegraph #711）</li> |
| <li>改进配置文件的默认配置项 （hugegraph #575）</li> |
| <li>改进 README 中的致谢信息 （hugegraph #548）</li> |
| </ul> |
| <h3 id="loader">Loader</h3> |
| <h4 id="功能更新-2">功能更新</h4> |
| <ul> |
| <li>支持 JSON 数据源的 selected 字段 （hugegraph-loader #62）</li> |
| <li>支持定制化 List 元素之间的分隔符 （hugegraph-loader #66）</li> |
| <li>支持值映射 （hugegraph-loader #67）</li> |
| <li>支持通过文件后缀过滤文件 （hugegraph-loader #82）</li> |
| <li>支持对导入进度进行记录和断点续传 （hugegraph-loader #70，hugegraph-loader #87）</li> |
| <li>支持从不同的关系型数据库中读取 Header 信息 （hugegraph-loader #79）</li> |
| <li>支持属性为 Unsigned Long 类型值 （hugegraph-loader #91）</li> |
| <li>支持顶点的 UUID ID 类型 （hugegraph-loader #98）</li> |
| <li>支持按照策略批量更新属性 （hugegraph-loader #97）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>修复 nullable key 在 mapping field 不工作的问题 （hugegraph-loader #64）</li> |
| <li>修复 Parse Exception 无法捕获的问题 （hugegraph-loader #74）</li> |
| <li>修复在等待异步任务完成时获取信号量数目错误的问题 （hugegraph-loader #86）</li> |
| <li>修复空表时 hasNext() 返回 true 的问题 （hugegraph-loader #90）</li> |
| <li>修复布尔值解析错误问题 （hugegraph-loader #92）</li> |
| </ul> |
| <h4 id="内部修改-2">内部修改</h4> |
| <ul> |
| <li>增加 HTTP 连接参数 （hugegraph-loader #81）</li> |
| <li>改进导入完成的总结信息 （hugegraph-loader #80）</li> |
| <li>改进一行数据缺少列或者有多余列的处理逻辑 （hugegraph-loader #93）</li> |
| </ul> |
| <h3 id="tools">Tools</h3> |
| <h4 id="功能更新-3">功能更新</h4> |
| <ul> |
| <li>支持 0.8 版本 server 备份的数据恢复至 0.9 版本的 server 中 （hugegraph-tools #34）</li> |
| <li>增加 timeout 全局参数 （hugegraph-tools #44）</li> |
| <li>增加 migrate 子命令支持迁移图 （hugegraph-tools #45）</li> |
| </ul> |
| <h4 id="bug修复-2">BUG修复</h4> |
| <ul> |
| <li>修复 dump 命令不支持 split size 参数的问题 （hugegraph-tools #32）</li> |
| </ul> |
| <h4 id="内部修改-3">内部修改</h4> |
| <ul> |
| <li>删除 Hadoop 对 Jersey 1.19的依赖 （hugegraph-tools #31）</li> |
| <li>优化子命令在 help 信息中的排序 （hugegraph-tools #37）</li> |
| <li>使用 log4j2 清除 log4j 的警告信息 （hugegraph-tools #39）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-5d75039168e433749fe461b9e0194290">9.4 - HugeGraph 0.9 Release Notes</h1> |
| |
| <h3 id="api--client">API & Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>增加 personal rank API 和 neighbor rank API （hugegraph #274）</li> |
| <li>Shortest path API 增加 skip_degree 参数跳过超级点（hugegraph #433，hugegraph-client #42）</li> |
| <li>vertex/edge 的 scan API 支持分页机制 （hugegraph #428，hugegraph-client #35）</li> |
| <li>VertexAPI 使用简化的属性序列化器 （hugegraph #332，hugegraph-client #37）</li> |
| <li>增加 customized paths API 和 customized crosspoints API （hugegraph #306，hugegraph-client #40）</li> |
| <li>在 server 端所有线程忙时返回503错误 （hugegraph #343）</li> |
| <li>保持 API 的 depth 和 degree 参数一致 （hugegraph #252，hugegraph-client #30）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>增加属性的时候验证 Date 而非 Timestamp 的值 （hugegraph-client #26）</li> |
| </ul> |
| <h4 id="内部修改">内部修改</h4> |
| <ul> |
| <li>RestClient 支持重用连接 （hugegraph-client #33）</li> |
| <li>使用 JsonUtil 替换冗余的 ObjectMapper （hugegraph-client #41）</li> |
| <li>Edge 直接引用 Vertex 使得批量插入更友好 （hugegraph-client #29）</li> |
| <li>使用 JaCoCo 替换 Cobertura 统计代码覆盖率 （hugegraph-client #39）</li> |
| <li>改进 Shard 反序列化机制 （hugegraph-client #34）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>支持 Cassandra 的 NetworkTopologyStrategy （hugegraph #448）</li> |
| <li>元数据删除和索引重建使用分页机制 (hugegraph #417)</li> |
| <li>支持将 HugeGraphServer 作为系统服务 （hugegraph #170)</li> |
| <li>单一索引查询支持分页机制 （hugegraph #328）</li> |
| <li>在初始化图库时支持定制化插件 （hugegraph #364）</li> |
| <li>为HBase后端增加 hbase.zookeeper.znode.parent 配置项 （hugegraph #333）</li> |
| <li>支持异步 Gremlin 任务的进度更新 （hugegraph #325）</li> |
| <li>使用异步任务的方式删除残留索引 （hugegraph #285）</li> |
| <li>支持按 sortKeys 范围查找功能 （hugegraph #271）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>修复二级索引删除时 Cassandra 后端的 batch 超过65535限制的问题 （hugegraph #386）</li> |
| <li>修复 RocksDB 磁盘利用率的 metrics 不正确问题 （hugegraph #326）</li> |
| <li>修复异步索引删除错误修复 （hugegraph #336）</li> |
| <li>修复 BackendSessionPool.close() 的竞争条件问题 （hugegraph #330）</li> |
| <li>修复保留的系统 ID 不工作问题 （hugegraph #315）</li> |
| <li>修复 cache 的 metrics 信息丢失问题 （hugegraph #321）</li> |
| <li>修复使用 hasId() 按 id 查询顶点时不支持数字 id 问题 （hugegraph #302）</li> |
| <li>修复重建索引时的 80w 限制问题和 Cassandra 后端的 batch 65535问题 （hugegraph #292）</li> |
| <li>修复残留索引删除无法处理未展开（none-flatten）查询的问题 （hugegraph #281）</li> |
| </ul> |
| <h4 id="内部修改-1">内部修改</h4> |
| <ul> |
| <li>迭代器变量统一命名为 ‘iter’（hugegraph #438）</li> |
| <li>增加 PageState.page() 方法统一获取分页信息接口 （hugegraph #429）</li> |
| <li>为基于 mapdb 的内存版后端调整代码结构，增加测试用例 （hugegraph #357）</li> |
| <li>支持代码覆盖率统计 （hugegraph #376）</li> |
| <li>设置 tx capacity 的下限为 COMMIT_BATCH（默认为500） （hugegraph #379）</li> |
| <li>增加 shutdown hook 来自动关闭线程池 （hugegraph #355）</li> |
| <li>PerfExample 的统计时间排除环境初始化时间 （hugegraph #329）</li> |
| <li>改进 BinarySerializer 中的 schema 序列化 （hugegraph #316）</li> |
| <li>避免对 primary key 的属性创建多余的索引 （hugegraph #317）</li> |
| <li>限制 Gremlin 异步任务的名字小于256字节 （hugegraph #313）</li> |
| <li>使用 multi-get 优化 HBase 后端的按 id 查询 （hugegraph #279）</li> |
| <li>支持更多的日期数据类型 （hugegraph #274）</li> |
| <li>修改 Cassandra 和 HBase 的 port 范围为（1，65535） （hugegraph #263）</li> |
| </ul> |
| <h4 id="其它">其它</h4> |
| <ul> |
| <li>增加 travis API 测试 （hugegraph #299）</li> |
| <li>删除 rest-server.properties 中的 GremlinServer 相关的默认配置项 （hugegraph #290）</li> |
| </ul> |
| <h3 id="loader">Loader</h3> |
| <h4 id="功能更新-2">功能更新</h4> |
| <ul> |
| <li>支持从 HDFS 和 关系型数据库导入数据 （hugegraph-loader #14）</li> |
| <li>支持传递权限 token 参数（hugegraph-loader #46）</li> |
| <li>支持通过 regex 指定要跳过的行 （hugegraph-loader #43）</li> |
| <li>支持导入 TEXT 文件时的 List/Set 属性（hugegraph-loader #38）</li> |
| <li>支持自定义的日期格式 （hugegraph-loader #28）</li> |
| <li>支持从指定目录导入数据 （hugegraph-loader #33）</li> |
| <li>支持忽略最后多余的列或者 null 值的列 （hugegraph-loader #23）</li> |
| </ul> |
| <h4 id="bug修复-2">BUG修复</h4> |
| <ul> |
| <li>修复 Example 问题（hugegraph-loader #57）</li> |
| <li>修复当 vertex 是 customized ID 策略时边解析问题（hugegraph-loader #24）</li> |
| </ul> |
| <h4 id="内部修改-2">内部修改</h4> |
| <ul> |
| <li>URL regex 改进 （hugegraph-loader #47）</li> |
| </ul> |
| <h3 id="tools">Tools</h3> |
| <h4 id="功能更新-3">功能更新</h4> |
| <ul> |
| <li>支持海量数据备份和恢复到本地和 HDFS，并支持压缩 （hugegraph-tools #21）</li> |
| <li>支持异步任务取消和清理功能 （hugegraph-tools #20）</li> |
| <li>改进 graph-clear 命令的提示信息 （hugegraph-tools #23）</li> |
| </ul> |
| <h4 id="bug修复-3">BUG修复</h4> |
| <ul> |
| <li>修复 restore 命令总是使用 ‘hugegraph’ 作为目标图的问题，支持指定图 （hugegraph-tools #26）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-f98fd193653a4b93fb4b460f9f1333f8">9.5 - HugeGraph 0.8 Release Notes</h1> |
| |
| <h3 id="api--client">API & Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>服务端增加 rays 和 rings 的 RESTful API（hugegraph #45）</li> |
| <li>使创建 IndexLabel 返回异步任务（hugegraph #95，hugegraph-client #9）</li> |
| <li>客户端增加恢复模式相关的 API（hugegraph-client #10）</li> |
| <li>让 task-list API 不返回 task_input 和 task_result（hugegraph #143）</li> |
| <li>增加取消异步任务的API（hugegraph #167，hugegraph-client #15）</li> |
| <li>增加获取后端 metrics 的 API（hugegraph #155）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>分页获取时最后一页的 page 应该为 null 而非 “null”（hugegraph #168）</li> |
| <li>分页迭代获取服务端已经没有下一页了应该停止获取（hugegraph-client #16）</li> |
| <li>添加顶点使用自定义 Number Id 时报类型无法转换（hugegraph-client #21）</li> |
| </ul> |
| <h4 id="内部修改">内部修改</h4> |
| <ul> |
| <li>增加持续集成测试（hugegraph-client #19）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>取消异步任务通过 label 查询时 80w 的限制（hugegraph #93）</li> |
| <li>允许 cardinality 为 set 时传入 Json List 形式的属性值（hugegraph #109）</li> |
| <li>支持在恢复模式和合并模式来恢复图（hugegraph #114）</li> |
| <li>RocksDB 后端支持多个图指定为同一个存储目录（hugegraph #123）</li> |
| <li>支持用户自定义权限认证器（hugegraph-loader #133）</li> |
| <li>当服务重启后重新开始未完成的任务（hugegraph #188）</li> |
| <li>当顶点的 Id 策略为自定义时，检查是否已存在相同 Id 的顶点（hugegraph #189）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>增加对 HasContainer 的 predicate 不为 null 的检查（hugegraph #16）</li> |
| <li>RocksDB 后端由于数据目录和日志目录错误导致 init-store 失败（hugegraph #25）</li> |
| <li>启动 hugegraph 时由于 logs 目录不存在导致提示超时但实际可访问（hugegraph #38）</li> |
| <li>ScyllaDB 后端遗漏注册顶点表（hugegraph #47）</li> |
| <li>使用 hasLabel 查询传入多个 label 时失败（hugegraph #50）</li> |
| <li>Memory 后端未初始化 task 相关的 schema（hugegraph #100）</li> |
| <li>当使用 hasLabel 查询时，如果元素数量超过 80w，即使加上 limit 也会报错（hugegraph #104）</li> |
| <li>任务的在运行之后没有保存过状态（hugegraph #113）</li> |
| <li>检查后端版本信息时直接强转 HugeGraphAuthProxy 为 HugeGraph（hugegraph #127）</li> |
| <li>配置项 batch.max_vertices_per_batch 未生效（hugegraph #130）</li> |
| <li>配置文件 rest-server.properties 有错误时 HugeGraphServer 启动不报错，但是无法访问（hugegraph #131）</li> |
| <li>MySQL 后端某个线程的提交对其他线程不可见（hugegraph #163）</li> |
| <li>使用 union(branch) + has(date) 查询时提示 String 无法转换为 Date（hugegraph #181）</li> |
| <li>使用 RocksDB 后端带 limit 查询顶点时会返回不完整的结果（hugegraph #197）</li> |
| <li>提示其他线程无法操作 tx（hugegraph #204）</li> |
| </ul> |
| <h4 id="内部修改-1">内部修改</h4> |
| <ul> |
| <li>拆分 graph.cache_xx 配置项为 vertex.cache_xx 和 edge.cache_xx 两类（hugegraph #56）</li> |
| <li>去除 hugegraph-dist 对 hugegraph-api 的依赖（hugegraph #61）</li> |
| <li>优化集合取交集和取差集的操作（hugegraph #85）</li> |
| <li>优化 transaction 的缓存处理和索引及 Id 查询（hugegraph #105）</li> |
| <li>给各线程池的线程命名（hugegraph #124）</li> |
| <li>增加并优化了一些 metrics 统计（hugegraph #138）</li> |
| <li>增加了对未完成任务的 metrics 记录（hugegraph #141）</li> |
| <li>让索引更新以分批方式提交，而不是全量提交（hugegraph #150）</li> |
| <li>在添加顶点/边时一直持有 schema 的读锁，直到提交/回滚完成（hugegraph #180）</li> |
| <li>加速 Tinkerpop 测试（hugegraph #19）</li> |
| <li>修复 Tinkerpop 测试在 resource 目录下找不到 filter 文件的 BUG（hugegraph #26）</li> |
| <li>开启 Tinkerpop 测试中 supportCustomIds 特性（hugegraph #69）</li> |
| <li>持续集成中添加 HBase 后端的测试（hugegraph #41）</li> |
| <li>避免持续集成的 deploy 脚本运行多次（hugegraph #170）</li> |
| <li>修复 cache 单元测试跑不过的问题（hugegraph #177）</li> |
| <li>持续集成中修改部分后端的存储为 tmpfs 以加快测试速度（hugegraph #206）</li> |
| </ul> |
| <h4 id="其它">其它</h4> |
| <ul> |
| <li>增加 issue 模版（hugegraph #42）</li> |
| <li>增加 CONTRIBUTING 文件（hugegraph #59）</li> |
| </ul> |
| <h3 id="loader">Loader</h3> |
| <h4 id="功能更新-2">功能更新</h4> |
| <ul> |
| <li>支持忽略源文件某些特定列（hugegraph-loader #2）</li> |
| <li>支持导入 cardinality 为 Set 的属性数据（hugegraph-loader #10）</li> |
| <li>单条插入也使用多个线程执行，解决了错误多时最后单条导入慢的问题（hugegraph-loader #12）</li> |
| </ul> |
| <h4 id="bug修复-2">BUG修复</h4> |
| <ul> |
| <li>导入过程可能统计出错（hugegraph-loader #4）</li> |
| <li>顶点使用自定义 Number Id 导入出错（hugegraph-loader #6）</li> |
| <li>顶点使用联合主键时导入出错（hugegraph-loader #18）</li> |
| </ul> |
| <h4 id="内部修改-2">内部修改</h4> |
| <ul> |
| <li>增加持续集成测试（hugegraph-loader #8）</li> |
| <li>优化检测到文件不存在时的提示信息（hugegraph-loader #16）</li> |
| </ul> |
| <h3 id="tools">Tools</h3> |
| <h4 id="功能更新-3">功能更新</h4> |
| <ul> |
| <li>增加 KgDumper （hugegraph-tools #6）</li> |
| <li>支持在恢复模式和合并模式中恢复图（hugegraph-tools #9）</li> |
| </ul> |
| <h4 id="bug修复-3">BUG修复</h4> |
| <ul> |
| <li>脚本中的工具函数 get_ip 在系统未安装 ifconfig 时报错（hugegraph-tools #13）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-d2f7c78812d582db588f4a926a665a30">9.6 - HugeGraph 0.7 Release Notes</h1> |
| |
| <h3 id="api--java-client">API & Java Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>支持异步删除元数据和重建索引（HugeGraph-889）</li> |
| <li>加入监控API，并与Gremlin的监控框架集成（HugeGraph-1273）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>EdgeAPI更新属性时会将属性值也置为属性键（HugeGraph-81）</li> |
| <li>当删除顶点或边时，如果id非法应该返回400错误而非404（HugeGraph-1337）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>支持HBase后端存储（HugeGraph-1280）</li> |
| <li>增加异步API框架，耗时操作可通过调用异步API实现（HugeGraph-387）</li> |
| <li>支持对长属性列建立二级索引，取消目前索引列长度256字节的限制（HugeGraph-1314）</li> |
| <li>支持顶点属性的“创建或更新”操作（HugeGraph-1303）</li> |
| <li>支持全文检索功能（HugeGraph-1322）</li> |
| <li>支持数据库表的版本号检查（HugeGraph-1328）</li> |
| <li>删除顶点时，如果遇到超级点的时候报错"Batch too large"或“Batch 65535 statements”（HugeGraph-1354）</li> |
| <li>支持异步删除元数据和重建索引（HugeGraph-889）</li> |
| <li>支持异步长时间执行Gremlin任务（HugeGraph-889）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>防止超级点访问时查询过多下一层顶点而阻塞服务（HugeGraph-1302）</li> |
| <li>HBase初始化时报错连接已经关闭（HugeGraph-1318）</li> |
| <li>按照date属性过滤顶点报错String无法转为Date（HugeGraph-1319）</li> |
| <li>残留索引删除，对range索引的判断存在错误（HugeGraph-1291）</li> |
| <li>支持组合索引后，残留索引清理没有考虑索引组合的情况（HugeGraph-1311）</li> |
| <li>根据otherV的条件来删除边时，可能会因为边的顶点不存在导致错误（HugeGraph-1347）</li> |
| <li>label索引对offset和limit结果错误（HugeGraph-1329）</li> |
| <li>vertex label或者edge label没有开启label index，删除label会导致数据无法删除（HugeGraph-1355）</li> |
| </ul> |
| <h4 id="内部修改">内部修改</h4> |
| <ul> |
| <li>hbase后端代码引入较新版本的Jackson-databind包，导致HugeGraphServer启动异常（HugeGraph-1306）</li> |
| <li>Core和Client都自己持有一个shard类，而不是依赖于common模块（HugeGraph-1316）</li> |
| <li>去掉rebuild index和删除vertex label和edge label时的80w的capacity限制（HugeGraph-1297）</li> |
| <li>所有schema操作需要考虑同步问题（HugeGraph-1279）</li> |
| <li>拆分Cassandra的索引表，把element id每条一行，避免聚合高时，导入速度非常慢甚至卡住（HugeGraph-1304）</li> |
| <li>将hugegraph-test中关于common的测试用例移动到hugegraph-common中（HugeGraph-1297）</li> |
| <li>异步任务支持保存任务参数，以支持任务恢复（HugeGraph-1344）</li> |
| <li>支持通过脚本部署文档到GitHub（HugeGraph-1351）</li> |
| <li>RocksDB和Hbase后端索引删除实现（HugeGraph-1317）</li> |
| </ul> |
| <h3 id="loader">Loader</h3> |
| <h4 id="功能更新-2">功能更新</h4> |
| <ul> |
| <li>HugeLoader支持用户手动创建schema，以文件的方式传入（HugeGraph-1295）</li> |
| </ul> |
| <h4 id="bug修复-2">BUG修复</h4> |
| <ul> |
| <li>HugeLoader导数据时未区分输入文件的编码，导致可能产生乱码（HugeGraph-1288）</li> |
| <li>HugeLoader打包的example目录的三个子目录下没有文件（HugeGraph-1288）</li> |
| <li>导入的CSV文件中如果数据列本身包含逗号会解析出错（HugeGraph-1320）</li> |
| <li>批量插入避免单条失败导致整个batch都无法插入（HugeGraph-1336）</li> |
| <li>异常信息作为模板打印异常（HugeGraph-1345）</li> |
| <li>导入边数据，当列数不对时导致程序退出（HugeGraph-1346）</li> |
| <li>HugeLoader的自动创建schema失败（HugeGraph-1363）</li> |
| <li>ID长度检查应该检查字节长度而非字符串长度（HugeGraph-1374）</li> |
| </ul> |
| <h4 id="内部修改-1">内部修改</h4> |
| <ul> |
| <li>添加测试用例（HugeGraph-1361）</li> |
| </ul> |
| <h3 id="tools">Tools</h3> |
| <h4 id="功能更新-3">功能更新</h4> |
| <ul> |
| <li>backup/restore使用多线程加速，并增加retry机制（HugeGraph-1307）</li> |
| <li>一键部署支持传入路径以存放包（HugeGraph-1325）</li> |
| <li>实现dump图功能（内存构建顶点及关联边）（HugeGraph-1339）</li> |
| <li>增加backup-scheduler功能，支持定时备份且保留一定数目最新备份（HugeGraph-1326）</li> |
| <li>增加异步任务查询和异步执行Gremlin的功能（HugeGraph-1357）</li> |
| </ul> |
| <h4 id="bug修复-3">BUG修复</h4> |
| <ul> |
| <li>hugegraph-tools的backup和restore编码为UTF-8（HugeGraph-1321）</li> |
| <li>hugegraph-tools设置默认JVM堆大小和发布版本号（HugeGraph-1340）</li> |
| </ul> |
| <h3 id="studio">Studio</h3> |
| <h4 id="bug修复-4">BUG修复</h4> |
| <ul> |
| <li>HugeStudio中顶点id包含换行符时g.V()会导致groovy解析出错（HugeGraph-1292）</li> |
| <li>限制返回的顶点及边的数量（HugeGraph-1333）</li> |
| <li>加载note出现消失或者卡住情况（HugeGraph-1353）</li> |
| <li>HugeStudio打包时，编译失败但没有报错，导致发布包无法启动（HugeGraph-1368）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-a40680f3cb756d27c8ad790330229be2">9.7 - HugeGraph 0.6 Release Notes</h1> |
| |
| <h3 id="api--java-client">API & Java Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>增加RESTFul API paths和crosspoints，找出source到target顶点间多条路径或包含交叉点的路径（HugeGraph-1210）</li> |
| <li>在API层添加批量插入并发数的控制，避免出现全部的线程都用于写而无法查询的情况（HugeGraph-1228）</li> |
| <li>增加scan-API，允许客户端并发地获取顶点和边（HugeGraph-1197）</li> |
| <li>Client支持传入用户名密码访问带权限控制的HugeGraph（HugeGraph-1256）</li> |
| <li>为顶点及边的list API添加offset参数（HugeGraph-1261）</li> |
| <li>RESTful API的顶点/边的list不允许同时传入page 和 [label，属性]（HugeGraph-1262）</li> |
| <li>k-out、K-neighbor、paths、shortestpath等API增加degree、capacity和limit（HugeGraph-1176）</li> |
| <li>增加restore status的set/get/clear接口（HugeGraph-1272）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>使 RestClient的basic auth使用Preemptive模式（HugeGraph-1257）</li> |
| <li>HugeGraph-Client中由ResultSet获取多次迭代器，除第一次外其他的无法迭代（HugeGraph-1278）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>RocksDB实现scan特性（HugeGraph-1198）</li> |
| <li>Schema userdata 提供删除 key 功能（HugeGraph-1195）</li> |
| <li>支持date类型属性的范围查询（HugeGraph-1208）</li> |
| <li>limit下沉到backend，尽可能不进行多余的索引读取（HugeGraph-1234）</li> |
| <li>增加 API 权限与访问控制（HugeGraph-1162）</li> |
| <li>禁止多个后端配置store为相同的值（HugeGraph-1269）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>RocksDB的Range查询时如果只指定上界或下界会查出其他IndexLabel的记录（HugeGraph-1211）</li> |
| <li>RocksDB带limit查询时，graphTransaction查询返回的结果多一个（HugeGraph-1234）</li> |
| <li>init-store在CentOS上依赖通用的io.netty有时会卡住，改为使用netty-transport-native-epoll（HugeGraph-1255）</li> |
| <li>Cassandra后端in语句（按id查询）元素个数最大65535（HugeGraph-1239）</li> |
| <li>主键加索引(或普通属性)作为查询条件时报错（HugeGraph-1276）</li> |
| <li>init-store.sh在Centos平台上初始化失败或者卡住（HugeGraph-1255）</li> |
| </ul> |
| <h3 id="测试">测试</h3> |
| <p>无</p> |
| <h3 id="内部修改">内部修改</h3> |
| <ul> |
| <li>将compareNumber方法搬移至common模块（HugeGraph-1208）</li> |
| <li>修复HugeGraphServer无法在Ubuntu机器上启动的Bug（HugeGraph-1154）</li> |
| <li>修复init-store.sh无法在bin目录下执行的BUG（HugeGraph-1223）</li> |
| <li>修复HugeGraphServer启动过程中无法通过CTRL+C终止的BUG（HugeGraph-1223）</li> |
| <li>HugeGraphServer启动前检查端口是否被占用（HugeGraph-1223）</li> |
| <li>HugeGraphServer启动前检查系统JDK是否安装以及版本是否为1.8（HugeGraph-1223）</li> |
| <li>给HugeConfig类增加getMap()方法（HugeGraph-1236）</li> |
| <li>修改默认配置项，后端使用RocksDB，注释重要的配置项（HugeGraph-1240）</li> |
| <li>重命名userData为userdata（HugeGraph-1249）</li> |
| <li>centos 4.3系统HugeGraphServer进程使用jps命令查不到</li> |
| <li>增加配置项ALLOW_TRACE，允许设置是否返回exception stack trace（HugeGraph-81）</li> |
| </ul> |
| <h3 id="tools">Tools</h3> |
| <h4 id="功能更新-2">功能更新</h4> |
| <ul> |
| <li>增加自动化部署工具以安装所有组件（HugeGraph-1267）</li> |
| <li>增加clear的脚本，并拆分deploy和start-all（HugeGraph-1274）</li> |
| <li>对hugegraph服务进行监控以提高可用性（HugeGraph-1266）</li> |
| <li>增加backup/restore功能和命令（HugeGraph-1272）</li> |
| <li>增加graphs API对应的命令（HugeGraph-1272）</li> |
| </ul> |
| <h4 id="bug修复-2">BUG修复</h4> |
| <h3 id="loader">Loader</h3> |
| <h4 id="功能更新-3">功能更新</h4> |
| <ul> |
| <li>默认添加csv及json的示例（HugeGraph-1259）</li> |
| </ul> |
| <h4 id="bug修复-3">BUG修复</h4> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-04bf2aaf34cd0b77f14833dec809fab4">9.8 - HugeGraph 0.5 Release Notes</h1> |
| |
| <h3 id="api--java-client">API & Java Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>VertexLabel与EdgeLabel增加bool参数enable_label_index表述是否构建label索引（HugeGraph-1085）</li> |
| <li>增加RESTful API来支持高效shortest path，K-out和K-neighbor查询（HugeGraph-944）</li> |
| <li>增加RESTful API支持按id列表批量查询顶点（HugeGraph-1153）</li> |
| <li>支持迭代获取全部的顶点和边，使用分页实现（HugeGraph-1166）</li> |
| <li>顶点id中包含 / % 等 URL 保留字符时通过 VertexAPI 查不出来（HugeGraph-1127）</li> |
| <li>批量插入边时是否检查vertex的RESTful API参数从checkVertex改为check_vertex (HugeGraph-81)</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>hasId()无法正确匹配LongId（HugeGraph-1083）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>RocksDB支持常用配置项（HugeGraph-1068）</li> |
| <li>支持插入、删除、更新等操作的限速（HugeGraph-1071）</li> |
| <li>支持RocksDB导入sst文件方案（HugeGraph-1077）</li> |
| <li>增加MySQL后端存储（HugeGraph-1091）</li> |
| <li>增加Palo后端存储（HugeGraph-1092）</li> |
| <li>增加开关：支持是否构建顶点/边的label index（HugeGraph-1085）</li> |
| <li>支持API分页获取数据（HugeGraph-1105）</li> |
| <li>RocksDB配置的数据存放目录如果不存在则自动创建（HugeGraph-1135）</li> |
| <li>增加高级遍历函数shortest path、K-neighbor，K-out和按id列表批量查询顶点（HugeGraph-944）</li> |
| <li>init-store.sh增加超时重试机制（HugeGraph-1150）</li> |
| <li>将边表拆分两个表：OUT表、IN表（HugeGraph-1002）</li> |
| <li>限制顶点ID最大长度为128字节（HugeGraph-1168）</li> |
| <li>Cassandra通过压缩数据（可配置snappy、lz4）进行优化（HugeGraph-428）</li> |
| <li>支持IN和OR操作（HugeGraph-137）</li> |
| <li>支持RocksDB并行写多个磁盘（HugeGraph-1177）</li> |
| <li>MySQL通过批量插入进行性能优化（HugeGraph-1188）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>Kryo系列化多线程时异常（HugeGraph-1066）</li> |
| <li>RocksDB索引内容中重复写了两次elem-id（HugeGraph-1094）</li> |
| <li>SnowflakeIdGenerator.instance在多线程环境下可能会初始化多个实例（HugeGraph-1095）</li> |
| <li>如果查询边的顶点但顶点不存在时，异常信息不够明确（HugeGraph-1101）</li> |
| <li>RocksDB配置了多个图时，init-store失败（HugeGraph-1151）</li> |
| <li>无法支持 Date 类型的属性值（HugeGraph-1165）</li> |
| <li>创建了系统内部索引，但无法根据其进行搜索（HugeGraph-1167）</li> |
| <li>拆表后根据label删除边时，edge-in表中的记录未被删除成功（HugeGraph-1182）</li> |
| </ul> |
| <h3 id="测试">测试</h3> |
| <ul> |
| <li>增加配置项：vertex.force_id_string，跑 tinkerpop 测试时打开（HugeGraph-1069）</li> |
| </ul> |
| <h3 id="内部修改">内部修改</h3> |
| <ul> |
| <li>common库OptionChecker增加allowValues()函数用于枚举值（HugeGraph-1075）</li> |
| <li>清理无用、版本老旧的依赖包，减少打包的压缩包的大小（HugeGraph-1078）</li> |
| <li>HugeConfig通过文件路径构造时，无法检查多次配置的配置项的值（HugeGraph-1079）</li> |
| <li>Server启动时可以支持智能分配最大内存（HugeGraph-1154）</li> |
| <li>修复Mac OS因为不支持free命令导致无法启动server的问题（HugeGraph-1154）</li> |
| <li>修改配置项的注册方式为字符串式，避免直接依赖Backend包（HugeGraph-1171）</li> |
| <li>增加StoreDumper工具以查看后端存储的数据内容（HugeGraph-1172）</li> |
| <li>Jenkins把所有与内部服务器有关的构建机器信息都参数化传入（HugeGraph-1179）</li> |
| <li>将RestClient移到common模块，令server和client都依赖common（HugeGraph-1183）</li> |
| <li>增加配置项dump工具ConfDumper（HugeGraph-1193）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-f3de79fd20e587ee8e2ed9c14e6b546e">9.9 - HugeGraph 0.4.4 Release Notes</h1> |
| |
| <h3 id="api--java-client">API & Java Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>HugeGraph-Server支持WebSocket，能用Gremlin-Console连接使用；并支持直接编写groovy脚本调用Core的代码（HugeGraph-977）</li> |
| <li>适配Schema-id（HugeGraph-1038）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>hugegraph-0.3.3：删除vertex的属性，body中properties=null，返回500，空指针（HugeGraph-950）</li> |
| <li>hugegraph-0.3.3： graph.schema().getVertexLabel() 空指针（HugeGraph-955）</li> |
| <li>HugeGraph-Client 中顶点和边的属性集合不是线程安全的（HugeGraph-1013）</li> |
| <li>批量操作的异常信息无法打印（HugeGraph-1013）</li> |
| <li>异常message提示可读性太差，都是用propertyKey的id显示，对于用户来说无法立即识别（HugeGraph-1055）</li> |
| <li>批量新增vertex实体，有一个body体为null，返回500，空指针（HugeGraph-1056）</li> |
| <li>追加属性body体中只包含properties，功能出现回退，抛出异常The label of vertex can’t be null（HugeGraph-1057）</li> |
| <li>HugeGraph-Client适配：PropertyKey的DateType中Timestamp替换成Date（HugeGraph-1059）</li> |
| <li>创建IndexLabel时baseValue为空会报出500错误（HugeGraph-1061）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>实现上层独立事务管理，并兼容tinkerpop事务规范（HugeGraph-918、HugeGraph-941）</li> |
| <li>完善memory backend，可以通过API正确访问，且适配了tinkerpop事务（HugeGraph-41）</li> |
| <li>增加RocksDB后端存储驱动框架（HugeGraph-929）</li> |
| <li>RocksDB数字索引range-query实现（HugeGraph-963）</li> |
| <li>为所有的schema增加了id，并将各表原依赖name的列也换成id（HugeGraph-589）</li> |
| <li>填充query key-value条件时，value的类型如果不匹配key定义的类型时需要转换为该类型（HugeGraph-964）</li> |
| <li>统一各后端的offset、limit实现（HugeGraph-995）</li> |
| <li>查询顶点、边时，Core支持迭代方式返回结果，而非一次性载入内存（HugeGraph-203）</li> |
| <li>memory backend支持range query（HugeGraph-967）</li> |
| <li>memory backend的secondary的支持方式从遍历改为IdQuery（HugeGraph-996）</li> |
| <li>联合索引支持复杂的（只要逻辑上可以查都支持）多种索引组合查询（HugeGraph-903）</li> |
| <li>Schema中增加存储用户数据的域（map）（HugeGraph-902）</li> |
| <li>统一ID的解析及系列化（包括API及Backend）（HugeGraph-965）</li> |
| <li>RocksDB没有keyspace概念，需要完善对多图实例的支持（HugeGraph-973）</li> |
| <li>支持Cassandra设置连接用户名密码（HugeGraph-999）</li> |
| <li>Schema缓存支持缓存所有元数据（get-all-schema）（HugeGraph-1037）</li> |
| <li>目前依然保持schema对外暴露name，暂不直接使用schema id（HugeGraph-1032）</li> |
| <li>用户传入ID的策略的修改为支持String和Number（HugeGraph-956）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>删除旧的前缀indexLabel时数据库中的schemaLabel对象还有残留（HugeGraph-969）</li> |
| <li>HugeConfig解析时共用了公共的Option，导致不同graph的配置项有覆盖（HugeGraph-984）</li> |
| <li>数据库数据不兼容时，提示更加友好的异常信息（HugeGraph-998）</li> |
| <li>支持Cassandra设置连接用户名密码（HugeGraph-999）</li> |
| <li>RocksDB deleteRange end溢出后触发RocksDB assert错误（HugeGraph-971）</li> |
| <li>允许根据null值id进行查询顶点/边，返回结果为空集合（HugeGraph-1045）</li> |
| <li>内存中存在部分更新数据未提交时，搜索结果不对（HugeGraph-1046）</li> |
| <li>g.V().hasLabel(XX)传入不存在的label时报错： Internal Server Error and Undefined property key: ‘~label’（HugeGraph-1048）</li> |
| <li>gremlin获取的的schema只剩下名称字符串（HugeGraph-1049）</li> |
| <li>大量数据情况下无法进行count操作（HugeGraph-1051）</li> |
| <li>RocksDB持续插入6~8千万条边时卡住（HugeGraph-1053）</li> |
| <li>整理属性类型的支持，并在BinarySerializer中使用二进制格式系列化属性值（HugeGraph-1062）</li> |
| </ul> |
| <h3 id="测试">测试</h3> |
| <ul> |
| <li>增加tinkerpop的performance测试（HugeGraph-987）</li> |
| </ul> |
| <h3 id="内部修改">内部修改</h3> |
| <ul> |
| <li>HugeFactory打开同一个图（name相同者）时，共用HugeGraph对象即可（HugeGraph-983）</li> |
| <li>规范索引类型命名secondary、range、search（HugeGraph-991）</li> |
| <li>数据库数据不兼容时，提示更加友好的异常信息（HugeGraph-998）</li> |
| <li>IO部分的 gryo 和 graphson 的module分开（HugeGraph-1041）</li> |
| <li>增加query性能测试到PerfExample中（HugeGraph-1044）</li> |
| <li>关闭gremlin-server的metric日志（HugeGraph-1050）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-ac8684ea0cd7198b6b256e2e5df6b75f">9.10 - HugeGraph 0.3.3 Release Notes</h1> |
| |
| <h3 id="api--java-client">API & Java Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <ul> |
| <li>为vertex-label和edge-label增加可空属性集合，允许在create和append时指定（HugeGraph-245）</li> |
| <li>配合core的功能为用户提供tinkerpop variables RESTful API（HugeGraph-396）</li> |
| <li>支持顶点／边属性的更新和删除（HugeGraph-894）</li> |
| <li>支持顶点／边的条件查询（HugeGraph-919）</li> |
| </ul> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>HugeGraph-API接收的RequestBody为null或"“时抛出空指针异常（HugeGraph-795）</li> |
| <li>为HugeGraph-API添加输入参数检查，避免抛出空指针异常（HugeGraph-796 ～ HugeGraph-798，HugeGraph-802，HugeGraph-808 ～ HugeGraph-814，HugeGraph-817，HugeGraph-823，HugeGraph-860）</li> |
| <li>创建缺失outV-label 或者 inV-label的实体边，依然能够被创建成功，不符合需求（HugeGraph-835）</li> |
| <li>创建vertex-label和edge-label时可以任意传入index-names（HugeGraph-837）</li> |
| <li>创建index，base-type=“VERTEX”等值（期望VL、EL），返回500（HugeGraph-846）</li> |
| <li>创建index，base-type和base-value不匹配，提示不友好（HugeGraph-848）</li> |
| <li>删除已经不存在的两个实体之间的关系，schema返回204，顶点和边类型的则返回404（期望统一为404）（HugeGraph-853，HugeGraph-854）</li> |
| <li>给vertex-label追加属性，缺失id-strategy，返回信息有误（HugeGraph-861）</li> |
| <li>给edge-label追加属性，name缺失，提示信息有误（HugeGraph-862）</li> |
| <li>给edge-label追加属性，source-label为“null”，提示信息有误（HugeGraph-863）</li> |
| <li>查询时的StringId如果为空字符串应该抛出异常（HugeGraph-868）</li> |
| <li>通Rest API创建两个顶点之间的边，在studio中通过g.V()则刚新创建的边则不显示，g.E()则能够显示新创建的边（HugeGraph-869）</li> |
| <li>HugeGraph-Server的内部错误500，不应该将stack trace返回给Client（HugeGraph-879）</li> |
| <li>addEdge传入空的id字符串时会抛出非法参数异常（HugeGraph-885）</li> |
| <li>HugeGraph-Client 的 Gremlin 查询结果在解析 Path 时，如果不包含Vertex／Edge会反序列化异常（HugeGraph-891）</li> |
| <li>枚举HugeKeys的字符串变成小写字母加下划线，导致API序列化时字段名与类中变量名不一致，进而序列化失败（HugeGraph-896）</li> |
| <li>增加边到不存在的顶点时返回404（期望400）（HugeGraph-922）</li> |
| </ul> |
| <h3 id="core">Core</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>支持对顶点/边属性（包括索引列）的更新操作（HugeGraph-369）</li> |
| <li>索引field为空或者空字符串的支持（hugegraph-553和hugegraph-288）</li> |
| <li>vertex/edge的属性一致性保证推迟到实际要访问属性时（hugegraph-763）</li> |
| <li>增加ScyllaDB后端驱动（HugeGraph-772）</li> |
| <li>支持tinkerpop的hasKey、hasValue查询（HugeGraph-826）</li> |
| <li>支持tinkerpop的variables功能(HugeGraph-396)</li> |
| <li>以“~”为开头的为系统隐藏属性，用户不可以创建(HugeGraph-842)</li> |
| <li>增加Backend Features以兼容不同后端的特性(HugeGraph-844)</li> |
| <li>对mutation的update可能出现的操作不直接抛错，进行细化处理（HugeGraph-887）</li> |
| <li>对append到vertex-label/edge-label的property检查，必须是nullable的（HugeGraph-890）</li> |
| <li>对于按照id查询，当有的id不存在时，返回其余存在的对象，而非直接抛异常（HugeGraph-900）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>Vertex.edges(Direction.BOTH,…) assert error（HugeGraph-661）</li> |
| <li>无法支持在addVertex函数中对同一property（single）多次赋值（HugeGraph-662）</li> |
| <li>更新属性时不涉及更新的索引列会丢失（HugeGraph-801）</li> |
| <li>GraphTransaction中的ConditionQuery需要索引查询时，没有触发commit，导致查询失败（HugeGraph-805）</li> |
| <li>Cassandra不支持query offset，查询时limit=offset+limit取回所有记录后过滤（HugeGraph-851）</li> |
| <li>多个插入操作加上一个删除操作，插入操作会覆盖删除操作（HugeGraph-857）</li> |
| <li>查询时的StringId如果为空字符串应该抛出异常（HugeGraph-868）</li> |
| <li>元数据schema方法只返回 hidden 信息（HugeGraph-912）</li> |
| </ul> |
| <h3 id="测试">测试</h3> |
| <ul> |
| <li>tinkerpop的structure和process测试使用不同的keyspace（HugeGraph-763）</li> |
| <li>将tinkerpop测试和unit测试添加到流水线release-after-merge中（HugeGraph-763）</li> |
| <li>jenkins脚本分离各阶段子脚本，修改项目中的子脚本即可生效构建（HugeGraph-800）</li> |
| <li>增加clear backends功能，在tinkerpop suite运行完成后清除后端（HugeGraph-852）</li> |
| <li>增加BackendMutation的测试（HugeGraph-801）</li> |
| <li>多线程操作图时可能抛出NoHostAvailableException异常（HugeGraph-883）</li> |
| </ul> |
| <h3 id="内部修改">内部修改</h3> |
| <ul> |
| <li>调整HugeGraphServer和HugeGremlinServer启动时JVM的堆内存初始为256M，最大为2048M（HugeGraph-218）</li> |
| <li>创建Cassandra Table时，使用schemaBuilder代替字符串拼接（hugegraph-773）</li> |
| <li>运行测试用例时如果初始化图失败（比如数据库连接不上），clear()报错（HugeGraph-910）</li> |
| <li>Example抛异常 Need to specify a readable config file rather than…（HugeGraph-921）</li> |
| <li>HugeGraphServer和HugeGreminServer的缓存保持同步（HugeGraph-569）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-3eb16892048936d4f8440f9216d11b41">9.11 - HugeGraph 0.2 Release Notes</h1> |
| |
| <h3 id="api--java-client">API & Java Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <p>0.2版实现了图数据库基本功能，提供如下功能：</p> |
| <h3 id="元数据schema">元数据（Schema）</h3> |
| <h4 id="顶点类型vertex-label">顶点类型（Vertex Label）</h4> |
| <ul> |
| <li>创建顶点类型</li> |
| <li>删除顶点类型</li> |
| <li>查询顶点类型</li> |
| <li>增加顶点类型的属性</li> |
| </ul> |
| <h4 id="边类型edge-label">边类型（Edge Label）</h4> |
| <ul> |
| <li>创建边类型</li> |
| <li>删除边类型</li> |
| <li>查询边类型</li> |
| <li>增加边类型的属性</li> |
| </ul> |
| <h4 id="属性property-key">属性（Property Key）</h4> |
| <ul> |
| <li>创建属性</li> |
| <li>删除属性</li> |
| <li>查询属性</li> |
| </ul> |
| <h4 id="索引index-label">索引（Index Label）</h4> |
| <ul> |
| <li>创建索引</li> |
| <li>删除索引</li> |
| <li>查询索引</li> |
| </ul> |
| <h4 id="元数据检查">元数据检查</h4> |
| <ul> |
| <li>元数据依赖的其它元数据检查（如Vertex Label依赖Property Key）</li> |
| <li>数据依赖的元数据检查（如Vertex依赖Vertex Label）</li> |
| </ul> |
| <h3 id="图数据">图数据</h3> |
| <h4 id="顶点vertex">顶点（Vertex）</h4> |
| <ul> |
| <li> |
| <p>增加顶点</p> |
| </li> |
| <li> |
| <p>删除顶点</p> |
| </li> |
| <li> |
| <p>增加顶点属性</p> |
| </li> |
| <li> |
| <p>删除顶点属性（必须为非索引列）</p> |
| </li> |
| <li> |
| <p>批量插入顶点</p> |
| </li> |
| <li> |
| <p>查询</p> |
| </li> |
| <li> |
| <p>批量查询</p> |
| </li> |
| <li> |
| <p>顶点ID策略</p> |
| <ul> |
| <li>用户指定ID（字符串）</li> |
| <li>用户指定某些属性组合作为ID（拼接为可见字符串）</li> |
| <li>自动生成ID</li> |
| </ul> |
| </li> |
| </ul> |
| <h4 id="边edge">边（Edge）</h4> |
| <ul> |
| <li>增加边</li> |
| <li>增加多条同类型边到指定的两个节点（SortKey）</li> |
| <li>删除边</li> |
| <li>增加边属性</li> |
| <li>删除边属性（必须为非索引列）</li> |
| <li>批量插入边</li> |
| <li>查询</li> |
| <li>批量查询</li> |
| </ul> |
| <h4 id="顶点边属性">顶点/边属性</h4> |
| <ul> |
| <li> |
| <p>属性类型支持</p> |
| <ul> |
| <li>text</li> |
| <li>boolean</li> |
| <li>byte、blob</li> |
| <li>int、long</li> |
| <li>float、double</li> |
| <li>timestamp</li> |
| <li>uuid</li> |
| </ul> |
| </li> |
| <li> |
| <p>支持单值属性</p> |
| </li> |
| <li> |
| <p>支持多值属性：List、Set（<em>注意：非嵌套属性</em>）</p> |
| </li> |
| </ul> |
| <h3 id="事务">事务</h3> |
| <ul> |
| <li>原子性级别保证（<em>依赖后端</em>）</li> |
| <li>自动提交事务</li> |
| <li>手动提交事务</li> |
| <li>并行事务</li> |
| </ul> |
| <h3 id="索引">索引</h3> |
| <h4 id="索引类型">索引类型</h4> |
| <ul> |
| <li>二级索引</li> |
| <li>范围索引（数字类型）</li> |
| </ul> |
| <h4 id="索引操作">索引操作</h4> |
| <ul> |
| <li>为指定类型的顶点/边创建单列索引（不支持List或Set列创建索引）</li> |
| <li>为指定类型的顶点/边创建复合索引（不支持List或Set列创建索引，复合索引为前缀索引）</li> |
| <li>删除指定类型顶点/边的索引（部分或全部索引均可）</li> |
| <li>重建指定类型顶点/边的索引（部分或全部索引均可）</li> |
| </ul> |
| <h3 id="查询遍历">查询/遍历</h3> |
| <ul> |
| <li> |
| <p>列出所有元数据、图数据（支持Limit，不支持分页）</p> |
| </li> |
| <li> |
| <p>根据ID查询元数据、图数据</p> |
| </li> |
| <li> |
| <p>根据指定属性的值查询图数据</p> |
| </li> |
| <li> |
| <p>根据指定属性的值范围查询图数据（属性必须为数字类型）</p> |
| </li> |
| <li> |
| <p>根据指定顶点/边类型、指定属性的值查询顶点/边</p> |
| </li> |
| <li> |
| <p>根据指定顶点/边类型、指定属性的值范围查询顶点（属性必须为数字类型）</p> |
| </li> |
| <li> |
| <p>根据顶点类型（Vertex Label）查询顶点</p> |
| </li> |
| <li> |
| <p>根据边类型（Edge Label）查询边</p> |
| </li> |
| <li> |
| <p>根据顶点查询边</p> |
| <ul> |
| <li>查询顶点的所有边</li> |
| <li>查询顶点的指定方向边（出边、入边）</li> |
| <li>查询顶点的指定方向、指定类型边</li> |
| <li>查询两个顶点的同类型边中的某条边（SortKey）</li> |
| </ul> |
| </li> |
| <li> |
| <p>标准Gremlin遍历</p> |
| </li> |
| </ul> |
| <h3 id="缓存">缓存</h3> |
| <h4 id="可缓存内容">可缓存内容</h4> |
| <ul> |
| <li>元数据缓存</li> |
| <li>顶点缓存</li> |
| </ul> |
| <h4 id="缓存特性">缓存特性</h4> |
| <ul> |
| <li>LRU策略</li> |
| <li>高性能并发访问</li> |
| <li>支持超时过期机制</li> |
| </ul> |
| <h3 id="接口restful-api">接口（RESTful API）</h3> |
| <ul> |
| <li>版本号接口</li> |
| <li>图实例接口</li> |
| <li>元数据接口</li> |
| <li>图数据接口</li> |
| <li>Gremlin接口</li> |
| </ul> |
| <p>更多细节详见<a href="/clients/hugegraph-api.html">API文档</a></p> |
| <h3 id="后端支持">后端支持</h3> |
| <h4 id="支持cassandra后端">支持Cassandra后端</h4> |
| <ul> |
| <li>持久化</li> |
| <li>CQL3</li> |
| <li>集群</li> |
| </ul> |
| <h4 id="支持memory后端仅用于测试">支持Memory后端（仅用于测试）</h4> |
| <ul> |
| <li>非持久化</li> |
| <li>部分特性无法支持（如：更新边属性、根据边类型查询边）</li> |
| </ul> |
| <h3 id="其它">其它</h3> |
| <h4 id="支持配置项">支持配置项</h4> |
| <ul> |
| <li>后端存储类型</li> |
| <li>序列化方式</li> |
| <li>缓存参数</li> |
| </ul> |
| <h4 id="支持多图实例">支持多图实例</h4> |
| <ul> |
| <li>静态方式（<em>增加多个图配置文件</em>）</li> |
| </ul> |
| <h4 id="版本检查">版本检查</h4> |
| <ul> |
| <li>内部依赖包匹配版本检查</li> |
| <li>API匹配版本检查</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-add34161ef49858de8d3ba17c475406f">9.12 - HugeGraph 0.2.4 Release Notes</h1> |
| |
| <h3 id="api--java-client">API & Java Client</h3> |
| <h4 id="功能更新">功能更新</h4> |
| <h3 id="元数据schema相关">元数据（Schema）相关</h3> |
| <h4 id="bug修复">BUG修复</h4> |
| <ul> |
| <li>Vertex Label为非primary-key id策略应该允许属性为空（HugeGraph-651）</li> |
| <li>Gremlin-Server 序列化的 EdgeLabel 仅有一个directed 属性，应该打印完整的schema描述（HugeGraph-680）</li> |
| <li>创建IndexLabel时使用不存在的属性抛出空指针异常，应该抛非法参数异常（HugeGraph-682）</li> |
| <li>创建schema如果已经存在并指定了ifNotExist时，结果应该返回原来的对象（HugeGraph-694）</li> |
| <li>由于EdgeLabel的Frequency默认为null以及不允许修改特性，导致Append操作传递null值在API层反序列化失败（HugeGraph-729）</li> |
| <li>增加对schema名称的正则检查配置项，默认不允许为全空白字符（HugeGraph-727）</li> |
| <li>中文名的schema在前端显示为乱码（HugeGraph-711）</li> |
| </ul> |
| <h3 id="图数据vertexedge相关">图数据（Vertex、Edge）相关</h3> |
| <h4 id="功能更新-1">功能更新</h4> |
| <ul> |
| <li>DataType支持Array，并且List类型除了一个一个添加object，也需要支持直接赋值List对象（HugeGraph-719）</li> |
| <li>自动生成的顶点id由十进制改为十六进制（字符串存储时）（HugeGraph-785）</li> |
| </ul> |
| <h4 id="bug修复-1">BUG修复</h4> |
| <ul> |
| <li>HugeGraph-API的VertexLabel/EdgeLabel API未提供eliminate接口（HugeGraph-614）</li> |
| <li>增加非primary-key id策略的顶点时，如果属性为空无法插入到数据库中（HugeGraph-652）</li> |
| <li>使用HugeGraph-Client的gremlin发送无返回值groovy请求时，由于gremlin-server将无返回值序列化为null，导致前端迭代结果集时出现空指针异常（HugeGraph-664）</li> |
| <li>RESTful API在没有找到对应id的vertex/edge时返回500（HugeGraph-734）</li> |
| <li>HugeElement/HugeProperty的equals()与tinkerpop不兼容（HugeGraph-653）</li> |
| <li>HugeEdgeProperty的property的equals函数与tinkerpop兼容 （HugeGraph-740）</li> |
| <li>HugeElement/HugeVertexProperty的hashcode函数与tinkerpop不兼容（HugeGraph-728）</li> |
| <li>HugeVertex/HugeEdge的toString函数与tinkerpop不兼容（HugeGraph-665）</li> |
| <li>与tinkerpop的异常不兼容，包括IllegalArgumentsException和UnsupportedOperationException（HugeGraph-667）</li> |
| <li>通过id无法找到element时，抛出的异常类型与tinkerpop不兼容（HugeGraph-689）</li> |
| <li>vertex.addEdge没有检查properties的数目是否为2的倍数（HugeGraph-716）</li> |
| <li>vertex.addEdge()时，assignId调用时机太晚，导致vertex的Set<Edge>中有重复的edge（HugeGraph-666）</li> |
| <li>查询时包含大于等于三层逻辑嵌套时，会抛出ClassCastException，现改成抛出非法参数异常（HugeGraph-481）</li> |
| <li>边查询如果同时包含source-vertex/direction和property作为条件，查询结果错误（HugeGraph-749）</li> |
| <li>HugeGraph-Server 在运行时如果 cassandra 宕掉，插入或查询操作时会抛出DataStax的异常以及详细的调用栈（HugeGraph-771）</li> |
| <li>删除不存在的 indexLabel 时会抛出异常，而删除其他三种元数据（不存在的）则不会（HugeGraph-782）</li> |
| <li>当传给EdgeApi的源顶点或目标顶点的id非法时，会因为查询不到该顶点向客户端返回404状态码（HugeGraph-784）</li> |
| <li>提供内部使用获取元数据的接口，使SchemaManager仅为外部使用，当获取不存在的schema时抛出NotFoundException异常（HugeGraph-743）</li> |
| <li>HugeGraph-Client 创建／添加／移除 元数据都应该返回来自服务端的结果（HugeGraph-760）</li> |
| <li>创建HugeGraph-Client时如果输入了错误的主机会导致进程阻塞，无法响应（HugeGraph-718）</li> |
| </ul> |
| <h3 id="查询索引缓存相关">查询、索引、缓存相关</h3> |
| <h4 id="功能更新-2">功能更新</h4> |
| <ul> |
| <li>缓存更新更加高效的锁方案（HugeGraph-555）</li> |
| <li>索引查询增加支持只有一个元素的IN语句（原来仅支持EQ）（HugeGraph-739）</li> |
| </ul> |
| <h4 id="bug修复-2">BUG修复</h4> |
| <ul> |
| <li>防止请求数据量过大时服务本身hang住（HugeGraph-777）</li> |
| </ul> |
| <h3 id="其它">其它</h3> |
| <h4 id="功能更新-3">功能更新</h4> |
| <ul> |
| <li>使Init-Store仅用于初始化数据库，清空后端由独立脚本实现（HugeGraph-650）</li> |
| </ul> |
| <h4 id="bug修复-3">BUG修复</h4> |
| <ul> |
| <li>单元测试跑完后在测试机上遗留了临时的keyspace（HugeGraph-611）</li> |
| <li>Cassandra的info日志信息过多，将大部分修改为debug级别（HugeGraph-722）</li> |
| <li>EventHub.containsListener(String event)判断逻辑有遗漏（HugeGraph-732）</li> |
| <li>EventHub.listeners/unlisten(String event)当没有对应event的listener时会抛空指针异常（HugeGraph-733）</li> |
| </ul> |
| <h3 id="测试">测试</h3> |
| <h4 id="tinkerpop合规测试">Tinkerpop合规测试</h4> |
| <ul> |
| <li>增加自定义ignore机制，规避掉暂时不需要加入持续集成的测试用例（HugeGraph-647）</li> |
| <li>为TestGraph注册GraphSon和Kryo序列化器，实现 IdGenerator$StringId 的 graphson-v1、graphson-v2 和 Kryo的序列化与反序列化（HugeGraph-660）</li> |
| <li>增加了可配置的测试用例过滤器，使得tinkerpop测试可以用在开发分支和发布分支的回归测试中</li> |
| <li>将tinkerpop测试通过配置文件，加入到回归测试中</li> |
| </ul> |
| <h4 id="单元测试">单元测试</h4> |
| <ul> |
| <li>增加Cache及Event的单元测试（HugeGraph-659）</li> |
| <li>HugeGraph-Client 增加API的测试（99个）</li> |
| <li>HugeGraph-Client 增加单元测试，包括RestResult反序列化的单测（12个）</li> |
| </ul> |
| <h3 id="内部修改">内部修改</h3> |
| <ul> |
| <li>改进LOG变量方面代码（HugeGraph-623/HugeGraph-631）</li> |
| <li>License格式调整（HugeGraph-625）</li> |
| <li>将序列化器中持有的graph抽离，要用到graph的函数通过传参数实现 （HugeGraph-750）</li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-dad363871d9408c4438794858aa44f57">10 - </h1> |
| |
| <p>HugeDoc Installation</p> |
| <p>HugeDoc use <a href="https://github.com/GitbookIO/gitbook">GitBook</a> to convert markdown to static website, |
| and use GitBook with NodeJs to server as web server.</p> |
| <h3 id="how-to-use">How To use</h3> |
| <p>Install GitBook is via <strong>NPM</strong>:</p> |
| <pre tabindex="0"><code>$ npm install gitbook-cli -g |
| </code></pre><p>Preview and serve your book using:</p> |
| <pre tabindex="0"><code>$ gitbook serve |
| </code></pre><p>Or build the static website using:</p> |
| <pre tabindex="0"><code>$ gitbook build |
| </code></pre> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-01c617939d9e21dc19567e8753d6fd3b">11 - </h1> |
| |
| <h2 id="contributor-agreement">Contributor Agreement</h2> |
| <h2 id="individual-contributor-exclusive-license-agreement">Individual Contributor exclusive License Agreement</h2> |
| <h2 id="including-the-traditional-patent-license-option">(including the TRADITIONAL PATENT LICENSE OPTION)</h2> |
| <p>Thank you for your interest in contributing to HugeGraph’s all projects (“We” or “Us”).</p> |
| <p>The purpose of this contributor agreement (“Agreement”) is to clarify and document the rights granted by contributors to Us. To make this document effective, please follow the comment of GitHub CLA-Assistant when submitting a new pull request.</p> |
| <h3 id="how-to-use-this-contributor-agreement">How to use this Contributor Agreement</h3> |
| <p>If You are an employee and have created the Contribution as part of your employment, You need to have Your employer approve this Agreement or sign the Entity version of this document. If You do not own the Copyright in the entire work of authorship, any other author of the Contribution should also sign this – in any event, please contact Us at <a href="mailto:hugegraph@googlegroups.com">hugegraph@googlegroups.com</a></p> |
| <h3 id="1-definitions">1. Definitions</h3> |
| <p><strong>“You”</strong> means the individual Copyright owner who Submits a Contribution to Us.</p> |
| <p><strong>“Contribution”</strong> means any original work of authorship, including any original modifications or additions to an existing work of authorship, Submitted by You to Us, in which You own the Copyright.</p> |
| <p><strong>“Copyright”</strong> means all rights protecting works of authorship, including copyright, moral and neighboring rights, as appropriate, for the full term of their existence.</p> |
| <p><strong>“Material”</strong> means the software or documentation made available by Us to third parties. When this Agreement covers more than one software project, the Material means the software or documentation to which the Contribution was Submitted. After You Submit the Contribution, it may be included in the Material.</p> |
| <p><strong>“Submit”</strong> means any act by which a Contribution is transferred to Us by You by means of tangible or intangible media, including but not limited to electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Us, but excluding any transfer that is conspicuously marked or otherwise designated in writing by You as “Not a Contribution.”</p> |
| <p><strong>“Documentation”</strong> means any non-software portion of a Contribution.</p> |
| <h3 id="2-license-grant">2. License grant</h3> |
| <h4 id="21-copyright-license-to-us">2.1 Copyright license to Us</h4> |
| <p>Subject to the terms and conditions of this Agreement, You hereby grant to Us a worldwide, royalty-free, Exclusive, perpetual and irrevocable (except as stated in Section 8.2) license, with the right to transfer an unlimited number of non-exclusive licenses or to grant sublicenses to third parties, under the Copyright covering the Contribution to use the Contribution by all means, including, but not limited to:</p> |
| <ul> |
| <li>publish the Contribution,</li> |
| <li>modify the Contribution,</li> |
| <li>prepare derivative works based upon or containing the Contribution and/or to combine the Contribution with other Materials,</li> |
| <li>reproduce the Contribution in original or modified form,</li> |
| <li>distribute, to make the Contribution available to the public, display and publicly perform the Contribution in original or modified form.</li> |
| </ul> |
| <h4 id="22-moral-rights">2.2 Moral rights</h4> |
| <p>Moral Rights remain unaffected to the extent they are recognized and not waivable by applicable law. Notwithstanding, You may add your name to the attribution mechanism customary used in the Materials you Contribute to, such as the header of the source code files of Your Contribution, and We will respect this attribution when using Your Contribution.</p> |
| <h4 id="23-copyright-license-back-to-you">2.3 Copyright license back to You</h4> |
| <p>Upon such grant of rights to Us, We immediately grant to You a worldwide, royalty-free, non-exclusive, perpetual and irrevocable license, with the right to transfer an unlimited number of non-exclusive licenses or to grant sublicenses to third parties, under the Copyright covering the Contribution to use the Contribution by all means, including, but not limited to:</p> |
| <ul> |
| <li>publish the Contribution,</li> |
| <li>modify the Contribution,</li> |
| <li>prepare derivative works based upon or containing the Contribution and/or to combine the Contribution with other Materials,</li> |
| <li>reproduce the Contribution in original or modified form,</li> |
| <li>distribute, to make the Contribution available to the public, display and publicly perform the Contribution in original or modified form.</li> |
| </ul> |
| <p>This license back is limited to the Contribution and does not provide any rights to the Material.</p> |
| <h3 id="3-patents">3. Patents</h3> |
| <h4 id="31-patent-license">3.1 Patent license</h4> |
| <p>Subject to the terms and conditions of this Agreement You hereby grant to Us and to recipients of Materials distributed by Us a worldwide, royalty-free, non-exclusive, perpetual and irrevocable (except as stated in Section 3.2) patent license, with the right to transfer an unlimited number of non-exclusive licenses or to grant sublicenses to third parties, to make, have made, use, sell, offer for sale, import and otherwise transfer the Contribution and the Contribution in combination with any Material (and portions of such combination). This license applies to all patents owned or controlled by You, whether already acquired or hereafter acquired, that would be infringed by making, having made, using, selling, offering for sale, importing or otherwise transferring of Your Contribution(s) alone or by combination of Your Contribution(s) with any Material.</p> |
| <h4 id="32-revocation-of-patent-license">3.2 Revocation of patent license</h4> |
| <p>You reserve the right to revoke the patent license stated in section 3.1 if We make any infringement claim that is targeted at your Contribution and not asserted for a Defensive Purpose. An assertion of claims of the Patents shall be considered for a “Defensive Purpose” if the claims are asserted against an entity that has filed, maintained, threatened, or voluntarily participated in a patent infringement lawsuit against Us or any of Our licensees.</p> |
| <h3 id="4-license-obligations-by-us">4. License obligations by Us</h3> |
| <p>We agree to (sub)license the Contribution or any Materials containing, based on or derived from your Contribution under the terms of any licenses the Free Software Foundation classifies as Free Software License and which are approved by the Open Source Initiative as Open Source licenses.</p> |
| <p>More specifically and in strict accordance with the above paragraph, we agree to (sub)license the Contribution or any Materials containing, based on or derived from the Contribution only in accordance with our licensing policy available at: <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>.</p> |
| <p>In addition, We may use the following licenses for Documentation in the Contribution: GFDL-1.2 (including any right to adopt any future version of a license).</p> |
| <p>We agree to license patents owned or controlled by You only to the extent necessary to (sub)license Your Contribution(s) and the combination of Your Contribution(s) with the Material under the terms of any licenses the Free Software Foundation classifies as Free Software licenses and which are approved by the Open Source Initiative as Open Source licenses..</p> |
| <h3 id="5-disclaimer">5. Disclaimer</h3> |
| <p>THE CONTRIBUTION IS PROVIDED “AS IS”. MORE PARTICULARLY, ALL EXPRESS OR IMPLIED WARRANTIES INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTY OF SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY DISCLAIMED BY YOU TO US AND BY US TO YOU. TO THE EXTENT THAT ANY SUCH WARRANTIES CANNOT BE DISCLAIMED, SUCH WARRANTY IS LIMITED IN DURATION AND EXTENT TO THE MINIMUM PERIOD AND EXTENT PERMITTED BY LAW.</p> |
| <h3 id="6-consequential-damage-waiver">6. Consequential damage waiver</h3> |
| <p>TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL YOU OR WE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF ANTICIPATED SAVINGS, LOSS OF DATA, INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL AND EXEMPLARY DAMAGES ARISING OUT OF THIS AGREEMENT REGARDLESS OF THE LEGAL OR EQUITABLE THEORY (CONTRACT, TORT OR OTHERWISE) UPON WHICH THE CLAIM IS BASED.</p> |
| <h3 id="7-approximation-of-disclaimer-and-damage-waiver">7. Approximation of disclaimer and damage waiver</h3> |
| <p>IF THE DISCLAIMER AND DAMAGE WAIVER MENTIONED IN SECTION 5. AND SECTION 6. CANNOT BE GIVEN LEGAL EFFECT UNDER APPLICABLE LOCAL LAW, REVIEWING COURTS SHALL APPLY LOCAL LAW THAT MOST CLOSELY APPROXIMATES AN ABSOLUTE WAIVER OF ALL CIVIL OR CONTRACTUAL LIABILITY IN CONNECTION WITH THE CONTRIBUTION.</p> |
| <h3 id="8-term">8. Term</h3> |
| <p>8.1 This Agreement shall come into effect upon Your acceptance of the terms and conditions.</p> |
| <p>8.2 This Agreement shall apply for the term of the copyright and patents licensed here. However, You shall have the right to terminate the Agreement if We do not fulfill the obligations as set forth in Section 4. Such termination must be made in writing.</p> |
| <p>8.3 In the event of a termination of this Agreement Sections 5, 6, 7, 8 and 9 shall survive such termination and shall remain in full force thereafter. For the avoidance of doubt, Free and Open Source Software (sub)licenses that have already been granted for Contributions at the date of the termination shall remain in full force after the termination of this Agreement.</p> |
| <h3 id="9-miscellaneous">9 Miscellaneous</h3> |
| <p>9.1 This Agreement and all disputes, claims, actions, suits or other proceedings arising out of this agreement or relating in any way to it shall be governed by the laws of China excluding its private international law provisions.</p> |
| <p>9.2 This Agreement sets out the entire agreement between You and Us for Your Contributions to Us and overrides all other agreements or understandings.</p> |
| <p>9.3 In case of Your death, this agreement shall continue with Your heirs. In case of more than one heir, all heirs must exercise their rights through a commonly authorized person.</p> |
| <p>9.4 If any provision of this Agreement is found void and unenforceable, such provision will be replaced to the extent possible with a provision that comes closest to the meaning of the original provision and that is enforceable. The terms and conditions set forth in this Agreement shall apply notwithstanding any failure of essential purpose of this Agreement or any limited remedy to the maximum extent possible under law.</p> |
| <p>9.5 You agree to notify Us of any facts or circumstances of which you become aware that would make this Agreement inaccurate in any respect.</p> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="td-content" style="page-break-before: always"> |
| |
| <h1 id="pg-a395eab4dc054c73b0174216cfbeaf1a">12 - </h1> |
| |
| <h1 id="hugegraph-docs">HugeGraph Docs</h1> |
| <ul> |
| <li><a href="download.md">Download</a></li> |
| </ul> |
| <h2 id="quickstart">Quickstart</h2> |
| <ul> |
| <li><a href="quickstart/hugegraph-server.md">Install HugeGraph-Server</a></li> |
| <li><a href="quickstart/hugegraph-loader.md">Load data with HugeGraph-Loader</a></li> |
| <li><a href="quickstart/hugegraph-tools.md">Manage with HugeGraph-Tools</a></li> |
| <li><a href="quickstart/hugegraph-hubble.md">Visual with HugeGraph-Hubble</a></li> |
| <li><a href="quickstart/hugegraph-studio.md">Display with HugeGraph-Studio</a></li> |
| <li><a href="quickstart/hugegraph-client.md">Develop with HugeGraph-Client</a></li> |
| <li><a href="quickstart/hugegraph-spark.md">Analysis with HugeGraph-Spark</a></li> |
| </ul> |
| <h2 id="config">Config</h2> |
| <ul> |
| <li><a href="config/config-guide.md">Config Guide</a></li> |
| <li><a href="config/config-option.md">Config Options</a></li> |
| <li><a href="config/config-authentication.md">Config Authentication</a></li> |
| <li><a href="config/config-https.md">Config HTTPS</a></li> |
| </ul> |
| <h2 id="api">API</h2> |
| <ul> |
| <li><a href="clients/hugegraph-api.md">RESTful API</a> |
| <ul> |
| <li><a href="clients/restful-api/schema.md">Schema</a></li> |
| <li><a href="clients/restful-api/propertykey.md">PropertyKey</a></li> |
| <li><a href="clients/restful-api/vertexlabel.md">VertexLabel</a></li> |
| <li><a href="clients/restful-api/edgelabel.md">EdgeLabel</a></li> |
| <li><a href="clients/restful-api/indexlabel.md">IndexLabel</a></li> |
| <li><a href="clients/restful-api/rebuild.md">Rebuild</a></li> |
| <li><a href="clients/restful-api/vertex.md">Vertex</a></li> |
| <li><a href="clients/restful-api/edge.md">Edge</a></li> |
| <li><a href="clients/restful-api/traverser.md">Traverser</a></li> |
| <li><a href="clients/restful-api/rank.md">Rank</a></li> |
| <li><a href="clients/restful-api/variable.md">Variable</a></li> |
| <li><a href="clients/restful-api/graphs.md">Graphs</a></li> |
| <li><a href="clients/restful-api/task.md">Task</a></li> |
| <li><a href="clients/restful-api/gremlin.md">Gremlin</a></li> |
| <li><a href="clients/restful-api/auth.md">Authentication</a></li> |
| <li><a href="clients/restful-api/other.md">Other</a></li> |
| </ul> |
| </li> |
| <li><a href="clients/hugegraph-client.md">Java Client</a></li> |
| <li><a href="clients/gremlin-console.md">Gremlin Console</a></li> |
| </ul> |
| <h2 id="guides">Guides</h2> |
| <ul> |
| <li><a href="guides/architectural.md">Architecture Overview</a></li> |
| <li><a href="guides/desgin-concept.md">Design Concepts</a></li> |
| <li><a href="guides/custom-plugin.md">Custom Plugins</a></li> |
| <li><a href="guides/backup-restore.md">Backup Restore</a></li> |
| <li><a href="guides/faq.md">FAQ</a></li> |
| </ul> |
| <h2 id="query-language">Query Language</h2> |
| <ul> |
| <li><a href="language/hugegraph-gremlin.md">Gremlin Query Language</a></li> |
| <li><a href="language/hugegraph-example.md">HugeGraph Examples</a></li> |
| </ul> |
| <h2 id="performance">Performance</h2> |
| <ul> |
| <li><a href="performance/hugegraph-benchmark-0.5.6.md">HugeGraph Benchmark Performance</a></li> |
| <li><a href="content/cn/docs/performance/api-preformance/_index.md">HugeGraph API Performance</a> |
| <ul> |
| <li><a href="content/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-RocksDB.md">v0.5.6 Stand-alone(RocksDB)</a></li> |
| <li><a href="content/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-Cassandra.md">v0.5.6 Cluster(Cassandra)</a></li> |
| <li><a href="content/cn/docs/performance/api-preformance/hugegraph-api-0.4.4.md">v0.4.4</a></li> |
| <li><a href="content/cn/docs/performance/api-preformance/hugegraph-api-0.2.md">v0.2</a></li> |
| </ul> |
| </li> |
| <li><a href="performance/hugegraph-loader-performance.md">HugeGraph-Loader Performance</a></li> |
| </ul> |
| <h2 id="changelogs">ChangeLogs</h2> |
| <ul> |
| <li><a href="changelog/hugegraph-0.12.0-release-notes.md">Release-0.12.0</a></li> |
| <li><a href="changelog/hugegraph-0.11.2-release-notes.md">Release-0.11.2</a></li> |
| <li><a href="changelog/hugegraph-0.10.4-release-notes.md">Release-0.10.4</a></li> |
| <li><a href="changelog/hugegraph-0.9.2-release-notes.md">Release-0.9.2</a></li> |
| <li><a href="changelog/hugegraph-0.8.0-release-notes.md">Release-0.8.0</a></li> |
| <li><a href="changelog/hugegraph-0.7.4-release-notes.md">Release-0.7.4</a></li> |
| <li><a href="changelog/hugegraph-0.6.1-release-notes.md">Release-0.6.1</a></li> |
| <li><a href="changelog/hugegraph-0.5.6-release-notes.md">Release-0.5.6</a></li> |
| <li><a href="changelog/hugegraph-0.4.4-release-notes.md">Release-0.4.4</a></li> |
| <li><a href="changelog/hugegraph-0.3.3-release-notes.md">Release-0.3.3</a></li> |
| <li><a href="changelog/hugegraph-0.2.4-release-notes.md">Release-0.2.4</a></li> |
| <li><a href="changelog/hugegraph-0.2-release-notes.md">Release-0.2</a></li> |
| </ul> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </main> |
| </div> |
| </div> |
| |
| <footer class="bg-dark py-3 row d-print-none"> |
| <div class="footer-container"> |
| <div class="row"> |
| |
| <div class="col-1"></div> |
| <div class="col-4 text-center container-center"> |
| <div class="footer-row"> |
| <a href="https://www.apache.org"> |
| <div class="footer-apache-logo"> |
| <svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 7127.6 2890" enable-background="new 0 0 7127.6 2890"><path fill="#6d6e71" d="M7104.7 847.8c15.3 15.3 22.9 33.7 22.9 55.2s-7.6 39.9-22.9 55.4c-15.3 15.4-33.8 23.1-55.6 23.1s-40.2-7.6-55.4-22.9c-15.1-15.3-22.7-33.7-22.7-55.2s7.6-39.9 22.9-55.4c15.3-15.4 33.7-23.1 55.4-23.1C7070.9 824.9 7089.4 832.5 7104.7 847.8zM7098.1 951.9c13.3-13.6 20-29.8 20-48.7s-6.6-35-19.8-48.5c-13.2-13.4-29.4-20.1-48.6-20.1-19.2.0-35.4 6.7-48.7 20.2s-19.9 29.7-19.9 48.7 6.6 35.2 19.7 48.6c13.1 13.4 29.3 20.1 48.5 20.1S7084.7 965.4 7098.1 951.9zm-11-63.8c0 14-6.1 22.8-18.4 26.4l22.5 30.5H7073l-20.3-28.3h-18.6V945h-14.7v-84.6h31.8c12.8.0 22 2.2 27.6 6.6C7084.4 871.4 7087.1 878.4 7087.1 888.1zM7068.2 9e2c3-2.4 4.4-6.5 4.4-12s-1.5-9.4-4.5-11.6-8.4-3.2-16-3.2h-18v30.5h17.5C7059.7 903.6 7065.3 902.4 7068.2 9e2z"/><path fill="#6d6e71" d="M1803.6 499.8v155.4h-20V499.8h-56.8v-19.2h133.9v19.2H1803.6z"/><path fill="#6d6e71" d="M2082.2 655.2v-76.9H1977v76.9h-20V480.5h20v78.9h105.2v-78.9h20v174.7h-20z"/><path fill="#6d6e71" d="M2241.4 499.8v57.4h88.1v19.2h-88.1v59.8h101.8v19h-121.8V480.5H2340v19.2H2241.4z"/><path fill="#d22128" d="M1574.5 1852.4l417.3-997.6h80.1l417.3 997.6h-105.4l-129.3-311.9h-448.2l-127.9 311.9H1574.5zM2032.6 970l-205.1 493.2h404.7L2032.6 970z"/><path fill="#d22128" d="M2596.9 1852.4V854.8H3010c171.4.0 295.1 158.8 295.1 313.3.0 163-115.2 316.1-286.6 316.1h-324.6v368.1h-97zm97-455.3h318.9c118 0 193.9-108.2 193.9-229 0-125.1-92.7-226.2-202.3-226.2h-310.5v455.2z"/><path fill="#d22128" d="M3250.5 1852.4l417.3-997.6h80.1l417.3 997.6h-105.4l-129.3-311.9h-448.2l-127.9 311.9H3250.5zM3708.6 970l-205.1 493.2h404.7L3708.6 970z"/><path fill="#d22128" d="M4637.3 849.1c177 0 306.3 89.9 368.1 217.8l-78.7 47.8c-63.2-132.1-186.9-177-295.1-177-238.9.0-369.5 213.6-369.5 414.5.0 220.6 161.6 420.1 373.7 420.1 112.4.0 244.5-56.2 307.7-185.5l81.5 42.1c-64.6 148.9-241.7 231.8-394.8 231.8-274 0-466.5-261.3-466.5-514.2C4163.8 1106.3 4336.6 849.1 4637.3 849.1z"/><path fill="#d22128" d="M5949.1 854.8v997.6h-98.4v-466.5h-591.5v466.5h-96.9V854.8h96.9v444h591.5v-444H5949.1z"/><path fill="#d22128" d="M6844.6 1765.2v87.1h-670.2V854.8H6832v87.1h-560.6v359.7h489v82.9h-489v380.8H6844.6z"/><path fill="#6d6e71" d="M1667.6 2063.6c11.8 3.5 22.2 8.3 31 14.2l-10.3 22.6c-9-6-18.6-10.4-28.9-13.4-10.2-2.9-20-4.4-29.2-4.4-13.6.0-24.5 2.4-32.6 7.3s-12.2 11.8-12.2 20.7c0 7.6 2.3 14 6.8 19s10.2 8.9 17 11.7c6.8 2.8 16.1 6 28 9.6 14.4 4.6 26 8.9 34.7 12.9 8.8 4 16.3 9.9 22.5 17.8 6.2 7.8 9.3 18.2 9.3 31 0 11.7-3.2 21.8-9.5 30.6-6.3 8.7-15.3 15.5-26.8 20.3-11.6 4.8-24.9 7.2-40 7.2s-29.7-2.9-43.9-8.7c-14.2-5.8-26.4-13.6-36.6-23.4l10.7-21.6c9.6 9.4 20.7 16.7 33.3 21.9 12.6 5.2 24.8 7.8 36.8 7.8 15.3.0 27.3-3 36.1-8.9s13.2-13.9 13.2-23.9c0-7.8-2.3-14.3-6.9-19.4-4.6-5.1-10.3-9-17.1-11.9-6.8-2.8-16.1-6-28-9.6-14.2-4.2-25.7-8.3-34.6-12.2-8.9-3.9-16.4-9.7-22.5-17.5-6.1-7.7-9.2-17.9-9.2-30.6.0-10.9 3-20.4 9-28.6s14.6-14.6 25.6-19.1c11.1-4.5 23.8-6.8 38.2-6.8C1643.8 2058.3 1655.7 2060.1 1667.6 2063.6z"/><path fill="#6d6e71" d="M1980.1 2072.8c16.8 9.4 30.2 22.3 40 38.4 9.8 16.2 14.8 33.9 14.8 53.3.0 19.5-4.9 37.4-14.8 53.6-9.8 16.3-23.2 29.1-40 38.6s-35.3 14.3-55.2 14.3c-20.3.0-38.8-4.7-55.7-14.3-16.8-9.5-30.2-22.4-40-38.6-9.8-16.3-14.8-34.1-14.8-53.6s4.9-37.3 14.8-53.5c9.8-16.2 23.2-29 40-38.3 16.8-9.4 35.4-14 55.7-14C1944.8 2058.6 1963.2 2063.3 1980.1 2072.8zM1881.9 2092.7c-13.1 7.4-23.6 17.5-31.4 30.1-7.8 12.6-11.8 26.5-11.8 41.7.0 15.3 3.9 29.3 11.8 42 7.8 12.7 18.3 22.8 31.4 30.2 13.1 7.4 27.4 11.1 42.9 11.1s29.7-3.7 42.7-11.1 23.3-17.4 31.1-30.2c7.7-12.7 11.6-26.7 11.6-42s-3.9-29.2-11.6-41.8c-7.7-12.6-18.1-22.6-31.1-30s-27.2-11.2-42.6-11.2C1909.4 2081.5 1895.1 2085.2 1881.9 2092.7z"/><path fill="#6d6e71" d="M2186.5 2082.4v74h98.4v23.2h-98.4v90.2h-24.1v-210.6h133.8v23.2H2186.5z"/><path fill="#6d6e71" d="M2491.6 2082.4v187.4h-24.1v-187.4h-68.4v-23.2h161.4v23.2H2491.6z"/><path fill="#6d6e71" d="M2871.8 2269.8l-56.8-177.4-57.6 177.4h-24.5l-70.5-210.6h25.9l57.9 182.7 57.1-182.4 24.1-.3 57.7 182.7 57.1-182.7h25l-70.6 210.6H2871.8z"/><path fill="#6d6e71" d="M3087.3 2216.6l-23.5 53.2h-25.6l94.4-210.6h25l94.1 210.6h-26.1l-23.5-53.2H3087.3zM3144.5 2086.6l-46.9 106.8h94.4l-47.5-106.8z"/><path fill="#6d6e71" d="M3461.1 2202.7c-6 .4-10.7.6-14.1.6h-56v66.5h-24v-210.6h80c26.2.0 46.6 6.2 61.2 18.5 14.5 12.3 21.8 29.8 21.8 52.3.0 17.2-4.1 31.7-12.2 43.3-8.1 11.6-19.8 20-35 25l49.2 71.5h-27.3L3461.1 2202.7zM3491.3 2167.6c10.3-8.4 15.5-20.8 15.5-37 0-15.9-5.2-27.9-15.5-36s-25.1-12.2-44.3-12.2h-56v97.8h56C3466.2 2180.2 3481 2176 3491.3 2167.6z"/><path fill="#6d6e71" d="M3688.3 2082.4v69.2h106.2v23.2h-106.2v72.1h122.8v22.9h-146.9v-210.6h142.9v23.2H3688.3z"/><path fill="#6d6e71" d="M4147 2082.4v74h98.4v23.2H4147v90.2h-24.1v-210.6h133.8v23.2H4147z"/><path fill="#6d6e71" d="M4523.3 2072.8c16.8 9.4 30.2 22.3 40 38.4 9.8 16.2 14.8 33.9 14.8 53.3.0 19.5-4.9 37.4-14.8 53.6-9.8 16.3-23.2 29.1-40 38.6s-35.3 14.3-55.2 14.3c-20.3.0-38.8-4.7-55.7-14.3-16.8-9.5-30.2-22.4-40-38.6-9.8-16.3-14.8-34.1-14.8-53.6s4.9-37.3 14.8-53.5c9.8-16.2 23.2-29 40-38.3 16.8-9.4 35.4-14 55.7-14C4488.1 2058.6 4506.5 2063.3 4523.3 2072.8zM4425.2 2092.7c-13.1 7.4-23.6 17.5-31.4 30.1-7.8 12.6-11.8 26.5-11.8 41.7.0 15.3 3.9 29.3 11.8 42 7.8 12.7 18.3 22.8 31.4 30.2 13.1 7.4 27.4 11.1 42.9 11.1s29.7-3.7 42.7-11.1 23.3-17.4 31.1-30.2c7.7-12.7 11.6-26.7 11.6-42s-3.9-29.2-11.6-41.8c-7.7-12.6-18.1-22.6-31.1-30s-27.2-11.2-42.6-11.2C4452.6 2081.5 4438.3 2085.2 4425.2 2092.7z"/><path fill="#6d6e71" d="M4854.7 2247.7c-15.7 15.5-37.3 23.3-64.8 23.3-27.7.0-49.4-7.8-65.1-23.3-15.7-15.5-23.6-37-23.6-64.6v-124h24.1v124c0 20.3 5.8 36.1 17.3 47.5 11.6 11.4 27.3 17.1 47.3 17.1 20.1.0 35.8-5.7 47.1-17 11.4-11.3 17-27.2 17-47.7v-124h24.1v124C4878.2 2210.7 4870.4 2232.2 4854.7 2247.7z"/><path fill="#6d6e71" d="M5169.5 2269.8l-126.3-169.1v169.1h-24.1v-210.6h25l126.3 169.3v-169.3h23.8v210.6H5169.5z"/><path fill="#6d6e71" d="M5478.4 2073.1c16.4 9.3 29.4 21.9 38.9 37.9 9.6 16 14.3 33.9 14.3 53.5s-4.8 37.6-14.3 53.6c-9.5 16.1-22.6 28.7-39.3 37.9-16.6 9.2-35.2 13.8-55.5 13.8h-84.3v-210.6h85.2C5443.7 2059.2 5462 2063.8 5478.4 2073.1zM5362.3 2246.9h61.4c15.5.0 29.6-3.5 42.3-10.6s22.8-16.9 30.2-29.5c7.4-12.5 11.1-26.5 11.1-42s-3.8-29.4-11.3-41.9-17.7-22.3-30.6-29.6c-12.8-7.2-27-10.9-42.6-10.9h-60.5v164.5z"/><path fill="#6d6e71" d="M5668.6 2216.6l-23.5 53.2h-25.6l94.4-210.6h25l94.1 210.6h-26l-23.5-53.2H5668.6zM5725.8 2086.6l-46.9 106.8h94.4l-47.5-106.8z"/><path fill="#6d6e71" d="M5991 2082.4v187.4h-24v-187.4h-68.4v-23.2H6060v23.2h-69z"/><path fill="#6d6e71" d="M6175.9 2269.8v-210.6h24.1v210.6H6175.9z"/><path fill="#6d6e71" d="M6493.7 2072.8c16.8 9.4 30.2 22.3 40 38.4 9.8 16.2 14.8 33.9 14.8 53.3.0 19.5-4.9 37.4-14.8 53.6-9.8 16.3-23.2 29.1-40 38.6s-35.3 14.3-55.2 14.3c-20.3.0-38.8-4.7-55.7-14.3-16.8-9.5-30.2-22.4-40-38.6-9.8-16.3-14.8-34.1-14.8-53.6s4.9-37.3 14.8-53.5c9.8-16.2 23.2-29 40-38.3 16.8-9.4 35.4-14 55.7-14C6458.5 2058.6 6476.9 2063.3 6493.7 2072.8zM6395.6 2092.7c-13.1 7.4-23.6 17.5-31.4 30.1-7.8 12.6-11.8 26.5-11.8 41.7.0 15.3 3.9 29.3 11.8 42 7.8 12.7 18.3 22.8 31.4 30.2 13.1 7.4 27.4 11.1 42.9 11.1s29.7-3.7 42.7-11.1 23.3-17.4 31.1-30.2c7.7-12.7 11.6-26.7 11.6-42s-3.9-29.2-11.6-41.8c-7.7-12.6-18.1-22.6-31.1-30s-27.2-11.2-42.6-11.2C6423 2081.5 6408.8 2085.2 6395.6 2092.7z"/><path fill="#6d6e71" d="M6826.5 2269.8l-126.3-169.1v169.1h-24.1v-210.6h25l126.3 169.3v-169.3h23.8v210.6H6826.5z"/><linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="-4516.6152" y1="-2338.7222" x2="-4108.4111" y2="-1861.3982" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset="0" style="stop-color:#F69923"/><stop offset=".3123" style="stop-color:#F79A23"/><stop offset=".8383" style="stop-color:#E97826"/></linearGradient><path fill="url(#SVGID_1_)" d="M1230.1 13.7c-45.3 26.8-120.6 102.5-210.5 212.3l82.6 155.9c58-82.9 116.9-157.5 176.3-221.2 4.6-5.1 7-7.5 7-7.5-2.3 2.5-4.6 5-7 7.5-19.2 21.2-77.5 89.2-165.5 224.4 84.7-4.2 214.9-21.6 321.1-39.7 31.6-177-31-258-31-258S1323.4-41.4 1230.1 13.7z"/><path fill="none" d="M1090.2 903.1c.6-.1 1.2-.2 1.8-.3l-11.9 1.3c-.7.3-1.4.7-2.1 1C1082.1 904.4 1086.2 903.7 1090.2 903.1z"/><path fill="none" d="M1005.9 1182.3c-6.7 1.5-13.7 2.7-20.7 3.7C992.3 1185 999.2 1183.8 1005.9 1182.3z"/><path fill="none" d="M432.9 1808.8c.9-2.3 1.8-4.7 2.6-7 18.2-48 36.2-94.7 54-140.1 20-51 39.8-100.4 59.3-148.3 20.6-50.4 40.9-99.2 60.9-146.3 21-49.4 41.7-97 62-142.8 16.5-37.3 32.8-73.4 48.9-108.3 5.4-11.7 10.7-23.2 16-34.6 10.5-22.7 21-44.8 31.3-66.5 9.5-20 19-39.6 28.3-58.8 3.1-6.4 6.2-12.8 9.3-19.1.5-1 1-2 1.5-3.1l-10.2 1.1-8-15.9c-.8 1.6-1.6 3.1-2.4 4.6-14.5 28.8-28.9 57.9-43.1 87.2-8.2 16.9-16.4 34-24.6 51-22.6 47.4-44.8 95.2-66.6 143.3-22.1 48.6-43.7 97.5-64.9 146.5-20.8 48.1-41.3 96.2-61.2 144.2-20 48-39.5 95.7-58.5 143.2-19.9 49.5-39.2 98.7-58 147.2-4.2 10.9-8.5 21.9-12.7 32.8-15 39.2-29.7 77.8-44 116l12.7 25.1 11.4-1.2c.4-1.1.8-2.3 1.3-3.4C396.7 1905.4 414.9 1856.4 432.9 1808.8z"/><path fill="none" d="M980 1186.8c.1.0.1.0.1-.1C980.1 1186.8 980.1 1186.8 980 1186.8z"/><path fill="#be202e" d="M952.6 1323c-10.6 1.9-21.4 3.8-32.5 5.7-.1.0-.1.1-.2.1 5.6-.8 11.2-1.7 16.6-2.6C942 1325.2 947.3 1324.1 952.6 1323z"/><path opacity=".35" fill="#be202e" d="M952.6 1323c-10.6 1.9-21.4 3.8-32.5 5.7-.1.0-.1.1-.2.1 5.6-.8 11.2-1.7 16.6-2.6C942 1325.2 947.3 1324.1 952.6 1323z"/><path fill="#be202e" d="M980.3 1186.7C980.2 1186.7 980.2 1186.7 980.3 1186.7c-.1.1-.2.1-.2.1 1.8-.2 3.5-.5 5.2-.8 7-1 13.9-2.2 20.7-3.7C997.5 1183.8 989 1185.2 980.3 1186.7z"/><path opacity=".35" fill="#be202e" d="M980.3 1186.7C980.2 1186.7 980.2 1186.7 980.3 1186.7c-.1.1-.2.1-.2.1 1.8-.2 3.5-.5 5.2-.8 7-1 13.9-2.2 20.7-3.7C997.5 1183.8 989 1185.2 980.3 1186.7z"/><linearGradient id="SVGID_2_" gradientUnits="userSpaceOnUse" x1="-7537.7339" y1="-2391.4075" x2="-4625.4141" y2="-2391.4075" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset=".3233" style="stop-color:#9E2064"/><stop offset=".6302" style="stop-color:#C92037"/><stop offset=".7514" style="stop-color:#CD2335"/><stop offset="1" style="stop-color:#E97826"/></linearGradient><path fill="url(#SVGID_2_)" d="M858.6 784.7c25.1-46.9 50.5-92.8 76.2-137.4 26.7-46.4 53.7-91.3 80.9-134.7 1.6-2.6 3.2-5.2 4.8-7.7 27-42.7 54.2-83.7 81.6-122.9L1019.5 226c-6.2 7.6-12.5 15.3-18.8 23.2-23.8 29.7-48.6 61.6-73.9 95.5-28.6 38.2-58 78.9-87.8 121.7-27.6 39.5-55.5 80.9-83.5 123.7-23.8 36.5-47.7 74-71.4 112.5-.9 1.4-1.8 2.9-2.6 4.3L789 919.2C811.8 873.6 835.1 828.7 858.6 784.7z"/><linearGradient id="SVGID_3_" gradientUnits="userSpaceOnUse" x1="-7186.1777" y1="-2099.3059" x2="-5450.7183" y2="-2099.3059" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset="0" style="stop-color:#282662"/><stop offset=".0954839" style="stop-color:#662E8D"/><stop offset=".7882" style="stop-color:#9F2064"/><stop offset=".9487" style="stop-color:#CD2032"/></linearGradient><path fill="url(#SVGID_3_)" d="M369 1981c-14.2 39.1-28.5 78.9-42.9 119.6-.2.6-.4 1.2-.6 1.8-2 5.7-4.1 11.5-6.1 17.2-9.7 27.4-18 52.1-37.3 108.2 31.7 14.5 57.1 52.5 81.1 95.6-2.6-44.7-21-86.6-56.2-119.1 156.1 7 290.6-32.4 360.1-146.6 6.2-10.2 11.9-20.9 17-32.2-31.6 40.1-70.8 57.1-144.5 53-.2.1-.3.1-.5.2.2-.1.3-.1.5-.2 108.6-48.6 163.1-95.3 211.2-172.6 11.4-18.3 22.5-38.4 33.8-60.6-94.9 97.5-205 125.3-320.9 104.2l-86.9 9.5C374.4 1966.3 371.7 1973.6 369 1981z"/><linearGradient id="SVGID_4_" gradientUnits="userSpaceOnUse" x1="-7374.1626" y1="-2418.5454" x2="-4461.8428" y2="-2418.5454" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset=".3233" style="stop-color:#9E2064"/><stop offset=".6302" style="stop-color:#C92037"/><stop offset=".7514" style="stop-color:#CD2335"/><stop offset="1" style="stop-color:#E97826"/></linearGradient><path fill="url(#SVGID_4_)" d="M409.6 1786.3c18.8-48.5 38.1-97.7 58-147.2 19-47.4 38.5-95.2 58.5-143.2s40.4-96.1 61.2-144.2c21.2-49 42.9-97.8 64.9-146.5 21.8-48.1 44-95.9 66.6-143.3 8.1-17.1 16.3-34.1 24.6-51 14.2-29.3 28.6-58.4 43.1-87.2.8-1.6 1.6-3.1 2.4-4.6L681.4 706.8c-1.8 2.9-3.5 5.8-5.3 8.6-25.1 40.9-50 82.7-74.4 125.4-24.7 43.1-49 87.1-72.7 131.7-20 37.6-39.6 75.6-58.6 113.9-3.8 7.8-7.6 15.5-11.3 23.2-23.4 48.2-44.6 94.8-63.7 139.5-21.7 50.7-40.7 99.2-57.5 145.1-11 30.2-21 59.4-30.1 87.4-7.5 24-14.7 47.9-21.5 71.8-16 56.3-29.9 112.4-41.2 168.3L353 1935.1c14.3-38.1 28.9-76.8 44-116C401.1 1808.2 405.4 1797.3 409.6 1786.3z"/><linearGradient id="SVGID_5_" gradientUnits="userSpaceOnUse" x1="-7161.7642" y1="-2379.1431" x2="-5631.2524" y2="-2379.1431" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset="0" style="stop-color:#282662"/><stop offset=".0954839" style="stop-color:#662E8D"/><stop offset=".7882" style="stop-color:#9F2064"/><stop offset=".9487" style="stop-color:#CD2032"/></linearGradient><path fill="url(#SVGID_5_)" d="M243.5 1729.4c-13.6 68.2-23.2 136.2-28 203.8-.2 2.4-.4 4.7-.5 7.1-33.7-54-124-106.8-123.8-106.2 64.6 93.7 113.7 186.7 120.9 278-34.6 7.1-82-3.2-136.8-23.3 57.1 52.5 1e2 67 116.7 70.9-52.5 3.3-107.1 39.3-162.1 80.8 80.5-32.8 145.5-45.8 192.1-35.3C148.1 2414.2 74.1 2645 0 2890c22.7-6.7 36.2-21.9 43.9-42.6 13.2-44.4 100.8-335.6 238-718.2 3.9-10.9 7.8-21.8 11.8-32.9 1.1-3 2.2-6.1 3.3-9.2 14.5-40.1 29.5-81.1 45.1-122.9 3.5-9.5 7.1-19 10.7-28.6.1-.2.1-.4.2-.6l-107.9-213.2C244.6 1724.4 244 1726.9 243.5 1729.4z"/><linearGradient id="SVGID_6_" gradientUnits="userSpaceOnUse" x1="-7374.1626" y1="-2117.1309" x2="-4461.8428" y2="-2117.1309" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset=".3233" style="stop-color:#9E2064"/><stop offset=".6302" style="stop-color:#C92037"/><stop offset=".7514" style="stop-color:#CD2335"/><stop offset="1" style="stop-color:#E97826"/></linearGradient><path fill="url(#SVGID_6_)" d="M805.6 937c-3.1 6.3-6.2 12.7-9.3 19.1-9.3 19.2-18.8 38.8-28.3 58.8-10.3 21.7-20.7 43.9-31.3 66.5-5.3 11.4-10.6 22.9-16 34.6-16.1 35-32.4 71.1-48.9 108.3-20.3 45.8-41 93.4-62 142.8-20 47.1-40.3 95.9-60.9 146.3-19.5 47.9-39.3 97.3-59.3 148.3-17.8 45.4-35.9 92.1-54 140.1-.9 2.3-1.8 4.7-2.6 7-18 47.6-36.2 96.6-54.6 146.8-.4 1.1-.8 2.3-1.3 3.4l86.9-9.5c-1.7-.3-3.5-.5-5.2-.9 103.9-13 242.1-90.6 331.4-186.5 41.1-44.2 78.5-96.3 113-157.3 25.7-45.4 49.8-95.8 72.8-151.5 20.1-48.7 39.4-101.4 58-158.6-23.9 12.6-51.2 21.8-81.4 28.2-5.3 1.1-10.7 2.2-16.1 3.1-5.5 1-11 1.8-16.6 2.6.1.0.1-.1.2-.1 96.9-37.3 158-109.2 202.4-197.4-25.5 17.4-66.9 40.1-116.6 51.1-6.7 1.5-13.7 2.7-20.7 3.7-1.7.3-3.5.6-5.2.8.1.0.1.0.1-.1h.1c33.6-14.1 62-29.8 86.6-48.4 5.3-4 10.4-8.1 15.3-12.3 7.5-6.5 14.7-13.3 21.5-20.5 4.4-4.6 8.6-9.3 12.7-14.2 9.6-11.5 18.7-23.9 27.1-37.3 2.6-4.1 5.1-8.3 7.6-12.6 3.2-6.2 6.3-12.3 9.3-18.3 13.5-27.2 24.4-51.5 33-72.8 4.3-10.6 8.1-20.5 11.3-29.7 1.3-3.7 2.5-7.2 3.7-10.6 3.4-10.2 6.2-19.3 8.4-27.3 3.3-12 5.3-21.5 6.4-28.4-3.3 2.6-7.1 5.2-11.3 7.7-29.3 17.5-79.5 33.4-119.9 40.8l79.8-8.8-79.8 8.8c-.6.1-1.2.2-1.8.3-4 .7-8.1 1.3-12.2 2 .7-.3 1.4-.7 2.1-1l-273 29.9C806.6 935 806.1 936 805.6 937z"/><linearGradient id="SVGID_7_" gradientUnits="userSpaceOnUse" x1="-7554.8232" y1="-2132.0981" x2="-4642.5034" y2="-2132.0981" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset=".3233" style="stop-color:#9E2064"/><stop offset=".6302" style="stop-color:#C92037"/><stop offset=".7514" style="stop-color:#CD2335"/><stop offset="1" style="stop-color:#E97826"/></linearGradient><path fill="url(#SVGID_7_)" d="M1112.9 385.1c-24.3 37.3-50.8 79.6-79.4 127.5-1.5 2.5-3 5.1-4.5 7.6-24.6 41.5-50.8 87.1-78.3 137-23.8 43.1-48.5 89.3-74.3 139C854 839.5 830.8 885.4 807 934l273-29.9c79.5-36.6 115.1-69.7 149.6-117.6 9.2-13.2 18.4-27 27.5-41.3 28-43.8 55.6-92 80.1-139.9 23.7-46.3 44.7-92.2 60.7-133.5 10.2-26.3 18.4-50.8 24.1-72.3 5-19 8.9-36.9 11.9-54.1C1327.9 363.5 1197.6 380.9 1112.9 385.1z"/><path fill="#be202e" d="M936.5 1326.1c-5.5 1-11 1.8-16.6 2.6C925.5 1328 931 1327.1 936.5 1326.1z"/><path opacity=".35" fill="#be202e" d="M936.5 1326.1c-5.5 1-11 1.8-16.6 2.6C925.5 1328 931 1327.1 936.5 1326.1z"/><linearGradient id="SVGID_8_" gradientUnits="userSpaceOnUse" x1="-7374.1626" y1="-2027.484" x2="-4461.8433" y2="-2027.484" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset=".3233" style="stop-color:#9E2064"/><stop offset=".6302" style="stop-color:#C92037"/><stop offset=".7514" style="stop-color:#CD2335"/><stop offset="1" style="stop-color:#E97826"/></linearGradient><path fill="url(#SVGID_8_)" d="M936.5 1326.1c-5.5 1-11 1.8-16.6 2.6C925.5 1328 931 1327.1 936.5 1326.1z"/><path fill="#be202e" d="M980 1186.8c1.8-.2 3.5-.5 5.2-.8C983.5 1186.3 981.8 1186.6 980 1186.8z"/><path opacity=".35" fill="#be202e" d="M980 1186.8c1.8-.2 3.5-.5 5.2-.8C983.5 1186.3 981.8 1186.6 980 1186.8z"/><linearGradient id="SVGID_9_" gradientUnits="userSpaceOnUse" x1="-7374.1626" y1="-2037.7417" x2="-4461.8433" y2="-2037.7417" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset=".3233" style="stop-color:#9E2064"/><stop offset=".6302" style="stop-color:#C92037"/><stop offset=".7514" style="stop-color:#CD2335"/><stop offset="1" style="stop-color:#E97826"/></linearGradient><path fill="url(#SVGID_9_)" d="M980 1186.8c1.8-.2 3.5-.5 5.2-.8C983.5 1186.3 981.8 1186.6 980 1186.8z"/><path fill="#be202e" d="M980.2 1186.7z"/><path opacity=".35" fill="#be202e" d="M980.2 1186.7z"/><linearGradient id="SVGID_10_" gradientUnits="userSpaceOnUse" x1="-5738.0635" y1="-2039.799" x2="-5094.3457" y2="-2039.799" gradientTransform="matrix(0.4226 -0.9063 0.9063 0.4226 5117.8774 -2859.9343)"><stop offset=".3233" style="stop-color:#9E2064"/><stop offset=".6302" style="stop-color:#C92037"/><stop offset=".7514" style="stop-color:#CD2335"/><stop offset="1" style="stop-color:#E97826"/></linearGradient><path fill="url(#SVGID_10_)" d="M980.2 1186.7z"/></svg> |
| </div> |
| </a> |
| <ul class="footer-link"> |
| <li><a class="white" href="http://www.apache.org">Foundation</a></li> |
| <li><a class="white" href="http://www.apache.org/licenses/">License</a></li> |
| <li><a class="white" href="https://www.apache.org/security/">Security</a></li> |
| <li><a class="white" href="http://www.apache.org/events/current-event">Events</a></li> |
| <li><a class="white" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a class="white" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="col-6 text-white text-center container-center"> |
| <p>Copyright © 2022 The Apache Software Foundation, Licensed under the <a class="white" href="https://www.apache.org/licenses/LICENSE-2.0">Apache License Version 2.0</a></p> |
| <p>Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> |
| </div> |
| <div class="col-1"></div> |
| </div> |
| </div> |
| </footer> |
| |
| |
| </div> |
| <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js" |
| integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" |
| crossorigin="anonymous"></script> |
| <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.6.1/dist/js/bootstrap.min.js" |
| integrity="sha512-UR25UO94eTnCVwjbXozyeVd6ZqpaAE9naiEUBK/A+QDbfSTQFhPGj5lOR6d8tsgbBk84Ggb5A3EkjsOgPRPcKA==" |
| crossorigin="anonymous"></script> |
| |
| |
| |
| |
| |
| <script src='/js/tabpane-persist.js'></script> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <script src="/js/main.min.1a2e43037d7eeb7eb548659ffab8adc920ddeef68063a09913f04392dd3c1f19.js" integrity="sha256-Gi5DA31+6361SGWf+ritySDd7vaAY6CZE/BDkt08Hxk=" crossorigin="anonymous"></script> |
| |
| |
| |
| <script src='/js/prism.js'></script> |
| |
| |
| |
| </body> |
| </html> |
