summaryrefslogtreecommitdiff
path: root/doc/src/sgml/logicaldecoding.sgml
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2017-02-15 18:15:47 -0500
committerTom Lane <tgl@sss.pgh.pa.us>2017-02-15 18:15:47 -0500
commitc3b5cfe33cda6e28bbdc75534706c1a00a9e6c4b (patch)
tree04c25b70ffdec00f388c26f98ebb783dc1f48be9 /doc/src/sgml/logicaldecoding.sgml
parent19c324d9fb4d59db1d0c3e8865356fb6867dc35e (diff)
Formatting and docs corrections for logical decoding output plugins.
Make the typedefs for output plugins consistent with project style; they were previously not even consistent with each other as to layout or inclusion of parameter names. Make the documentation look the same, and fix errors therein (missing and misdescribed parameters). Back-patch because of the documentation bugs.
Diffstat (limited to 'doc/src/sgml/logicaldecoding.sgml')
-rw-r--r--doc/src/sgml/logicaldecoding.sgml37
1 files changed, 14 insertions, 23 deletions
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index b65de324f53..d595c2eae8b 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -366,7 +366,7 @@ typedef struct OutputPluginCallbacks
LogicalDecodeShutdownCB shutdown_cb;
} OutputPluginCallbacks;
-typedef void (*LogicalOutputPluginInit)(struct OutputPluginCallbacks *cb);
+typedef void (*LogicalOutputPluginInit) (struct OutputPluginCallbacks *cb);
</programlisting>
The <function>begin_cb</function>, <function>change_cb</function>
and <function>commit_cb</function> callbacks are required,
@@ -450,11 +450,9 @@ CREATE TABLE another_catalog_table(data text) WITH (user_catalog_table = true);
a replication slot is created or asked to stream changes, independent
of the number of changes that are ready to be put out.
<programlisting>
-typedef void (*LogicalDecodeStartupCB) (
- struct LogicalDecodingContext *ctx,
- OutputPluginOptions *options,
- bool is_init
-);
+typedef void (*LogicalDecodeStartupCB) (struct LogicalDecodingContext *ctx,
+ OutputPluginOptions *options,
+ bool is_init);
</programlisting>
The <literal>is_init</literal> parameter will be true when the
replication slot is being created and false
@@ -489,9 +487,7 @@ typedef struct OutputPluginOptions
be used to deallocate resources private to the output plugin. The slot
isn't necessarily being dropped, streaming is just being stopped.
<programlisting>
-typedef void (*LogicalDecodeShutdownCB) (
- struct LogicalDecodingContext *ctx
-);
+typedef void (*LogicalDecodeShutdownCB) (struct LogicalDecodingContext *ctx);
</programlisting>
</para>
</sect3>
@@ -504,10 +500,8 @@ typedef void (*LogicalDecodeShutdownCB) (
start of a committed transaction has been decoded. Aborted transactions
and their contents never get decoded.
<programlisting>
-typedef void (*LogicalDecodeBeginCB) (
- struct LogicalDecodingContext *,
- ReorderBufferTXN *txn
-);
+typedef void (*LogicalDecodeBeginCB) (struct LogicalDecodingContext *ctx,
+ ReorderBufferTXN *txn);
</programlisting>
The <parameter>txn</parameter> parameter contains meta information about
the transaction, like the time stamp at which it has been committed and
@@ -525,10 +519,9 @@ typedef void (*LogicalDecodeBeginCB) (
rows will have been called before this, if there have been any modified
rows.
<programlisting>
-typedef void (*LogicalDecodeCommitCB) (
- struct LogicalDecodingContext *,
- ReorderBufferTXN *txn
-);
+typedef void (*LogicalDecodeCommitCB) (struct LogicalDecodingContext *ctx,
+ ReorderBufferTXN *txn,
+ XLogRecPtr commit_lsn);
</programlisting>
</para>
</sect3>
@@ -544,12 +537,10 @@ typedef void (*LogicalDecodeCommitCB) (
several rows at once the callback will be called individually for each
row.
<programlisting>
-typedef void (*LogicalDecodeChangeCB) (
- struct LogicalDecodingContext *ctx,
- ReorderBufferTXN *txn,
- Relation relation,
- ReorderBufferChange *change
-);
+typedef void (*LogicalDecodeChangeCB) (struct LogicalDecodingContext *ctx,
+ ReorderBufferTXN *txn,
+ Relation relation,
+ ReorderBufferChange *change);
</programlisting>
The <parameter>ctx</parameter> and <parameter>txn</parameter> parameters
have the same contents as for the <function>begin_cb</function>