Graph

```
public interface Graph
```
入口类，图对象

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`Set<Integer>`	`affinities()` 获取集群中所有affinity。
`int`	`affinity(long elementId)` 获取点VertexId所在的主机号。
`<V> Collection<V>`	`broadcastCallable(Collection<Integer> affinities, GraphBroadcastCallable<V> callable)` 带返回值的广播任务。
`default <V> Collection<V>`	`broadcastCallable(GraphBroadcastCallable<V> callable)` 带返回值的广播任务。
`void`	`broadcastRunnable(Collection<Integer> affinities, GraphBroadcastRunnable runnable)` 不带返回值的广播任务。
`default void`	`broadcastRunnable(GraphBroadcastRunnable runnable)` 不带返回值的广播任务。
`void`	`deleteEdge(String edgeId)` 删除边
`void`	`deleteVertex(long vertexId)` 删除点以及所有与点相关的边
`void`	`deleteVertex(long vertexId, boolean isDeleteEdge)` 删除点
`default long`	`edgeIteratorFast(Consumer<Edge> consumer)` 多线程迭代本地边
`default long`	`edgeIteratorFast(Consumer<Edge> consumer, Set<Integer> types)` 多线程迭代本地边
`long`	`edgeIteratorFast(Consumer<Edge> consumer, Set<Integer> types, boolean backup)` 多线程迭代本地边
`int`	`edgeTypeIndex(String edgeId)` 通过边EdgeId获取边类型index
`default <CONFIG extends com.graphdbapi.pregel.GraphPregelConfig> com.graphdbapi.pregel.GraphPregelResult`	`executePregel(CONFIG config, com.graphdbapi.pregel.GraphPregelComputation<CONFIG> computation)` 执行分布式 pregel 任务
`void`	`flushData()` 手动触发写盘
`long`	`getAllEdgeCount()` 查询集群总边数
`long`	`getAllVertexCount()` 查询集群总点数
`long`	`getEdgeCount(boolean isLocal)` 查询边数量
`long`	`getEdgeCount(int edgeTypeIndex)` 查询集群指定边类型总数
`long`	`getEdgeCount(int typeIndex, boolean isLocal)` 查询指定边类型数量
`String`	`getGraphName()` 查询图名称
`GraphDbAtomicLong`	`getOrCreateGraphDbAtomicLong(String name, long initValue)` 创建一个分布式 AtomicLong
`String`	`getPk(long vertexId)` 根据VertexId来查询对应点的外部唯一标识值
`long`	`getSnowId()` 返回 Cypher 任务 id
`long`	`getVertexCount(boolean isLocal)` 查询点数量
`long`	`getVertexCount(int vertexTypeIndex)` 查询集群指定点类型总数
`long`	`getVertexCount(int typeIndex, boolean isLocal)` 查询指定点类型数量
`Map<Long,Vertex>`	`getVertexes(Collection<Long> ids)` 批量查询点
`Set<Long>`	`getVertexIdByPk(String pk)` 根据外部唯一标识查询点VertexId
`Long`	`getVertexIdByPk(String pk, int typeIndex)` 根据外部唯一标识和点类型index查询点VertexId
`Long`	`getVertexIdByPk(String pk, String type)` 根据外部唯一标识和点类型名查询点VertexId。
`Set<Long>`	`getVertexIdByPkCompatible(String pk)` 根据外部唯一标识查询点VertexId
`Long`	`getVertexIdByPkCompatible(String pk, int typeIndex)` 根据外部唯一标识和点类型index查询点VertexId
`Long`	`getVertexIdByPkCompatible(String pk, String type)` 根据外部唯一标识和点类型名查询点VertexId。
`boolean`	`hasVertex(long id)` 根据点VertexId判断点是否存在
`Edge`	`insertEdgeByVertexId(long fromId, long toId, int typeIndex, Map<String,Object> propertyMap)` 添加边
`Vertex`	`insertVertexByPk(String pk, int typeIndex, Map<String,Object> propertyMap)` 添加点
`boolean`	`isStop()` 返回布尔值用于停止plugin任务
`int`	`localAffinity()` 获取本机的affinity。
`GraphSchema`	`meta()` 查询图的meta信息
`default void`	`putPropertyValue(long vertexId, String propertyName, Object data)` 为点添加属性
`void`	`putPropertyValue(long vertexId, String propertyName, Object data, boolean isMerge)` 为点添加属性
`default void`	`putPropertyValue(String edgeId, String propertyName, Object data)` 为边添加属性
`void`	`putPropertyValue(String edgeId, String propertyName, Object data, boolean isMerge)` 为边添加属性
`boolean`	`removePropertyValue(long vertexId)` 删除点VertexId的所有属性，除外部唯一标识值
`boolean`	`removePropertyValue(long vertexId, String propertyName)` 删除点VertexId的属性
`boolean`	`removePropertyValue(String edgeId)` 删除边EdgeId的所有属性，除combineKey
`boolean`	`removePropertyValue(String edgeId, String propertyName)` 删除边EdgeId的属性
`default GraphAutoCloseableIterator<Edge>`	`retrieveAllEdges()` 查询集群所有边
`GraphAutoCloseableIterator<Edge>`	`retrieveAllEdges(Set<Integer> edgeTypes, Predicate<Edge> pe)` 查询带条件过滤的集群所有边
`default GraphAutoCloseableIterator<Vertex>`	`retrieveAllVertexes()` 查询集群所有点
`GraphAutoCloseableIterator<Vertex>`	`retrieveAllVertexes(Set<Integer> vertexTypes, Predicate<Vertex> pv)` 查询带条件过滤的集群所有点
`Edge`	`retrieveEdge(String edgeId)` 查询边
`default List<Edge>`	`retrieveEdgeByVertexId(long vertexId)` 找边。
`List<Edge>`	`retrieveEdgeByVertexId(long srcId, long dstId, Set<Integer> edgeTypeFilter, Direction direction, int limit, Predicate<Element> pe)` 找边。
`List<Edge>`	`retrieveEdgeByVertexId(long vertexId, Set<Integer> edgeTypeFilter, Direction direction, int neighborLimit, int edgeLimit, Predicate<Element> pv, Predicate<Element> pe, boolean includeLoop)` 找边
`Iterator<Edge>`	`retrieveEdgeByVertexId(long vertexId, Set<Integer> edgeTypeFilter, Direction direction, int neighborLimit, int edgeLimit, Predicate<Element> pv, Predicate<Element> pe, boolean includeLoop, boolean onlyLoop, boolean includeProps)` 找边。
`List<Edge>`	`retrieveEdgeByVertexIdForAlgo(long vertexId, Set<Integer> edgeTypeFilter, Direction direction, int neighborLimit, int edgeLimit, Predicate<Element> pv, Predicate<Element> pe, boolean includeLoop)` 根据VertexId查边
`Iterator<Edge>`	`retrieveEdgeByVertexIdForAlgo(long vertexId, Set<Integer> edgeTypeFilter, Direction direction, int neighborLimit, int edgeLimit, Predicate<Element> pv, Predicate<Element> pe, boolean includeLoop, boolean onlyLoop, boolean includeProps)` 根据VertexId查边
`List<Edge>`	`retrieveEdgeByVertexIdNoProps(long vertexId, Set<Integer> edgeTypeFilter, Direction direction, int neighborLimit, int edgeLimit, Predicate<Element> pv, Predicate<Element> pe, boolean includeLoop)` 找边。
`Edge`	`retrieveEdgeCompatible(String edgeId)` 查询边
`default Iterator<Edge>`	`retrieveLocalEdges()` 查询本机所有边
`Iterator<Edge>`	`retrieveLocalEdges(Set<Integer> edgeTypes, Predicate<Edge> pe)` 查询带条件过滤的本机所有边
`default Iterator<Vertex>`	`retrieveLocalVertexes()` 查询本机所有点
`Iterator<Vertex>`	`retrieveLocalVertexes(Set<Integer> vertexTypes, Predicate<Vertex> pv)` 查询带条件过滤的本机所有点
`Iterator<Long>`	`retrieveNeighborIdIterator(long vertexId, Direction direction, Set<Integer> types)` 获取邻居ElementId
`List<Edge>`	`retrieveOrInsertEdge(long fromId, long toId, int typeIndex, Map<String,Object> propertyMap)` 查询或插入边。
`Vertex`	`retrieveOrInsertVertex(String pk, int typeIndex, Map<String,Object> propertyMap)` 查询或插入点。
`Vertex`	`retrieveVertex(long vertexId)` 查询点。
`Vertex`	`retrieveVertexByPk(String pk, int typeIndex)` 查询点。
`Vertex`	`retrieveVertexByPkCompatible(String pk, int typeIndex)` 查询点。
`Vertex`	`retrieveVertexCompatible(long vertexId)` 查询点。
`GraphAutoCloseableIterator<String>`	`searchEdgesByIndex(String typeName, String propName, Object data, int skip, int limit)` 通过索引，查找边数据，返回边Id
`GraphAutoCloseableIterator<Long>`	`searchVertexesByIndex(String typeName, String propName, Object data, int skip, int limit)` 通过索引，查找点数据，返回点Id
`default Edge`	`updateEdge(String edgeId, Map<String,Object> propertyMap)` 更新边的多个属性
`Edge`	`updateEdge(String edgeId, Map<String,Object> propertyMap, boolean isMerge)` 更新边的多个属性
`default Vertex`	`updateVertex(long vertexId, Map<String,Object> propertyMap)` 更新点的多个属性
`Vertex`	`updateVertex(long vertexId, Map<String,Object> propertyMap, boolean isMerge)` 更新点的多个属性
`default List<Edge>`	`upsertEdge(long fromId, long toId, int typeIndex, Map<String,Object> propertyMap)` 插入或更新边。
`List<Edge>`	`upsertEdge(long fromId, long toId, int typeIndex, Map<String,Object> propertyMap, boolean isMerge)` 插入或更新边。
`default Vertex`	`upsertVertex(String pk, int typeIndex, Map<String,Object> propertyMap)` 插入或更新点。
`Vertex`	`upsertVertex(String pk, int typeIndex, Map<String,Object> propertyMap, boolean isMerge)` 插入或更新点。
`default long`	`vertexIteratorFast(Consumer<Vertex> consumer)` 多线程迭代本地点
`default long`	`vertexIteratorFast(Consumer<Vertex> consumer, Set<Integer> types)` 多线程迭代本地点
`long`	`vertexIteratorFast(Consumer<Vertex> consumer, Set<Integer> types, boolean backup)` 多线程迭代本地点
`int`	`vertexTypeIndex(long vertexId)` 通过点VertexId获取点类型Index

