8.附录

8.1.HugeGraph Gremlin语法使用手册

HugeGraph支持Apache TinkerPop3的图形遍历查询语言Gremlin。 SQL是关系型数据库查询语言，而Gremlin是一种通用的图数据库查询语言，Gremlin可用于创建图的实体（Vertex和Edge）、修改实体内部属性、删除实体，也可执行图的查询操作。

Gremlin可用于创建图的实体（Vertex和Edge）、修改实体内部属性、删除实体，更主要的是可用于执行图的查询及分析操作。

8.1.1.Gremlin标准语法

以下是HugeGraph⽀持的Gremlin标准语法：

8.1.2.Schema语法

schema相关的语法虽然不是Gremlin标准语法，但却是HugeGraph的核⼼功能，也可以通过Gremlin接⼝进⾏操作。

HugeGraph中的元数据主要⽤来定义和约束顶点、边、属性和索引，包括：

• PropertyKey：属性的类型
• VertexLabel：顶点的类型
• EdgeLabel：边的类型
• IndexLabel：索引的类型

四种元数据的依赖关系如下（虚线上⾯的依赖虚线下⾯的）：

            IndexLabel
            /      \
           /        \
          /        EdgeLabel
         /        /       /
        /        /       /
      VertexLabel       /
           \           /
            \         /
           PropertyKey

根据依赖关系，下⾯将按照PropertyKey、VertexLabel、EdgeLabel和IndexLabel的顺序依次介绍元数据。

8.1.2.1.PropertyKey

PropertyKey定义属性的类型，包括名字、类型、基数等。例如：

graph.schema().propertyKey("name").asText().create(); //创建姓名属性(文本类型)
graph.schema().propertyKey("age").asInt().create(); //创建年龄属性(整数类型)
graph.schema().propertyKey("addr").asText().create(); //创建地址属性(文本类型)
graph.schema().propertyKey("lang").asText().create(); //创建语言属性(文本类型)
graph.schema().propertyKey("tag").asText().create(); //创建标签属性(文本类型)
graph.schema().propertyKey("weight").asFloat().create(); //创建权重属性(浮点类型)

以PropertyKey的name为例：

• propertyKey("name"): 表示属性的名字为“name”
• asText(): 表示属性的类型为⽂本
• valueSingle(): 表示属性的基数为single，即单值类型

定义PropertyKey可⽤的完整⽅法说明：

名字是字符串：propertyKey(String)

类型包括：

• asText(): 字符串类型，是默认值
• asInt(): 整型
• asDate(): ⽇期类型
• asUuid(): UUID类型
• asBoolean(): 布尔型
• asByte(): 字节型
• asBlob(): 字节数组型
• asDouble(): 双精度浮点型
• asFloat(): 单精度浮点型
• asLong(): ⻓整型

基数包括：

• valueSingle(): 值是单值类型，是默认值
• valueList(): 值是列表类型
• valueSet(): 值是集合类型

8.1.2.2.VertexLabel

VertexLabel是顶点的类型，每个顶点都有对应的VertexLabel，⼀个VertexLabel可以有多个具体的顶点。 VertexLabel可以定义⼀类 顶点的类型名称、拥有的属性、 ID策略、是否创建按类型的索引等。例如：

// 创建顶点类型：⼈ "person"，包含姓名、年龄、地址等属性，使⽤⾃定义的字符串作为 ID
graph.schema().vertexLabel("person")
              .properties("name", "age", "addr", "weight")
              .nullableKeys("addr", "weight")
              .useCustomizeStringId()
              .create()

// 创建顶点类型：软件"software"，包含名称、使⽤语⾔、标签等属性，使⽤名称作为主键
graph.schema().vertexLabel("software")
              .properties("name", "lang", "tag", "weight")
              .primaryKeys("name")
              .create()

// 创建顶点类型：语⾔"language"，包含名称、使⽤语⾔等属性，使⽤名称作为主键
graph.schema().vertexLabel("language")
              .properties("name", "lang", "weight")
              .primaryKeys("name")
              .create()

以VertexLabel为例：

• vertexLabel("person") 表示顶点类型的名字为“person”
• properties("name", "age", "addr", "weight") 表示 weight 类型的属性
• nullableKeys("addr", "weight") 表示 person 类型的顶点可以不包含PropertyKey addr 和 weight 类型的属性
• useCustomizeStringId() 表示 person 类型的顶点使⽤指定的String类型的ID
• 默认包含 enableLabelIndex(true) ，表示可以按类型查找 person 类型的顶点

定义VertexLable可⽤的完整⽅法说明：

