Skip to content

Commit

Permalink
Small changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
jpe442 committed Sep 10, 2024
1 parent 3845b6d commit 620b4a5
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 15 deletions.
9 changes: 5 additions & 4 deletions product_docs/docs/pgd/5.6/commit-scopes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: PGD Synchronous Commit
title: Synchronous Commit
deepToC: true
---

Expand Down
20 changes: 10 additions & 10 deletions product_docs/docs/pgd/5.6/reference/commit-scopes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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`.

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 620b4a5

Please sign in to comment.