- 方法详细资料
  - meta
```
GraphSchema meta()
```
    查询图的meta信息
    
    返回:
    
    GraphSchema
  - getGraphName
```
String getGraphName()
```
    查询图名称
    
    返回:
    
    图名称
  - getAllVertexCount
```
long getAllVertexCount()
```
    查询集群总点数
    
    返回:
    
    集群总点数
  - getAllEdgeCount
```
long getAllEdgeCount()
```
    查询集群总边数
    
    返回:
    
    总边数
  - getVertexCount
```
long getVertexCount(int vertexTypeIndex)
```
    查询集群指定点类型总数
    
    参数:
    
    vertexTypeIndex - 点类型index
    
    返回:
    
    指定点类型总数
  - getEdgeCount
```
long getEdgeCount(int edgeTypeIndex)
```
    查询集群指定边类型总数
    
    参数:
    
    edgeTypeIndex - 边类型index
    
    返回:
    
    指定边类型总数
  - getVertexCount
```
long getVertexCount(boolean isLocal)
```
    查询点数量
    
    参数:
    
    isLocal - 是否只取本地的点数量。true本地点数，false集群总点数
    
    返回:
    
    点总数
  - getEdgeCount
```
long getEdgeCount(boolean isLocal)
```
    查询边数量
    
    参数:
    
    isLocal - 是否只取本地的边数量。true本地边数，false集群总边数
    
    返回:
    
    边总数
  - getVertexCount
