Postgres函数返回一行作为JSON值

时间:2015-06-30 15:08:29

标签: json postgresql sql-function postgresql-9.4

我是PG的新手,并尝试从MSSQL转换。

我正在处理一个将返回JSON结果的函数。 这个有效:

Create Or Replace Function ExampleTable_SelectList()
Returns JSON As
$$
  Select array_to_json(array_agg(row_to_json(t))) From
    (Select id, value1, value2, From ExampleTable) t
$$ Language SQL;

现在,我想调用可以更新的返回值并将该值转换为JSON以返回。因此,这个在set命令上给出了错误。

Create Or Replace Function ExampleTable_Update (id bigint, value1 text)
  Returns JSON As
$$
  Select row_to_json(t) From
  (
    Update ExampleTable
    Set Value1 = value1
    Where id= id
    Returning Value1, Value2;
  ) t
$$ Language SQL;

我怀疑Postgres不允许将UPDATE语句作为子查询。反正有吗?

2 个答案:

答案 0 :(得分:8)

我看到两个主要问题:
1。无法将UPDATE放入子查询 。您可以使用类似data-modifying CTEPatrick demonstrates来解决此问题,但这比手头的情况更加昂贵且冗长。 2。您有潜在危险的命名冲突,尚未解决。

更好的查询/功能

暂时搁置SQL函数包装器(我们将再回过头来看看)。您可以使用带UPDATE子句的简单RETURNING

UPDATE tbl
SET    value1 = 'something_new'
WHERE  id = 123
RETURNING row_to_json(ROW(value1, value2));

RETURNING子句允许涉及更新行的列的任意表达式。这比数据修改CTE更短,更便宜。

剩下的问题:行构造函数ROW(...)不保留列名(这是一个已知的弱点),因此您可以获得JSON值中的通用键:

row_to_json
{"f1":"something_new","f2":"what ever is in value2"}

在Postgres 9.3中,你需要一个CTE另一个函数来封装第一步或者一个强制转换为明确定义的行类型。详细说明:

在Postgres中 9.4 ,只需使用json_build_object() or json_object()

UPDATE tbl
SET    value1 = 'something_new'
WHERE  id = 123
RETURNING json_build_object('value1', value1, 'value2', value2);

或者:

...
RETURNING json_object('{value1, value2}', ARRAY[value1, value2]);

现在您可以获得原始列名称或您选择的任何键名称:

row_to_json
{"value1":"something_new","value2":"what ever is in value2"}

很容易将它包装在一个函数中,这将我们带到你的第二个问题......

命名冲突

在原始函数中,您对函数参数和列名称使用相同的名称。这通常是一个非常糟糕的主意。您需要密切了解哪个标识符首先出现在哪个范围内。

在手头的情况下,结果完全是胡说八道:

Create Or Replace Function ExampleTable_Update (id bigint, value1 text) Returns 
...
    Update ExampleTable
    Set Value1 = value1
    Where id = id
    Returning Value1, Value2;
...
$$ Language SQL;

虽然您似乎期望id的第二个实例将引用函数参数,但事实并非如此。列名首先在SQL语句的范围内,第二个实例引用该列。导致表达式始终为true,但id中的NULL值除外。因此,您需要更新 所有行 ,这可能会导致灾难性数据丢失。 更糟糕的是,您可能直到稍后才意识到这一点,因为SQL函数将返回 一个 任意行,如函数的RETURNING子句所定义(返回一行行,而不是一组行。)

在这种特殊情况下,你会得到“幸运”,因为你还有value1 = value1,它用预先存在的值覆盖了列,有效地做了......没有什么是非常昂贵的方式(除非触发器做某事)。您可能会感到困惑的是获得一个任意行,结果不变value1

所以,不要。

避免这样的潜在命名冲突,除非您确切知道自己在做什么(显然不是这种情况)。我喜欢的一个约定是在函数中为参数和变量名前置下划线,而列名永远不会以下划线开头。在许多情况下,您可以使用位置引用来明确:$1$2,...,但这只能避开问题的一半。只要您避免命名冲突,任何方法都是好的。我建议:

CREATE OR REPLACE FUNCTION foo (_id bigint, _value1 text)
   RETURNS json AS
$func$
UPDATE tbl
SET    value1 = _value1
WHERE  id     = _id
RETURNING json_build_object('value1', value1, 'value2', value2);
$func$  LANGUAGE sql;

另请注意,这会在value1之后的UPDATE中返回 实际列值 ,这可能与您的相同或不同输入参数_value1。可能存在数据库规则或触发器干扰...

答案 1 :(得分:2)

您需要将UPDATE语句放在CTE

CREATE OR REPLACE FUNCTION ExampleTable_Update (id bigint, value1 text) RETURNS json AS $$
  WITH t(Value2) AS (
    UPDATE ExampleTable
    SET Value1 = $2
    WHERE id = $1
    RETURNING Value2)
  SELECT row_to_json($2, Value2) 
  FROM t;
$$ LANGUAGE sql;

请注意,我使用positional parameters $1$2作为函数参数。这些参数的名称与表中的列名相同,这通常是一个坏主意,因为可能存在名称解析冲突;请参阅Erwin Brandstetter的答案,以获得更详细的解释。