Postgresql自定義函式詳解

阿新 • • 發佈：2020-12-29

PostgreSQL函式也稱為PostgreSQL儲存過程。 PostgreSQL函式或儲存過程是儲存在資料庫伺服器上並可以使用SQL介面呼叫的一組SQL和過程語句(宣告，分配，迴圈，控制流程等)。

語法：

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:它指定實現該函式的語言的名稱。

下面我將建立一個簡單的函式：

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.準備資料

建表

 create table city (
 cityId int,cityName varchar(20)
 );

插入資料

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

2. 函式例項

2.1 setof 表名

建立函式getCity()，它返回city表中所有的資料，返回值宣告為 setof 表名。

create or replace function getCity() returns setof city as 
$$
begin
return query select * from city;
end;
$$
language plpgsql;

執行函式。

mydb=# select getCity();
   getcity
-----------------
 (1,BeiJing)
 (2,NewYork)
 (3,"Hong kong")
 (4,ShaingHai)
(4 行記錄)

也可以用類似查詢表的方式。

mydb=# select * from getCity();
 cityid | cityname
--------+-----------
   1 | BeiJing
   2 | NewYork
   3 | Hong kong
   4 | ShaingHai
(4 行記錄)

PostgreSQL還支援對函式執行結果進行條件判斷並過濾。

mydb=# select * from getCity() where cityId > 3;
 cityid | cityname
--------+-----------
   4 | ShaingHai
(1 行記錄)

2.2 setof record

為了使函式更加通用，以解決動態返回資料集的問題。建立函式getRows(text)，將表名city作為函式引數，它返回表中所有的資料，返回值宣告為 setof record。

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';

執行函式。

mydb=# select * from getRows('city') as city(id int,name varchar(20));
 id |  name
----+-----------
 1 | BeiJing
 2 | NewYork
 3 | Hong kong
 4 | ShaingHai
(4 行記錄)

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援我們。如有錯誤或未考慮完全的地方，望不吝賜教。