```
long getVertexCount(int typeIndex,
                    boolean isLocal)
```
    查询指定点类型数量
    
    参数:
    
    typeIndex - 点类型index
    
    isLocal - 是否只取本节点数量。true本机数量，false集群总数量
    
    返回:
    
    指定点类型总数
  - getEdgeCount
```
long getEdgeCount(int typeIndex,
                  boolean isLocal)
```
    查询指定边类型数量
    
    参数:
    
    typeIndex - 边类型index
    
    isLocal - 是否只取本节点数量。true本机数量，false集群总数量
    
    返回:
    
    指定边类型总数
  - hasVertex
```
boolean hasVertex(long id)
```
    根据点VertexId判断点是否存在
    
    参数:
    
    id - VertexId
    
    返回:
    
    true存在，false不存在
  - getVertexIdByPk
```
Set<Long> getVertexIdByPk(String pk)
```
    根据外部唯一标识查询点VertexId
    
    参数:
    
    pk - 外部唯一标识
    
    返回:
    
    VertexId集合。若找到点，则返回点id集合。若没找到返回PkNotFound异常。
  - getVertexIdByPkCompatible
```
Set<Long> getVertexIdByPkCompatible(String pk)
```
    根据外部唯一标识查询点VertexId
    
    参数:
    
    pk - 外部唯一标识
    
    返回:
    
    VertexId集合。若找到点，则返回点id集合。若没找到，返回emptySet。
  - getVertexIdByPk
```
Long getVertexIdByPk(String pk,
                     int typeIndex)
```
    根据外部唯一标识和点类型index查询点VertexId
    
    参数:
    
    pk - 外部唯一标识
    
    typeIndex - 点类型index
    
    返回:
    
    若找到点，则返回点id。若没找到返回PkNotFound异常。
  - getVertexIdByPkCompatible
```
Long getVertexIdByPkCompatible(String pk,
                               int typeIndex)
```
    根据外部唯一标识和点类型index查询点VertexId
    
    参数:
    
    pk - 外部唯一标识
    
    typeIndex - 点类型index
    
    返回:
    
    若找到点，则返回点id。若没找到，返回null。
  - getVertexIdByPk
```
Long getVertexIdByPk(String pk,
                     String type)
```
    根据外部唯一标识和点类型名查询点VertexId。
    
    参数:
    
    pk - 外部唯一标识
    
    type - 点类型名
    
    返回:
    
    VertexId 若找到点，则返回点id。若没找到返回PkNotFound异常。
  - getVertexIdByPkCompatible
```
Long getVertexIdByPkCompatible(String pk,
                               String type)
```
    根据外部唯一标识和点类型名查询点VertexId。
    
    参数:
    
    pk - 外部唯一标识
    
    type - 点类型名
    
    返回:
    
    VertexId 若找到点，则返回点id。若没找到，返回null。
  - retrieveVertexByPk
```
Vertex retrieveVertexByPk(String pk,
                          int typeIndex)
```
    查询点。根据外部唯一标识值和点类型index查询点。
    
    参数:
    
    pk - 外部唯一标识值
    
    typeIndex - 点类型index
    
    返回:
    
    点信息。如果存在，返回点信息。若没找到返回VertexNotFound异常。
  - retrieveVertexByPkCompatible
