Skip to content

Commit b674122

Browse files
josh-wongjosh-wong
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 6c27ba7 commit b674122

File tree

3 files changed

+97
-17
lines changed

3 files changed

+97
-17
lines changed

‎docs/configurations.mdx‎

Lines changed: 48 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,12 @@ The following performance-related configurations are available for the Consensus
151151

152152
ScalarDB has a storage (database) abstraction layer that supports multiple storage implementations. You can specify the storage implementation by using the `scalar.db.storage` property.
153153

154+
:::note
155+
156+
For details about using multiple storages, see [Multi-storage configurations](#multi-storage-configurations).
157+
158+
:::
159+
154160
Select a database to see the configurations available for each storage.
155161

156162
<Tabs groupId="databases" queryString>
@@ -161,7 +167,6 @@ Select a database to see the configurations available for each storage.
161167

162168
- **Field:** `scalar.db.storage`
163169
- **Description:** `jdbc` must be specified.
164-
- **Default value:** empty
165170

166171
<h4>`contact_points`</h4>
167172

@@ -317,7 +322,6 @@ For information on YugabyteDB's smart driver and load balancing, see [YugabyteDB
317322

318323
- **Field:** `scalar.db.storage`
319324
- **Description:** `dynamo` must be specified.
320-
- **Default value:** empty
321325

322326
<h4>`contact_points`</h4>
323327

@@ -356,7 +360,6 @@ For information on YugabyteDB's smart driver and load balancing, see [YugabyteDB
356360

357361
- **Field:** `scalar.db.storage`
358362
- **Description:** `cosmos` must be specified.
359-
- **Default value:** empty
360363

361364
<h4>`contact_points`</h4>
362365

@@ -383,7 +386,6 @@ For information on YugabyteDB's smart driver and load balancing, see [YugabyteDB
383386

384387
- **Field:** `scalar.db.storage`
385388
- **Description:** `cassandra` must be specified.
386-
- **Default value:** empty
387389

388390
<h4>`contact_points`</h4>
389391

@@ -411,11 +413,49 @@ For information on YugabyteDB's smart driver and load balancing, see [YugabyteDB
411413
</TabItem>
412414
</Tabs>
413415

414-
### Multi-storage support
416+
### Multi-storage configurations
417+
418+
ScalarDB supports using multiple storage implementations simultaneously. For details about using multiple storages, see [Multi-Storage Transactions](./multi-storage-transactions.mdx).
419+
420+
#### `storage`
421+
422+
- **Field:** `scalar.db.storage`
423+
- **Description:** `multi-storage` must be specified.
424+
425+
#### `multi_storage.storages`
426+
427+
- **Field:** `scalar.db.multi_storage.storages`
428+
- **Description:** Comma-separated storage names (for example, `cassandra,mysql`). These storage names will be used in the `scalar.db.multi_storage.namespace_mapping` property to map namespaces to storages.
429+
- **Default value:** empty
430+
431+
#### `multi_storage.default_storage`
432+
433+
- **Field:** `scalar.db.multi_storage.default_storage`
434+
- **Description:** Default storage name. This storage will be used for any namespace that doesn't have mapping defined in the `scalar.db.multi_storage.namespace_mapping` property.
435+
- **Default value:** empty
436+
437+
#### `multi_storage.namespace_mapping`
438+
439+
- **Field:** `scalar.db.multi_storage.namespace_mapping`
440+
- **Description:** Mapping of namespaces to storages (for example, `user:my_cassandra,coordinator:my_mysql`).
441+
- **Default value:** empty
442+
443+
:::tip
444+
445+
The storage names (`<STORAGE_NAME_FOR_NAMESPACE>`) are arbitrary values that you need to define. You can use any names that you like as long as they are consistent across the multi-storage configurations.
446+
447+
:::
448+
449+
#### `multi_storage.storages.<STORAGE_NAME_FOR_NAMESPACE>.<PROPERTY_NAME>`
450+
451+
For configuring specific storages, use `scalar.db.multi_storage.storages.<STORAGE_NAME_FOR_NAMESPACE>.<PROPERTY_NAME>`, with `<STORAGE_NAME_FOR_NAMESPACE>` being one of the storage names specified in the `scalar.db.multi_storage.storages` property and `<PROPERTY_NAME>` being the property name for the specific storage.
452+
453+
For example, if you've defined [namespace mapping](#multi_storagenamespace_mapping) as `scalar.db.multi_storage.namespace_mapping=user:my_cassandra,coordinator:my_mysql`, with `my_cassandra` and `my_mysql` being the storage names for the `user` and `coordinator` namespaces, respectively:
415454

416-
ScalarDB supports using multiple storage implementations simultaneously. You can use multiple storages by specifying `multi-storage` as the value for the `scalar.db.storage` property.
455+
- You can specify the contact points for Cassandra by using `scalar.db.multi_storage.storages.my_cassandra.contact_points`.
456+
- You can specify the max idle time for the connection pool settings for MySQL by using `scalar.db.multi_storage.storages.my_mysql.jdbc.connection_pool.max_idle`.
417457

418-
For details about using multiple storages, see [Multi-Storage Transactions](multi-storage-transactions.mdx).
458+
For details about the properties available for each storage, see [Storage-related configurations](#storage-related-configurations).
419459

420460
### Cross-partition scan configurations
421461

@@ -447,7 +487,7 @@ For non-JDBC databases, transactions could be executed at read-committed snapsho
447487
- **Description:** Enable ordering in cross-partition scan.
448488
- **Default value:** `false`
449489

450-
### Scan fetch size
490+
### Scan configurations
451491

452492
You can configure the fetch size for storage scan operations by using the following property.
453493

‎docs/multi-storage-transactions.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ scalar.db.multi_storage.namespace_mapping=user:cassandra,coordinator:mysql
6161
scalar.db.multi_storage.default_storage=cassandra
6262
```
6363

64-
For additional configurations, see [ScalarDB Configurations](configurations.mdx).
64+
For additional configurations, see [Multi-storage configurations](configurations.mdx#multi-storage-configurations).
6565

6666
## Hands-on tutorial
6767

‎docs/scalardb-cluster/scalardb-cluster-configurations.mdx‎

Lines changed: 48 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,12 @@ The following performance-related configurations are available for the Consensus
228228

229229
ScalarDB has a storage (database) abstraction layer that supports multiple storage implementations. You can specify the storage implementation by using the `scalar.db.storage` property.
230230

231+
:::note
232+
233+
For details about using multiple storages, see [Multi-storage configurations](#multi-storage-configurations).
234+
235+
:::
236+
231237
Select a database to see the configurations available for each storage.
232238

233239
<Tabs groupId="databases" queryString>
@@ -238,7 +244,6 @@ Select a database to see the configurations available for each storage.
238244

239245
- **Field:** `scalar.db.storage`
240246
- **Description:** `jdbc` must be specified.
241-
- **Default value:** empty
242247

243248
<h4>`contact_points`</h4>
244249

@@ -361,7 +366,6 @@ The following configurations are available for DynamoDB.
361366

362367
- **Field:** `scalar.db.storage`
363368
- **Description:** `dynamo` must be specified.
364-
- **Default value:** empty
365369

366370
<h4>`contact_points`</h4>
367371

@@ -400,7 +404,6 @@ The following configurations are available for DynamoDB.
400404

401405
- **Field:** `scalar.db.storage`
402406
- **Description:** `cosmos` must be specified.
403-
- **Default value:** empty
404407

405408
<h4>`contact_points`</h4>
406409

@@ -427,7 +430,6 @@ The following configurations are available for DynamoDB.
427430

428431
- **Field:** `scalar.db.storage`
429432
- **Description:** `cassandra` must be specified.
430-
- **Default value:** empty
431433

432434
<h4>`contact_points`</h4>
433435

@@ -455,11 +457,49 @@ The following configurations are available for DynamoDB.
455457
</TabItem>
456458
</Tabs>
457459

458-
#### Multi-storage support
460+
#### Multi-storage configurations
461+
462+
ScalarDB supports using multiple storage implementations simultaneously. For details about using multiple storages, see [Multi-Storage Transactions](../multi-storage-transactions.mdx).
463+
464+
##### `storage`
465+
466+
- **Field:** `scalar.db.storage`
467+
- **Description:** `multi-storage` must be specified.
468+
469+
##### `multi_storage.storages`
470+
471+
- **Field:** `scalar.db.multi_storage.storages`
472+
- **Description:** Comma-separated storage names (for example, `cassandra,mysql`). These storage names will be used in the `scalar.db.multi_storage.namespace_mapping` property to map namespaces to storages.
473+
- **Default value:** empty
474+
475+
##### `multi_storage.default_storage`
476+
477+
- **Field:** `scalar.db.multi_storage.default_storage`
478+
- **Description:** Default storage name. This storage will be used for any namespace that doesn't have mapping defined in the `scalar.db.multi_storage.namespace_mapping` property.
479+
- **Default value:** empty
480+
481+
##### `multi_storage.namespace_mapping`
482+
483+
- **Field:** `scalar.db.multi_storage.namespace_mapping`
484+
- **Description:** Mapping of namespaces to storages (for example, `user:my_cassandra,coordinator:my_mysql`).
485+
- **Default value:** empty
486+
487+
:::tip
488+
489+
The storage names (`<STORAGE_NAME_FOR_NAMESPACE>`) are arbitrary values that you need to define. You can use any names that you like as long as they are consistent across the multi-storage configurations.
490+
491+
:::
492+
493+
##### `multi_storage.storages.<STORAGE_NAME_FOR_NAMESPACE>.<PROPERTY_NAME>`
494+
495+
For configuring specific storages, use `scalar.db.multi_storage.storages.<STORAGE_NAME_FOR_NAMESPACE>.<PROPERTY_NAME>`, with `<STORAGE_NAME_FOR_NAMESPACE>` being one of the storage names specified in the `scalar.db.multi_storage.storages` property and `<PROPERTY_NAME>` being the property name for the specific storage.
496+
497+
For example, if you've defined [namespace mapping](#multi_storagenamespace_mapping) as `scalar.db.multi_storage.namespace_mapping=user:my_cassandra,coordinator:my_mysql`, with `my_cassandra` and `my_mysql` being the storage names for the `user` and `coordinator` namespaces, respectively:
459498

460-
ScalarDB supports using multiple storage implementations simultaneously. You can use multiple storages by specifying `multi-storage` as the value for the `scalar.db.storage` property.
499+
- You can specify the contact points for Cassandra by using `scalar.db.multi_storage.storages.my_cassandra.contact_points`.
500+
- You can specify the max idle time for the connection pool settings for MySQL by using `scalar.db.multi_storage.storages.my_mysql.jdbc.connection_pool.max_idle`.
461501

462-
For details about using multiple storages, see [Multi-Storage Transactions](../multi-storage-transactions.mdx).
502+
For details about the properties available for each storage, see [Storage-related configurations](#storage-related-configurations).
463503

464504
#### Cross-partition scan configurations
465505

@@ -491,7 +531,7 @@ For non-JDBC databases, we do not recommend enabling cross-partition scan with t
491531
- **Description:** Enable ordering in cross-partition scan.
492532
- **Default value:** `false`
493533

494-
#### Scan fetch size
534+
#### Scan configurations
495535

496536
You can configure the fetch size for storage scan operations by using the following property.
497537

0 commit comments

Comments
 (0)