[docs] Add syntax documentation for logical replication #23270
Conversation
dr0pdb
requested review from
suranjan,
vaibhav-yb,
siddharth2411 and
asrinivasanyb
✅ Deploy Preview for infallible-bardeen-164bc9 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
docs/content/preview/api/ysql/the-sql-language/statements/streaming_create_repl_slot.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/ddl_alter_publication.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/ddl_alter_publication.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/ddl_alter_publication.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/ddl_alter_publication.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/ddl_create_publication.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/ddl_create_publication.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/ddl_create_publication.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/ddl_drop_publication.md
Outdated
Show resolved
Hide resolved
docs/content/preview/api/ysql/the-sql-language/statements/streaming_drop_repl_slot.md
Outdated
Show resolved
Hide resolved
| Optional value, in the form of a string constant, associated with the specified option. | ||
|
|
||
| ## Example | ||
|
|
There was a problem hiding this comment.
Add brief summary - "Start replication from Replication Slot test_slot using LSN 0/2 and something something" (explain what is going on)
There was a problem hiding this comment.
Do we need to document these options too https://www.postgresql.org/docs/current/protocol-logical-replication.html ?
There was a problem hiding this comment.
In this example, we probably need a full example? So creating a table, a publication, and then starting replication.
And maybe even show the output of start_replication.
There was a problem hiding this comment.
Do we need to document these options too https://www.postgresql.org/docs/current/protocol-logical-replication.html ?
So these parameters depend on the output plugin chosen. These parameters are specific to pgoutput. I've added links to the respective documentation for pgoutput, yboutput and wal2json. If the user uses any other plugin, they have to find the documentation for that plugin.
In this example, we probably need a full example? So creating a table, a publication, and then starting replication.
And maybe even show the output of start_replication.
Good point. I've added one. We can't show the output of the start_replication as it streams data via copy protocol. The command doesn't output anything on the shell.
|
@ddorian can you take a look |
Co-authored-by: Dwight Hodge <[email protected]>
Co-authored-by: Dwight Hodge <[email protected]>
Co-authored-by: Dwight Hodge <[email protected]>
Co-authored-by: Dwight Hodge <[email protected]>
Co-authored-by: Dwight Hodge <[email protected]>
…aming_drop_repl_slot.md Co-authored-by: Dwight Hodge <[email protected]>
…drop_publication.md Co-authored-by: Dwight Hodge <[email protected]>
…create_publication.md Co-authored-by: Dwight Hodge <[email protected]>
…create_publication.md Co-authored-by: Dwight Hodge <[email protected]>
| @@ -38,18 +38,36 @@ The log sequence number from where to start the streaming from. | |||
|
|
|||
| The name of an option passed to the slot's logical decoding plugin. | |||
|
|
|||
| The applicable options accepted by the command depends on the output plugin of the replication slot. They can be viewed in the respective documentation of the output plugin itself. | |||
|
|
|||
| For `pgoutput` and `yboutput`, check the section [53.5.1. Logical Streaming Replication Parameters](https://www.postgresql.org/docs/11/protocol-logical-replication.html) in the PG documentation. | |||
There was a problem hiding this comment.
Do we need to document somehow yboutput? Or say how/if it differes from pgoutput ?
There was a problem hiding this comment.
Yes but not in the syntax section. cc: @asrinivasanyb
docs/content/preview/api/ysql/the-sql-language/statements/streaming_start_replication.md
Show resolved
Hide resolved
Summary: 5aa0c0a [PLAT-14078] Add local provider test for update databases cdd97f8 remove ea badge (#23276) 2813d78 [PLAT-14156][PLAT-14323]: Move all UI Driven flags to INTERNAL and remove YBM key as its not used 49523f5 [PLAT-14733]: Add support for OIDC attributes jwt_jwks_path and jwt_jwks_url b039d1a [PLAT-14366] Basic local provider test for master auto failover 700fd49 [#23275] docdb: Fix missing home icon on master UI 89e434e [#13254] YSQL: import pgtap v1.3.3 1b3585f [doc][cdc] Updated diagrams (#23262) 399f165 [#23266] YSQL: Only require YB Admin privileges to run pg_locks 5a4bbd4 [#19954] docdb: Register both tablet split children atomically b4c4294 [PLAT-14617] Add support for numerical search and enable extra search fields forxCluster 84fb7ad [#22449] YSQL: wal2json YB specific changes afe84d4 [#13254] YSQL: add pgtap to build adf3c54 [#23272] YSQL, ASH: Fix incorrect popping of query id from nested query ids stack 3b42c2e [docs] Add syntax documentation for logical replication (#23270) Test Plan: Jenkins: rebase: pg15-cherrypicks Reviewers: jason, tfoucher Tags: #jenkins-ready Differential Revision: https://phorge.dev.yugabyte.com/D36841
No description provided.