38

我编写了一个函数,它SELECT以文本形式输出格式良好的 PostgreSQL 查询。现在我不想再输出文本了,但实际上SELECT对数据库运行生成的语句并返回结果 - 就像查询本身一样。

到目前为止我所拥有的:

CREATE OR REPLACE FUNCTION data_of(integer)
  RETURNS text AS
$BODY$
DECLARE
   sensors varchar(100);   -- holds list of column names
   type    varchar(100);   -- holds name of table
   result  text;           -- holds SQL query
       -- declare more variables

BEGIN
      -- do some crazy stuff

      result := 'SELECT\r\nDatahora,' || sensors ||
      '\r\n\r\nFROM\r\n' || type ||
      '\r\n\r\nWHERE\r\id=' || $1 ||'\r\n\r\nORDER BY Datahora;';

      RETURN result;
END;
$BODY$
LANGUAGE 'plpgsql' VOLATILE;
ALTER FUNCTION data_of(integer) OWNER TO postgres;

sensors保存表的列名列表type。这些是在函数的过程中声明和填充的。最终,他们持有如下价值观:

  • sensors:'column1, column2, column3'
    除了Datahora( timestamp) 所有列都是类型double precision

  • type:'myTable'
    可以是四个表之一的名称。每个都有不同的列,除了 common column Datahora

基础表的定义

该变量sensors将保存此处显示的所有列,用于 中的相应表type。例如:如果typepcdmet那么sensors将是'datahora,dirvento,precipitacao,pressaoatm,radsolacum,tempar,umidrel,velvento'

这些变量用于构建SELECT存储在result. 像:

SELECT Datahora, column1, column2, column3
FROM   myTable
WHERE  id=20
ORDER  BY Datahora;

现在,我的函数将此语句返回为text. 我复制粘贴并在 pgAdmin 中或通过 psql 执行它。我想自动化这个,自动运行查询并返回结果。我怎样才能做到这一点?

4

4 回答 4

92

动态 SQL 和RETURN类型

(我把最好的留到最后,继续阅读!)
你想执行动态 SQL。原则上,在 plpgsql 的帮助下,这很简单EXECUTE。你不需要光标。事实上,大多数情况下,没有显式游标会更好。

您遇到的问题:您想要返回尚未定义类型的记录。函数需要在RETURNS子句中声明其返回类型(或使用OUTINOUT参数)。在您的情况下,您将不得不回退到匿名记录,因为numbernames和返回列的类型各不相同。像:

CREATE FUNCTION data_of(integer)
  RETURNS SETOF record AS ...

然而,这并不是特别有用。您必须在每次调用时提供列定义列表。像:

SELECT * FROM data_of(17)
AS foo (colum_name1 integer
      , colum_name2 text
      , colum_name3 real);

但是,当您事先不知道列时,您将如何做到这一点?
您可以使用结构较少的文档数据类型,如json,或. 看:jsonbhstorexml

但是,出于这个问题的目的,我们假设您希望尽可能多地返回单独的、正确键入和命名的列。

具有固定返回类型的简单解决方案

该列datahora似乎是给定的,我将假设数据类型timestamp,并且总是有另外两列具有不同的名称和数据类型。

我们将在返回类型中放弃名称以支持通用名称
我们也将放弃类型,并将所有类型转换为,text因为每种数据类型都可以转换为text.

CREATE OR REPLACE FUNCTION data_of(_id integer)
  RETURNS TABLE (datahora timestamp, col2 text, col3 text)
  LANGUAGE plpgsql AS
$func$
DECLARE
   _sensors text := 'col1::text, col2::text';  -- cast each col to text
   _type    text := 'foo';
BEGIN
   RETURN QUERY EXECUTE '
      SELECT datahora, ' || _sensors || '
      FROM   ' || quote_ident(_type) || '
      WHERE  id = $1
      ORDER  BY datahora'
   USING  _id;
END
$func$;

变量_sensors_type可以是输入参数。

注意RETURNS TABLE子句。

注意使用RETURN QUERY EXECUTE. 这是从动态查询返回行的更优雅的方法之一。

我使用函数参数的名称,只是为了使USING子句RETURN QUERY EXECUTE不那么混乱。$1SQL 字符串中的不是指函数参数,而是指与USING子句一起传递的值。(在这个简单的例子中,两者恰好都$1在各自的范围内。)

请注意以下示例值_sensors:每列都被强制转换为 type text

这种代码很容易受到SQL 注入的影响。我quote_ident()用来防止它。将变量中的几个列名集中在一起会_sensors阻止使用quote_ident()(通常是一个坏主意!)。确保没有坏东西可以通过其他方式出现,例如通过单独运行列名quote_ident()VARIADIC想到一个参数...

自 PostgreSQL 9.1 起更简单

使用 9.1 或更高版本,您可以format()进一步简化:

RETURN QUERY EXECUTE format('
   SELECT datahora, %s  -- identifier passed as unescaped string
   FROM   %I            -- assuming the name is provided by user
   WHERE  id = $1
   ORDER  BY datahora'
  ,_sensors, _type)
USING  _id;

同样,单个列名可以正确转义,这将是一种干净的方式。

共享相同类型的可变列数

