2024年9月26日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2 / 7.1

8.15. 数组 #

PostgreSQL 允许将表的列定义为可变长度的多维数组。可以创建任何内置或用户定义的基本类型、枚举类型、复合类型、范围类型或域的数组。

8.15.1. 数组类型的声明 #

为了说明数组类型的用法,我们创建了这个表

CREATE TABLE sal_emp (
    name            text,
    pay_by_quarter  integer[],
    schedule        text[][]
);

如所示,数组数据类型通过在数组元素的数据类型名称后附加方括号([])来命名。上述命令将创建一个名为 sal_emp 的表,其中包含一个类型为 textname)的列,一个类型为 integerpay_by_quarter)的一维数组,表示员工按季度的工资,以及一个二维 text 数组(schedule),表示员工的每周时间表。

CREATE TABLE 的语法允许指定数组的确切大小,例如

CREATE TABLE tictactoe (
    squares   integer[3][3]
);

但是,当前的实现会忽略任何提供的数组大小限制,即行为与未指定长度的数组相同。

当前的实现也不强制执行声明的维度数。特定元素类型的数组,无论大小或维度数如何,都被视为同一类型。因此,在 CREATE TABLE 中声明数组大小或维度数仅仅是文档;它不影响运行时行为。

可以使用另一种语法(通过使用关键字 ARRAY 符合 SQL 标准)用于一维数组。 pay_by_quarter 可以定义为

    pay_by_quarter  integer ARRAY[4],

或者,如果不需要指定数组大小

    pay_by_quarter  integer ARRAY,

但是,与之前一样,PostgreSQL 在任何情况下都不会强制执行大小限制。

8.15.2. 数组值的输入 #

要将数组值作为文字常量写入,请将元素值括在花括号内并用逗号分隔。(如果您了解 C,这与 C 初始化结构的语法非常相似。)您可以将任何元素值用双引号括起来,并且如果它包含逗号或花括号,则必须这样做。(更多详细信息如下。)因此,数组常量的通用格式如下

'{ val1 delim val2 delim ... }'

其中 delim 是类型的分隔符字符,记录在其 pg_type 条目中。在 PostgreSQL 发行版中提供的标准数据类型中,所有类型都使用逗号(,),除了类型 box 使用分号(;)。每个 val 都是数组元素类型的常量或子数组。数组常量的示例如下

'{{1,2,3},{4,5,6},{7,8,9}}'

此常量是一个二维的 3x3 数组,由三个整数子数组组成。

要将数组常量的某个元素设置为 NULL,请为元素值写入 NULL。(NULL 的任何大小写变体都可以。)如果要使用实际的字符串值NULL,则必须用双引号括起来。

(这些类型的数组常量实际上只是在第 4.1.2.7 节中讨论的通用类型常量的特例。该常量最初被视为字符串并传递给数组输入转换例程。可能需要显式类型规范。)

现在我们可以展示一些 INSERT 语句

INSERT INTO sal_emp
    VALUES ('Bill',
    '{10000, 10000, 10000, 10000}',
    '{{"meeting", "lunch"}, {"training", "presentation"}}');

INSERT INTO sal_emp
    VALUES ('Carol',
    '{20000, 25000, 25000, 25000}',
    '{{"breakfast", "consulting"}, {"meeting", "lunch"}}');

前两个插入的结果如下所示

SELECT * FROM sal_emp;
 name  |      pay_by_quarter       |                 schedule
-------+---------------------------+-------------------------------------------
 Bill  | {10000,10000,10000,10000} | {{meeting,lunch},{training,presentation}}
 Carol | {20000,25000,25000,25000} | {{breakfast,consulting},{meeting,lunch}}
(2 rows)

多维数组必须为每个维度具有匹配的范围。不匹配会导致错误,例如

INSERT INTO sal_emp
    VALUES ('Bill',
    '{10000, 10000, 10000, 10000}',
    '{{"meeting", "lunch"}, {"meeting"}}');
