关于postgresql：Postgres函数返回一行作为JSON值

Postgres function returning a row as JSON value

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

我正在开发一个将返回JSON结果的函数。
这个工作：

1
2
3
4
5
6

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命令的错误。

1
2
3
4
5
6
7
8
9
10
11

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语句作为子查询。那还有吗？

相关讨论

我看到两个主要问题：
1.根本不能将UPDATE放入子查询中。您可以通过像Patrick演示的数据修改CTE来解决这个问题，但这比手头的案例更加昂贵和冗长。
2.您有潜在的危险命名冲突，尚未解决。

更好的查询/功能

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

1
2
3
4

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

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

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

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

在Postgres 9.3中，你需要一个CTE另一个函数来封装第一步或者转换为明确定义的行类型。细节：

在SQL中返回JSON对象数组(Postgres)

在Postgres 9.4中，只需使用json_build_object()或json_object()：

1
2
3
4

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

要么：

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

现在，您将获得原始列名称或您选择的任何键名称：

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

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

命名冲突

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

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

1
2
3
4
5
6
7
8

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，...，但这只能回避问题的一半。只要避免命名冲突，任何方法都是好的。我建议：

1
2
3
4
5
6
7
8

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;

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