• 名字是字符串，vertexLabel(String)
• 包含的属性，properties(String...) ，必须是系统中已经创建过的PropertyKey的名字
• 可空属性，nullableKeys(String...) ，必须是 properties 的⼦集
• ID策略:
  • useAutomaticId() ，⾃动ID策略，该类型的每个顶点会在创建时由系统提供⼀个数字ID
  • usePrimaryKeyId() ，主键ID策略，该类型的顶点的ID是通过拼接 primaryKeys(String...) 中的多个属性的值组成
  • useCustomizeStringId() ，指定String ID策略，该类型的顶点在创建时使⽤指定的String作为顶点ID
  • useCustomizeNumberId() ，指定Number ID策略，该类型的顶点在创建时使⽤指定的Number作为顶点ID
• 类型索引，enableLabelIndex(Boolean) ，是否创建类型索引，如果创建了类型索引，就可以⾼效按类型查询顶点。

8.1.2.3.EdgeLabel

EdgeLabel是边的类型，每条边都有对应的EdgeLabel，⼀个EdgeLabel可以有多条具体的边。EdgeLabel可以定义⼀类边的类型名 称、拥有的属性、是否创建按类型的索引等。例如：

// 创建边类型：⼈认识⼈ "knows"，此类边由"person"指向 "person"
graph.schema().edgeLabel("knows")
              .sourceLabel("person").targetLabel("person")
              .properties("weight")
              .create()

// 创建边类型：⼈创建软件"created"，此类边由"person"指向 "software"
graph.schema().edgeLabel("created")
              .sourceLabel("person").targetLabel("software")
              .properties("weight")
              .create()

// 创建边类型：软件包含软件"contains"，此类边由"software"指向 "software"
graph.schema().edgeLabel("contains")
              .sourceLabel("software").targetLabel("software")
              .properties("weight")
              .create()

// 创建边类型：软件定义语⾔"define"，此类边由"software"指向 "language"
graph.schema().edgeLabel("define")
              .sourceLabel("software").targetLabel("language")
              .properties("weight")
              .create()

// 创建边类型：软件实现软件"implements"，此类边由"software"指向 "software"
graph.schema().edgeLabel("implements")
              .sourceLabel("software").targetLabel("software")
              .properties("weight")
              .create()

// 创建边类型：软件⽀持语⾔"supports"，此类边由"software"指向 "language"
graph.schema().edgeLabel("supports")
              .sourceLabel("software").targetLabel("language")
              .properties("weight")
              .create()

以EdgeLabel的knows为例：

• edgeLabel("knows") 表示边的类型的名字为“knows”
• sourceLabel("person") 表示 knows 类型的边从 person 类型的顶点发出
• targetLabel("person") 表示 knows 类型的边指向 person 类型的顶点
• properties("weight") 表示 knows 类型的边包含PropertyKey weight 类型的属性
• singleTime() 是默认值，表示从任意⼀个 person 顶点到另⼀个 person 顶点之间只能有⼀条 knows 类型的边

定义EdgeLabel可⽤的完整⽅法说明：

• 名字是字符串，edgeLabel(String)
• 包含的属性，properties(String...) ，必须是系统中已经创建过的PropertyKey的名字
• 可空属性，nullableKeys(String...) ，必须是 properties 的⼦集
• 频度，表示从⼀个点出发到另⼀个点的该类型的边是否可以存在多条
  • singleTime() 表示只能有⼀条
  • multiTimes() 表示可以有多条，此时需要指定 sortKeys(String...)
• 排序键， sortKeys(String...) ，当频度为 multiTimes() 时，可⽤于区分不同的该类型的边
• ID策略，边没有ID策略，所有类型的边都⽤拼接的字符串ID
  • singleTime() 时，ID格式为“sourceVertexId>label>>targetLabelId”
  • multiTimes() 时，ID格式为“sourceVertexId>label>sortKeys>targetLabelId”
• 类型索引，enableLabelIndex(Boolean) ，是否创建类型索引，如果创建了类型索引，就可以⾼效按类型查询边。

8.1.2.4.IndexLabel

IndexLabel是索引的类型，定义对X类型的顶点或者边的Ys属性建⽴Z类型的索引。其中：

• X表示VertexLabel或者EdgeLabel
• Ys表示X的⼀个或者多个PropertyKey属性
• Z表示索引的种类
  • ⼆级索引
    • 单列索引
    • 联合索引
  • 范围索引
  • 全⽂索引
  • 分⽚索引
  • 唯⼀索引

// 创建索引类型：   "personByName"，可以按“name”属性的值快速查询对应的“person”顶点
schema.indexLabel("personByName")
      .onV("person")
      .by("name")
      .secondary()
      .create();

// 创建索引类型：   "personByAge"，可以按“age”属性的范围快速查询对应的“person”顶点
schema.indexLabel("personByAge")
      .onV("person")
      .by("age")
      .range()
      .create();

// 创建索引类型：   "knowsByWeight"，可以按“weight”属性的范围快速查询对应的“knows”边
schema.indexLabel("knowsByWeight")
      .onE("knows")
      .by("weight")
      .range()
      .ifNotExist()
      .create();