```
Vertex retrieveVertexByPkCompatible(String pk,
                                    int typeIndex)
```
    查询点。根据外部唯一标识值和点类型index查询点。
    
    参数:
    
    pk - 外部唯一标识值
    
    typeIndex - 点类型index
    
    返回:
    
    点信息。如果存在，返回点信息。如果不存在，返回null。
  - retrieveVertex
```
Vertex retrieveVertex(long vertexId)
```
    查询点。根据点id查询点。
    
    参数:
    
    vertexId - 点VertexId
    
    返回:
    
    点信息。如果存在，返回点信息。若没找到返回VertexNotFound异常。
  - retrieveVertexCompatible
```
Vertex retrieveVertexCompatible(long vertexId)
```
    查询点。根据点id查询点。
    
    参数:
    
    vertexId - 点VertexId
    
    返回:
    
    点信息。如果存在，返回点信息。如果不存在，返回null。
  - getVertexes
```
Map<Long,Vertex> getVertexes(Collection<Long> ids)
```
    批量查询点
    
    参数:
    
    ids - 点VertexId列表
    
    返回:
    
    查询到的id和点的map映射
  - retrieveEdge
```
Edge retrieveEdge(String edgeId)
```
    查询边
    
    参数:
    
    edgeId - 边EdgeId
    
    返回:
    
    边信息。如果存在，返回边信息。如果不存在，返回EdgeNotFound异常。
  - retrieveEdgeCompatible
```
Edge retrieveEdgeCompatible(String edgeId)
```
    查询边
    
    参数:
    
    edgeId - 边EdgeId
    
    返回:
    
    边信息。如果存在，返回边信息。如果不存在，返回null。
  - retrieveEdgeByVertexId
```
List<Edge> retrieveEdgeByVertexId(long srcId,
                                  long dstId,
                                  Set<Integer> edgeTypeFilter,
                                  Direction direction,
                                  int limit,
                                  Predicate<Element> pe)
```
    找边。
    
    参数:
    
    srcId - 起始点VertexId
    
    dstId - 终止点VertexId
    
    edgeTypeFilter - 边类型过滤
    
    direction - 边方向
    
    pe - 边条件
    
    limit - 边个数限制
    
    返回:
    
    边集合。如果有边，则返回边集合。如果没有边，返回emptyList。如果起止点不存在，返回emptyList。
  - retrieveEdgeByVertexId
```
default List<Edge> retrieveEdgeByVertexId(long vertexId)
```
    找边。无条件，Both方向
    
    参数:
    
    vertexId - 点VertexId
    
    返回:
    
    边列表。如果有边，则返回边集合。如果没有边，返回emptyList。如果起始点不存在，返回emptyList。
  - retrieveEdgeByVertexId
```
Iterator<Edge> retrieveEdgeByVertexId(long vertexId,
                                      Set<Integer> edgeTypeFilter,
                                      Direction direction,
                                      int neighborLimit,
                                      int edgeLimit,
                                      Predicate<Element> pv,
                                      Predicate<Element> pe,
                                      boolean includeLoop,
                                      boolean onlyLoop,
                                      boolean includeProps)
```
    找边。通过边迭代获取
    
    参数:
    
    vertexId - 点VertexId
    
    edgeTypeFilter - 边类型过滤
    
    direction - 边方向
    
    pe - 边条件
    
    pv - 点条件
    
    neighborLimit - 邻居点个数上限
    
    edgeLimit - 邻居边数上限
    
    includeLoop - 是否返回包含环路的边
    
    onlyLoop - 是否只返回环路边
    
    includeProps - 边是否要返回属性
    
    返回:
    
    边列表。如果有边，则返回边集合。如果没有边，返回emptyList。如果起始点不存在，返回emptyList。
  - retrieveEdgeByVertexIdForAlgo
```
Iterator<Edge> retrieveEdgeByVertexIdForAlgo(long vertexId,
                                             Set<Integer> edgeTypeFilter,
                                             Direction direction,
                                             int neighborLimit,
                                             int edgeLimit,
                                             Predicate<Element> pv,
                                             Predicate<Element> pe,
                                             boolean includeLoop,
                                             boolean onlyLoop,
                                             boolean includeProps)
```
    根据VertexId查边
    
    参数:
    
    vertexId - 点id
    
    edgeTypeFilter - 过滤的边类型
    
    direction - 边方向
    
    neighborLimit - 邻居点个数上限
    
    edgeLimit - 邻居边数上限
    
    pv - 点条件
    
    pe - 边条件
    
    includeLoop - 是否返回包含环路的边
    
    onlyLoop - 是否只返回环路边
    
    includeProps - 边是否要返回属性
    
    返回:
    
    边迭代器
  - retrieveEdgeByVertexId
```
List<Edge> retrieveEdgeByVertexId(long vertexId,
                                  Set<Integer> edgeTypeFilter,
                                  Direction direction,
                                  int neighborLimit,
                                  int edgeLimit,
                                  Predicate<Element> pv,
                                  Predicate<Element> pe,
                                  boolean includeLoop)
```
    找边
    
    参数:
    
    vertexId - 点VertexId
    
    edgeTypeFilter - 边条件
    
    direction - 边方向
    
    neighborLimit - 邻居点上限, 填小于0 不参与计算
    
    edgeLimit - 邻居边上限，填小于0 不参与计算
    
    pv - 点条件
    
    pe - 边条件
    
    includeLoop - 是否包含环路边
    
    返回:
    
    边列表。如果有边，则返回边集合。如果没有边，返回emptyList。如果起始点不存在，返回emptyList。
  - retrieveEdgeByVertexIdForAlgo
