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

INSERT

INSERT — 在表中创建新行

概要

[ WITH [ RECURSIVE ] with_query [, ...] ]
INSERT INTO table_name [ AS alias ] [ ( column_name [, ...] ) ]
    [ OVERRIDING { SYSTEM | USER } VALUE ]
    { DEFAULT VALUES | VALUES ( { expression | DEFAULT } [, ...] ) [, ...] | query }
    [ ON CONFLICT [ conflict_target ] conflict_action ]
    [ RETURNING { * | output_expression [ [ AS ] output_name ] } [, ...] ]

where conflict_target can be one of:

    ( { index_column_name | ( index_expression ) } [ COLLATE collation ] [ opclass ] [, ...] ) [ WHERE index_predicate ]
    ON CONSTRAINT constraint_name

and conflict_action is one of:

    DO NOTHING
    DO UPDATE SET { column_name = { expression | DEFAULT } |
                    ( column_name [, ...] ) = [ ROW ] ( { expression | DEFAULT } [, ...] ) |
                    ( column_name [, ...] ) = ( sub-SELECT )
                  } [, ...]
              [ WHERE condition ]

描述

INSERT 将新行插入到表中。可以使用值表达式指定一行或多行,或者使用查询生成零行或多行。

目标列名可以按任意顺序列出。如果根本没有列出列名,则默认为表的全部列,并按其声明顺序排列;或者前 N 个列名,如果 VALUES 子句或 query 只提供了 N 个列。由 VALUES 子句或 query 提供的值将从左到右与显式或隐式列列表相关联。

每个不在显式或隐式列列表中的列都将填充默认值,无论是其声明的默认值,还是如果没有则为 null。

如果任何列的表达式的数据类型不正确,则将尝试自动类型转换。

INSERT 到缺少唯一索引的表的操作不会被并发活动阻塞。如果并发会话执行锁定或修改与正在插入的唯一索引值匹配的行,则具有唯一索引的表可能会被阻塞;详细信息在第 62.5 节中介绍。可以使用 ON CONFLICT 指定替代操作,而不是引发唯一约束或排除约束违规错误。(请参见下面的ON CONFLICT 子句。)

可选的 RETURNING 子句导致 INSERT 计算并返回基于实际插入的每一行(或更新,如果使用了 ON CONFLICT DO UPDATE 子句)的值。这主要用于获取由默认值提供的值,例如序列号。但是,允许使用表的列的任何表达式。 RETURNING 列表的语法与 SELECT 的输出列表相同。仅返回成功插入或更新的行。例如,如果一行被锁定但未更新,因为 ON CONFLICT DO UPDATE ... WHERE 子句的 condition 不满足,则不会返回该行。

您必须对表具有 INSERT 权限才能向其中插入数据。如果存在 ON CONFLICT DO UPDATE,则还需要对表具有 UPDATE 权限。

如果指定了列列表,则您只需要对列出的列具有 INSERT 权限。类似地,当指定 ON CONFLICT DO UPDATE 时,您只需要对列出要更新的列具有 UPDATE 权限。但是, ON CONFLICT DO UPDATE 也需要对在 ON CONFLICT DO UPDATE 表达式或 condition 中读取值的任何列具有 SELECT 权限。

使用 RETURNING 子句需要对 RETURNING 中提到的所有列具有 SELECT 权限。如果您使用 query 子句从查询中插入行,则当然需要对查询中使用的任何表或列具有 SELECT 权限。

参数

插入

本节介绍仅在插入新行时可能使用的参数。仅与 ON CONFLICT 子句一起使用的参数在单独的部分中描述。

with_query

WITH 子句允许您指定一个或多个子查询,这些子查询可以在 INSERT 查询中按名称引用。有关详细信息,请参见第 7.8 节SELECT

querySELECT 语句)也可能包含 WITH 子句。在这种情况下,两个 with_query 集都可以在 query 中引用,但第二个集优先,因为它嵌套得更紧密。

table_name

现有表的名称(可以选择模式限定)。

alias

table_name 的替代名称。当提供别名时,它会完全隐藏表的实际名称。当 ON CONFLICT DO UPDATE 针对名为 excluded 的表时,这特别有用,因为否则它将被视为表示建议插入行的特殊表的名称。

column_name

