HugeGraph-Client Quick Start

1 概述

HugeGraph-Client向HugeGraph-Server发出HTTP请求，获取并解析Server的执行结果。目前仅提供了Java版，用户可以使用HugeGraph-Client编写Java代码操作HugeGraph，比如元数据和图数据的增删改查，或者执行gremlin语句。

2 环境要求

  • jdk1.8
  • maven-3.3.9

3 使用流程

使用HugeGraph-Client的基本步骤如下:

  • 新建Eclipse/ IDEA Maven项目；
  • 在pom文件中添加HugeGraph-Client依赖；
  • 创建类，调用HugeGraph-Client接口；

详细使用过程见下节完整示例。

4 完整示例

4.1 新建Maven工程

可以选择Eclipse或者Intellij Idea创建工程：

4.2 添加hugegraph-client依赖

添加hugegraph-client依赖

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>com.baidu.hugegraph</groupId>
  4.         <artifactId>hugegraph-client</artifactId>
  5.         <version>${version}</version>
  6.     </dependency>    
  7. </dependencies>

4.3 Example

4.3.1 SingleExample
  1. import java.io.IOException;
  2. import java.util.Iterator;
  3. import java.util.List;
  5. import com.baidu.hugegraph.driver.GraphManager;
  6. import com.baidu.hugegraph.driver.GremlinManager;
  7. import com.baidu.hugegraph.driver.HugeClient;
  8. import com.baidu.hugegraph.driver.SchemaManager;
  9. import com.baidu.hugegraph.structure.constant.T;
  10. import com.baidu.hugegraph.structure.graph.Edge;
  11. import com.baidu.hugegraph.structure.graph.Path;
  12. import com.baidu.hugegraph.structure.graph.Vertex;
  13. import com.baidu.hugegraph.structure.gremlin.Result;
  14. import com.baidu.hugegraph.structure.gremlin.ResultSet;
  16. public class SingleExample {
  18.     public static void main(String[] args) throws IOException {
  19.         // If connect failed will throw a exception.
  20.         HugeClient hugeClient = new HugeClient("http://localhost:8080", "hugegraph");
  22.         SchemaManager schema = hugeClient.schema();
  24.         schema.propertyKey("name").asText().ifNotExist().create();
  25.         schema.propertyKey("age").asInt().ifNotExist().create();
  26.         schema.propertyKey("city").asText().ifNotExist().create();
  27.         schema.propertyKey("weight").asDouble().ifNotExist().create();
  28.         schema.propertyKey("lang").asText().ifNotExist().create();
  29.         schema.propertyKey("date").asText().ifNotExist().create();
  30.         schema.propertyKey("price").asInt().ifNotExist().create();
  32.         schema.vertexLabel("person")
  33.               .properties("name", "age", "city")
  34.               .primaryKeys("name")
  35.               .ifNotExist()
  36.               .create();
  38.         schema.vertexLabel("software")
  39.               .properties("name", "lang", "price")
  40.               .primaryKeys("name")
  41.               .ifNotExist()
  42.               .create();
  44.         schema.indexLabel("personByCity")
  45.               .onV("person")
  46.               .by("city")
  47.               .secondary()
  48.               .ifNotExist()
  49.               .create();
  51.         schema.indexLabel("personByAgeAndCity")
  52.               .onV("person")
  53.               .by("age", "city")
  54.               .secondary()
  55.               .ifNotExist()
  56.               .create();
  58.         schema.indexLabel("softwareByPrice")
  59.               .onV("software")
  60.               .by("price")
  61.               .range()
  62.               .ifNotExist()
  63.               .create();
  65.         schema.edgeLabel("knows")
  66.               .sourceLabel("person")
  67.               .targetLabel("person")
  68.               .properties("date", "weight")
  69.               .ifNotExist()
  70.               .create();
  72.         schema.edgeLabel("created")
  73.               .sourceLabel("person").targetLabel("software")
  74.               .properties("date", "weight")
  75.               .ifNotExist()
  76.               .create();
  78.         schema.indexLabel("createdByDate")
  79.               .onE("created")
  80.               .by("date")
  81.               .secondary()
  82.               .ifNotExist()
  83.               .create();
  85.         schema.indexLabel("createdByWeight")
  86.               .onE("created")
  87.               .by("weight")
  88.               .range()
  89.               .ifNotExist()
  90.               .create();
  92.         schema.indexLabel("knowsByWeight")
  93.               .onE("knows")
  94.               .by("weight")
  95.               .range()
  96.               .ifNotExist()
  97.               .create();
  100.         GraphManager graph = hugeClient.graph();
  101.         Vertex marko = graph.addVertex(T.label, "person", "name", "marko",
  102.                                        "age", 29, "city", "Beijing");
  103.         Vertex vadas = graph.addVertex(T.label, "person", "name", "vadas",
  104.                                        "age", 27, "city", "Hongkong");
  105.         Vertex lop = graph.addVertex(T.label, "software", "name", "lop",
  106.                                        "lang", "java", "price", 328);
  107.         Vertex josh = graph.addVertex(T.label, "person", "name", "josh",
  108.                                        "age", 32, "city", "Beijing");
  109.         Vertex ripple = graph.addVertex(T.label, "software", "name", "ripple",
  110.                                        "lang", "java", "price", 199);
  111.         Vertex peter = graph.addVertex(T.label, "person", "name", "peter",
  112.                                        "age", 35, "city", "Shanghai");
  114.         marko.addEdge("knows", vadas, "date", "20160110", "weight", 0.5);
  115.         marko.addEdge("knows", josh, "date", "20130220", "weight", 1.0);
  116.         marko.addEdge("created", lop, "date", "20171210", "weight", 0.4);
  117.         josh.addEdge("created", lop, "date", "20091111", "weight", 0.4);
  118.         josh.addEdge("created", ripple, "date", "20171210", "weight", 1.0);
  119.         peter.addEdge("created", lop, "date", "20170324", "weight", 0.2);
  121.         GremlinManager gremlin = hugeClient.gremlin();
  122.         ResultSet resultSet = gremlin.gremlin("g.V().outE().path()").execute();
  123.         Iterator<Result> results = resultSet.iterator();
  124.         results.forEachRemaining(result -> {
  125.             System.out.println(result.getObject().getClass());
  126.             Object object = result.getObject();
  127.             if (object instanceof Vertex) {
  128.                 System.out.println(((Vertex) object).id());
  129.             } else if (object instanceof Edge) {
  130.                 System.out.println(((Edge) object).id());
  131.             } else if (object instanceof Path) {
  132.                 List<Object> elements = ((Path) object).objects();
  133.                 elements.forEach(element -> {
  134.                     System.out.println(element.getClass());
  135.                     System.out.println(element);
  136.                 });
  137.             } else {
  138.                 System.out.println(object);
  139.             }
  140.         });
  141.     }
  142. }
