Skip to content

Commit 39e07cd

Browse files
authored
Merge pull request #6714 from EnterpriseDB/dev/pgd/DOCS-1449-remove-pause_in_standby-reference
PGD: remove reference to "pause_in_standby"
2 parents 45514d5 + dab4bbc commit 39e07cd

File tree

2 files changed

+6
-10
lines changed

2 files changed

+6
-10
lines changed

product_docs/docs/pgd/6/nodes/logical_standby_nodes.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ A master node can have zero, one, or more logical standby nodes.
1414
location is always preferred.
1515

1616
Logical standby nodes are nodes that are held in a state of continual recovery,
17-
constantly updating until they're required. This behavior is similar to how Postgres physical standbys operate while using logical replication for better performance. [`bdr.join_node_group`](/pgd/latest/reference/nodes-management-interfaces#bdrjoin_node_group) has the `pause_in_standby`
18-
option to make the node stay in halfway-joined as a logical standby node.
17+
constantly updating until they're required. This behavior is similar to how Postgres physical
18+
standbys operate, while using logical replication for better performance.
1919
Logical standby nodes receive changes but don't send changes made locally
2020
to other nodes.
2121

22+
A logical standby is created by specifying the `node_kind` as `standby` when creating
23+
the node with [`bdr.create_node`](/pgd/latest/reference/nodes-management-interfaces#bdrpromote_node).
24+
2225
Later, if you want, use
2326
[`bdr.promote_node`](/pgd/latest/reference/nodes-management-interfaces#bdrpromote_node)
2427
to move the logical standby into a full, normal send/receive node.

product_docs/docs/pgd/6/reference/nodes-management-interfaces.mdx

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,6 @@ Joins the local node to an already existing PGD group.
294294
bdr.join_node_group (
295295
join_target_dsn text,
296296
node_group_name text DEFAULT NULL,
297-
pause_in_standby boolean DEFAULT NULL,
298297
wait_for_completion boolean DEFAULT true,
299298
synchronize_structure text DEFAULT 'all'
300299
)
@@ -308,19 +307,13 @@ bdr.join_node_group (
308307
| `node_group_name` | Optional name of the PGD group. Defaults to NULL, which tries to detect the group name from information present on the source node. |
309308
| `wait_for_completion` | Wait for the join process to complete before returning. Defaults to `true`. |
310309
| `synchronize_structure` | Specifies whether to perform database structure (schema) synchronization during the join. `all`, the default setting, synchronizes the complete database structure. `none` does not synchronize any structure. However, data will still be synchronized, meaning the database structure must already be present on the joining node. Note that by design, neither schema nor data will ever be synchronized to witness nodes. |
311-
| `pause_in_standby` | Optionally tells the join process to join only as a logical standby node, which can be later promoted to a full member. This option is deprecated and will be disabled or removed in future versions of PGD. |
312-
313-
!!! Warning
314-
`pause_in_standby` is deprecated since BDR 5.0. The recommended way to create
315-
a logical standby is to set `node_kind` to `standby` when creating the node
316-
with [`bdr.create_node`](#bdrcreate_node).
317310

318311
If `wait_for_completion` is specified as `false`, the function call returns
319312
as soon as the joining procedure starts. You can see the progress of the join in
320313
the log files and the [`bdr.event_summary`](/pgd/latest/reference/catalogs-internal#bdrevent_summary)
321314
information view. You can call the function [`bdr.wait_for_join_completion()`](#bdrwait_for_join_completion)
322315
after `bdr.join_node_group()` to wait for the join operation to complete.
323-
It can emit progress information if called with `verbose_progress` set to `true`.
316+
It can emit progress information if [`bdr.wait_for_join_completion()`](#bdrwait_for_join_completion) is called with `verbose_progress` set to `true`.
324317

325318
### Notes
326319

0 commit comments

Comments
 (0)