Chapter 51. Logical Decoding

Table of Contents

51.1. Logical Decoding Examples
51.2. Logical Decoding Concepts
51.2.1. Logical Decoding
51.2.2. Replication Slots
51.2.3. Output Plugins
51.2.4. Exported Snapshots
51.3. Streaming Replication Protocol Interface
51.4. Logical Decoding SQL Interface
51.5. System Catalogs Related to Logical Decoding
51.6. Logical Decoding Output Plugins
51.6.1. Initialization Function
51.6.2. Capabilities
51.6.3. Output Modes
51.6.4. Output Plugin Callbacks
51.6.5. Functions for Producing Output
51.7. Logical Decoding Output Writers
51.8. Synchronous Replication Support for Logical Decoding
51.8.1. Overview
51.8.2. Caveats
51.9. Streaming of Large Transactions for Logical Decoding
51.10. Two-phase Commit Support for Logical Decoding

PostgreSQL provides infrastructure to stream the modifications performed via SQL to external consumers. This functionality can be used for a variety of purposes, including replication solutions and auditing.

Changes are sent out in streams identified by logical replication slots.

The format in which those changes are streamed is determined by the output plugin used. An example plugin is provided in the PostgreSQL distribution. Additional plugins can be written to extend the choice of available formats without modifying any core code. Every output plugin has access to each individual new row produced by INSERT and the new row version created by UPDATE. Availability of old row versions for UPDATE and DELETE depends on the configured replica identity (see REPLICA IDENTITY).

Changes can be consumed either using the streaming replication protocol (see Section 57.4 and Section 51.3), or by calling functions via SQL (see Section 51.4). It is also possible to write additional methods of consuming the output of a replication slot without modifying core code (see Section 51.7).