public inbox for [email protected]
help / color / mirror / Atom feed[PATCH 16/18] doc review for logical decoding of prepared xacts
6+ messages / 5 participants
[nested] [flat]
* [PATCH 16/18] doc review for logical decoding of prepared xacts
@ 2021-01-24 03:03 Justin Pryzby <[email protected]>
0 siblings, 0 replies; 6+ messages in thread
From: Justin Pryzby @ 2021-01-24 03:03 UTC (permalink / raw)
0aa8a01d04c8fe200b7a106878eebc3d0af9105c
---
doc/src/sgml/logicaldecoding.sgml | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index b854f2ccfc..71e9f36b8e 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -791,9 +791,9 @@ typedef void (*LogicalDecodeMessageCB) (struct LogicalDecodingContext *ctx,
<para>
The optional <function>filter_prepare_cb</function> callback
is called to determine whether data that is part of the current
- two-phase commit transaction should be considered for decode
- at this prepare stage or as a regular one-phase transaction at
- <command>COMMIT PREPARED</command> time later. To signal that
+ two-phase commit transaction should be considered for decoding
+ at this prepare stage or later as a regular one-phase transaction at
+ <command>COMMIT PREPARED</command> time. To signal that
decoding should be skipped, return <literal>true</literal>;
<literal>false</literal> otherwise. When the callback is not
defined, <literal>false</literal> is assumed (i.e. nothing is
@@ -820,11 +820,11 @@ typedef bool (*LogicalDecodeFilterPrepareCB) (struct LogicalDecodingContext *ctx
The required <function>begin_prepare_cb</function> callback is called
whenever the start of a prepared transaction has been decoded. The
<parameter>gid</parameter> field, which is part of the
- <parameter>txn</parameter> parameter can be used in this callback to
- check if the plugin has already received this prepare in which case it
+ <parameter>txn</parameter> parameter, can be used in this callback to
+ check if the plugin has already received this PREPARE in which case it
can skip the remaining changes of the transaction. This can only happen
- if the user restarts the decoding after receiving the prepare for a
- transaction but before receiving the commit prepared say because of some
+ if the user restarts the decoding after receiving the PREPARE for a
+ transaction but before receiving the COMMIT PREPARED, say because of some
error.
<programlisting>
typedef void (*LogicalDecodeBeginPrepareCB) (struct LogicalDecodingContext *ctx,
@@ -842,7 +842,7 @@ typedef bool (*LogicalDecodeFilterPrepareCB) (struct LogicalDecodingContext *ctx
decoded. The <function>change_cb</function> callback for all modified
rows will have been called before this, if there have been any modified
rows. The <parameter>gid</parameter> field, which is part of the
- <parameter>txn</parameter> parameter can be used in this callback.
+ <parameter>txn</parameter> parameter, can be used in this callback.
<programlisting>
typedef void (*LogicalDecodePrepareCB) (struct LogicalDecodingContext *ctx,
ReorderBufferTXN *txn,
@@ -856,9 +856,9 @@ typedef bool (*LogicalDecodeFilterPrepareCB) (struct LogicalDecodingContext *ctx
<para>
The required <function>commit_prepared_cb</function> callback is called
- whenever a transaction commit prepared has been decoded. The
+ whenever a transaction COMMIT PREPARED has been decoded. The
<parameter>gid</parameter> field, which is part of the
- <parameter>txn</parameter> parameter can be used in this callback.
+ <parameter>txn</parameter> parameter, can be used in this callback.
<programlisting>
typedef void (*LogicalDecodeCommitPreparedCB) (struct LogicalDecodingContext *ctx,
ReorderBufferTXN *txn,
@@ -872,15 +872,15 @@ typedef bool (*LogicalDecodeFilterPrepareCB) (struct LogicalDecodingContext *ctx
<para>
The required <function>rollback_prepared_cb</function> callback is called
- whenever a transaction rollback prepared has been decoded. The
+ whenever a transaction ROLLBACK PREPARED has been decoded. The
<parameter>gid</parameter> field, which is part of the
- <parameter>txn</parameter> parameter can be used in this callback. The
+ <parameter>txn</parameter> parameter, can be used in this callback. The
parameters <parameter>prepare_end_lsn</parameter> and
<parameter>prepare_time</parameter> can be used to check if the plugin
- has received this prepare transaction in which case it can apply the
+ has received this PREPARE TRANSACTION in which case it can apply the
rollback, otherwise, it can skip the rollback operation. The
<parameter>gid</parameter> alone is not sufficient because the downstream
- node can have prepared transaction with same identifier.
+ node can have a prepared transaction with same identifier.
<programlisting>
typedef void (*LogicalDecodeRollbackPreparedCB) (struct LogicalDecodingContext *ctx,
ReorderBufferTXN *txn,
@@ -1122,7 +1122,7 @@ OutputPluginWrite(ctx, true);
the <function>stream_commit_cb</function> callback
(or possibly aborted using the <function>stream_abort_cb</function> callback).
If two-phase commits are supported, the transaction can be prepared using the
- <function>stream_prepare_cb</function> callback, commit prepared using the
+ <function>stream_prepare_cb</function> callback, COMMIT PREPARED using the
<function>commit_prepared_cb</function> callback or aborted using the
<function>rollback_prepared_cb</function>.
</para>
--
2.17.0
--lc9FT7cWel8HagAv
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment;
filename="0017-an-old-and-deleted-has-happened.patch"
^ permalink raw reply [nested|flat] 6+ messages in thread
* An improved README experience for PostgreSQL
@ 2024-02-26 17:31 Andrew Atkinson <[email protected]>
2024-02-26 18:30 ` Re: An improved README experience for PostgreSQL Nathan Bossart <[email protected]>
0 siblings, 1 reply; 6+ messages in thread
From: Andrew Atkinson @ 2024-02-26 17:31 UTC (permalink / raw)
To: pgsql-hackers; [email protected]
Hello Hackers. We’re proposing an improved README for PostgreSQL that
includes more helpful links for prospective PostgreSQL contributors and has
a nicer presentation.
Although development does not take place on GitHub or GitLab for
PostgreSQL, many developers might view the PostgreSQL source code using one
of those mirrors (I do myself). Since both support Markdown files, a
Markdown version of the README (as README.md) gets presentational benefits
that I think are helpful.
For a head-to-head comparison of what that looks like, review the current
README and a proposed README.md version below:
Current version:
https://github.com/andyatkinson/postgres/blob/master/README
Markdown README.md version on GitHub:
https://github.com/andyatkinson/postgres/blob/e88138765750b6f7898089b4016641eee01bf616/README.md
---- Feedback Requested ----
Samay Sharma are both interested in the initial developer experience for
PostgreSQL. We had a chat about the role the README plays in that, while
it's a small role, we thought this might be a place to start.
We'd love some feedback.
Prospective contributors need to know about compilation, the mailing lists,
and how the commitfest events work. This information is scattered around on
wiki pages, but we're wondering if more could be brought into the README
and whether that would help?
If you do check out the new file, we'd love to know whether you think
there's useful additions, or there's content that's missing.
If there's any kind of feedback or consensus on this thread, I'm happy to
create and send a patch.
Thanks for taking a look!
Andrew Atkinson w/ reviews from Samay Sharma
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: An improved README experience for PostgreSQL
2024-02-26 17:31 An improved README experience for PostgreSQL Andrew Atkinson <[email protected]>
@ 2024-02-26 18:30 ` Nathan Bossart <[email protected]>
2024-02-26 20:30 ` Re: An improved README experience for PostgreSQL Tom Lane <[email protected]>
0 siblings, 1 reply; 6+ messages in thread
From: Nathan Bossart @ 2024-02-26 18:30 UTC (permalink / raw)
To: Andrew Atkinson <[email protected]>; +Cc: pgsql-hackers; [email protected]
On Mon, Feb 26, 2024 at 11:31:19AM -0600, Andrew Atkinson wrote:
> Hello Hackers. We’re proposing an improved README for PostgreSQL that
> includes more helpful links for prospective PostgreSQL contributors and has
> a nicer presentation.
>
> Although development does not take place on GitHub or GitLab for
> PostgreSQL, many developers might view the PostgreSQL source code using one
> of those mirrors (I do myself). Since both support Markdown files, a
> Markdown version of the README (as README.md) gets presentational benefits
> that I think are helpful.
I think this would be nice. If the Markdown version is reasonably readable
as plain-text, maybe we could avoid maintaining two READMEs files, too.
But overall, +1 to modernizing the README a bit.
--
Nathan Bossart
Amazon Web Services: https://aws.amazon.com
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: An improved README experience for PostgreSQL
2024-02-26 17:31 An improved README experience for PostgreSQL Andrew Atkinson <[email protected]>
2024-02-26 18:30 ` Re: An improved README experience for PostgreSQL Nathan Bossart <[email protected]>
@ 2024-02-26 20:30 ` Tom Lane <[email protected]>
2024-02-26 20:40 ` Re: An improved README experience for PostgreSQL Andrew Atkinson <[email protected]>
2024-02-28 13:46 ` Re: An improved README experience for PostgreSQL Daniel Gustafsson <[email protected]>
0 siblings, 2 replies; 6+ messages in thread
From: Tom Lane @ 2024-02-26 20:30 UTC (permalink / raw)
To: Nathan Bossart <[email protected]>; +Cc: Andrew Atkinson <[email protected]>; pgsql-hackers; [email protected]
Nathan Bossart <[email protected]> writes:
> I think this would be nice. If the Markdown version is reasonably readable
> as plain-text, maybe we could avoid maintaining two READMEs files, too.
> But overall, +1 to modernizing the README a bit.
Per past track record, we change the top-level README only once every
three years or so, so I doubt it'd be too painful to maintain two
versions of it.
Having said that, any proposal for this ought to be submitted as
a patch, rather than expecting people to go digging around on
some other repo.
regards, tom lane
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: An improved README experience for PostgreSQL
2024-02-26 17:31 An improved README experience for PostgreSQL Andrew Atkinson <[email protected]>
2024-02-26 18:30 ` Re: An improved README experience for PostgreSQL Nathan Bossart <[email protected]>
2024-02-26 20:30 ` Re: An improved README experience for PostgreSQL Tom Lane <[email protected]>
@ 2024-02-26 20:40 ` Andrew Atkinson <[email protected]>
1 sibling, 0 replies; 6+ messages in thread
From: Andrew Atkinson @ 2024-02-26 20:40 UTC (permalink / raw)
To: Tom Lane <[email protected]>; +Cc: Nathan Bossart <[email protected]>; pgsql-hackers; [email protected]
Thanks for the feedback Nathan and Tom. Samay also suggested adding the
patch. I've added a .patch with the file for consideration.
On Mon, Feb 26, 2024 at 2:30 PM Tom Lane <[email protected]> wrote:
> Nathan Bossart <[email protected]> writes:
> > I think this would be nice. If the Markdown version is reasonably
> readable
> > as plain-text, maybe we could avoid maintaining two READMEs files, too.
> > But overall, +1 to modernizing the README a bit.
>
> Per past track record, we change the top-level README only once every
> three years or so, so I doubt it'd be too painful to maintain two
> versions of it.
>
> Having said that, any proposal for this ought to be submitted as
> a patch, rather than expecting people to go digging around on
> some other repo.
>
> regards, tom lane
>
Attachments:
[application/octet-stream] 0001-Adds-modernized-README.md.patch (1.7K, ../../CAG6XLEn0CroZoRgJ9M-O8nENYbyF87zHxBKXbWhQ_T85gV0zLg@mail.gmail.com/3-0001-Adds-modernized-README.md.patch)
download | inline diff:
From 3847f3e07ba55c441c7d3432d721ae00d94cc995 Mon Sep 17 00:00:00 2001
From: Andy Atkinson <[email protected]>
Date: Mon, 26 Feb 2024 14:36:55 -0600
Subject: [PATCH] Adds modernized README.md
Incorporate feedback from Samay
---
README.md | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..987bd06979
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# PostgreSQL
+[PostgreSQL](https://www.postgresql.org/) is an advanced object-relational database management system
+that supports an extended subset of the SQL standard, including
+transactions, foreign keys, subqueries, triggers, user-defined types
+and functions. This distribution also contains C language bindings.
+
+## Download Binaries
+The latest version of this software, and related software, may be
+obtained at <https://www.postgresql.org/download/>.
+
+## Source Code Contributions and CommitFest
+Follow the instructions in
+[Installation from Source Code](https://www.postgresql.org/docs/current/installation.html)
+to learn how to compile PostgreSQL for your platform.
+
+Changes to PostgreSQL source code are proposed as patches, attached to
+emails that are sent to the [pgsql-hackers](https://www.postgresql.org/list/pgsql-hackers/) mailing list.
+
+During [CommitFest](https://wiki.postgresql.org/wiki/CommitFest) events,
+patches are reviewed and committed to PostgreSQL, for release in a future version.
+
+Read more about making contributions on the
+[So, you want to be a developer?](https://wiki.postgresql.org/wiki/So,_you_want_to_be_a_developer%3F) wiki page.
+
+## Copyright and License
+Copyright and license information can be found in the file [COPYRIGHT](COPYRIGHT).
--
2.43.0
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: An improved README experience for PostgreSQL
2024-02-26 17:31 An improved README experience for PostgreSQL Andrew Atkinson <[email protected]>
2024-02-26 18:30 ` Re: An improved README experience for PostgreSQL Nathan Bossart <[email protected]>
2024-02-26 20:30 ` Re: An improved README experience for PostgreSQL Tom Lane <[email protected]>
@ 2024-02-28 13:46 ` Daniel Gustafsson <[email protected]>
1 sibling, 0 replies; 6+ messages in thread
From: Daniel Gustafsson @ 2024-02-28 13:46 UTC (permalink / raw)
To: Tom Lane <[email protected]>; +Cc: Nathan Bossart <[email protected]>; Andrew Atkinson <[email protected]>; pgsql-hackers; [email protected]
> On 26 Feb 2024, at 21:30, Tom Lane <[email protected]> wrote:
>
> Nathan Bossart <[email protected]> writes:
>> I think this would be nice. If the Markdown version is reasonably readable
>> as plain-text, maybe we could avoid maintaining two READMEs files, too.
>> But overall, +1 to modernizing the README a bit.
>
> Per past track record, we change the top-level README only once every
> three years or so, so I doubt it'd be too painful to maintain two
> versions of it.
It wont be, and we kind of already have two since there is another similar
README displayed at https://www.postgresql.org/ftp/. That being said, a
majority of those reading the README will likely be new developers accustomed
to Markdown (or doing so via interfaces such as Github) so going to Markdown
might not be a bad idea. We can also render a plain text version with pandoc
for release builds should we want to.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 6+ messages in thread
end of thread, other threads:[~2024-02-28 13:46 UTC | newest]
Thread overview: 6+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2021-01-24 03:03 [PATCH 16/18] doc review for logical decoding of prepared xacts Justin Pryzby <[email protected]>
2024-02-26 17:31 An improved README experience for PostgreSQL Andrew Atkinson <[email protected]>
2024-02-26 18:30 ` Re: An improved README experience for PostgreSQL Nathan Bossart <[email protected]>
2024-02-26 20:30 ` Re: An improved README experience for PostgreSQL Tom Lane <[email protected]>
2024-02-26 20:40 ` Re: An improved README experience for PostgreSQL Andrew Atkinson <[email protected]>
2024-02-28 13:46 ` Re: An improved README experience for PostgreSQL Daniel Gustafsson <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox