Movatterモバイル変換

CREATE PUBLICATION

CREATE PUBLICATION — define a new publication

Synopsis

CREATE PUBLICATIONname    [ FOR ALL TABLES      | FORpublication_object [, ... ] ]    [ WITH (publication_parameter [=value] [, ... ] ) ]wherepublication_object is one of:    TABLE [ ONLY ]table_name [ * ] [ (column_name [, ... ] ) ] [ WHERE (expression ) ] [, ... ]    TABLES IN SCHEMA {schema_name | CURRENT_SCHEMA } [, ... ]

Description

CREATE PUBLICATION adds a new publication into the current database. The publication name must be distinct from the name of any existing publication in the current database.

A publication is essentially a group of tables whose data changes are intended to be replicated through logical replication. SeeSection 28.1 for details about how publications fit into the logical replication setup.

Parameters

When specifying a parameter of typeboolean, the=value part can be omitted, which is equivalent to specifyingTRUE.

Notes

IfFOR TABLE,FOR ALL TABLES orFOR TABLES IN SCHEMA are not specified, then the publication starts out with an empty set of tables. That is useful if tables or schemas are to be added later.

The creation of a publication does not start replication. It only defines a grouping and filtering logic for future subscribers.

To create a publication, the invoking user must have theCREATE privilege for the current database. (Of course, superusers bypass this check.)

To add a table to a publication, the invoking user must have ownership rights on the table. TheFOR ALL TABLES andFOR TABLES IN SCHEMA clauses require the invoking user to be a superuser.

The tables added to a publication that publishesUPDATE and/orDELETE operations must haveREPLICA IDENTITY defined. Otherwise those operations will be disallowed on those tables.

Any column list must include theREPLICA IDENTITY columns in order forUPDATE orDELETE operations to be published. There are no column list restrictions if the publication publishes onlyINSERT operations.

A row filter expression (i.e., theWHERE clause) must contain only columns that are covered by theREPLICA IDENTITY, in order forUPDATE andDELETE operations to be published. For publication ofINSERT operations, any column may be used in theWHERE expression. The row filter allows simple expressions that don't have user-defined functions, user-defined operators, user-defined types, user-defined collations, non-immutable built-in functions, or references to system columns.

The row filter on a table becomes redundant ifFOR TABLES IN SCHEMA is specified and the table belongs to the referred schema.

For published partitioned tables, the row filter for each partition is taken from the published partitioned table if the publication parameterpublish_via_partition_root is true, or from the partition itself if it is false (the default). SeeSection 28.4 for details about row filters. Similarly, for published partitioned tables, the column list for each partition is taken from the published partitioned table if the publication parameterpublish_via_partition_root is true, or from the partition itself if it is false.

For anINSERT ... ON CONFLICT command, the publication will publish the operation that results from the command. Depending on the outcome, it may be published as eitherINSERT orUPDATE, or it may not be published at all.

For aMERGE command, the publication will publish anINSERT,UPDATE, orDELETE for each row inserted, updated, or deleted.

ATTACHing a table into a partition tree whose root is published using a publication withpublish_via_partition_root set totrue does not result in the table's existing contents being replicated.

COPY ... FROM commands are published asINSERT operations.

DDL operations are not published.

TheWHERE clause expression is executed with the role used for the replication connection.

Examples

Create a publication that publishes all changes in two tables:

CREATE PUBLICATION mypublication FOR TABLE users, departments;

Create a publication that publishes all changes from active departments:

CREATE PUBLICATION active_departments FOR TABLE departments WHERE (active IS TRUE);

Create a publication that publishes all changes in all tables:

CREATE PUBLICATION alltables FOR ALL TABLES;

Create a publication that only publishesINSERT operations in one table:

CREATE PUBLICATION insert_only FOR TABLE mydata    WITH (publish = 'insert');

Create a publication that publishes all changes for tablesusers,departments and all changes for all the tables present in the schemaproduction:

CREATE PUBLICATION production_publication FOR TABLE users, departments, TABLES IN SCHEMA production;

Create a publication that publishes all changes for all the tables present in the schemasmarketing andsales:

CREATE PUBLICATION sales_publication FOR TABLES IN SCHEMA marketing, sales;

Create a publication that publishes all changes for tableusers, but replicates only columnsuser_id andfirstname:

CREATE PUBLICATION users_filtered FOR TABLE users (user_id, firstname);

Compatibility

CREATE PUBLICATION is aPostgres Pro extension.

See Also