Apache AGE (incubating) for openGauss 适配详情

说明

Apache AGE通过创建插件的形式使用。

create extension age;

AGE安装之后，会默认创建ag_catalog的schema，AGE内置的数据类型、函数均存储在ag_catalog下。因此在使用AGE的时候，特别是执行cypher语句时，需要先执行命令：

SET search_path TO ag_catalog;

同时需要执行 load 'age' 命令确保age插件的全部hook被加载，保证图数据的完整性。

load 'age';

限制：
创建使用age插件前需要关闭线程池，设置enable_thread_pool = off

1. 图的操作

图由一组顶点和边组成，其中每个单独的节点和边都具有属性映射。顶点是图的基本对象，它可以独立于图中的其他任何东西而存在。边在两个顶点之间创建有向连接。

1.1 创建图

创建图使用函数：create_graph(graph_name);

SELECT * FROM ag_catalog.create_graph('graph_name');

1.2 删除图

删除图使用函数：drop_graph(graph_name, cascade);

1. 第一个参数graph_name为要删除的图，第二个参数cascade为布尔值，表示是否删除依赖于图表的标签和数据
2. 建议将 cascade 选项设置为 true，否则必须使用 SQL DDL 命令手动删除图中的所有内容

SELECT * FROM ag_catalog.drop_graph('graph_name', true);

1.3 创建图中的点类型

创建图中的点类型使用函数：create_vlabel(graph_name, label_name);

SELECT * FROM ag_catalog.create_vlabel('graph_name','label_name');

每当使用create_vlabel()函数创建顶点标签时，会在new_graph的命名空间new_graph中生成一个新表"<label_name>"。用于创建边类型的create_elabel()函数也是如此。这两个函数不是必须使用的，用Cypher语句创建顶点和边时，如果类型表不存在，会自动创建。

1.4 创建图中的边类型

创建图使用函数：create_elabel(graph_name, label_name);

SELECT * FROM ag_catalog.create_elabel('graph_name','label_name');

2. 图的存储

2.1 图

图创建之后，内核会创建一个与图名称相同的schema。同时在ag_catalog.ag_graph的表中会插入一条数据，标记新创建的schema用来存储图数据。

SELECT create_graph('new_graph');

NOTICE:  graph "new_graph" has been created
 create_graph 
--------------

(1 row)

SELECT * FROM ag_catalog.ag_graph;

   name    | namespace 
-----------+-----------
 new_graph | new_graph
(1 row)

图中的点和边

-- 创建图之后，会在该图对应的schema中创建_ag_label_vertex和_ag_label_edge两张表作为默认的点表和边表，同时会在ag_catalog.ag_label中插入两条数据将点表和边表与schema关联起来。
SELECT * FROM ag_catalog.ag_label;

       name       | graph | id | kind |          relation          
------------------+-------+----+------+----------------------------
 _ag_label_vertex | 68484 |  1 | v    | new_graph._ag_label_vertex 
 _ag_label_edge   | 68484 |  2 | e    | new_graph._ag_label_edge   
(2 rows)

-- 创建点表
SELECT create_vlabel('new_graph', 'Person');
NOTICE:  VLabel "Person" has been created
 create_vlabel 
---------------
 
(1 row)

-- 创建点表之后，会在ag_catalog.ag_label表中插入一条数据将点表与图关联起来。kind为v代表点表kind为e代表边表
SELECT * FROM ag_catalog.ag_label;
       name       | graph | id | kind |          relation          
------------------+-------+----+------+----------------------------
 _ag_label_vertex | 68484 |  1 | v    | new_graph._ag_label_vertex 
 _ag_label_edge   | 68484 |  2 | e    | new_graph._ag_label_edge   
 Person           | 68484 |  3 | v    | new_graph."Person"         
(3 rows)

3. Cypher查询

Cypher语句无法在数据库中直接执行。需要通过cypher()函数构造，将Cypher语句作为cypher()函数的参数执行，cypher()函数返回一个SETOF records。

3.1 cypher()函数介绍

cypher(graph_name, query_string, parameters)

第一个参数graph_name为要查询的图，第二个参数query_string为Cypher语句，第三个参数parameters为可选参数只能与Prepared Statements一起使用。否则将抛出错误。

SELECT * FROM cypher('graph_name', $$ 
/* Cypher Query Here */ 
$$) AS (result1 agtype, result2 agtype);

注意事项

1. AS 后的 (result1 agtype, result2 agtype) 即SETOF records 需要和Cypher语句中的返回值个数相同
2. SELECT * FROM cypher 不能写成 SELECT cypher
3. 执行语句前需要执行 load 'age' 和 set search_path = ag_catalog

数据类型及函数说明

以下对AGE中包含的数据类型、Cypher语法、函数进行简要说明。

1 数据类型

AGE的会创建两种数据类型: graphid 和 agtype。其中graphid代表点和边的唯一id标识符。agtype为AGE的核心数据类型，具体介绍可参考 https://age.apache.org/age-manual/master/intro/types.html。

1.1 Simple DataTypes

简单数据类型包括：Null、Integer、Float、Numeric、Bool、String。

1.2 Composite DataTypes

复合数据类型包括：List、Map。

• List支持以下操作

• Map支持以下操作

1.3 Simple Entities

简单实体类型包括 GraphId、Labels、Properties。又简单实体类型组成Vertex、Edge、Composite Entities。

1.4 Vertex

Vertex 是图的基本组成元素，代表节点。

1.5 Edge

Edge 是图的基本组成元素，代表边。

1.6 Composite Entities

由Vertex 和 Edge组成的Path类型。

2 Cypher语法

AGE对Cypher语法的支持具体介绍可参考：https://age.apache.org/age-manual/master/clauses/match.html

2.1 Match

2.2 With

2.3 SKIP

2.4 LIMIT

2.5 Return

2.6 ORDER BY

2.7 CREATE

2.8 SET

2.9 REMOVE

2.10 DELETE

3 函数支持

函数主要是对agtype的操作和表达式的生成，具体内容可参考：https://age.apache.org/age-manual/master/functions/predicate_functions.html

3.1 Predicate Functions

3.2 Scalar Functions

3.3 List Functions

3.4 Numeric Functions

3.5 Logarithmic Functions

3.6 Trigonometric Functions

3.7 String Functions

3.8 Aggregation Functions