Skip to content

Commit

Permalink
Merge pull request #5670 from EnterpriseDB/docs/edits_to_pgd_pr5651
Browse files Browse the repository at this point in the history
Edits to PGD PR5651
  • Loading branch information
ebgitelman authored Jun 4, 2024
2 parents b9d9763 + 96fe01f commit 811283b
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 26 deletions.
18 changes: 9 additions & 9 deletions product_docs/docs/pgd/4/bdr/catalogs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -786,15 +786,15 @@ 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`](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`](configuration.mdx#bdrtrack_apply_lock_timing)
is set to `on` (default: `off`).

The stored relation statistics can be reset by calling
[`bdr.reset_relation_stats()`](/pgd/4/bdr/functions.mdx#bdrreset_relation_stats).
You can reset the stored relation statistics by calling
[`bdr.reset_relation_stats()`](functions.mdx#bdrreset_relation_stats).

#### `bdr.stat_relation` columns

Expand All @@ -818,11 +818,11 @@ 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
[`bdr.track_subscription_apply`](/pgd/4/bdr/configuration.mdx#bdrtrack_subscription_apply).
Shows apply statistics for each subscription. Contains data only if tracking is enabled with
[`bdr.track_subscription_apply`](configuration.mdx#bdrtrack_subscription_apply).

The stored subscription statistics can be reset by calling
[`bdr.reset_subscription_stats()`](/pgd/4/bdr/functions.mdx#bdrreset_subscripion_stats).
You can reset the stored subscription statistics by calling
[`bdr.reset_subscription_stats()`](functions.mdx#bdrreset_subscripion_stats).

#### `bdr.stat_subscription` columns

Expand Down
6 changes: 3 additions & 3 deletions product_docs/docs/pgd/4/bdr/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`](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`](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`](catalogs.mdx#bdrstat_relation).
The default value is `off`.

### Internals
Expand Down
18 changes: 9 additions & 9 deletions product_docs/docs/pgd/5/reference/catalogs-visible.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -857,15 +857,15 @@ 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
[`bdr.track_relation_apply`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_relation_apply)
Shows apply statistics for each relation. Contains data only if tracking is enabled with
[`bdr.track_relation_apply`](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-settings.mdx#bdrtrack_apply_lock_timing)
is set to `on` (default: `off`).

The stored relation statistics can be reset by calling
[`bdr.reset_relation_stats()`](/pgd/5/reference/functions-internal.mdx#bdrreset_relation_stats).
You can reset the stored relation statistics by calling
[`bdr.reset_relation_stats()`](functions-internal.mdx#bdrreset_relation_stats).

#### `bdr.stat_relation` columns

Expand All @@ -891,11 +891,11 @@ 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
[`bdr.track_subscription_apply`](/pgd/5/reference/pgd-settings.mdx#bdrtrack_subscription_apply).
Shows apply statistics for each subscription. Contains data only if tracking is enabled with
[`bdr.track_subscription_apply`](pgd-settings.mdx#bdrtrack_subscription_apply).

The stored subscription statistics can be reset by calling
[`bdr.reset_subscription_stats()`](/pgd/5/reference/functions-internal.mdx#bdrreset_subscription_stats).
You can reset the stored subscription statistics by calling
[`bdr.reset_subscription_stats()`](functions-internal.mdx#bdrreset_subscription_stats).

#### `bdr.stat_subscription` columns

Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/pgd/5/reference/functions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
6 changes: 3 additions & 3 deletions product_docs/docs/pgd/5/reference/pgd-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`](/pgd/latest/reference/catalogs-visible#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`](/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 via [`bdr.stat_relation`](/pgd/5/reference/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`.

Expand Down

1 comment on commit 811283b

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.