```
List<Edge> retrieveEdgeByVertexIdForAlgo(long vertexId,
                                         Set<Integer> edgeTypeFilter,
                                         Direction direction,
                                         int neighborLimit,
                                         int edgeLimit,
                                         Predicate<Element> pv,
                                         Predicate<Element> pe,
                                         boolean includeLoop)
```
    根据VertexId查边
    
    参数:
    
    vertexId - 点id
    
    edgeTypeFilter - 过滤的边类型
    
    direction - 边方向
    
    neighborLimit - 邻居点个数上限
    
    edgeLimit - 邻居边数上限
    
    pv - 点条件
    
    pe - 边条件
    
    includeLoop - 是否返回包含环路的边
    
    返回:
    
    边列表
  - retrieveEdgeByVertexIdNoProps
```
List<Edge> retrieveEdgeByVertexIdNoProps(long vertexId,
                                         Set<Integer> edgeTypeFilter,
                                         Direction direction,
                                         int neighborLimit,
                                         int edgeLimit,
                                         Predicate<Element> pv,
                                         Predicate<Element> pe,
                                         boolean includeLoop)
```
    找边。不返回边属性
    
    参数:
    
    vertexId - 点VertexId
    
    edgeTypeFilter - 边条件
    
    direction - 边方向
    
    neighborLimit - 邻居点上限, 填小于0 不参与计算
    
    edgeLimit - 邻居边上限，填小于0 不参与计算
    
    pv - 点条件
    
    pe - 边条件
    
    includeLoop - 是否包含环路边
    
    返回:
    
    边列表。如果有边，则返回边集合。如果没有边，返回emptyList。如果起始点不存在，返回emptyList。
  - retrieveNeighborIdIterator
```
Iterator<Long> retrieveNeighborIdIterator(long vertexId,
                                          Direction direction,
                                          Set<Integer> types)
```
    获取邻居ElementId
    
    参数:
    
    vertexId - 点Id
    
    direction - 方向
    
    types - 边类型
    
    返回:
    
    邻居ElementId
  - getPk
```
String getPk(long vertexId)
```
    根据VertexId来查询对应点的外部唯一标识值
    
    参数:
    
    vertexId - 点VertexId
    
    返回:
    
    点外部唯一标识值
  - retrieveAllVertexes
```
default GraphAutoCloseableIterator<Vertex> retrieveAllVertexes()
```
    查询集群所有点
    
    返回:
    
    迭代查询集群所有点
  - retrieveAllVertexes
```
GraphAutoCloseableIterator<Vertex> retrieveAllVertexes(Set<Integer> vertexTypes,
                                                       Predicate<Vertex> pv)
```
    查询带条件过滤的集群所有点
    
    参数:
    
    vertexTypes - 点类型过滤
    
    pv - 点条件过滤
    
    返回:
    
    迭代查询带条件过滤的集群所有点
  - retrieveLocalVertexes
```
default Iterator<Vertex> retrieveLocalVertexes()
```
    查询本机所有点
    
    返回:
    
    迭代查询本机所有点
  - retrieveLocalVertexes
```
Iterator<Vertex> retrieveLocalVertexes(Set<Integer> vertexTypes,
                                       Predicate<Vertex> pv)
```
    查询带条件过滤的本机所有点
    
    参数:
    
    vertexTypes - 点类型index集合
    
    pv - 点过滤
    
    返回:
    
    迭代查询带条件过滤的本机所有点
  - retrieveAllEdges
```
default GraphAutoCloseableIterator<Edge> retrieveAllEdges()
```
    查询集群所有边
    
    返回:
    
    迭代查询集群所有边
  - retrieveAllEdges
```
GraphAutoCloseableIterator<Edge> retrieveAllEdges(Set<Integer> edgeTypes,
                                                  Predicate<Edge> pe)
```
    查询带条件过滤的集群所有边
    
    参数:
    
    edgeTypes - 边类型index集合
    
    pe - 边过滤
    
    返回:
    
    迭代查询带条件过滤的集群所有边
  - retrieveLocalEdges
```
default Iterator<Edge> retrieveLocalEdges()
```
    查询本机所有边
    
    返回:
    
    迭代查询本机所有边
  - retrieveLocalEdges
```
Iterator<Edge> retrieveLocalEdges(Set<Integer> edgeTypes,
                                  Predicate<Edge> pe)
```
    查询带条件过滤的本机所有边
    
    参数:
    
    edgeTypes - 边类型index集合
    
    pe - 边过滤
    
    返回:
    
    迭代查询带条件过滤的本机所有边
  - vertexIteratorFast
```
default long vertexIteratorFast(Consumer<Vertex> consumer)
```
    多线程迭代本地点
    
    参数:
    
    consumer - consumer实现需要保证线程安全
    
    返回:
    
    迭代过的点数量
  - vertexIteratorFast