ERROR:  malformed array literal: "{{"meeting", "lunch"}, {"meeting"}}"
DETAIL:  Multidimensional arrays must have sub-arrays with matching dimensions.

ARRAY 构造函数语法也可以使用

INSERT INTO sal_emp
    VALUES ('Bill',
    ARRAY[10000, 10000, 10000, 10000],
    ARRAY[['meeting', 'lunch'], ['training', 'presentation']]);

INSERT INTO sal_emp
    VALUES ('Carol',
    ARRAY[20000, 25000, 25000, 25000],
    ARRAY[['breakfast', 'consulting'], ['meeting', 'lunch']]);

请注意,数组元素是普通的 SQL 常量或表达式;例如,字符串文字用单引号括起来,而不是像在数组文字中那样用双引号括起来。ARRAY 构造函数语法在第 4.2.12 节中有更详细的讨论。

8.15.3. 访问数组 #

现在,我们可以对表运行一些查询。首先,我们展示如何访问数组的单个元素。此查询检索在第二季度工资发生变化的员工的姓名

SELECT name FROM sal_emp WHERE pay_by_quarter[1] <> pay_by_quarter[2];

 name
-------
 Carol
(1 row)

数组下标数字写在方括号内。默认情况下,PostgreSQL 对数组使用基于 1 的编号约定,即 n 个元素的数组以 array[1] 开始,以 array[n] 结束。

此查询检索所有员工的第三季度工资

SELECT pay_by_quarter[3] FROM sal_emp;

 pay_by_quarter
----------------
          10000
          25000
(2 rows)

我们还可以访问数组的任意矩形切片或子数组。数组切片表示为为一个或多个数组维度编写 lower-bound:upper-bound。例如,此查询检索 Bill 在一周前两天时间表中的第一项

SELECT schedule[1:2][1:1] FROM sal_emp WHERE name = 'Bill';

        schedule
------------------------
 {{meeting},{training}}
(1 row)

如果任何维度被写为切片,即包含冒号,则所有维度都被视为切片。任何只有单个数字(没有冒号)的维度都被视为从 1 到指定的数字。例如,[2] 被视为 [1:2],如本例所示

SELECT schedule[1:2][2] FROM sal_emp WHERE name = 'Bill';

                 schedule
-------------------------------------------
 {{meeting,lunch},{training,presentation}}
(1 row)

为了避免与非切片情况混淆,最好对所有维度使用切片语法,例如 [1:2][1:1],而不是 [2][1:1]

可以省略切片说明符的 lower-bound 和/或 upper-bound;缺失的边界将替换为数组下标的下限或上限。例如

SELECT schedule[:2][2:] FROM sal_emp WHERE name = 'Bill';

        schedule
------------------------
 {{lunch},{presentation}}
(1 row)

SELECT schedule[:][1:1] FROM sal_emp WHERE name = 'Bill';

        schedule
------------------------
 {{meeting},{training}}
(1 row)

如果数组本身或任何下标表达式为 null,则数组下标表达式将返回 null。此外,如果下标超出数组边界,则返回 null(此情况不会引发错误)。例如,如果 schedule 当前具有维度 [1:3][1:2],则引用 schedule[3][3] 将产生 NULL。类似地,具有错误下标数的数组引用会产生 null 而不是错误。

数组切片表达式同样在数组本身或任何下标表达式为 null 时产生 null。但是,在其他情况下,例如选择完全超出当前数组边界的数组切片,切片表达式会产生一个空(零维)数组而不是 null。(这与非切片行为不匹配,并且出于历史原因而执行。)如果请求的切片部分重叠数组边界,则它会静默地缩减到仅重叠区域而不是返回 null。

可以使用 array_dims 函数检索任何数组值的当前维度

SELECT array_dims(schedule) FROM sal_emp WHERE name = 'Carol';

 array_dims