以IndexLabel personByName 为例：

• indexLabel("personByName") 表示IndexLabel的名字为“personByName”
• onV("person") 表示对 person 类型的顶点建⽴索引，还有 onE(String) 表示对某个类型的边建⽴索引
• by("name") 表示对顶点或者边的“name”属性的值建⽴索引
• secondary() 表示建⽴的是⼆级索引，即可以快速查询属性的值等于某个具体值的顶点或者边

定义IndexLabel可⽤的完整⽅法说明：

• 名字是字符串， indexLabel(String)
• on语句，表示是对哪个类型的顶点或者边建⽴索引
  • onV(String) 表示对某个类型的顶点建⽴索引
  • onE(String) 表示对某个类型的边建⽴索引
• 属性列表， by(String...) 表示对于顶点或者边的哪些属性的值建⽴索引

• 索引类型: 建⽴的索引类型，⽬前⽀持五种，即 Secondary、 Range、 Search、 Shard 和 Unique。

  • Secondary ⽀持精确匹配的⼆级索引，允许建⽴联合索引，联合索引⽀持索引前缀搜索

    • 单个属性，⽀持相等查询，⽐如： person顶点的city属性的⼆级索引，可以⽤ g.V().has("city", "北京") 查询"city属性值是北京"的全部顶点

    • 联合索引，⽀持前缀查询和相等查询，⽐如： person顶点的city和street属性的联合索引，可以⽤ g.V().has("city", "北京").has('street', '中关村街道') 查询"city属性值是北京且street属性值是中关村"的全部顶点，或 者 g.V().has("city", "北京") 查询"city属性值是北京"的全部顶点

      注意：secondary index的查询都是基于"是"或者"相等"的查询条件，不⽀持"部分匹配"

  • Range ⽀持数值类型的范围查询
    • 必须是单个数字或者⽇期属性，⽐如： person顶点的age属性的范围索引，可以⽤ g.V().has("age", P.gt(18))查询"age属性值⼤于18"的顶点。除了 P.gt() 以外，还⽀持 P.gte() , P.lte() , P.lt() , P.eq() , P.between() , P.inside() 和 P.outside() 等

  • Search ⽀持全⽂检索的索引

    • 必须是单个⽂本属性，⽐如： person顶点的address属性的全⽂索引，可以⽤ g.V().has("address", Text .contains('⼤厦 ') 查询"address属性中包含⼤厦"的全部顶点。⽬前仅⽀持 Text.contains() ⼀种模糊查询。

      注意：search index的查询是基于"是"或者"包含"的查询条件

  • Shard ⽀持前缀匹配 + 数字范围查询的索引
    • N个属性的分⽚索引，⽀持前缀相等情况下的范围查询，⽐如： person顶点的city和age属性的分⽚索引，可以⽤ g.V().has("city", "北京").has("age", P.between(18, 30)) 查询"city属性是北京且年龄⼤于等于18⼩于30"的全部顶点
    • shard index N个属性全是⽂本属性时，等价于secondary index
    • shard index只有单个数字或者⽇期属性时，等价于range index 注意：shard index可以有任意数字或者⽇期属性，但是查询时最多只能提供⼀个范围查找条件，且该范围查找条件的属性
  • Unique ⽀持属性值唯⼀性约束，即可以限定属性的值不重复，允许联合索引，但不⽀持查询
    • 单个或者多个属性的唯⼀性索引，不可⽤来查询，只可对属性的值进⾏限定，当出现重复值时将报错

以上四种元数据创建时，可以添加 ifNotExist() ，如 ...ifNotExist().create() ，表示不存在时才创建，存在则返回已 存在的同名元数据类型

8.1.3.常⽤Gremlin算法

8.1.3.1.Kout--3度邻居

只需要邻居点

g.V( '1:marko').repeat(out().limit(10000)).times(3).dedup()

需要路径（仅点信息）

g.V( '1:marko').repeat(out().limit(10000)).times(3).dedup().path()

需要路径（点边信息）

g.V( '1:marko').repeat(outE().inV().limit(10000)).times(3).dedup().path()

8.1.3.2.Kneighbor--3度以内邻居

只需要邻居点

g.V( '1:marko').repeat(out().limit(10000)).emit().times(3).dedup()

需要路径（仅点信息）

g.V( '1:marko').repeat(out().limit(10000)).emit().times(3).dedup().path()

需要路径（点边信息）

g.V( '1:marko').repeat(outE().inV().limit(10000)).emit().times(3).dedup().path()

8.1.3.3.Shortestpath--6度以内最短路径

g.V( '1:marko').repeat(bothE().otherV().simplePath()).until(hasId( '2:ripple').or().loops().is(P.gte(6))).hasId( '2:ripple').path().limit(1)