```
default long vertexIteratorFast(Consumer<Vertex> consumer,
                                Set<Integer> types)
```
    多线程迭代本地点
    
    参数:
    
    consumer - consumer实现需要保证线程安全
    
    types - 需要迭代的点类型
    
    返回:
    
    迭代过的点数量
  - vertexIteratorFast
```
long vertexIteratorFast(Consumer<Vertex> consumer,
                        Set<Integer> types,
                        boolean backup)
```
    多线程迭代本地点
    
    参数:
    
    consumer - consumer实现需要保证线程安全
    
    types - 需要迭代的点类型
    
    backup - 是否迭代backup数据
    
    返回:
    
    迭代过的点数量
  - edgeIteratorFast
```
default long edgeIteratorFast(Consumer<Edge> consumer)
```
    多线程迭代本地边
    
    参数:
    
    consumer - consumer实现需要保证线程安全
    
    返回:
    
    迭代过的边数量
  - edgeIteratorFast
```
default long edgeIteratorFast(Consumer<Edge> consumer,
                              Set<Integer> types)
```
    多线程迭代本地边
    
    参数:
    
    consumer - consumer实现需要保证线程安全
    
    types - 需要迭代的边类型
    
    返回:
    
    迭代过的边数量
  - edgeIteratorFast
```
long edgeIteratorFast(Consumer<Edge> consumer,
                      Set<Integer> types,
                      boolean backup)
```
    多线程迭代本地边
    
    参数:
    
    consumer - consumer实现需要保证线程安全
    
    types - 需要迭代的边类型
    
    backup - 是否迭代backup数据
    
    返回:
    
    迭代过的边数量
  - putPropertyValue
```
default void putPropertyValue(long vertexId,
                              String propertyName,
                              Object data)
```
    为点添加属性
    
    参数:
    
    vertexId - 点VertexId
    
    propertyName - 属性名
    
    data - 属性值
  - putPropertyValue
```
void putPropertyValue(long vertexId,
                      String propertyName,
                      Object data,
                      boolean isMerge)
```
    为点添加属性
    
    参数:
    
    vertexId - 点VertexId
    
    propertyName - 属性名
    
    data - 属性值
    
    isMerge - 集合属性追加或覆盖
  - putPropertyValue
```
default void putPropertyValue(String edgeId,
                              String propertyName,
                              Object data)
```
    为边添加属性
    
    参数:
    
    edgeId - 边EdgeId
    
    propertyName - 属性名
    
    data - 属性值
  - putPropertyValue
```
void putPropertyValue(String edgeId,
                      String propertyName,
                      Object data,
                      boolean isMerge)
```
    为边添加属性
    
    参数:
    
    edgeId - 边EdgeId
    
    propertyName - 属性名
    
    data - 属性值
    
    isMerge - 集合属性追加或覆盖
  - insertVertexByPk
```
Vertex insertVertexByPk(String pk,
                        int typeIndex,
                        Map<String,Object> propertyMap)
```
    添加点
    
    参数:
    
    pk - 外部唯一标识值
    
    typeIndex - 点类型index
    
    propertyMap - {propertyName, Object} 属性列表
    
    返回:
    
    添加成功的点。如果点存在，则抛出异常。如果点不存在，则插入。
  - insertEdgeByVertexId
```
Edge insertEdgeByVertexId(long fromId,
                          long toId,
                          int typeIndex,
                          Map<String,Object> propertyMap)
```
    添加边
    
    参数:
    
    fromId - 起始点VertexId
    
    toId - 终止点VertexId
    
    typeIndex - 边类型index
    
    propertyMap - 边属性
    
    返回:
    
    添加成功的边
  - retrieveOrInsertVertex
```
Vertex retrieveOrInsertVertex(String pk,
                              int typeIndex,
                              Map<String,Object> propertyMap)
```
    查询或插入点。
    
    参数:
    
    pk - 外部唯一标识
    
    typeIndex - 点类型index
    
    propertyMap - 点属性
    
    返回:
    
    若点已经存在，仅查询并返回点信息，属性值不做修改。若点不存在，则插入。
  - retrieveOrInsertEdge
```
List<Edge> retrieveOrInsertEdge(long fromId,
                                long toId,
                                int typeIndex,
                                Map<String,Object> propertyMap)
```
    查询或插入边。
    
    参数:
    
    fromId - 起始点VertexId
    
    toId - 终止点VertexId
    
    typeIndex - 边类型index
    
    propertyMap - 边属性
    
    返回:
    
    若边已经存在，仅查询并返回边信息，属性值不做修改。若点不存在，则插入。
  - upsertVertex
```
default Vertex upsertVertex(String pk,
                            int typeIndex,
                            Map<String,Object> propertyMap)
```
    插入或更新点。
    
    参数:
    
    pk - 外部唯一标识
    
    typeIndex - 点类型index
    
    propertyMap - 点属性
    
    返回:
    
    若点已经存在，更新属性值。若点不存在，则插入。
  - upsertVertex
```
Vertex upsertVertex(String pk,
                    int typeIndex,
                    Map<String,Object> propertyMap,
                    boolean isMerge)
```
    插入或更新点。
    
    参数:
    
    pk - 外部唯一标识
    
    typeIndex - 点类型index
    
    propertyMap - 点属性
    
    isMerge - 集合属性追加或覆盖
    
    返回:
    
    若点已经存在，更新属性值。若点不存在，则插入。
  - upsertEdge