------------
 [1:2][1:2]
(1 row)

array_dims 生成一个 text 结果,这对于人们阅读来说很方便,但对于程序来说可能不方便。维度也可以使用 array_upperarray_lower 检索,它们分别返回指定数组维度的上限和下限

SELECT array_upper(schedule, 1) FROM sal_emp WHERE name = 'Carol';

 array_upper
-------------
           2
(1 row)

array_length 将返回指定数组维度的长度

SELECT array_length(schedule, 1) FROM sal_emp WHERE name = 'Carol';

 array_length
--------------
            2
(1 row)

cardinality 返回数组中所有维度中元素的总数。它实际上是调用 unnest 将产生的行数

SELECT cardinality(schedule) FROM sal_emp WHERE name = 'Carol';

 cardinality
-------------
           4
(1 row)

8.15.4. 修改数组 #

数组值可以完全替换

UPDATE sal_emp SET pay_by_quarter = '{25000,25000,27000,27000}'
    WHERE name = 'Carol';

或使用 ARRAY 表达式语法

UPDATE sal_emp SET pay_by_quarter = ARRAY[25000,25000,27000,27000]
    WHERE name = 'Carol';

数组也可以在单个元素处更新

UPDATE sal_emp SET pay_by_quarter[4] = 15000
    WHERE name = 'Bill';

或在切片中更新

UPDATE sal_emp SET pay_by_quarter[1:2] = '{27000,27000}'
    WHERE name = 'Carol';

也可以使用省略了 lower-bound 和/或 upper-bound 的切片语法,但仅当更新的数组值不为 NULL 或零维时(否则,没有现有的下标限制可以替换)。

可以通过分配给尚未存在的元素来扩大存储的数组值。先前存在的元素和新分配的元素之间的任何位置都将填充为 null。例如,如果数组 myarray 当前有 4 个元素,则在更新分配给 myarray[6] 后,它将有 6 个元素;myarray[5] 将包含 null。目前,这种方式的扩展仅允许用于一维数组,而不是多维数组。

下标赋值允许创建不使用基于一的索引的数组。例如,可以赋值给myarray[-2:7]来创建一个索引值从 -2 到 7 的数组。

新的数组值也可以使用连接运算符 || 构造。

SELECT ARRAY[1,2] || ARRAY[3,4];
 ?column?
-----------
 {1,2,3,4}
(1 row)

SELECT ARRAY[5,6] || ARRAY[[1,2],[3,4]];
      ?column?
---------------------
 {{5,6},{1,2},{3,4}}
(1 row)

连接运算符允许将单个元素推送到一维数组的开头或结尾。它还可以接受两个N维数组,或一个N维数组和一个N+1维数组。

当将单个元素推送到一维数组的开头或结尾时,结果数组将与数组操作数具有相同的下界索引。例如

SELECT array_dims(1 || '[0:1]={2,3}'::int[]);
 array_dims
------------
 [0:2]
(1 row)

SELECT array_dims(ARRAY[1,2] || 3);
 array_dims
------------
 [1:3]
(1 row)

当连接两个具有相同维数的数组时,结果将保留左侧操作数外部维度的下界索引。结果是一个数组,包含左侧操作数的每个元素,后跟右侧操作数的每个元素。例如

SELECT array_dims(ARRAY[1,2] || ARRAY[3,4,5]);
 array_dims
------------
 [1:5]
(1 row)

SELECT array_dims(ARRAY[[1,2],[3,4]] || ARRAY[[5,6],[7,8],[9,0]]);
 array_dims
------------
 [1:5][1:2]
(1 row)

当将一个N维数组推送到一个N+1维数组的开头或结尾时,结果类似于上述元素-数组的情况。每个N维子数组本质上是N+1维数组外部维度的元素。例如

SELECT array_dims(ARRAY[1,2] || ARRAY[[3,4],[5,6]]);
 array_dims
