From 08545a4598e27cae9001b489a7a518a0f76b7de6 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Tue, 21 May 2024 15:19:28 -0400 Subject: [PATCH 1/7] Edits to PGD PR5651 --- product_docs/docs/pgd/4/bdr/catalogs.mdx | 12 ++++++------ product_docs/docs/pgd/4/bdr/configuration.mdx | 6 +++--- .../docs/pgd/5/reference/catalogs-visible.mdx | 10 +++++----- product_docs/docs/pgd/5/reference/pgd-settings.mdx | 6 +++--- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/product_docs/docs/pgd/4/bdr/catalogs.mdx b/product_docs/docs/pgd/4/bdr/catalogs.mdx index a025358871a..355fc7b9e86 100644 --- a/product_docs/docs/pgd/4/bdr/catalogs.mdx +++ b/product_docs/docs/pgd/4/bdr/catalogs.mdx @@ -786,14 +786,14 @@ is set correctly when the wait relates to BDR. ### `bdr.stat_relation` -Shows apply statistics for each relation. Contains data only if tracking is enabled via -[`bdr.track_relation_apply`](/pgd/4/bdr/configuration.mdx#bdrtrack_relation_apply), +Shows apply statistics for each relation. Contains data only if tracking is enabled with +[`bdr.track_relation_apply`](/pgd/4/bdr/configuration.mdx#bdrtrack_relation_apply) and if data was replicated for a given relation. -`lock_acquire_time` is only updated if [`bdr.track_apply_lock_timing`](/pgd/4/bdr/configuration.mdx#bdrtrack_apply_lock_timing) +`lock_acquire_time` is updated only if [`bdr.track_apply_lock_timing`](/pgd/4/bdr/configuration.mdx#bdrtrack_apply_lock_timing) is set to `on` (default: `off`). -The stored relation statistics can be reset by calling +You can reset the stored relation statistics by calling [`bdr.reset_relation_stats()`](/pgd/4/bdr/functions.mdx#bdrreset_relation_stats). #### `bdr.stat_relation` columns @@ -818,10 +818,10 @@ The stored relation statistics can be reset by calling ### `bdr.stat_subscription` -Shows apply statistics for each subscription. Contains data only if tracking is enabled via +Shows apply statistics for each subscription. Contains data only if tracking is enabled with [`bdr.track_subscription_apply`](/pgd/4/bdr/configuration.mdx#bdrtrack_subscription_apply). -The stored subscription statistics can be reset by calling +You can reset the stored subscription statistics by calling [`bdr.reset_subscription_stats()`](/pgd/4/bdr/functions.mdx#bdrreset_subscripion_stats). #### `bdr.stat_subscription` columns diff --git a/product_docs/docs/pgd/4/bdr/configuration.mdx b/product_docs/docs/pgd/4/bdr/configuration.mdx index 8b235b29282..b13fa2571e9 100644 --- a/product_docs/docs/pgd/4/bdr/configuration.mdx +++ b/product_docs/docs/pgd/4/bdr/configuration.mdx @@ -488,13 +488,13 @@ and receivers don't have a writer ID. archival, and rotation to prevent disk space exhaustion. - `bdr.track_subscription_apply` — Track apply statistics for - each subscription via [`bdr.stat_subscription`](/pgd/4/bdr/catalogs.mdx#bdrstat_subscription). + each subscription with [`bdr.stat_subscription`](/pgd/4/bdr/catalogs.mdx#bdrstat_subscription). The default value is `on`. - `bdr.track_relation_apply` — Track apply statistics for each - relation via [`bdr.stat_relation`](/pgd/4/bdr/catalogs.mdx#bdrstat_relation). + relation with [`bdr.stat_relation`](/pgd/4/bdr/catalogs.mdx#bdrstat_relation). The default value is `off`. - `bdr.track_apply_lock_timing` — Track lock timing when tracking - statistics for relations via [`bdr.stat_relation`](/pgd/4/bdr/catalogs.mdx#bdrstat_relation). + statistics for relations with [`bdr.stat_relation`](/pgd/4/bdr/catalogs.mdx#bdrstat_relation). The default value is `off`. ### Internals diff --git a/product_docs/docs/pgd/5/reference/catalogs-visible.mdx b/product_docs/docs/pgd/5/reference/catalogs-visible.mdx index bcc25b7d313..658c6ff2f5d 100644 --- a/product_docs/docs/pgd/5/reference/catalogs-visible.mdx +++ b/product_docs/docs/pgd/5/reference/catalogs-visible.mdx @@ -857,14 +857,14 @@ is set correctly when the wait relates to PGD. ### `bdr.stat_relation` -Shows apply statistics for each relation. Contains data only if tracking is enabled via +Shows apply statistics for each relation. Contains data only if tracking is enabled with [`bdr.track_relation_apply`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_relation_apply) and if data was replicated for a given relation. -`lock_acquire_time` is only updated if [`bdr.track_apply_lock_timing`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_apply_lock_timing) +`lock_acquire_time` is updated only if [`bdr.track_apply_lock_timing`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_apply_lock_timing) is set to `on` (default: `off`). -The stored relation statistics can be reset by calling +You can reset the stored relation statistics by calling [`bdr.reset_relation_stats()`](/pgd/5/reference/functions-internal.mdx#bdrreset_relation_stats). #### `bdr.stat_relation` columns @@ -891,10 +891,10 @@ The stored relation statistics can be reset by calling ### `bdr.stat_subscription` -Shows apply statistics for each subscription. Contains data only if tracking is enabled via +Shows apply statistics for each subscription. Contains data only if tracking is enabled with [`bdr.track_subscription_apply`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_subscription_apply). -The stored subscription statistics can be reset by calling +You can reset the stored subscription statistics by calling [`bdr.reset_subscription_stats()`](/pgd/5/reference/functions-internal.mdx#bdrreset_subscription_stats). #### `bdr.stat_subscription` columns diff --git a/product_docs/docs/pgd/5/reference/pgd-settings.mdx b/product_docs/docs/pgd/5/reference/pgd-settings.mdx index 3b6130d1a18..7d426e957a9 100644 --- a/product_docs/docs/pgd/5/reference/pgd-settings.mdx +++ b/product_docs/docs/pgd/5/reference/pgd-settings.mdx @@ -472,19 +472,19 @@ archival, and rotation to prevent disk space exhaustion. ### `bdr.track_subscription_apply` -Track apply statistics for each subscription via [`bdr.stat_subscription`](/pgd/5/reference/catalogs-visible.mdx#bdrstat_subscription). +Track apply statistics for each subscription with [`bdr.stat_subscription`](catalogs-visible.mdx#bdrstat_subscription). The default value is `on`. ### `bdr.track_relation_apply` -Track apply statistics for each relation via [`bdr.stat_relation`](/pgd/5/reference/catalogs-visible.mdx#bdrstat_relation). +Track apply statistics for each relation with [`bdr.stat_relation`](catalogs-visible.mdx#bdrstat_relation). The default value is `off`. ### `bdr.track_apply_lock_timing` -Track lock timing when tracking statistics for relations via [`bdr.stat_relation`](/pgd/5/reference/catalogs-visible.mdx#bdrstat_relation). +Track lock timing when tracking statistics for relations with [`bdr.stat_relation`](catalogs-visible.mdx#bdrstat_relation). The default value is `off`. From 03f458aa551e9a972c86a56fee2e1b7631bebd3e Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Tue, 21 May 2024 15:23:22 -0400 Subject: [PATCH 2/7] Apply suggestions from code review --- product_docs/docs/pgd/5/reference/catalogs-visible.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/pgd/5/reference/catalogs-visible.mdx b/product_docs/docs/pgd/5/reference/catalogs-visible.mdx index 658c6ff2f5d..f31c35ec812 100644 --- a/product_docs/docs/pgd/5/reference/catalogs-visible.mdx +++ b/product_docs/docs/pgd/5/reference/catalogs-visible.mdx @@ -861,11 +861,11 @@ Shows apply statistics for each relation. Contains data only if tracking is enab [`bdr.track_relation_apply`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_relation_apply) and if data was replicated for a given relation. -`lock_acquire_time` is updated only if [`bdr.track_apply_lock_timing`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_apply_lock_timing) +`lock_acquire_time` is updated only if [`bdr.track_apply_lock_timing`](pgd-settings.mdx#bdrtrack_apply_lock_timing) is set to `on` (default: `off`). You can reset the stored relation statistics by calling -[`bdr.reset_relation_stats()`](/pgd/5/reference/functions-internal.mdx#bdrreset_relation_stats). +[`bdr.reset_relation_stats()`](functions-internal.mdx#bdrreset_relation_stats). #### `bdr.stat_relation` columns @@ -892,10 +892,10 @@ You can reset the stored relation statistics by calling ### `bdr.stat_subscription` Shows apply statistics for each subscription. Contains data only if tracking is enabled with -[`bdr.track_subscription_apply`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_subscription_apply). +[`bdr.track_subscription_apply`](pgd-settings.mdx#bdrtrack_subscription_apply). You can reset the stored subscription statistics by calling -[`bdr.reset_subscription_stats()`](/pgd/5/reference/functions-internal.mdx#bdrreset_subscription_stats). +[`bdr.reset_subscription_stats()`](functions-internal.mdx#bdrreset_subscription_stats). #### `bdr.stat_subscription` columns From f600aa8c76f8593b190bcb49b9c967e8442aaf3e Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Tue, 21 May 2024 15:24:12 -0400 Subject: [PATCH 3/7] Update product_docs/docs/pgd/5/reference/catalogs-visible.mdx --- product_docs/docs/pgd/5/reference/catalogs-visible.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/reference/catalogs-visible.mdx b/product_docs/docs/pgd/5/reference/catalogs-visible.mdx index f31c35ec812..8b5bc6a0b55 100644 --- a/product_docs/docs/pgd/5/reference/catalogs-visible.mdx +++ b/product_docs/docs/pgd/5/reference/catalogs-visible.mdx @@ -858,7 +858,7 @@ is set correctly when the wait relates to PGD. ### `bdr.stat_relation` Shows apply statistics for each relation. Contains data only if tracking is enabled with -[`bdr.track_relation_apply`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_relation_apply) +[`bdr.track_relation_apply`](pgd-settings.mdx#bdrtrack_relation_apply) and if data was replicated for a given relation. `lock_acquire_time` is updated only if [`bdr.track_apply_lock_timing`](pgd-settings.mdx#bdrtrack_apply_lock_timing) From b2da8cfbd15b3e162b23a7f71cdf9b2497d9635f Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Tue, 21 May 2024 15:35:53 -0400 Subject: [PATCH 4/7] Apply suggestions from code review --- product_docs/docs/pgd/4/bdr/catalogs.mdx | 8 ++++---- product_docs/docs/pgd/4/bdr/configuration.mdx | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/pgd/4/bdr/catalogs.mdx b/product_docs/docs/pgd/4/bdr/catalogs.mdx index 355fc7b9e86..6ef86b99900 100644 --- a/product_docs/docs/pgd/4/bdr/catalogs.mdx +++ b/product_docs/docs/pgd/4/bdr/catalogs.mdx @@ -787,14 +787,14 @@ is set correctly when the wait relates to BDR. ### `bdr.stat_relation` Shows apply statistics for each relation. Contains data only if tracking is enabled with -[`bdr.track_relation_apply`](/pgd/4/bdr/configuration.mdx#bdrtrack_relation_apply) +[`bdr.track_relation_apply`](configuration.mdx#bdrtrack_relation_apply) and if data was replicated for a given relation. `lock_acquire_time` is updated only if [`bdr.track_apply_lock_timing`](/pgd/4/bdr/configuration.mdx#bdrtrack_apply_lock_timing) is set to `on` (default: `off`). You can reset the stored relation statistics by calling -[`bdr.reset_relation_stats()`](/pgd/4/bdr/functions.mdx#bdrreset_relation_stats). +[`bdr.reset_relation_stats()`](functions.mdx#bdrreset_relation_stats). #### `bdr.stat_relation` columns @@ -819,10 +819,10 @@ You can reset the stored relation statistics by calling ### `bdr.stat_subscription` Shows apply statistics for each subscription. Contains data only if tracking is enabled with -[`bdr.track_subscription_apply`](/pgd/4/bdr/configuration.mdx#bdrtrack_subscription_apply). +[`bdr.track_subscription_apply`](configuration.mdx#bdrtrack_subscription_apply). You can reset the stored subscription statistics by calling -[`bdr.reset_subscription_stats()`](/pgd/4/bdr/functions.mdx#bdrreset_subscripion_stats). +[`bdr.reset_subscription_stats()`](functions.mdx#bdrreset_subscripion_stats). #### `bdr.stat_subscription` columns diff --git a/product_docs/docs/pgd/4/bdr/configuration.mdx b/product_docs/docs/pgd/4/bdr/configuration.mdx index b13fa2571e9..be3a971ea8f 100644 --- a/product_docs/docs/pgd/4/bdr/configuration.mdx +++ b/product_docs/docs/pgd/4/bdr/configuration.mdx @@ -488,13 +488,13 @@ and receivers don't have a writer ID. archival, and rotation to prevent disk space exhaustion. - `bdr.track_subscription_apply` — Track apply statistics for - each subscription with [`bdr.stat_subscription`](/pgd/4/bdr/catalogs.mdx#bdrstat_subscription). + each subscription with [`bdr.stat_subscription`](catalogs.mdx#bdrstat_subscription). The default value is `on`. - `bdr.track_relation_apply` — Track apply statistics for each - relation with [`bdr.stat_relation`](/pgd/4/bdr/catalogs.mdx#bdrstat_relation). + relation with [`bdr.stat_relation`](catalogs.mdx#bdrstat_relation). The default value is `off`. - `bdr.track_apply_lock_timing` — Track lock timing when tracking - statistics for relations with [`bdr.stat_relation`](/pgd/4/bdr/catalogs.mdx#bdrstat_relation). + statistics for relations with [`bdr.stat_relation`](catalogs.mdx#bdrstat_relation). The default value is `off`. ### Internals From 69a313fb1837a9f91eec8c19f0fd19630f75510a Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Tue, 21 May 2024 15:36:19 -0400 Subject: [PATCH 5/7] Update product_docs/docs/pgd/4/bdr/catalogs.mdx --- product_docs/docs/pgd/4/bdr/catalogs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/4/bdr/catalogs.mdx b/product_docs/docs/pgd/4/bdr/catalogs.mdx index 6ef86b99900..55a2158bc69 100644 --- a/product_docs/docs/pgd/4/bdr/catalogs.mdx +++ b/product_docs/docs/pgd/4/bdr/catalogs.mdx @@ -790,7 +790,7 @@ Shows apply statistics for each relation. Contains data only if tracking is enab [`bdr.track_relation_apply`](configuration.mdx#bdrtrack_relation_apply) and if data was replicated for a given relation. -`lock_acquire_time` is updated only if [`bdr.track_apply_lock_timing`](/pgd/4/bdr/configuration.mdx#bdrtrack_apply_lock_timing) +`lock_acquire_time` is updated only if [`bdr.track_apply_lock_timing`](configuration.mdx#bdrtrack_apply_lock_timing) is set to `on` (default: `off`). You can reset the stored relation statistics by calling From 243af503d4b47357072f08e1d2f60937156c5b81 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Mon, 3 Jun 2024 10:38:16 +0100 Subject: [PATCH 6/7] Normalize links to standard reference links Signed-off-by: Dj Walker-Morgan --- product_docs/docs/pgd/5/reference/pgd-settings.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/pgd/5/reference/pgd-settings.mdx b/product_docs/docs/pgd/5/reference/pgd-settings.mdx index 7d426e957a9..127129f6c69 100644 --- a/product_docs/docs/pgd/5/reference/pgd-settings.mdx +++ b/product_docs/docs/pgd/5/reference/pgd-settings.mdx @@ -472,19 +472,19 @@ archival, and rotation to prevent disk space exhaustion. ### `bdr.track_subscription_apply` -Track apply statistics for each subscription with [`bdr.stat_subscription`](catalogs-visible.mdx#bdrstat_subscription). +Track apply statistics for each subscription with [`bdr.stat_subscription`](/pgd/latest/reference/catalogs-visible#bdrstat_subscription). The default value is `on`. ### `bdr.track_relation_apply` -Track apply statistics for each relation with [`bdr.stat_relation`](catalogs-visible.mdx#bdrstat_relation). +Track apply statistics for each relation with [`bdr.stat_relation`](/pgd/latest/reference/catalogs-visible#bdrstat_relation). The default value is `off`. ### `bdr.track_apply_lock_timing` -Track lock timing when tracking statistics for relations with [`bdr.stat_relation`](catalogs-visible.mdx#bdrstat_relation). +Track lock timing when tracking statistics for relations with [`bdr.stat_relation`](/pgd/latest/reference/catalogs-visible#bdrstat_relation). The default value is `off`. From 96fe01f64a95c3f1e74743692bbccdba18d5ce84 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Mon, 3 Jun 2024 10:42:39 +0100 Subject: [PATCH 7/7] More normalised links (absolute to reference, less stray .mdx extension) Signed-off-by: Dj Walker-Morgan --- product_docs/docs/pgd/5/reference/functions.mdx | 2 +- .../docs/pgd/5/reference/nodes-management-interfaces.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/pgd/5/reference/functions.mdx b/product_docs/docs/pgd/5/reference/functions.mdx index de9ce918c55..1072c4b37f7 100644 --- a/product_docs/docs/pgd/5/reference/functions.mdx +++ b/product_docs/docs/pgd/5/reference/functions.mdx @@ -983,7 +983,7 @@ bdr.lag_control() #### Output columns -- `commit_scope_id` — OID of the commit scope (see [`bdr.commit_scopes`](catalogs-visible.mdx#bdrcommit_scopes)) +- `commit_scope_id` — OID of the commit scope (see [`bdr.commit_scopes`](/pgd/latest/reference/catalogs-visible#bdrcommit_scopes))) - `sessions` — Number of sessions referencing the lag control entry diff --git a/product_docs/docs/pgd/5/reference/nodes-management-interfaces.mdx b/product_docs/docs/pgd/5/reference/nodes-management-interfaces.mdx index 36d06d3657d..1b7a2ad0762 100644 --- a/product_docs/docs/pgd/5/reference/nodes-management-interfaces.mdx +++ b/product_docs/docs/pgd/5/reference/nodes-management-interfaces.mdx @@ -312,7 +312,7 @@ bdr.join_node_group ( If `wait_for_completion` is specified as `false`, the function call returns as soon as the joining procedure starts. You can see the progress of the join in -the log files and the [`bdr.event_summary`](catalogs-internal.mdx#bdrevent_summary) +the log files and the [`bdr.event_summary`](/pgd/latest/reference/catalogs-internal#bdrevent_summary) information view. You can call the function [`bdr.wait_for_join_completion()`](#bdrwait_for_join_completion) after `bdr.join_node_group()` to wait for the join operation to complete. It can emit progress information if called with `verbose_progress` set to `true`.