47

据我所知,我的功能与我看到的示例非常相似。有人能告诉我我是如何让它工作的吗?

create or replace function get_user_by_username(
    username varchar(250),
    online boolean
    ) returns setof record as $$
declare result record;
begin

    if online then 
        update users
        set last_activity = current_timestamp
        where user_name = username;
    end if;

    return query
    select
        user_id,
        user_name,
        last_activity,
        created,
        email,
        approved,
        last_lockout,
        last_login,
        last_password_changed,
        password_question,
        comment
    from
        users
    where
        user_name = username
    limit 1;

    return;
end;
$$ language plpgsql;
4

2 回答 2

57

返回选定的列

CREATE OR REPLACE FUNCTION get_user_by_username(_username text
                                              , _online bool DEFAULT false)
  RETURNS TABLE (
    user_id int
  , user_name varchar
  , last_activity timestamptz
  )
  LANGUAGE plpgsql AS
$func$
BEGIN
   IF _online THEN
      RETURN QUERY
      UPDATE users u 
      SET    last_activity = current_timestamp  -- ts with time zone
      WHERE  u.user_name = _username
      RETURNING u.user_id
              , u.user_name
              , u.last_activity;
   ELSE
      RETURN QUERY
      SELECT u.user_id
           , u.user_name
           , u.last_activity
      FROM   users u
      WHERE  u.user_name = _username;
   END IF;
END
$func$;

称呼:

SELECT * FROM get_user_by_username('myuser', true);

您有DECLARE result record;但没有使用该变量。我删除了杂物。

您可以直接从 中返回记录,这比调用附加语句UPDATE要快得多。SELECT使用RETURN QUERYand UPDATEwithRETURNING子句

如果用户不是_online,则默认为普通的SELECT。如果省略第二个参数,这也是(安全)默认值 - 只有DEFAULT false在函数定义中提供该默认值后才有可能。

如果您tablename.columnname在函数内部的查询中没有对列名 ( ) 进行表限定,请注意列名和命名参数之间的命名冲突,这些冲突在函数内的任何地方(大多数)都是可见的。
您还可以通过$n对参数使用位置引用 ( ) 来避免此类冲突。或者使用您从不用于列名的前缀:例如下划线 ( _username)。

如果在您的表users.username中定义为唯一LIMIT 1的,那么在第二个查询中只是简单的。如果不是,则UPDATE可以更新多行,这很可能是错误的。我假设一个独特的username并修剪噪音。

定义函数的返回类型(就像@ertx 演示的那样),或者您必须为每个函数调用提供一个列定义列表,这很尴尬。

为此目的创建一个类型(如@ertx 提议的)是一种有效的方法,但对于单个函数来说可能是矫枉过正。这是在我们RETURNS TABLE为此目的之前在旧版本的 Postgres 中使用的方法——如上所示。

这个简单的函数不需要循环

每个函数都需要一个语言声明。LANGUAGE plpgsql在这种情况下。

我使用timestamptz( timestamp with time zone) 而不是timestamp( timestamp without time zone),这是正常的默认设置。看:

返回(组)整行

要返回现有表的所有列users,有一种更简单的方法。Postgres 自动为每个表定义一个同名的复合类型。只需用于RETURNS SETOF users大大简化查询:

CREATE OR REPLACE FUNCTION get_user_by_username(_username text
                                              , _online bool DEFAULT false)
  RETURNS SETOF users
  LANGUAGE plpgsql AS
$func$
BEGIN
   IF _online THEN
      RETURN QUERY
      UPDATE users u 
      SET    last_activity = current_timestamp
      WHERE  u.user_name = _username
      RETURNING u.*;
   ELSE
      RETURN QUERY
      SELECT *
      FROM   users u
      WHERE  u.user_name = _username;
   END IF;
END
$func$;

返回整行加上自定义添加

要解决 TheRealChx101 在下面的评论中添加的问题:

如果除了整个表之外还有一个计算值怎么办?

没有那么简单,但可行。我们可以将整个行类型作为一个字段发送,并添加更多:

CREATE OR REPLACE FUNCTION get_user_by_username3(_username text
                                               , _online bool DEFAULT false)
  RETURNS TABLE (
    users_row users
  , custom_addition text
  )
  LANGUAGE plpgsql AS
$func$
BEGIN
   IF _online THEN
      RETURN QUERY
      UPDATE users u 
      SET    last_activity = current_timestamp  -- ts with time zone
      WHERE  u.user_name = _username
      RETURNING u  -- whole row
              , u.user_name || u.user_id;
   ELSE
      RETURN QUERY
      SELECT u, u.user_name || u.user_id
      FROM   users u
      WHERE  u.user_name = _username;
   END IF;
END
$func$;

“魔法”在函数调用中,我们(可选地)分解行类型:

SELECT (users_row).*, custom_addition FROM get_user_by_username('foo', true);

db<>fiddle here(显示全部)


如果您需要更“动态”的东西,请考虑:

于 2011-12-23T02:29:29.993 回答
36

如果您想创建返回 setof 记录的函数,则需要在 select 语句中定义列类型

更多信息

您的查询应如下所示:

select * from get_user_by_username('Username', True) as 
  f(user_id integer, user_name varchar, last_activity, varchar, created date, email        archar, approved boolean, last_lockout timestamp, last_login timestamp, 
  last_password_changed timestamp, password_question varchar, comment varchar)

(您可能需要更改数据类型)

我个人更喜欢类型方法。它确保如果函数被编辑,所有查询都将返回正确的结果。这可能会很痛苦,因为每次修改函数的参数时,您都需要重新创建/删除类型。

例如:

CREATE TYPE return_type as 
(user_id integer,
 user_name varchar,
 last_activity varchar,
 created timestamp,
 email varchar,
 approved boolean,
 last_lockout timestamp ,
 last_login timestamp,
 last_password_changed timestamp,
 password_question varchar,
 comment varchar);

create or replace function get_user_by_username( username varchar(250), online 

boolean) returns setof return_type as $$
declare _rec return_type;
begin
    if online then 
        update users
        set last_activity = current_timestamp
        where user_name = username;
    end if;
    for _rec in select
        user_id,
        user_name,
        last_activity,
        created,
        email,
        approved,
        last_lockout,
        last_login,
        last_password_changed,
        password_question,
        comment
      from
        users
      where
        user_name = username
      limit 1 
    loop

      return next _rec;

    end loop

end;
$$ language plpgsql;
于 2011-12-22T14:23:56.600 回答