------------
 [1:3][1:2]
(1 row)

还可以使用函数 array_prependarray_appendarray_cat 构造数组。前两个只支持一维数组,但 array_cat 支持多维数组。一些示例

SELECT array_prepend(1, ARRAY[2,3]);
 array_prepend
---------------
 {1,2,3}
(1 row)

SELECT array_append(ARRAY[1,2], 3);
 array_append
--------------
 {1,2,3}
(1 row)

SELECT array_cat(ARRAY[1,2], ARRAY[3,4]);
 array_cat
-----------
 {1,2,3,4}
(1 row)

SELECT array_cat(ARRAY[[1,2],[3,4]], ARRAY[5,6]);
      array_cat
---------------------
 {{1,2},{3,4},{5,6}}
(1 row)

SELECT array_cat(ARRAY[5,6], ARRAY[[1,2],[3,4]]);
      array_cat
---------------------
 {{5,6},{1,2},{3,4}}

在简单情况下,上面讨论的连接运算符比直接使用这些函数更可取。但是,由于连接运算符被重载以服务于所有三种情况,因此在某些情况下,使用其中一个函数有助于避免歧义。例如,考虑

SELECT ARRAY[1, 2] || '{3, 4}';  -- the untyped literal is taken as an array
 ?column?
-----------
 {1,2,3,4}

SELECT ARRAY[1, 2] || '7';                 -- so is this one
ERROR:  malformed array literal: "7"

SELECT ARRAY[1, 2] || NULL;                -- so is an undecorated NULL
 ?column?
----------
 {1,2}
(1 row)

SELECT array_append(ARRAY[1, 2], NULL);    -- this might have been meant
 array_append
--------------
 {1,2,NULL}

在上面的示例中,解析器在连接运算符的一侧看到一个整数数组,在另一侧看到一个类型未确定的常量。它用来解析常量类型的启发式方法是假设它与运算符的另一个输入类型相同——在本例中为整数数组。因此,连接运算符被假定为表示 array_cat,而不是 array_append。当这是错误的选择时,可以通过将常量转换为数组的元素类型来修复;但是,显式使用 array_append 可能是一个更好的解决方案。

8.15.5. 数组搜索 #

要在数组中搜索某个值,必须检查每个值。如果知道数组的大小,可以手动执行此操作。例如

SELECT * FROM sal_emp WHERE pay_by_quarter[1] = 10000 OR
                            pay_by_quarter[2] = 10000 OR
                            pay_by_quarter[3] = 10000 OR
                            pay_by_quarter[4] = 10000;

但是,对于大型数组,这很快就会变得很繁琐,并且如果数组的大小未知,则没有帮助。第 9.25 节 描述了一种替代方法。上述查询可以替换为

SELECT * FROM sal_emp WHERE 10000 = ANY (pay_by_quarter);

此外,您可以找到数组的所有值都等于 10000 的行,方法是

SELECT * FROM sal_emp WHERE 10000 = ALL (pay_by_quarter);

或者,可以使用 generate_subscripts 函数。例如

SELECT * FROM
   (SELECT pay_by_quarter,
           generate_subscripts(pay_by_quarter, 1) AS s
      FROM sal_emp) AS foo
 WHERE pay_by_quarter[s] = 10000;

此函数在表 9.68 中进行了描述。

您还可以使用 && 运算符搜索数组,该运算符检查左操作数是否与右操作数重叠。例如

SELECT * FROM sal_emp WHERE pay_by_quarter && ARRAY[10000];

此运算符和其他数组运算符在第 9.19 节 中进行了进一步描述。它可以通过适当的索引加速,如第 11.2 节 所述。

您还可以使用 array_positionarray_positions 函数在数组中搜索特定值。前者返回数组中第一个出现的某个值的索引;后者返回一个数组,其中包含数组中所有出现的某个值的索引。例如