在您的问题更新后,您的返回类型看起来像

  • 可变数量的列
  • 但相同类型 的所有列double precision(别名float8

在这种情况下使用ARRAY类型来嵌套可变数量的值。此外,我返回一个包含列名的数组:

CREATE OR REPLACE FUNCTION data_of(_id integer)
  RETURNS TABLE (datahora timestamp, names text[], values float8[])
  LANGUAGE plpgsql AS
$func$
DECLARE
   _sensors text := 'col1, col2, col3';  -- plain list of column names
   _type    text := 'foo';
BEGIN
   RETURN QUERY EXECUTE format('
      SELECT datahora
           , string_to_array($1)  -- AS names
           , ARRAY[%s]            -- AS values
      FROM   %s
      WHERE  id = $2
      ORDER  BY datahora'
    , _sensors, _type)
   USING  _sensors, _id;
END
$func$;

各种完整的表类型

要实际返回table 的所有列,有一个使用多态类型的简单而强大的解决方案:

CREATE OR REPLACE FUNCTION data_of(_tbl_type anyelement, _id int)
  RETURNS SETOF anyelement
  LANGUAGE plpgsql AS
$func$
BEGIN
   RETURN QUERY EXECUTE format('
      SELECT *
      FROM   %s  -- pg_typeof returns regtype, quoted automatically
      WHERE  id = $1
      ORDER  BY datahora'
    , pg_typeof(_tbl_type))
   USING  _id;
END
$func$;

致电(重要!):

SELECT * FROM data_of(NULL::pcdmet, 17);

在调用中替换pcdmet为任何其他表名。

这是如何运作的?

anyelement是伪数据类型,多态类型,任何非数组数据类型的占位符。函数中所有出现的anyelement都评估为运行时提供的相同类型。通过提供一个定义类型的值作为函数的参数,我们隐式地定义了返回类型。

PostgreSQL 自动为每个创建的表定义一个行类型(一种复合数据类型),因此每个表都有一个定义良好的类型。这包括临时表,便于临时使用。

任何类型都可以NULL。提交一个NULL值,强制转换为表格类型:NULL::pcdmet.

现在该函数返回一个定义明确的行类型,我们可以使用它SELECT * FROM data_of()来分解行并获取各个列。

pg_typeof(_tbl_type)返回表的名称作为对象标识符类型regtype。当自动转换为 时,如果需要text,标识符会自动被双引号和模式限定,从而自动防御 SQL 注入。这甚至可以处理quote_ident()会失败的模式限定表名。看:

于 2012-08-01T01:51:13.627 回答
4

您可能想要返回一个cursor。尝试这样的事情(我还没有尝试过):

CREATE OR REPLACE FUNCTION data_of(integer)
  RETURNS refcursor AS
$BODY$
DECLARE
      --Declaring variables
      ref refcursor;
BEGIN
      -- make sure `sensors`, `type`, $1 variable has valid value
      OPEN ref FOR 'SELECT Datahora,' || sensors ||
      ' FROM ' || type ||
      ' WHERE nomepcd=' || $1 ||' ORDER BY Datahora;';
      RETURN ref;
END;
$BODY$
LANGUAGE 'plpgsql' VOLATILE;
ALTER FUNCTION data_of(integer) OWNER TO postgres;
于 2012-07-31T12:52:40.607 回答
1

我很抱歉地说,但你的问题很不清楚。但是,您将在下面找到一个自包含示例,如何创建和使用返回游标变量的函数。希望能帮助到你 !

begin;

create table test (id serial, data1 text, data2 text);

insert into test(data1, data2) values('one', 'un');
insert into test(data1, data2) values('two', 'deux');
insert into test(data1, data2) values('three', 'trois');

create function generate_query(query_name refcursor, columns text[])
returns refcursor 
as $$
begin
  open query_name for execute 
    'select id, ' || array_to_string(columns, ',') || ' from test order by id';
  return query_name;
end;
$$ language plpgsql;

select generate_query('english', array['data1']);
fetch all in english;

select generate_query('french', array['data2']);
fetch all in french;
move absolute 0 from french; -- do it again !
fetch all in french;

select generate_query('all_langs', array['data1','data2']);
fetch all in all_langs;

-- this will raise in runtime as there is no data3 column in the test table
select generate_query('broken', array['data3']);

rollback;
于 2012-07-31T19:01:35.640 回答
0
# copy paste me into bash shell directly
clear; IFS='' read -r -d '' sql_code << 'EOF_SQL_CODE'
CREATE OR REPLACE FUNCTION func_get_all_users_roles()
  -- define the return type of the result set as table
  -- those datatypes must match the ones in the src
  RETURNS TABLE (
                 id           bigint
               , email        varchar(200)
               , password     varchar(200)
               , roles        varchar(100)) AS
$func$
BEGIN
   RETURN QUERY 
   -- start the select clause
   SELECT users.id, users.email, users.password, roles.name as roles
   FROM user_roles
   LEFT JOIN roles ON (roles.guid = user_roles.roles_guid)
   LEFT JOIN users ON (users.guid = user_roles.users_guid)
   -- stop the select clause
;
END
$func$  LANGUAGE plpgsql;
EOF_SQL_CODE
# create the function
psql -d db_name -c "$sql_code"; 

# call the function 
psql -d db_name -c "select * from func_get_all_users_roles() "
于 2020-03-07T20:34:07.360 回答