table_name 指定的表中列的名称。如果需要,列名可以使用子字段名或数组下标进行限定。(仅插入复合列的某些字段会将其他字段保留为 null。)当使用 ON CONFLICT DO UPDATE 引用列时,请不要在目标列的规范中包含表的名称。例如,INSERT INTO table_name ... ON CONFLICT DO UPDATE SET table_name.col = 1 无效(这遵循 UPDATE 的常规行为)。

OVERRIDING SYSTEM VALUE

如果指定了此子句,则为标识列提供的任何值都将覆盖默认的序列生成值。

对于定义为 GENERATED ALWAYS 的标识列,在不指定 OVERRIDING SYSTEM VALUEOVERRIDING USER VALUE 的情况下插入显式值(DEFAULT 除外)是一个错误。(对于定义为 GENERATED BY DEFAULT 的标识列,OVERRIDING SYSTEM VALUE 是正常行为,指定它不会产生任何影响,但PostgreSQL 允许它作为扩展。)

OVERRIDING USER VALUE

如果指定了此子句,则为标识列提供的任何值都将被忽略,并将应用默认的序列生成值。

例如,当在表之间复制值时,此子句很有用。编写 INSERT INTO tbl2 OVERRIDING USER VALUE SELECT * FROM tbl1 将从 tbl1 复制所有不是 tbl2 中标识列的列,而 tbl2 中标识列的值将由与 tbl2 关联的序列生成。

DEFAULT VALUES

所有列都将填充其默认值,就像对每个列都显式指定了 DEFAULT 一样。(在此表单中不允许使用 OVERRIDING 子句。)

expression

要分配给相应列的表达式或值。

DEFAULT

相应列将填充其默认值。标识列将填充由关联序列生成的新值。对于生成的列,允许指定此值,但这仅仅指定了根据其生成表达式计算列的正常行为。

query

提供要插入行的查询(SELECT 语句)。有关语法的说明,请参阅SELECT语句。

output_expression

要计算并在插入或更新每一行后由 INSERT 命令返回的表达式。该表达式可以使用由 table_name 指定的表的任何列名。编写 * 以返回插入或更新的行(s)的所有列。

output_name

要用于返回列的名称。

ON CONFLICT 子句

可选的 ON CONFLICT 子句指定替代操作,而不是引发唯一约束或排除约束违规错误。对于建议插入的每一行,要么插入操作继续进行,要么如果 conflict_target 指定的仲裁者约束或索引被违反,则采取替代 conflict_actionON CONFLICT DO NOTHING 只是避免插入行作为其替代操作。 ON CONFLICT DO UPDATE 更新与建议插入的行冲突的现有行作为其替代操作。

conflict_target 可以执行唯一索引推断。在执行推断时,它由一个或多个 index_column_name 列和/或 index_expression 表达式以及可选的 index_predicate 组成。所有 table_name 唯一索引,无论顺序如何,都精确包含 conflict_target 指定的列/表达式,都会被推断(选择)为仲裁索引。如果指定了 index_predicate,则它必须作为推断的进一步要求来满足仲裁索引。请注意,这意味着如果存在满足所有其他条件的非部分唯一索引(没有谓词的唯一索引),则会推断(并因此由 ON CONFLICT 使用)该索引。如果推断尝试不成功,则会引发错误。

ON CONFLICT DO UPDATE 保证原子性的 INSERTUPDATE 操作结果;只要没有独立的错误,即使在高并发情况下,这两个结果之一也得到保证。这也被称为 UPSERT更新或插入

冲突目标

通过选择 仲裁索引,指定 ON CONFLICT 对哪些冲突采取替代操作。要么执行 唯一索引推断,要么显式命名约束。对于 ON CONFLICT DO NOTHING,可以选择指定 conflict_target;如果省略,则处理与所有可用约束(和唯一索引)的冲突。对于 ON CONFLICT DO UPDATEconflict_target 必须提供。

冲突操作

conflict_action 指定一个替代的 ON CONFLICT 操作。它可以是 DO NOTHING,或者是一个 DO UPDATE 子句,该子句指定在发生冲突时要执行的 UPDATE 操作的精确细节。 ON CONFLICT DO UPDATE 中的 SETWHERE 子句可以访问使用表名(或别名)的现有行,以及使用特殊 excluded 表提出的要插入的行。在目标表中,如果读取相应的 excluded 列,则需要 SELECT 权限。