SELECT array_position(ARRAY['sun','mon','tue','wed','thu','fri','sat'], 'mon');
 array_position
----------------
              2
(1 row)

SELECT array_positions(ARRAY[1, 4, 3, 1, 3, 4, 2, 1], 1);
 array_positions
-----------------
 {1,4,8}
(1 row)

提示

数组不是集合;搜索特定数组元素可能是数据库设计错误的迹象。考虑使用一个单独的表,为每个将作为数组元素的项目创建一个行。这将更容易搜索,并且对于大量元素更有可能扩展得更好。

8.15.6. 数组输入和输出语法 #

数组值的外部文本表示由根据数组元素类型的 I/O 转换规则解释的项目以及指示数组结构的修饰组成。修饰包括数组值周围的花括号({})以及相邻项目之间的分隔符字符。分隔符字符通常是逗号(,),但可以是其他字符:它由数组元素类型的 typdelim 设置确定。在 PostgreSQL 发行版中提供的标准数据类型中,所有类型都使用逗号,除了类型 box,它使用分号(;)。在多维数组中,每个维度(行、平面、立方体等)都有自己的花括号级别,并且必须在同一级别的相邻花括号实体之间写入分隔符。

如果元素值为空字符串、包含花括号、分隔符字符、双引号、反斜杠或空格,或者与单词 NULL 匹配,则数组输出例程将在元素值周围加上双引号。嵌入在元素值中的双引号和反斜杠将被反斜杠转义。对于数字数据类型,可以安全地假设永远不会出现双引号,但对于文本数据类型,应该准备好应对引号的存在或不存在。

默认情况下,数组维度的下界索引值设置为 1。要表示具有其他下界的数组,可以在写入数组内容之前显式指定数组下标范围。此修饰包括每个数组维度的下界和上界周围的方括号([]),以及它们之间的冒号(:)分隔符字符。数组维度修饰后跟一个等号(=)。例如

SELECT f1[1][-2][3] AS e1, f1[1][-1][5] AS e2
 FROM (SELECT '[1:1][-2:-1][3:5]={{{1,2,3},{4,5,6}}}'::int[] AS f1) AS ss;

 e1 | e2
----+----
  1 |  6
(1 row)

只有当存在一个或多个与 1 不同的下界时,数组输出例程才会在其结果中包含显式维度。

如果为元素写入的值为 NULL(在任何情况变体中),则该元素将被视为 NULL。任何引号或反斜杠的存在都会禁用此功能,并允许输入文字字符串值NULL。此外,为了与 8.2 之前的 PostgreSQL 版本向后兼容,可以将 array_nulls 配置参数设置为 off 以抑制识别 NULL 为 NULL。

如前所示,在编写数组值时,可以在任何单个数组元素周围使用双引号。如果元素值会导致数组值解析器混淆,则必须这样做。例如,包含花括号、逗号(或数据类型的分隔符字符)、双引号、反斜杠或前导或尾随空格的元素必须用双引号括起来。空字符串和与单词 NULL 匹配的字符串也必须用引号括起来。要在带引号的数组元素值中添加双引号或反斜杠,请在其前面加上反斜杠。或者,您可以避免使用引号并使用反斜杠转义来保护所有原本会被视为数组语法的字符。

您可以在左括号之前或右括号之后添加空格。您也可以在任何单个项目字符串之前或之后添加空格。在所有这些情况下,空格都将被忽略。但是,双引号元素内的空格或元素两侧都由非空格字符包围的空格不会被忽略。

提示

ARRAY 构造语法(请参阅第 4.2.12 节)在 SQL 命令中编写数组值时,通常比数组文字语法更容易使用。在 ARRAY 中,各个元素值以与它们不是数组成员时相同的方式写入。

提交更正

如果您在文档中看到任何不正确的内容、与您对特定功能的体验不符或需要进一步说明的内容,请使用此表单 报告文档问题。