# 图查询接口
# 接口列表
# 1、节点及相关信息查询:
# 2、边及相关信息查询:
# 3、查询邻居:
# 4、路径查询:
# 5、其他:
- 子图查询
- 获取SCHEMA集合
- 批量获取邻接图的信息
- 批量获取关系图的信息
- 通过指定属性过滤查询邻居
- 通过指定属性过滤查询路径
- 通过指定边类型查询邻居
- 通过指定属性统计邻居数量并排序
- 通过指定多个边类型查询邻居
- 查询公共关系
# 查询一阶邻居
# 方法
one_neighbour query_one_neighbour(String db_name,
int node_id,
search_direction_type search_direction);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
node_id | int | 节点ID | 否 | 0 | 0 | |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | one_neighbour | 节点的详细信息 | 否 | * | * |
# 查询邻居
# 方法
neighbour query_neighbour(String db_name,
int node_id,
int k_min,
int k_max,
search_direction_type search_direction,
String condition,
boolean return_relations);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
node_id | String | 起始节点ID | 否 | * | 1 | |
k_min | int | 起始邻居层数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 终止邻居层数 | 否 | * | 5 | 大于等于k_min |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
return_relations | boolean | 是否返回 | 否 | * | false |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | neighbour | 邻居结构 | 否 | * | * |
# 轻量查询邻居
# 方法
neighbour_simple_v2 query_simple_neighbour(String db_name,
int node_id,
int node_id,
search_direction_type search_direction,
String condition);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
node_id | String | 起始节点ID | 否 | * | 1 | |
k_min | int | 起始邻居层数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 终止邻居层数 | 否 | * | 5 | 大于等于k_min |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | neighbour_simple_v2 | 邻居结构 | 否 | * | * |
# 多点公共邻居查询
# 简述
将图视为有向图,查找给定点集中所有节点的共同邻居。
# 方法
common_neighbour query_common_simple_neighbour(String db_name,
List<Integer> ids,
int k_min, nt k_max,
search_direction_type search_direction,
String condition);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
ids | List | 节点id列表 | 否 | * | [0, 1, 2] | |
k_min | int | 起始邻居层数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 终止邻居层数 | 否 | * | 5 | 大于等于k_min |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | common_neighbour | 多节点之间的公共邻居 | 否 | * | * |
# 根据邻居查询边信息
# 方法
neighbour_path query_neighbour_path(String db_name,
search_direction_type search_direction,
String condition,
Map<Integer,Set<Integer>> nodes);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
nodes | Map | 节点id | 否 | * | * |
|
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | neighbour_path | 邻居路径结构 | 否 | * | * |
# 查询邻居数量
# 方法
neighbour_count_v2 query_neighbour_count(String db_name,
int node_id,
int k_min,
int k_max,
search_direction_type search_direction,
String condition);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
node_id | String | 起始节点ID | 否 | * | "6da2kgeqj2nvla1kg3" | |
k_min | int | 起始邻居层数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 终止邻居层数 | 否 | * | 5 | 大于等于k_min |
search_direction | search_direction_type | 搜索方向 | 否 | * | 2 | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | neighbour_count_v2 | 邻居数量结构 | 否 | * | * |
# 路径查询
# 方法
paths query_path(String db_name,
int src_node_id,
int dest_node_id,
int k_min,
int k_max,
search_direction_type search_direction,
String condition,
int max_size,
int query_type);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
src_node_id | int | 起始节点ID | 否 | * | 1 | |
dest_node_id | int | 终点节点ID | 否 | * | 2 | |
k_min | int | 起始邻居层数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 最大跳数 | 否 | * | 2 | 从起点ID开始以最大条数查询到终点ID |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
max_size | int | 返回的最大路径数 | 否 | * | 5 | |
query_type | int | 查询类型 | 否 | * | 1 | 1:普通路径查询;2:全路径去重(点);3:全路径不去重。 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | paths_v2 | 路径结构 | 否 | * | * |
# 轻量路径查询
# 方法
paths_simple_v2 query_simple_path(String db_name,
int src_node_id,
int dest_node_id,
int k_max,
search_direction_type search_direction,
String condition,
int max_size);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
src_node_id | int | 起始节点ID | 否 | * | 1 | |
dest_node_id | int | 终点节点ID | 否 | * | 2 | |
k_max | int | 最大跳数 | 否 | * | 2 | 从起点ID开始以最大条数查询到终点ID |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
max_size | int | 返回的最大路径数 | 否 | * | 5 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | paths_simple_v2 | 路径结构 | 否 | * | * |
# 全路径查询
# 方法
paths_simple_v2 query_full_path(String db_name,
int src_node_id,
int dest_node_id,
int k_max,
search_direction_type search_direction,
String condition,
int max_size,
boolean distinct);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
src_node_id | int | 起始节点ID | 否 | * | 1 | |
dest_node_id | int | 终点节点ID | 否 | * | 2 | |
k_max | int | 最大跳数 | 否 | * | 2 | 从起点ID开始以最大条数查询到终点ID |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
max_size | int | 返回的最大路径数 | 否 | * | 5 | |
distinct | boolean | 是否去重 | 否 | * | true |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | paths_simple_v2 | 路径结构 | 否 | * | * |
# 子图查询
# 方法
graph_v2 query_subgraph(String db_name,
int node_id,
int k_min,
int k_max,
search_direction_type search_direction,
String condition);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | * | "ezoo" | |
node_id | int | 起始节点ID | 否 | * | 1 | |
k_min | int | 起始跳数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 终止跳数 | 否 | * | 5 | 大于等于k_min |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
condition | String | 过滤条件 | 否 | * | "node::person.age = 10" | 条件过滤参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | graph_v2 | 图结构 | 否 | * | * |
# 获取SCHEMA集合
# 简述
通过此接口,可以批量获取当前服务中图数据库的结构定义,包括点边类型与各个类型的定义等。
# 方法
graph_schema_list get_graph_schema_list(List<String> db_name_list);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name_list | List<String> | 数据库名称列表 | 否 | * | ["ezoo"] |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | graph_schema_list | schema列表 | 否 | * | * |
# 通过节点唯一索引获取节点详细信息
# 简述
通过此接口,可以使用节点外部定义的唯一索引,获取节点详细信息,包括节点的类型,节点id,以及各个属性的值。
# 方法
node_s get_node(String db_name,
node_index node_id);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
node_id | node_id | 唯一索引 | 否 | "" | * |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | node_s | 节点的详细信息 | 否 | * | * |
# 通过节点id获取节点详细信息
# 简述
通过此接口,可以使用节点的id,获取节点详细信息,包括节点的类型以及各个属性的值。其中节点的id可以通过其他查询时获得,其他查询包括但不限于查询邻居,路径查询,节点查询。
# 方法
node_s get_node_with_id(String db_name,
int id);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
id | int | 节点id | 否 | 0 | 0 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | node_s | 节点的详细信息 | 否 | * | * |
# 获取图中所有节点的数量
# 简述
通过此接口,可以使用数据库名,获取该数据库中节点的总数量。
# 方法
graph_node_size get_graph_all_node_size(String db_name);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | graph_node_size | 节点的数量 | 否 | * | * |
# 通过节点的类型获取图中节点的数量
# 简述
通过此接口,可以使用数据库名与指定的类型名,获取该数据库中该类型下节点的总数量。
# 方法
graph_node_size get_graph_node_size(String db_name,
String node_type);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
node_type | String | 节点的类型 | 否 | "" | "person" |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | graph_node_size | 节点的数量 | 否 | * | * |
# 批量获取节点属性
# 简述
通过此接口,可以使用数据库名与节点的id,批量获取该数据库中节点的详细信息,包括节点的类型以及各个属性的值。
# 方法
node_s get_nodes_with_ids(String db_name,
List<Integer> ids);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
ids | List<Integer> | 节点id的集合 | 否 | [] | [12] |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | nodes_s | 节点属性 | 否 | * | * |
# 批量获取边的属性
# 简述
通过此接口,可以使用数据库名,边的基础id,批量获取该数据库中节点的详细信息,包括边的起点id,终点id与,边的类型以及边上各个属性的值。
# 方法
edges_s get_edges_with_basic_ids(String db_name,
List<edge_basic_id> edge_ids);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
edge_basic_ids | vector<edge_basic_id> | 边的信息 | 否 | [] | [] |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | edges_s | 边的属性 | 否 | * | * |
# 通过边的唯一索引获取边的详细信息
# 简述
通过此接口,可以使用数据库名,边的唯一索引,批量获取该数据库中边的详细信息,包括边的起点id与类型,终点id与类型,边的类型以及边上各个属性的值。
# 方法
edge_s get_edge(String db_name,
edge_index edge_id);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
edge_id | edge_id | 唯一索引 | 否 | "" | * |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | edge_s | 边的详细信息 | 否 | * | * |
# 通过边的id获取边的详细信息
# 简述
通过此接口,可以使用数据库名,边的id,获取该数据库中边的详细信息,包括边的起点id,终点id,边的类型以及边上各个属性的值。
# 方法
edge_s get_edge_with_basic_id(String db_name,
edge_basic_id edge_id);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
edge_basic_id | edge_basic_id | 边的id | 否 | * | * |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | edge_s | 边的详细信息 | 否 | * | * |
# 获取图中所有边的数量
# 简述
通过此接口,可以使用数据库名,获取对应数据库中边的总数量。
# 方法
graph_edge_size get_graph_all_edge_size(String db_name);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | graph_edge_size | 边的数量 | 否 | * | * |
# 通过边的类型获取图中边的数量
# 简述
通过此接口,可以使用数据库名与指定的类型名,获取该数据库中该类型下边的总数量。
# 方法
graph_edge_size get_graph_edge_size(String db_name,
String type);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
edge_type | String | 边的类型 | 否 | "" | "use" |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | graph_edge_size | 边的数量 | 否 | * | * |
# 批量获取节点信息
# 简述
通过此接口,可以使用数据库名,起点id,预期获取数量,批量获取从起始id开始,包含节点的唯一索引,类型,节点id。
# 方法
node_list get_node_s_batch(String db_name,
int src_id,
int count);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
src_id | int | 起点ID | 否 | 0 | 0 | |
count | int | 数量 | 否 | 0 | 0 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | node_list | 节点列表 | 否 | * | * |
# 批量获取邻接图的信息
# 简述
通过此接口,可获取图中各节点间的邻接关系(只展示节点间是否存在边,不关心边的类型与数量)。提供了顺序获取与批量获取两种方法。顺序获取输入为起点id(src_id)与获取数量(count)参数,可获取src_id起,count个可用的id与他们身上所有的出边与入边。批量获取输入为起点id的集合(src_ids),可获得集合中所有点与他们身上所有的出边和入边(要求集合中所有的id真实有效)。当选择一种方法后,另一种方法对应的参数的数据不生效。
# 方法
return_graph get_basic_graph(String db_name,
int src_id,
int count,
List<Integer> src_ids,
boolean if_order);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
src_id | int | 顺序获取起点ID | 否 | 0 | 0 | |
count | int | 顺序获取数量 | 否 | 0 | 0 | |
src_ids | List | 批量获取用起点ID | 否 | 0 | 0 | |
if_order | boolean | 是否使用顺序获取模式 | 否 | 0 | 0 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | return_graph | 图的基础信息 | 否 | * | * |
# 批量获取关系图的信息
# 简述
通过此接口,可获取图中各节点间的关系(展示两点间所有边以及他们的类型与id)。提供了顺序获取与批量获取两种方法。顺序获取输入为起点id(src_id)与获取数量(count)参数,可获取src_id起,count个可用的id与他们身上所有的出边与入边。批量获取输入为起点id的集合(src_ids),可获得集合中所有点与他们身上所有的出边和入边(要求集合中所有的id真实有效)。当选择一种方法后,另一种方法对应的参数的数据不生效。
# 方法
return_graph get_rel_graph(String db_name,
int src_id,
int count,
List<Integer> src_ids,
boolean if_order);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
src_id | int | 顺序获取起点ID | 否 | 0 | 0 | |
count | int | 顺序获取数量 | 否 | 0 | 0 | |
src_ids | List | 批量获取用起点ID | 否 | 0 | 0 | |
if_order | boolean | 是否使用顺序获取模式 | 否 | 0 | 0 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | return_graph | 图的基础信息 | 否 | * | * |
# 通过指定属性过滤查询邻居
# 简述
通过此接口,可以通过指定起点,边,终点的类型和属性来查找对应的邻居关系。
# 方法
unified_response query_neighbour_with_prop_filter(String db_name,
node_filter start_node,
edge_filter edge,
node_filter end_node,
search_direction_type search_direction,
int k_min,
int k_max);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
start_node | node_filter | 起点过滤条件 | 否 | 类型和属性不可空 | ||
edge | edge_filter | 边过滤条件 | 否 | 其中type为空时代表不进行任何校验;type不为空props为空时代表只进行类型校验;type和props都不为空时都进行校验 | ||
end_node | node_filter | 终点过滤条件 | 否 | 其中type为空时代表不进行任何校验;type不为空props为空时代表只进行类型校验;type和props都不为空时都进行校验 | ||
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
k_min | int | 起始跳数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 终止跳数 | 否 | * | 5 | 大于等于k_min |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | one_neighbour_l1 | 否 | * | * |
# 通过指定属性过滤查询路径
# 简述
通过此接口,可以通过指定起点,边,终点的类型和属性来查找对应的路径。
# 方法
unified_response query_path_with_prop_filter(String db_name,
node_filter start_node,
edge_filter edge,
node_filter end_node,
search_direction_type search_direction,
int k_min,
int k_max,
distinct_type distinct);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
start_node | node_filter | 起点过滤条件 | 否 | 类型和属性不可空 | ||
edge | edge_filter | 边过滤条件 | 否 | 其中type为空时代表不进行任何校验;type不为空props为空时代表只进行类型校验;type和props都不为空时都进行校验 | ||
end_node | node_filter | 终点过滤条件 | 否 | 其中type为空时代表不进行任何校验;type不为空props为空时代表只进行类型校验;type和props都不为空时都进行校验 | ||
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
k_min | int | 起始跳数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 终止跳数 | 否 | * | 5 | 大于等于k_min |
distinct | distinct_type | 去重策略 | 否 | * | distinct_edge | 去重参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | paths_l1 | 否 | * | * |
# 通过指定边类型查询邻居
# 简述
通过此接口,可以通过指定起点,终点的类型和属性以及边的类型来查找对应的一阶邻居关系。
# 方法
unified_response query_neighbour_with_edge_filter(String db_name,
node_filter start_node,
String edge_type,
boolean is_valid_edge,
node_filter end_node,
search_direction_type search_direction);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
start_node | node_filter | 起点过滤条件 | 否 | 类型和属性不可空 | ||
edge_type | String | 边类型过滤条件 | 否 | 与is_valid_edge结合使用 | ||
is_valid_edge | boolean | 边类型过滤方式 | 否 | * | true | true:符合edge_type的边被选择;false:不符合edge_type的边被选择 |
end_node | node_filter | 终点过滤条件 | 否 | 其中type为空时代表不进行任何校验;type不为空props为空时代表只进行类型校验;type和props都不为空时都进行校验 | ||
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | one_neighbour_l1 | 否 | * | * |
# 通过指定属性统计邻居数量并排序
# 简述
通过此接口,可以通过指定起点,边的类型和属性以及终点的类型来查找对应的邻居,通过指定终点的属性对其结果进行数量统计和排序。
# 方法
unified_response count_neighbour_with_prop_filter(String db_name,
node_filter start_node,
edge_filter edge,
String end_node_type,
String end_node_order_prop_name,
search_direction_type search_direction,
int k_min,
int k_max);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
start_node | node_filter | 起点过滤条件 | 否 | 类型和属性不可空 | ||
edge | edge_filter | 边过滤条件 | 否 | 其中type为空时代表不进行任何校验;type不为空props为空时代表只进行类型校验;type和props都不为空时都进行校验 | ||
end_node_type | String | 终点类型 | 否 | "" | "person" | |
end_node_order_prop_name | String | 终点统计属性名称 | 否 | "" | "age" | |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
k_min | int | 起始跳数 | 否 | * | 1 | 小于等于k_max, 大于0 |
k_max | int | 终止跳数 | 否 | * | 5 | 大于等于k_min |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | count_neighbour_l1 | 否 | * | * |
# 通过指定多个边类型查询邻居
# 简述
通过此接口,可以通过指定起点,终点的类型和属性以及多终边类型来查找对应的一阶邻居关系。
# 方法
unified_response query_neighbour_with_multi_edge_filter(String db_name,
node_filter start_node,
List<String> edge_type_list,
node_filter end_node,
:search_direction_type search_direction);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
start_node | node_filter | 起点过滤条件 | 否 | 类型和属性不可空 | ||
edge_type_list | list | 多种边类型 | 否 | |||
end_node | node_filter | 终点过滤条件 | 否 | 其中type为空时代表不进行任何校验;type不为空props为空时代表只进行类型校验;type和props都不为空时都进行校验 | ||
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | paths_l1 | 否 | * | * |
# 查询公共关系
# 简述
通过此接口,可以通过指定多个点的类型和属性查询之间的公共关系。
# 方法
unified_response query_common_relation(String db_name,
List<node_filter> node_list,
int k_max,
search_direction_type search_direction,
distinct_type distinct);
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | String | 数据库名称 | 否 | "" | "ezoo" | |
node_list | list<node_filter> node_filter | 起点过滤条件 | 否 | 类型和属性不可空 | ||
k_max | int | 终止跳数 | 否 | * | 5 | 大于等于1 |
search_direction | search_direction_type | 搜索方向 | 否 | * | search_direction_in | 方向参数说明 |
distinct | distinct_type | 去重策略 | 否 | * | distinct_edge | 去重参数说明 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | paths_l1 | 否 | * | * |