请注意,所有每行 BEFORE INSERT 触发器的效果都反映在 excluded 值中,因为这些效果可能导致该行被排除在插入之外。

索引列名

table_name 列的名称。用于推断仲裁索引。遵循 CREATE INDEX 格式。需要 index_column_nameSELECT 权限。

索引表达式

类似于 index_column_name,但用于推断出现在索引定义中(而不是简单列)的 table_name 列上的表达式。遵循 CREATE INDEX 格式。需要出现在 index_expression 中的任何列的 SELECT 权限。

排序规则

如果指定,则强制相应的 index_column_nameindex_expression 使用特定的排序规则才能在推断期间匹配。通常省略此项,因为排序规则通常不会影响是否发生约束违规。遵循 CREATE INDEX 格式。

操作符类

如果指定,则强制相应的 index_column_nameindex_expression 使用特定的操作符类才能在推断期间匹配。通常省略此项,因为 相等性语义通常在类型的操作符类之间是等价的,或者因为相信已定义的唯一索引具有相关的相等性定义就足够了。遵循 CREATE INDEX 格式。

索引谓词

用于允许推断部分唯一索引。任何满足谓词的索引(不一定实际上是部分索引)都可以被推断。遵循 CREATE INDEX 格式。需要出现在 index_predicate 中的任何列的 SELECT 权限。

约束名

通过名称显式指定仲裁 约束,而不是推断约束或索引。

条件

返回类型为 boolean 的值的表达式。只有此表达式返回 true 的行才会被更新,尽管在采取 ON CONFLICT DO UPDATE 操作时所有行都会被锁定。请注意,condition 是最后评估的,在冲突被识别为更新候选项之后。

请注意,排除约束不支持作为 ON CONFLICT DO UPDATE 的仲裁者。在所有情况下,仅支持 NOT DEFERRABLE 约束和唯一索引作为仲裁者。

INSERT 带有 ON CONFLICT DO UPDATE 子句是一个 确定性 语句。这意味着不允许该命令影响任何单个现有行多次;当出现这种情况时,将引发基数违规错误。就仲裁索引或约束约束的属性而言,提出的要插入的行不应相互重复。

请注意,目前不支持将应用于分区表的 INSERTON CONFLICT DO UPDATE 子句更新冲突行的分区键,以至于需要将该行移动到新的分区。

提示

通常最好使用唯一索引推断,而不是使用 ON CONFLICT ON CONSTRAINT constraint_name 直接命名约束。当底层索引被另一个或多或少等效的索引以重叠的方式替换时,例如在删除被替换的索引之前使用 CREATE UNIQUE INDEX ... CONCURRENTLY 时,推断将继续正常工作。

输出

成功完成时,INSERT 命令返回以下形式的命令标记

INSERT oid count

count 是插入或更新的行数。oid 始终为 0(它曾经是OID如果 count 恰好为 1 且目标表声明为 WITH OIDS,则分配给插入行的值,否则为 0,但不再支持创建 WITH OIDS 表)。

如果 INSERT 命令包含 RETURNING 子句,则结果将类似于包含在 RETURNING 列表中定义的列和值的 SELECT 语句的结果,该语句计算在命令插入或更新的行上。

注释

如果指定的表是分区表,则每行都会路由到相应的分区并插入其中。如果指定的表是分区,则如果其中一个输入行违反了分区约束,则会发生错误。

您可能还想考虑使用 MERGE,因为它允许在一个语句中混合使用 INSERTUPDATEDELETE。请参阅 MERGE

示例

将一行插入表 films

INSERT INTO films VALUES
    ('UA502', 'Bananas', 105, '1971-07-13', 'Comedy', '82 minutes');

在此示例中,len 列被省略,因此它将具有默认值

INSERT INTO films (code, title, did, date_prod, kind)
    VALUES ('T_601', 'Yojimbo', 106, '1961-06-16', 'Drama');

此示例对日期列使用 DEFAULT 子句,而不是指定值

INSERT INTO films VALUES
    ('UA502', 'Bananas', 105, DEFAULT, 'Comedy', '82 minutes');
INSERT INTO films (code, title, did, date_prod, kind)
    VALUES ('T_601', 'Yojimbo', 106, DEFAULT, 'Drama');

要插入完全由默认值组成的行

INSERT INTO films DEFAULT VALUES;

