Wiki / Logical Decoding Plugins
test_decoding
A test and example output plugin that renders logical changes in a textual format.
Reading PG 18·Select a recorded version
- Interface family
- Logical-decoding output plugin
- Handler or routine
- _PG_output_plugin_init
- Recorded callbacks
- 21
- evidence kind
- source and documentation
- manual path
- /docs/18/test-decoding.html
- runtime verified
- false
Definition PG 18
F.45. test_decoding — SQL-based test/example module for WAL logical decoding
test_decoding is an example of a logical decoding output plugin. It doesn't do anything especially useful, but can serve as a starting point for developing your own output plugin.
test_decoding receives WAL through the logical decoding mechanism and decodes it into text representations of the operations performed.
Typical output from this plugin, used over the SQL logical decoding interface, might be:
postgres=# SELECT * FROM pg_logical_slot_get_changes('test_slot', NULL, NULL, 'include-xids', '0');
lsn | xid | data
-----------+-----+--------------------------------------------------
0/16D30F8 | 691 | BEGIN
0/16D32A0 | 691 | table public.data: INSERT: id[int4]:2 data[text]:'arg'
0/16D32A0 | 691 | table public.data: INSERT: id[int4]:3 data[text]:'demo'
0/16D32A0 | 691 | COMMIT
0/16D32D8 | 692 | BEGIN
0/16D3398 | 692 | table public.data: DELETE: id[int4]:2
0/16D3398 | 692 | table public.data: DELETE: id[int4]:3
0/16D3398 | 692 | COMMIT
(8 rows)
We can also get the changes of the in-progress transaction, and the typical output might be:
postgres[33712]=#* SELECT * FROM pg_logical_slot_get_changes('test_slot', NULL, NULL, 'stream-changes', '1');
lsn | xid | data
-----------+-----+--------------------------------------------------
0/16B21F8 | 503 | opening a streamed block for transaction TXN 503
0/16B21F8 | 503 | streaming change for TXN 503
0/16B2300 | 503 | streaming change for TXN 503
0/16B2408 | 503 | streaming change for TXN 503
0/16BEBA0 | 503 | closing a streamed block for transaction TXN 503
0/16B21F8 | 503 | opening a streamed block for transaction TXN 503
0/16BECA8 | 503 | streaming change for TXN 503
0/16BEDB0 | 503 | streaming change for TXN 503
0/16BEEB8 | 503 | streaming change for TXN 503
0/16BEBA0 | 503 | closing a streamed block for transaction TXN 503
(10 rows)
Registered interface handlers
| Interface operation | Source observation | Callback | Implementation |
|---|---|---|---|
| Begin transaction | Handler registered; conditions apply | begin_cb | pg_decode_begin_txn |
| Row changes | Handler registered; conditions apply | change_cb | pg_decode_change |
| Commit | Handler registered; conditions apply | commit_cb | pg_decode_commit_txn |
| TRUNCATE | Handler registered; conditions apply | truncate_cb | pg_decode_truncate |
| Logical messages | Handler registered; conditions apply | message_cb | pg_decode_message |
| Start streamed transaction | Handler registered; conditions apply | stream_start_cb | pg_decode_stream_start |
| Stream row changes | Handler registered; conditions apply | stream_change_cb | pg_decode_stream_change |
| Prepare transaction | Handler registered; conditions apply | prepare_cb | pg_decode_prepare_txn |
| Commit prepared | Handler registered; conditions apply | commit_prepared_cb | pg_decode_commit_prepared_txn |
| Rollback prepared | Handler registered; conditions apply | rollback_prepared_cb | pg_decode_rollback_prepared_txn |
Option names recognized by this plugin build
| Source option name |
|---|
| force-binary |
| include-rewrites |
| include-timestamp |
| include-xids |
| only-local |
| skip-empty-xacts |
| stream-changes |
Compare versions
Complete source facts
callbacks
{"begin_cb":"pg_decode_begin_txn","begin_prepare_cb":"pg_decode_begin_prepare_txn","change_cb":"pg_decode_change","commit_cb":"pg_decode_commit_txn","commit_prepared_cb":"pg_decode_commit_prepared_txn","filter_by_origin_cb":"pg_decode_filter","filter_prepare_cb":"pg_decode_filter_prepare","message_cb":"pg_decode_message","prepare_cb":"pg_decode_prepare_txn","rollback_prepared_cb":"pg_decode_rollback_prepared_txn","shutdown_cb":"pg_decode_shutdown","startup_cb":"pg_decode_startup","stream_abort_cb":"pg_decode_stream_abort","stream_change_cb":"pg_decode_stream_change","stream_commit_cb":"pg_decode_stream_commit","stream_message_cb":"pg_decode_stream_message","stream_prepare_cb":"pg_decode_stream_prepare","stream_start_cb":"pg_decode_stream_start","stream_stop_cb":"pg_decode_stream_stop","stream_truncate_cb":"pg_decode_stream_truncate","truncate_cb":"pg_decode_truncate"}Source references
Full definition and evidence JSON
Definition sources
center · PostgreSQL 18 · 555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f
Text language: en · 555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f