Fork me on GitHub

Warning: This documentation is for a pre-release version of pgAdmin 4

Publication Dialog

Logical replication uses a publish and subscribe model with one or more subscribers subscribing to one or more publications on a publisher node.

Use the publication dialog to create a publication. A publication is a set of changes generated from a table or a group of tables or a schema or a group of schemas, and might also be described as a change set or replication set.

The publication dialog organizes the development of a publication through the following dialog tabs: General, Tables and Options. The SQL tab displays the SQL code generated by dialog selections.

Publication dialog general tab

Use the fields in the General tab to identify the publication:

  • Use the Name field to add a descriptive name for the publication. The name will be displayed in the pgAdmin tree control.

  • The Owner field takes the name of the user automatically as current connected user. You can change the owner after creating publication using alter publication.

Click the Tables tab to continue.

Tables tab for PostgreSQL version <= 14

Publication dialog definition tab

Tables tab for PostgreSQL version >= 15

Publication dialog definition tab

Use the Tables tab to set table properties for the publication:

  • Move the switch next to All tables? to Yes to replicate all the tables of the database, including tables created in the future.

  • Move the switch next to Only table? to Yes to replicate only the listed tables excluding all its descendant tables.

  • Specify a table or list of tables separated by a comma in Tables field to replicate all the listed table. With PostgreSQL 15 forward, specify a table or list of tables to replicate all the listed tables along with specific columns and/or WHERE clause to filter rows.

  • With PostgreSQL 15 forward, specify a schema or list of schemas separated by a comma in Tables In Schema field to replicate all the listed schemas. This field will be disabled if any columns are selected for tables.

Click the Options tab to continue.

Publication dialog options tab

Use the Options tab to set option properties for the publication:

  • Use the With section to determine which DML operations will be published by the new publication to the subscribers. Move the switch next to INSERT, UPDATE, DELETE, or TRUNCATE to No if you do not want to replicate any of these DML operations from Publication to Subscription. By default, all the switches are set to Yes allowing all the DML operations.

Note

A published table must have a “replica identity” configured in order to be able to replicate UPDATE and DELETE operations. You can change with ALTER TABLE statement. For more information on replica identity see Logical Replication Publication.

Click the SQL tab to continue.

Your entries in the Publication dialog generate a SQL command (see an example below). Use the SQL tab for review; revisit or switch tabs to make any changes to the SQL command.

Example

The following is an example of the sql command generated by user selections in the Publication dialog:

Publication dialog sql tab

The example creates a publication named pub1 that is owned by postgres. It allows replication of all the DML operations.

  • Click the Info button (i) to access online help.

  • Click the Save button to save work.

  • Click the Close button to exit without saving work.

  • Click the Reset button to restore all the default settings.