要使用多行 VALUES 语法插入多行

INSERT INTO films (code, title, did, date_prod, kind) VALUES
    ('B6717', 'Tampopo', 110, '1985-02-10', 'Comedy'),
    ('HG120', 'The Dinner Game', 140, DEFAULT, 'Comedy');

此示例将一些行从具有与 films 相同列布局的表 tmp_films 插入到表 films

INSERT INTO films SELECT * FROM tmp_films WHERE date_prod < '2004-05-07';

此示例插入数组列

-- Create an empty 3x3 gameboard for noughts-and-crosses
INSERT INTO tictactoe (game, board[1:3][1:3])
    VALUES (1, '{{" "," "," "},{" "," "," "},{" "," "," "}}');
-- The subscripts in the above example aren't really needed
INSERT INTO tictactoe (game, board)
    VALUES (2, '{{X," "," "},{" ",O," "},{" ",X," "}}');

将一行插入表 distributors 中,返回由 DEFAULT 子句生成的序列号

INSERT INTO distributors (did, dname) VALUES (DEFAULT, 'XYZ Widgets')
   RETURNING did;

增加管理 Acme Corporation 帐户的销售人员的销售计数,并将整个更新的行以及当前时间记录到日志表中

WITH upd AS (
  UPDATE employees SET sales_count = sales_count + 1 WHERE id =
    (SELECT sales_person FROM accounts WHERE name = 'Acme Corporation')
    RETURNING *
)
INSERT INTO employees_log SELECT *, current_timestamp FROM upd;

根据需要插入或更新新的分销商。假设已定义一个唯一索引,该索引约束出现在 did 列中的值。请注意,特殊 excluded 表用于引用最初提出的要插入的值

INSERT INTO distributors (did, dname)
    VALUES (5, 'Gizmo Transglobal'), (6, 'Associated Computing, Inc')
    ON CONFLICT (did) DO UPDATE SET dname = EXCLUDED.dname;

插入分销商,或者对于在现有排除行(在 before row insert 触发器触发后具有匹配约束列或列的行)存在时提出的要插入的行,不执行任何操作。示例假设已定义一个唯一索引,该索引约束出现在 did 列中的值

INSERT INTO distributors (did, dname) VALUES (7, 'Redline GmbH')
    ON CONFLICT (did) DO NOTHING;

根据需要插入或更新新的分销商。示例假设已定义一个唯一索引,该索引约束出现在 did 列中的值。 WHERE 子句用于限制实际更新的行(尽管任何未更新的现有行仍将被锁定)。

-- Don't update existing distributors based in a certain ZIP code
INSERT INTO distributors AS d (did, dname) VALUES (8, 'Anvil Distribution')
    ON CONFLICT (did) DO UPDATE
    SET dname = EXCLUDED.dname || ' (formerly ' || d.dname || ')'
    WHERE d.zipcode <> '21201';

-- Name a constraint directly in the statement (uses associated
-- index to arbitrate taking the DO NOTHING action)
INSERT INTO distributors (did, dname) VALUES (9, 'Antwerp Design')
    ON CONFLICT ON CONSTRAINT distributors_pkey DO NOTHING;

如果可能,插入新的分销商;否则 DO NOTHING。示例假设已在 is_active 布尔列计算结果为 true 的行的子集上定义了一个唯一索引,该索引约束出现在 did 列中的值。

-- This statement could infer a partial unique index on "did"
-- with a predicate of "WHERE is_active", but it could also
-- just use a regular unique constraint on "did"
INSERT INTO distributors (did, dname) VALUES (10, 'Conrad International')
    ON CONFLICT (did) WHERE is_active DO NOTHING;

兼容性

INSERT 符合 SQL 标准,除了 RETURNING 子句是 PostgreSQL 扩展,以及能够使用 WITHINSERT,以及能够使用 ON CONFLICT 指定替代操作。此外,标准不允许省略列名列表但并非所有列都从 VALUES 子句或 query 中填充的情况。如果您更喜欢比 ON CONFLICT 更符合 SQL 标准的语句,请参阅 MERGE

SQL 标准规定,只有在始终存在生成的标识列时才能指定 OVERRIDING SYSTEM VALUE。PostgreSQL 在任何情况下都允许该子句,如果它不适用则忽略它。

query 子句的可能限制在 SELECT 中有说明。

提交更正

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