From f0c108560bce3a5481db57ffc3743e71b5f7b2d1 Mon Sep 17 00:00:00 2001 From: Andres Freund Date: Thu, 5 Jun 2014 16:29:20 +0200 Subject: Consistently spell a replication slot's name as slot_name. Previously there's been a mix between 'slotname' and 'slot_name'. It's not nice to be unneccessarily inconsistent in a new feature. As a post beta1 initdb now is required in the wake of eeca4cd35e, fix the inconsistencies. Most the changes won't affect usage of replication slots because the majority of changes is around function parameter names. The prominent exception to that is that the recovery.conf parameter 'primary_slotname' is now named 'primary_slot_name'. --- doc/src/sgml/func.sgml | 28 ++++++++++++++-------------- doc/src/sgml/high-availability.sgml | 6 +++--- doc/src/sgml/logicaldecoding.sgml | 8 ++++---- doc/src/sgml/protocol.sgml | 16 ++++++++-------- doc/src/sgml/recovery-config.sgml | 6 +++--- 5 files changed, 32 insertions(+), 32 deletions(-) (limited to 'doc/src') diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index c4bcefd2c2c..5c906f36732 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -16609,14 +16609,14 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); pg_create_physical_replication_slot - pg_create_physical_replication_slot(slotname name) + pg_create_physical_replication_slot(slot_name name) - (slotname name, xlog_position pg_lsn) + (slot_name name, xlog_position pg_lsn) Creates a new physical replication slot named - slotname. Streaming changes from a physical slot + slot_name. Streaming changes from a physical slot is only possible with the walsender protocol - see . Corresponds to the walsender protocol command CREATE_REPLICATION_SLOT ... PHYSICAL. @@ -16627,14 +16627,14 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); pg_drop_replication_slot - pg_drop_replication_slot(slotname name) + pg_drop_replication_slot(slot_name name) void Drops the physical or logical replication slot - named slotname. Same as walsender protocol + named slot_name. Same as walsender protocol command DROP_REPLICATION_SLOT. @@ -16644,14 +16644,14 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); pg_create_logical_replication_slot - pg_create_logical_replication_slot(slotname name, plugin name) + pg_create_logical_replication_slot(slot_name name, plugin name) - (slotname name, xlog_position pg_lsn) + (slot_name name, xlog_position pg_lsn) Creates a new logical (decoding) replication slot named - slotname using the output plugin + slot_name using the output plugin plugin. A call to this function has the same effect as the replication protocol command CREATE REPLICATION SLOT ... LOGICAL. @@ -16663,16 +16663,16 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); pg_logical_slot_get_changes - pg_logical_slot_get_changes(slotname name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) + pg_logical_slot_get_changes(slot_name name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) (location pg_lsn, xid xid, data text) - Returns changes in the slot slotname, starting + Returns changes in the slot slot_name, starting from the point at which since changes have been consumed last. If upto_lsn and upto_nchanges are NULL, - logical decoding will continue until end of WAL. If + logical decoding will continue until end of WAL. If upto_lsn is non-NULL, decoding will include only those transactions which commit prior to the specified LSN. If upto_nchanges is non-NULL, decoding will @@ -16688,7 +16688,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); pg_logical_slot_peek_changes - pg_logical_slot_peek_changes(slotname name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) + pg_logical_slot_peek_changes(slot_name name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) (location text, xid xid, data text) @@ -16706,7 +16706,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); pg_logical_slot_get_binary_changes - pg_logical_slot_get_binary_changes(slotname name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) + pg_logical_slot_get_binary_changes(slot_name name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) (location pg_lsn, xid xid, data bytea) @@ -16723,7 +16723,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); pg_logical_slot_peek_binary_changes - pg_logical_slot_peek_binary_changes(slotname name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) + pg_logical_slot_peek_binary_changes(slot_name name, upto_lsn pg_lsn, upto_nchanges int, VARIADIC options text[]) (location pg_lsn, xid xid, data bytea) diff --git a/doc/src/sgml/high-availability.sgml b/doc/src/sgml/high-availability.sgml index 7bba6515446..657097d6460 100644 --- a/doc/src/sgml/high-availability.sgml +++ b/doc/src/sgml/high-availability.sgml @@ -929,7 +929,7 @@ primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass' You can create a replication slot like this: postgres=# SELECT * FROM pg_create_physical_replication_slot('node_a_slot'); - slotname | xlog_position + slot_name | xlog_position -------------+--------------- node_a_slot | @@ -939,13 +939,13 @@ postgres=# SELECT * FROM pg_replication_slots; node_a_slot | physical | | | f | | (1 row) - To configure the standby to use this slot, primary_slotname + To configure the standby to use this slot, primary_slot_name should be configured in the standby's recovery.conf. Here is a simple example: standby_mode = 'on' primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass' -primary_slotname = 'node_a_slot' +primary_slot_name = 'node_a_slot' diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml index 549f2bc9f5f..a2108d68e2d 100644 --- a/doc/src/sgml/logicaldecoding.sgml +++ b/doc/src/sgml/logicaldecoding.sgml @@ -54,7 +54,7 @@ postgres=# -- Create a slot named 'regression_slot' using the output plugin 'test_decoding' postgres=# SELECT * FROM pg_create_logical_replication_slot('regression_slot', 'test_decoding'); - slotname | xlog_position + slot_name | xlog_position -----------------+--------------- regression_slot | 0/16B1970 (1 row) @@ -256,9 +256,9 @@ CTRL-C Streaming Replication Protocol Interface - The CREATE_REPLICATION_SLOT slotname LOGICAL - options, DROP_REPLICATION_SLOT slotname - and START_REPLICATION SLOT slotname LOGICAL options + The CREATE_REPLICATION_SLOT slot_name LOGICAL + options, DROP_REPLICATION_SLOT slot_name + and START_REPLICATION SLOT slot_name LOGICAL options commands can be used to create, drop and stream changes from a replication slot respectively. These commands are only available over a replication connection; they cannot be used via SQL. diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index ee3d9de4c07..c6eb863d1fb 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1428,7 +1428,7 @@ The commands accepted in walsender mode are: - CREATE_REPLICATION_SLOT slotname { PHYSICAL | LOGICAL output_plugin } CREATE_REPLICATION_SLOT + CREATE_REPLICATION_SLOT slot_name { PHYSICAL | LOGICAL output_plugin } CREATE_REPLICATION_SLOT Create a physical or logical replication @@ -1437,7 +1437,7 @@ The commands accepted in walsender mode are: - slotname + slot_name The name of the slot to create. Must be a valid replication slot @@ -1460,7 +1460,7 @@ The commands accepted in walsender mode are: - START_REPLICATION [SLOT slotname] [PHYSICAL] XXX/XXX [TIMELINE tli] + START_REPLICATION [SLOT slot_name] [PHYSICAL] XXX/XXX [TIMELINE tli] Instructs server to start streaming WAL, starting at @@ -1506,7 +1506,7 @@ The commands accepted in walsender mode are: If a slot's name is provided - via slotname, it will be updated + via slot_name, it will be updated as replication progresses so that the server knows which WAL segments - and if hot_standby_feedback is on which transactions - are still needed by the standby. @@ -1788,7 +1788,7 @@ The commands accepted in walsender mode are: - START_REPLICATION SLOT slotname LOGICAL XXX/XXX [ ( option_name [option_value] [, ... ] ) ] + START_REPLICATION SLOT slot_name LOGICAL XXX/XXX [ ( option_name [option_value] [, ... ] ) ] Instructs server to start streaming WAL for logical replication, starting @@ -1810,7 +1810,7 @@ The commands accepted in walsender mode are: - SLOT slotname + SLOT slot_name The name of the slot to stream changes from. This parameter is required, @@ -1850,7 +1850,7 @@ The commands accepted in walsender mode are: - DROP_REPLICATION_SLOT slotname + DROP_REPLICATION_SLOT slot_name Drops a replication slot, freeing any reserved server-side resources. If @@ -1858,7 +1858,7 @@ The commands accepted in walsender mode are: - slotname + slot_name The name of the slot to drop. diff --git a/doc/src/sgml/recovery-config.sgml b/doc/src/sgml/recovery-config.sgml index 762207ebeae..76f9d0327ac 100644 --- a/doc/src/sgml/recovery-config.sgml +++ b/doc/src/sgml/recovery-config.sgml @@ -370,10 +370,10 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows - - primary_slotname (string) + + primary_slot_name (string) - primary_slotname recovery parameter + primary_slot_name recovery parameter -- cgit v1.2.3