Skip to content

Commit 2e83983

Browse files
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 323d418 commit 2e83983

File tree

51 files changed

+497
-485
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+497
-485
lines changed

versioned_docs/version-3.11/add-scalardb-to-your-build.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The ScalarDB library is available on the [Maven Central Repository](https://mvnr
99

1010
Select your build tool, and follow the instructions to add the build dependency for ScalarDB to your application.
1111

12-
<Tabs groupId="build_dependency" queryString>
12+
<Tabs groupId="build_tools" queryString>
1313
<TabItem value="Gradle" label="Gradle" default>
1414
To add the build dependency for ScalarDB by using Gradle, add the following to `build.gradle` in your application, replacing `<VERSION>` with the version of ScalarDB that you want to use:
1515

versioned_docs/version-3.11/api-guide.mdx

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,8 @@ In the creation operations, like creating a namespace and creating a table, you
6060
Select your database to see the options available:
6161

6262
<Tabs groupId="databases" queryString>
63-
<TabItem value="Cassandra" label="Cassandra" default>
64-
| Name | Description | Default |
65-
|----------------------|----------------------------------------------------------------------------------------|------------------|
66-
| replication-strategy | Cassandra replication strategy. Must be `SimpleStrategy` or `NetworkTopologyStrategy`. | `SimpleStrategy` |
67-
| compaction-strategy | Cassandra compaction strategy, Must be `LCS`, `STCS` or `TWCS`. | `STCS` |
68-
| replication-factor | Cassandra replication factor. | 1 |
69-
</TabItem>
70-
<TabItem value="Cosmos_DB_for_NoSQL" label="Cosmos DB for NoSQL">
71-
| Name | Description | Default |
72-
|------------|-----------------------------------------------------|---------|
73-
| ru | Base resource unit. | 400 |
74-
| no-scaling | Disable auto-scaling for Cosmos DB for NoSQL. | false |
63+
<TabItem value="JDBC_databases" label="JDBC databases" default>
64+
No options are available for JDBC databases.
7565
</TabItem>
7666
<TabItem value="DynamoDB" label="DynamoDB">
7767
| Name | Description | Default |
@@ -80,8 +70,18 @@ Select your database to see the options available:
8070
| no-backup | Disable continuous backup for DynamoDB. | false |
8171
| ru | Base resource unit. | 10 |
8272
</TabItem>
83-
<TabItem value="JDBC_databases" label="JDBC_databases">
84-
No options are available for JDBC databases.
73+
<TabItem value="Cosmos_DB_for_NoSQL" label="Cosmos DB for NoSQL">
74+
| Name | Description | Default |
75+
|------------|-----------------------------------------------------|---------|
76+
| ru | Base resource unit. | 400 |
77+
| no-scaling | Disable auto-scaling for Cosmos DB for NoSQL. | false |
78+
</TabItem>
79+
<TabItem value="Cassandra" label="Cassandra">
80+
| Name | Description | Default |
81+
|----------------------|----------------------------------------------------------------------------------------|------------------|
82+
| replication-strategy | Cassandra replication strategy. Must be `SimpleStrategy` or `NetworkTopologyStrategy`. | `SimpleStrategy` |
83+
| compaction-strategy | Cassandra compaction strategy, Must be `LCS`, `STCS` or `TWCS`. | `STCS` |
84+
| replication-factor | Cassandra replication factor. | 1 |
8585
</TabItem>
8686
</Tabs>
8787

@@ -298,6 +298,7 @@ admin.importTable("ns", "tbl", options);
298298

299299
You should carefully plan to import a table to ScalarDB in production because it will add transaction metadata columns to your database tables and the ScalarDB metadata tables. In this case, there would also be several differences between your database and ScalarDB, as well as some limitations. For details, see [Importing Existing Tables to ScalarDB by Using ScalarDB Schema Loader](./schema-loader-import.mdx).
300300

301+
301302
:::
302303

303304
## Transactional API

versioned_docs/version-3.11/backup-restore.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The backup methods by database listed below are just examples of some of the dat
4040

4141
:::
4242

43-
<Tabs groupId="database" queryString>
43+
<Tabs groupId="databases" queryString>
4444
<TabItem value="Amazon_RDS_or_Azure_Database_for_MySQL_or_PostgreSQL" label="Amazon RDS or Azure Database for MySQL or PostgreSQL" default>
4545
You can restore to any point within the backup retention period by using the automated backup feature.
4646
</TabItem>
@@ -85,22 +85,22 @@ The backup methods by database listed below are just examples of some of the dat
8585
:::
8686

8787
<Tabs groupId="databases" queryString>
88-
<TabItem value="Cassandra" label="Cassandra" default>
89-
Cassandra has a built-in replication feature, so you do not always have to create a transactionally consistent backup. For example, if the replication factor is set to `3` and only the data of one of the nodes in a Cassandra cluster is lost, you won't need a transactionally consistent backup (snapshot) because the node can be recovered by using a normal, transactionally inconsistent backup (snapshot) and the repair feature.
90-
91-
However, if the quorum of cluster nodes loses their data, you will need a transactionally consistent backup (snapshot) to restore the cluster to a certain transactionally consistent point.
88+
<TabItem value="DynamoDB" label="DynamoDB" default>
89+
You must enable the PITR feature for DynamoDB tables. If you're using [ScalarDB Schema Loader](schema-loader.mdx) to create schemas, the tool enables the PITR feature for tables by default.
9290

93-
To create a transactionally consistent cluster-wide backup (snapshot), pause the application that is using ScalarDB or [ScalarDB Cluster (redirects to the Enterprise docs site)](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/) and create backups (snapshots) of the nodes as described in [Back up with explicit pausing](#back-up-with-explicit-pausing) or stop the Cassandra cluster, take copies of all the data in the nodes, and start the cluster.
91+
To specify a transactionally consistent restore point, pause your application that is using ScalarDB with DynamoDB as described in [Back up with explicit pausing](#back-up-with-explicit-pausing).
9492
</TabItem>
9593
<TabItem value="Cosmos_DB_for_NoSQL" label="Cosmos DB for NoSQL">
9694
You must create a Cosmos DB for NoSQL account with a continuous backup policy that has the PITR feature enabled. After enabling the feature, backups are created continuously.
9795

9896
To specify a transactionally consistent restore point, pause your application that is using ScalarDB with Cosmos DB for NoSQL as described in [Back up with explicit pausing](#back-up-with-explicit-pausing).
9997
</TabItem>
100-
<TabItem value="DynamoDB" label="DynamoDB">
101-
You must enable the PITR feature for DynamoDB tables. If you're using [ScalarDB Schema Loader](schema-loader.mdx) to create schemas, the tool enables the PITR feature for tables by default.
98+
<TabItem value="Cassandra" label="Cassandra">
99+
Cassandra has a built-in replication feature, so you do not always have to create a transactionally consistent backup. For example, if the replication factor is set to `3` and only the data of one of the nodes in a Cassandra cluster is lost, you won't need a transactionally consistent backup (snapshot) because the node can be recovered by using a normal, transactionally inconsistent backup (snapshot) and the repair feature.
102100

103-
To specify a transactionally consistent restore point, pause your application that is using ScalarDB with DynamoDB as described in [Back up with explicit pausing](#back-up-with-explicit-pausing).
101+
However, if the quorum of cluster nodes loses their data, you will need a transactionally consistent backup (snapshot) to restore the cluster to a certain transactionally consistent point.
102+
103+
To create a transactionally consistent cluster-wide backup (snapshot), pause the application that is using ScalarDB or [ScalarDB Cluster (redirects to the Enterprise docs site)](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/) and create backups (snapshots) of the nodes as described in [Back up with explicit pausing](#back-up-with-explicit-pausing) or stop the Cassandra cluster, take copies of all the data in the nodes, and start the cluster.
104104
</TabItem>
105105
</Tabs>
106106

0 commit comments

Comments
 (0)