```
default List<Edge> upsertEdge(long fromId,
                              long toId,
                              int typeIndex,
                              Map<String,Object> propertyMap)
```
    插入或更新边。
    
    参数:
    
    fromId - 起始点VertexId
    
    toId - 终止点VertexId
    
    typeIndex - 边类型index
    
    propertyMap - 边属性
    
    返回:
    
    若边已经存在，更新属性值。若点不存在，则插入。
  - upsertEdge
```
List<Edge> upsertEdge(long fromId,
                      long toId,
                      int typeIndex,
                      Map<String,Object> propertyMap,
                      boolean isMerge)
```
    插入或更新边。
    
    参数:
    
    fromId - 起始点VertexId
    
    toId - 终止点VertexId
    
    typeIndex - 边类型index
    
    propertyMap - 边属性
    
    isMerge - 集合属性追加或覆盖
    
    返回:
    
    若边已经存在，更新属性值。若点不存在，则插入。
  - updateVertex
```
default Vertex updateVertex(long vertexId,
                            Map<String,Object> propertyMap)
```
    更新点的多个属性
    
    参数:
    
    vertexId - 点VertexId
    
    propertyMap - 点属性
    
    返回:
    
    更新成功的点
  - updateVertex
```
Vertex updateVertex(long vertexId,
                    Map<String,Object> propertyMap,
                    boolean isMerge)
```
    更新点的多个属性
    
    参数:
    
    vertexId - 点VertexId
    
    propertyMap - 点属性
    
    isMerge - 集合属性追加或覆盖
    
    返回:
    
    更新成功的点
  - updateEdge
```
default Edge updateEdge(String edgeId,
                        Map<String,Object> propertyMap)
```
    更新边的多个属性
    
    参数:
    
    edgeId - 边EdgeId
    
    propertyMap - 边属性
    
    返回:
    
    更新成功的边
  - updateEdge
```
Edge updateEdge(String edgeId,
                Map<String,Object> propertyMap,
                boolean isMerge)
```
    更新边的多个属性
    
    参数:
    
    edgeId - 边EdgeId
    
    propertyMap - 边属性
    
    isMerge - 集合属性追加或覆盖
    
    返回:
    
    更新成功的边
  - deleteVertex
```
void deleteVertex(long vertexId)
```
    删除点以及所有与点相关的边
    
    参数:
    
    vertexId - 点VertexId
  - deleteVertex
```
void deleteVertex(long vertexId,
                  boolean isDeleteEdge)
```
    删除点
    
    参数:
    
    vertexId - 点VertexId
    
    isDeleteEdge - true：删除点以及所有与点相关的边。false：若边存在，则会删除失败并抛GraphDbApiException
  - deleteEdge
```
void deleteEdge(String edgeId)
```
    删除边
    
    参数:
    
    edgeId - 边EdgeId
  - removePropertyValue
```
boolean removePropertyValue(long vertexId,
                            String propertyName)
```
    删除点VertexId的属性
    
    参数:
    
    vertexId - 点VertexId
    
    propertyName - 属性名
    
    返回:
    
    是否成功
  - removePropertyValue
```
boolean removePropertyValue(String edgeId,
                            String propertyName)
```
    删除边EdgeId的属性
    
    参数:
    
    edgeId - 边EdgeId
    
    propertyName - 属性名
    
    返回:
    
    是否成功
  - removePropertyValue
```
boolean removePropertyValue(long vertexId)
```
    删除点VertexId的所有属性，除外部唯一标识值
    
    参数:
    
    vertexId - 点VertexId
    
    返回:
    
    是否成功
  - removePropertyValue
```
boolean removePropertyValue(String edgeId)
```
    删除边EdgeId的所有属性，除combineKey
    
    参数:
    
    edgeId - 边EdgeId
    
    返回:
    
    是否成功
  - broadcastCallable
```
default <V> Collection<V> broadcastCallable(GraphBroadcastCallable<V> callable)
```
    带返回值的广播任务。将会在所有节点上执行。单机版不可用。
    
    类型参数:
    
    V - 返回值集合
    
    参数:
    
    callable - 任务
    
    返回:
    
    广播任务的返回值集合
  - broadcastCallable
```
<V> Collection<V> broadcastCallable(Collection<Integer> affinities,
                                    GraphBroadcastCallable<V> callable)
```
    带返回值的广播任务。将会在指定节点上执行。单机版不可用。
    
    类型参数:
    
    V - 返回值集合
    
    参数:
    
    affinities - 节点affinity集合
    
    callable - 任务
    
    返回:
    
    广播任务的返回值集合
  - broadcastRunnable
```
default void broadcastRunnable(GraphBroadcastRunnable runnable)
```
    不带返回值的广播任务。将会在所有节点上执行。单机版不可用。
    
    参数:
    
    runnable - 任务
  - broadcastRunnable
```
void broadcastRunnable(Collection<Integer> affinities,
                       GraphBroadcastRunnable runnable)
```
    不带返回值的广播任务。将会在指定节点上执行。单机版不可用。
    
    参数:
    
    affinities - 节点affinity集合
    
    runnable - 任务
  - affinity
