From 620b4a5630ac6de911bdf91290501185523ff4ac Mon Sep 17 00:00:00 2001 From: Josh Earlenbaugh Date: Tue, 10 Sep 2024 15:08:01 -0400 Subject: [PATCH] Small changes. --- .../docs/pgd/5.6/commit-scopes/index.mdx | 9 +++++---- .../5.6/commit-scopes/synchronous_commit.mdx | 2 +- .../docs/pgd/5.6/reference/commit-scopes.mdx | 20 +++++++++---------- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/product_docs/docs/pgd/5.6/commit-scopes/index.mdx b/product_docs/docs/pgd/5.6/commit-scopes/index.mdx index 62948a28da2..3cc8720aaf8 100644 --- a/product_docs/docs/pgd/5.6/commit-scopes/index.mdx +++ b/product_docs/docs/pgd/5.6/commit-scopes/index.mdx @@ -8,10 +8,11 @@ navigation: - commit-scope-rules - comparing - '# Commit Scope kinds' + - synchronous_commit - group-commit - camo - lag-control - - synchronous_commit + - '# Working with' - administering - legacy-sync @@ -45,6 +46,9 @@ a commit scope rule. ## Commit scope kinds +* [Synchronous Commit](synchronous_commit) examines a commit scope mechanism that works +in a similar fashion to legacy synchronous replication, but from within the commit scope framework. + * [Group Commit](group-commit) focuses on the Group Commit option, where you can define a transaction as done when a group of nodes agrees it's done. @@ -56,9 +60,6 @@ retrying. This ensures that their commits only happen at most once. dynamically throttle nodes according to the slowest node and regulates how far out of sync nodes may go when a database node goes out of service. -* [Synchronous Commit](synchronous_commit) examines a commit scope mechanism that works -in a similar fashion to legacy synchronous replication, but from within the commit scope framework. - ## Working with commit scopes * [Administering](administering) addresses how to manage a PGD cluster with Group Commit diff --git a/product_docs/docs/pgd/5.6/commit-scopes/synchronous_commit.mdx b/product_docs/docs/pgd/5.6/commit-scopes/synchronous_commit.mdx index 654adbbc933..9919a2ff980 100644 --- a/product_docs/docs/pgd/5.6/commit-scopes/synchronous_commit.mdx +++ b/product_docs/docs/pgd/5.6/commit-scopes/synchronous_commit.mdx @@ -1,5 +1,5 @@ --- -title: PGD Synchronous Commit +title: Synchronous Commit deepToC: true --- diff --git a/product_docs/docs/pgd/5.6/reference/commit-scopes.mdx b/product_docs/docs/pgd/5.6/reference/commit-scopes.mdx index 2adaf3710f0..8293e7e055c 100644 --- a/product_docs/docs/pgd/5.6/reference/commit-scopes.mdx +++ b/product_docs/docs/pgd/5.6/reference/commit-scopes.mdx @@ -49,9 +49,9 @@ Where `node_group` is the name of a PGD data node group. ### commit_scope_degrade_operation -Moreover, where the `commit_scope_degrade_operation` is either the same commit scope kind with a less restrictive commit scope group as the overall rule being defined, or is asynchronous (`ASYNC`). +The `commit_scope_degrade_operation` is either the same commit scope kind with a less restrictive commit scope group as the overall rule being defined, or is asynchronous (`ASYNC`). -For instance, you can have a degradation from an `ALL SYNCHRONOUS_COMMIT` to a `MAJORITY SYNCHRONOUS_COMMIT` or a `MAJORITY SYNCHRONOUS_COMMIT` to an `ANY 3 SYNCHRONOUS_COMMIT` or even an `ANY 3 SYNCHRONOUS_COMMIT` to an `ANY 2 SYNCHRONOUS_COMMIT`. You can also degrade from `SYNCRHONOUS_COMMIT` to `ASYNC`. However, you cannot degrade from `SYNCHRONOUS_COMMIT` to `GROUP_COMMIT` or the other way around, regardless of the commit scope groups involved. +For instance, you can degrade from an `ALL SYNCHRONOUS_COMMIT` to a `MAJORITY SYNCHRONOUS_COMMIT` or a `MAJORITY SYNCHRONOUS_COMMIT` to an `ANY 3 SYNCHRONOUS_COMMIT` or even an `ANY 3 SYNCHRONOUS_COMMIT` to an `ANY 2 SYNCHRONOUS_COMMIT`. You can also degrade from `SYNCRHONOUS_COMMIT` to `ASYNC`. However, you cannot degrade from `SYNCHRONOUS_COMMIT` to `GROUP_COMMIT` or the other way around, regardless of the commit scope groups involved. It is also possible to combine rules using `AND`, each with their own degradation clause: @@ -144,10 +144,10 @@ The `SYNCHRONOUS_COMMIT` has `DEGRADE ON` parameters: | Parameter | Type | Default | Description | | ------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | -| timeout | interval | 0 | Timeout in milliseconds (accepts other units) after which operation degrades. (0 means not set.) | -| require_write_lead | Boolean | False | Specifies whether the node must be a write lead to be able to switch to degraded operation. | +| `timeout` | interval | 0 | Timeout in milliseconds (accepts other units) after which operation degrades. (0 means not set.) | +| `require_write_lead` | Boolean | False | Specifies whether the node must be a write lead to be able to switch to degraded operation. | -These set the conditions by which the commit scope rule will degrade to a less restrictive mode of operation. +These set the conditions on which the commit scope rule will degrade to a less restrictive mode of operation. The `commit_scope_degrade_operation` must be `SYNCHRONOUS_COMMIT` with a less restrictive commit scope group or be `ASYNC`. @@ -172,14 +172,14 @@ GROUP COMMIT [ ( group_commit_parameter = value [, ...] ) ] [ ABORT ON ( abort_o | Parameter | Type | Default | Description | | -------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `timeout` | interval | 0 | Timeout in milliseconds (accepts other units). (0 means not set.) | -| `require_write_lead` | bool | false | CAMO only. If set, then for a transaction to switch to local (async) mode, a consensus request is required. | +| `require_write_lead` | Boolean | False | CAMO only. If set, then for a transaction to switch to local (async) mode, a consensus request is required. | ### DEGRADE ON parameters | Parameter | Type | Default | Description | | ------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | -| timeout | interval | 0 | Timeout in milliseconds (accepts other units) after which operation degrades. (0 means not set.) | -| require_write_lead | Boolean | False | Specifies whether the node must be a write lead to be able to switch to degraded operation. | +| `timeout` | interval | 0 | Timeout in milliseconds (accepts other units) after which operation degrades. (0 means not set.) | +| `require_write_lead` | Boolean | False | Specifies whether the node must be a write lead to be able to switch to degraded operation. | ### transaction_tracking settings @@ -233,8 +233,8 @@ Allows degrading to asynchronous operation on timeout. | Parameter | Type | Default | Description | | ------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | -| timeout | interval | 0 | Timeout in milliseconds (accepts other units) after which operation becomes asynchronous. (0 means not set.) | -| require_write_lead | Boolean | False | Specifies whether the node must be a write lead to be able to switch to asynchronous mode. | +| `timeout` | interval | 0 | Timeout in milliseconds (accepts other units) after which operation becomes asynchronous. (0 means not set.) | +| `require_write_lead` | Boolean | False | Specifies whether the node must be a write lead to be able to switch to asynchronous mode. | ## LAG CONTROL