Postgresql自定义函数详解

时间:2022-02-09 22:10:28

PostgreSQL函数也称为PostgreSQL存储过程。 PostgreSQL函数或存储过程是存储在数据库服务器上并可以使用SQL界面调用的一组SQL和过程语句(声明,分配,循环,控制流程等)。

语法:

?
1
2
3
4
5
6
7
8
9
10
CREATE [OR REPLACE] FUNCTION function_name (arguments) 
RETURNS return_datatype AS $variable_name$
 DECLARE
  declaration;
  [...]
 BEGIN
  < function_body >
  [...]
  RETURN { variable_name | value }
 END; LANGUAGE plpgsql;

参数说明

function_name:指定函数的名称。

[OR REPLACE]:是可选的,它允许修改/替换现有函数。

DECLARE:定义参数(参数名写在前面 类型写在后面)。

BEGIN~END: 在中间写方法主体。

RETURN:指定要从函数返回的数据类型(它可以是基础,复合或域类型,或者也可以引用表列的类型)。

LANGUAGE:它指定实现该函数的语言的名称。

下面我将创建一个简单的函数:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
CREATE OR REPLACE FUNCTION test(id uuid)
 RETURNS INTEGER
 LANGUAGE plpgsql
AS
$$
declare
 count integer;
begin
 count = (SELECT
       json_array_length(A.json::json -> 'features')
      FROM "Json" A
      WHERE A.uid = id);
 return count;
end;
 
$$

该函数的功能是用来返回json中数组的长度的

定义好该函数后,我们可以像调用其他的函数一样调用它

SELECT test(id)

返回数组长度(integer)

补充:PostgreSQL中自定义函数(function)返回数据集

1.准备数据

建表

?
1
2
3
4
create table city (
cityId int,
cityName varchar(20)
);

插入数据

insert into city values(1,'BeiJing'),(2,'NewYork'),(3,'*'),(4,'ShaingHai');

2. 函数实例

2.1 setof 表名

创建函数getCity(),它返回city表中所有的数据,返回值声明为 setof 表名。

?
1
2
3
4
5
6
7
create or replace function getCity() returns setof city as
$$
begin
return query select * from city;
end;
$$
language plpgsql;

执行函数。

?
1
2
3
4
5
6
7
8
mydb=# select getCity();
   getcity
-----------------
 (1,BeiJing)
 (2,NewYork)
 (3,"*")
 (4,ShaingHai)
(4 行记录)

也可以用类似查询表的方式。

?
1
2
3
4
5
6
7
8
mydb=# select * from getCity();
 cityid | cityname
--------+-----------
   1 | BeiJing
   2 | NewYork
   3 | *
   4 | ShaingHai
(4 行记录)

PostgreSQL还支持对函数执行结果进行条件判断并过滤。

?
1
2
3
4
5
mydb=# select * from getCity() where cityId > 3;
 cityid | cityname
--------+-----------
   4 | ShaingHai
(1 行记录)

2.2 setof record

为了使函数更加通用,以解决动态返回数据集的问题。创建函数getRows(text),将表名city作为函数参数,它返回表中所有的数据,返回值声明为 setof record。

?
1
2
3
4
5
6
7
8
9
10
11
12
create or replace function getRows(text) returns setof record as
$$
declare
rec record;
begin
for rec in EXECUTE 'select * from ' || $1 loop
return next rec;
end loop;
return;
end
$$
language 'plpgsql';

执行函数。

?
1
2
3
4
5
6
7
8
9
mydb=# select * from getRows('city') as city(id int, name varchar(20));
 id |  name
----+-----------
 1 | BeiJing
 2 | NewYork
 3 | *
 4 | ShaingHai
(4 行记录)

以上为个人经验,希望能给大家一个参考,也希望大家多多支持服务器之家。如有错误或未考虑完全的地方,望不吝赐教。

原文链接:https://blog.csdn.net/qq_36213352/article/details/86698682