```
int affinity(long elementId)
```
    获取点VertexId所在的主机号。单机版默认返回0。
    
    参数:
    
    elementId - 点VertexId
    
    返回:
    
    节点号
  - localAffinity
```
int localAffinity()
```
    获取本机的affinity。单机版默认返回0。
    
    返回:
    
    affinity
  - affinities
```
Set<Integer> affinities()
```
    获取集群中所有affinity。单机版默认返回0。
    
    返回:
    
    所有affinity
  - vertexTypeIndex
```
int vertexTypeIndex(long vertexId)
```
    通过点VertexId获取点类型Index
    
    参数:
    
    vertexId - 点VertexId
    
    返回:
    
    如果会抛出异常或者类型在meta中不存在，是点VertexId不存在或不符合规范。为了性能没有验证是否存在
  - edgeTypeIndex
```
int edgeTypeIndex(String edgeId)
```
    通过边EdgeId获取边类型index
    
    参数:
    
    edgeId - 边EdgeId
    
    返回:
    
    如果会抛出异常或者类型在meta中不存在，是边EdgeId不存在或不符合规范。为了性能没有验证是否存在
  - getSnowId
```
long getSnowId()
```
    返回 Cypher 任务 id
    
    返回:
    
    cypherTaskID
  - flushData
```
void flushData()
```
    手动触发写盘
  - getOrCreateGraphDbAtomicLong
```
GraphDbAtomicLong getOrCreateGraphDbAtomicLong(String name,
                                               long initValue)
```
    创建一个分布式 AtomicLong
    
    参数:
    
    name。同名将复用 -
    
    initValue。初始值 -
    
    返回:
    
    GraphDbAtomicLong
  - searchVertexesByIndex
```
GraphAutoCloseableIterator<Long> searchVertexesByIndex(String typeName,
                                                       String propName,
                                                       Object data,
                                                       int skip,
                                                       int limit)
```
    通过索引，查找点数据，返回点Id
    
    参数:
    
    typeName - 类型名
    
    propName - 属性名
    
    data - 查找值
    
    skip - 跳过
    
    limit - 限制返回数量
    
    返回:
    
    点id迭代器
  - searchEdgesByIndex
```
GraphAutoCloseableIterator<String> searchEdgesByIndex(String typeName,
                                                      String propName,
                                                      Object data,
                                                      int skip,
                                                      int limit)
```
    通过索引，查找边数据，返回边Id
    
    参数:
    
    typeName - 类型名
    
    propName - 属性名
    
    data - 查找值
    
    skip - 跳过
    
    limit - 限制返回数量
    
    返回:
    
    边id迭代器
  - isStop
```
boolean isStop()
```
    返回布尔值用于停止plugin任务
    
    返回:
    
    用于判断的布尔值
  - executePregel
```
default <CONFIG extends com.graphdbapi.pregel.GraphPregelConfig> com.graphdbapi.pregel.GraphPregelResult executePregel(CONFIG config,
                                                                                                                       com.graphdbapi.pregel.GraphPregelComputation<CONFIG> computation)
```
    执行分布式 pregel 任务
    
    类型参数:
    
    CONFIG - GraphPregelConfig类型
    
    参数:
    
    config - pregel 配置类
    
    computation - pregel 计算类
    
    返回:
    
    分布式 pregel 任务计算结果
    
    从以下版本开始:
    
    3.4.0

接口 Graph

方法概要

方法详细资料

meta

getGraphName

getAllVertexCount

getAllEdgeCount

getVertexCount

getEdgeCount

getVertexCount

getEdgeCount

getVertexCount

getEdgeCount

hasVertex

getVertexIdByPk

getVertexIdByPkCompatible

getVertexIdByPk

getVertexIdByPkCompatible

getVertexIdByPk

getVertexIdByPkCompatible

retrieveVertexByPk

retrieveVertexByPkCompatible

retrieveVertex

retrieveVertexCompatible

getVertexes

retrieveEdge

retrieveEdgeCompatible

retrieveEdgeByVertexId

retrieveEdgeByVertexId

retrieveEdgeByVertexId

retrieveEdgeByVertexIdForAlgo

retrieveEdgeByVertexId

retrieveEdgeByVertexIdForAlgo

retrieveEdgeByVertexIdNoProps

retrieveNeighborIdIterator

getPk

retrieveAllVertexes

retrieveAllVertexes

retrieveLocalVertexes

retrieveLocalVertexes

retrieveAllEdges

retrieveAllEdges

retrieveLocalEdges

retrieveLocalEdges

vertexIteratorFast

vertexIteratorFast

vertexIteratorFast

edgeIteratorFast

edgeIteratorFast

edgeIteratorFast

putPropertyValue

putPropertyValue

putPropertyValue

putPropertyValue

insertVertexByPk

insertEdgeByVertexId

retrieveOrInsertVertex

retrieveOrInsertEdge

upsertVertex

upsertVertex

upsertEdge

upsertEdge

updateVertex

updateVertex

updateEdge

updateEdge

deleteVertex

deleteVertex

deleteEdge

removePropertyValue

removePropertyValue

removePropertyValue

removePropertyValue

broadcastCallable

broadcastCallable

broadcastRunnable

broadcastRunnable

affinity

localAffinity

affinities