4.3.2 BatchExample
  1. import java.util.LinkedList;
  2. import java.util.List;
  4. import com.baidu.hugegraph.driver.GraphManager;
  5. import com.baidu.hugegraph.driver.HugeClient;
  6. import com.baidu.hugegraph.driver.SchemaManager;
  7. import com.baidu.hugegraph.structure.graph.Edge;
  8. import com.baidu.hugegraph.structure.graph.Vertex;
  10. public class BatchExample {
  12.     public static void main(String[] args) {
  13.         // If connect failed will throw a exception.
  14.         HugeClient hugeClient = new HugeClient("http://localhost:8080", "hugegraph");
  16.         SchemaManager schema = hugeClient.schema();
  18.         schema.propertyKey("name").asText().ifNotExist().create();
  19.         schema.propertyKey("age").asInt().ifNotExist().create();
  20.         schema.propertyKey("lang").asText().ifNotExist().create();
  21.         schema.propertyKey("date").asText().ifNotExist().create();
  22.         schema.propertyKey("price").asInt().ifNotExist().create();
  24.         schema.vertexLabel("person")
  25.               .properties("name", "age")
  26.               .primaryKeys("name")
  27.               .ifNotExist()
  28.               .create();
  30.         schema.vertexLabel("person")
  31.               .properties("price")
  32.               .nullableKeys("price")
  33.               .append();
  35.         schema.vertexLabel("software")
  36.               .properties("name", "lang", "price")
  37.               .primaryKeys("name")
  38.               .ifNotExist()
  39.               .create();
  41.         schema.indexLabel("softwareByPrice")
  42.               .onV("software").by("price")
  43.               .range()
  44.               .ifNotExist()
  45.               .create();
  47.         schema.edgeLabel("knows")
  48.               .link("person", "person")
  49.               .properties("date")
  50.               .ifNotExist()
  51.               .create();
  53.         schema.edgeLabel("created")
  54.               .link("person", "software")
  55.               .properties("date")
  56.               .ifNotExist()
  57.               .create();
  59.         schema.indexLabel("createdByDate")
  60.               .onE("created").by("date")
  61.               .secondary()
  62.               .ifNotExist()
  63.               .create();
  65.         GraphManager graph = hugeClient.graph();
  67.         Vertex marko = new Vertex("person").property("name", "marko")
  68.                                            .property("age", 29);
  69.         Vertex vadas = new Vertex("person").property("name", "vadas")
  70.                                            .property("age", 27);
  71.         Vertex lop = new Vertex("software").property("name", "lop")
  72.                                            .property("lang", "java")
  73.                                            .property("price", 328);
  74.         Vertex josh = new Vertex("person").property("name", "josh")
  75.                                           .property("age", 32);
  76.         Vertex ripple = new Vertex("software").property("name", "ripple")
  77.                                               .property("lang", "java")
  78.                                               .property("price", 199);
  79.         Vertex peter = new Vertex("person").property("name", "peter")
  80.                                            .property("age", 35);
  82.         // Create a list to put vertex(Default max size is 500)
  83.         List<Vertex> vertices = new LinkedList<>();
  84.         vertices.add(marko);
  85.         vertices.add(vadas);
  86.         vertices.add(lop);
  87.         vertices.add(josh);
  88.         vertices.add(ripple);
  89.         vertices.add(peter);
  91.         // Post a vertex list to server
  92.         vertices = graph.addVertices(vertices);
  93.         vertices.forEach(vertex -> System.out.println(vertex));
  95.         Edge markoKnowsVadas = new Edge("knows").source(marko).target(vadas)
  96.                                                 .property("date", "20160110");
  97.         Edge markoKnowsJosh = new Edge("knows").source(marko).target(josh)
  98.                                                .property("date", "20130220");
  99.         Edge markoCreateLop = new Edge("created").source(marko).target(lop)
  100.                                                  .property("date", "20171210");
  101.         Edge joshCreateRipple = new Edge("created").source(josh).target(ripple)
  102.                                                    .property("date", "20171210");
  103.         Edge joshCreateLop = new Edge("created").source(josh).target(lop)
  104.                                                 .property("date", "20091111");
  105.         Edge peterCreateLop = new Edge("created").source(peter).target(lop)
  106.                                                  .property("date", "20170324");
  108.         // Create a list to put edge(Default max size is 500)
  109.         List<Edge> edges = new LinkedList<>();
  110.         edges.add(markoKnowsVadas);
  111.         edges.add(markoKnowsJosh);
  112.         edges.add(markoCreateLop);
  113.         edges.add(joshCreateRipple);
  114.         edges.add(joshCreateLop);
  115.         edges.add(peterCreateLop);
  117.         // Post a edge list to server
  118.         edges = graph.addEdges(edges, false);
  119.         edges.forEach(edge -> System.out.println(edge));
  120.     }
  121. }

4.4 运行Example

运行Example之前需要启动Sever, 启动过程见HugeGraph-Server Quick Start

4.5 Example示例说明

示例说明见HugeGraph-Client基本API介绍