Movatterモバイル変換

INSERT

INSERT — create new rows in a table

Synopsis

[ WITH [ RECURSIVE ]with_query [, ...] ]INSERT INTOtable_name [ ASalias ] [ (column_name [, ...] ) ]    [ OVERRIDING { SYSTEM | USER } VALUE ]    { DEFAULT VALUES | VALUES ( {expression | DEFAULT } [, ...] ) [, ...] |query }    [ ON CONFLICT [conflict_target ]conflict_action ]    [ RETURNING { * |output_expression [ [ AS ]output_name ] } [, ...] ]whereconflict_target can be one of:    ( {index_column_name | (index_expression ) } [ COLLATEcollation ] [opclass ] [, ...] ) [ WHEREindex_predicate ]    ON CONSTRAINTconstraint_nameandconflict_action is one of:    DO NOTHING    DO UPDATE SET {column_name = {expression | DEFAULT } |                    (column_name [, ...] ) = [ ROW ] ( {expression | DEFAULT } [, ...] ) |                    (column_name [, ...] ) = (sub-SELECT )                  } [, ...]              [ WHEREcondition ]

Description

INSERT inserts new rows into a table. One can insert one or more rows specified by value expressions, or zero or more rows resulting from a query.

The target column names can be listed in any order. If no list of column names is given at all, the default is all the columns of the table in their declared order; or the firstN column names, if there are onlyN columns supplied by theVALUES clause orquery. The values supplied by theVALUES clause orquery are associated with the explicit or implicit column list left-to-right.

Each column not present in the explicit or implicit column list will be filled with a default value, either its declared default value or null if there is none.

If the expression for any column is not of the correct data type, automatic type conversion will be attempted.

INSERT into tables that lack unique indexes will not be blocked by concurrent activity. Tables with unique indexes might block if concurrent sessions perform actions that lock or modify rows matching the unique index values being inserted; the details are covered inSection 60.5.ON CONFLICT can be used to specify an alternative action to raising a unique constraint or exclusion constraint violation error. (SeeON CONFLICT Clause below.)

The optionalRETURNING clause causesINSERT to compute and return value(s) based on each row actually inserted (or updated, if anON CONFLICT DO UPDATE clause was used). This is primarily useful for obtaining values that were supplied by defaults, such as a serial sequence number. However, any expression using the table's columns is allowed. The syntax of theRETURNING list is identical to that of the output list ofSELECT. Only rows that were successfully inserted or updated will be returned. For example, if a row was locked but not updated because anON CONFLICT DO UPDATE ... WHERE clausecondition was not satisfied, the row will not be returned.

You must haveINSERT privilege on a table in order to insert into it. IfON CONFLICT DO UPDATE is present,UPDATE privilege on the table is also required.

If a column list is specified, you only needINSERT privilege on the listed columns. Similarly, whenON CONFLICT DO UPDATE is specified, you only needUPDATE privilege on the column(s) that are listed to be updated. However,ON CONFLICT DO UPDATE also requiresSELECT privilege on any column whose values are read in theON CONFLICT DO UPDATE expressions orcondition.

Use of theRETURNING clause requiresSELECT privilege on all columns mentioned inRETURNING. If you use thequery clause to insert rows from a query, you of course need to haveSELECT privilege on any table or column used in the query.

Parameters

Outputs

On successful completion, anINSERT command returns a command tag of the form

INSERToidcount

Thecount is the number of rows inserted or updated.oid is always 0 (it used to be theOID assigned to the inserted row ifcount was exactly one and the target table was declaredWITH OIDS and 0 otherwise, but creating a tableWITH OIDS is not supported anymore).

If theINSERT command contains aRETURNING clause, the result will be similar to that of aSELECT statement containing the columns and values defined in theRETURNING list, computed over the row(s) inserted or updated by the command.

Notes

If the specified table is a partitioned table, each row is routed to the appropriate partition and inserted into it. If the specified table is a partition, an error will occur if one of the input rows violates the partition constraint.

You may also wish to consider usingMERGE, since that allows mixingINSERT,UPDATE, andDELETE within a single statement. SeeMERGE.

Examples

Insert a single row into tablefilms:

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

In this example, thelen column is omitted and therefore it will have the default value:

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

This example uses theDEFAULT clause for the date columns rather than specifying a value:

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');

To insert a row consisting entirely of default values:

INSERT INTO films DEFAULT VALUES;

To insert multiple rows using the multirowVALUES syntax:

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

This example inserts some rows into tablefilms from a tabletmp_films with the same column layout asfilms:

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

This example inserts into array columns:

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

Insert a single row into tabledistributors, returning the sequence number generated by theDEFAULT clause:

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

Increment the sales count of the salesperson who manages the account for Acme Corporation, and record the whole updated row along with current time in a log table:

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;

Insert or update new distributors as appropriate. Assumes a unique index has been defined that constrains values appearing in thedid column. Note that the specialexcluded table is used to reference values originally proposed for insertion:

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

Insert a distributor, or do nothing for rows proposed for insertion when an existing, excluded row (a row with a matching constrained column or columns after before row insert triggers fire) exists. Example assumes a unique index has been defined that constrains values appearing in thedid column:

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

Insert or update new distributors as appropriate. Example assumes a unique index has been defined that constrains values appearing in thedid column.WHERE clause is used to limit the rows actually updated (any existing row not updated will still be locked, though):

-- Don't update existing distributors based in a certain ZIP codeINSERT 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;

Insert new distributor if possible; otherwiseDO NOTHING. Example assumes a unique index has been defined that constrains values appearing in thedid column on a subset of rows where theis_active Boolean column evaluates totrue:

-- 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;

Compatibility

INSERT conforms to the SQL standard, except that theRETURNING clause is aPostgres Pro extension, as is the ability to useWITH withINSERT, and the ability to specify an alternative action withON CONFLICT. Also, the case in which a column name list is omitted, but not all the columns are filled from theVALUES clause orquery, is disallowed by the standard. If you prefer a more SQL standard conforming statement thanON CONFLICT, seeMERGE.

The SQL standard specifies thatOVERRIDING SYSTEM VALUE can only be specified if an identity column that is generated always exists. Postgres Pro allows the clause in any case and ignores it if it is not applicable.

Possible limitations of thequery clause are documented underSELECT.