Skip to content

Commit 29b9772

Browse files
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 0ae5030 commit 29b9772

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/api-guide.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1539,7 +1539,7 @@ In the sample code, the transaction is retried three times maximum and sleeps fo
15391539

15401540
:::
15411541

1542-
### Group commit for the Coordinator table
1542+
## Group commit for the Coordinator table
15431543

15441544
The Coordinator table that is used for Consensus Commit transactions is a vital data store, and using robust storage for it is recommended. However, utilizing more robust storage options, such as internally leveraging multi-AZ or multi-region replication, may lead to increased latency when writing records to the storage, resulting in poor throughput performance.
15451545

@@ -1559,11 +1559,11 @@ scalar.db.consensus_commit.coordinator.group_commit.enabled=true
15591559
# scalar.db.consensus_commit.coordinator.group_commit.metrics_monitor_log_enabled=true
15601560
```
15611561

1562-
#### Limitations
1562+
### Limitations
15631563

15641564
This section describes the limitations of the group commit feature.
15651565

1566-
##### Custom transaction ID passed by users
1566+
#### Custom transaction ID passed by users
15671567

15681568
The group commit feature implicitly generates an internal value and uses it as a part of transaction ID. Therefore, a custom transaction ID manually passed by users via `com.scalar.db.transaction.consensuscommit.ConsensusCommitManager.begin(String txId)` or `com.scalar.db.transaction.consensuscommit.TwoPhaseConsensusCommitManager.begin(String txId)` can't be used as is for later API calls. You need to use a transaction ID returned from`com.scalar.db.transaction.consensuscommit.ConsensusCommit.getId()` or `com.scalar.db.transaction.consensuscommit.TwoPhaseConsensusCommit.getId()` instead.
15691569

@@ -1582,7 +1582,7 @@ The group commit feature implicitly generates an internal value and uses it as a
15821582
logger.info("The transaction state: {}", manager.getState(transaction.getId()));
15831583
```
15841584

1585-
##### Prohibition of use with a two-phase commit interface
1585+
#### Prohibition of use with a two-phase commit interface
15861586

15871587
The group commit feature manages all ongoing transactions in memory. If this feature is enabled with a two-phase commit interface, the information must be solely maintained by the coordinator service to prevent conflicts caused by participant services' inconsistent writes to the Coordinator table, which may contain different transaction distributions over groups.
15881588

0 commit comments

Comments
 (0)