Skip to content

Commit c57dbe9

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

File tree

35 files changed

+171
-171
lines changed

35 files changed

+171
-171
lines changed

‎versioned_docs/version-3.8/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_tool" 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.8/api-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Select your database to see the options available:
8080
| no-backup | Disable continuous backup for DynamoDB. | false |
8181
| ru | Base resource unit. | 10 |
8282
</TabItem>
83-
<TabItem value="JDBC_databases" label="JDBC_databases">
83+
<TabItem value="JDBC_databases" label="JDBC databases">
8484
No options are available for JDBC databases.
8585
</TabItem>
8686
</Tabs>

‎versioned_docs/version-3.8/backup-restore.mdx

Lines changed: 2 additions & 2 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>
@@ -90,7 +90,7 @@ The backup methods by database listed below are just examples of some of the dat
9090

9191
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.
9292

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.
93+
To create a transactionally consistent cluster-wide backup (snapshot), pause the application that is using ScalarDB or [ScalarDB Server](scalardb-server.mdx) 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.
9494
</TabItem>
9595
<TabItem value="Cosmos_DB_for_NoSQL" label="Cosmos DB for NoSQL">
9696
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.

‎versioned_docs/version-3.8/configurations.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -67,28 +67,28 @@ Select a database to see the configurations available for each storage.
6767
| `scalar.db.username` | Username to access the database. | |
6868
| `scalar.db.password` | Password to access the database. | |
6969
</TabItem>
70-
<TabItem value="CosmosDB_for_NoSQL" label="CosmosDB for NoSQL">
70+
<TabItem value="Cosmos_DB_for_NoSQL" label="Cosmos DB for NoSQL">
7171
The following configurations are available for CosmosDB for NoSQL:
7272

73-
| Name | Description | Default |
74-
|--------------------------------------------|----------------------------------------------------------------------------------------------------------|------------|
75-
| `scalar.db.storage` | `cosmos` must be specified. | - |
76-
| `scalar.db.contact_points` | Azure Cosmos DB for NoSQL endpoint with which ScalarDB should communicate. | |
77-
| `scalar.db.password` | Either a master or read-only key used to perform authentication for accessing Azure Cosmos DB for NoSQL. | |
78-
| `scalar.db.cosmos.table_metadata.database` | Database name for the table metadata used for ScalarDB. | `scalardb` |
73+
| Name | Description | Default |
74+
|--------------------------------------|----------------------------------------------------------------------------------------------------------|------------|
75+
| `scalar.db.storage` | `cosmos` must be specified. | - |
76+
| `scalar.db.contact_points` | Azure Cosmos DB for NoSQL endpoint with which ScalarDB should communicate. | |
77+
| `scalar.db.password` | Either a master or read-only key used to perform authentication for accessing Azure Cosmos DB for NoSQL. | |
78+
| `scalar.db.cosmos.table_metadata.database` | Database name for the table metadata used for ScalarDB. | `scalardb` |
7979
</TabItem>
8080
<TabItem value="DynamoDB" label="DynamoDB">
8181
The following configurations are available for DynamoDB:
8282

83-
| Name | Description | Default |
84-
|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
85-
| `scalar.db.storage` | `dynamo` must be specified. | - |
86-
| `scalar.db.contact_points` | AWS region with which ScalarDB should communicate (e.g., `us-east-1`). | |
87-
| `scalar.db.username` | AWS access key used to identify the user interacting with AWS. | |
88-
| `scalar.db.password` | AWS secret access key used to authenticate the user interacting with AWS. | |
89-
| `scalar.db.dynamo.endpoint_override` | Amazon DynamoDB endpoint with which ScalarDB should communicate. This is primarily used for testing with a local instance instead of an AWS service. | |
90-
| `scalar.db.dynamo.table_metadata.namespace` | Namespace name for the table metadata used for ScalarDB. | `scalardb` |
91-
| `scalar.db.dynamo.namespace.prefix` | Prefix for the user namespaces and metadata namespace names. Since AWS requires having unique tables names in a single AWS region, this is useful if you want to use multiple ScalarDB environments (development, production, etc.) in a single AWS region. | |
83+
| Name | Description | Default |
84+
|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
85+
| `scalar.db.storage` | `dynamo` must be specified. | - |
86+
| `scalar.db.contact_points` | AWS region with which ScalarDB should communicate (e.g., `us-east-1`). | |
87+
| `scalar.db.username` | AWS access key used to identify the user interacting with AWS. | |
88+
| `scalar.db.password` | AWS secret access key used to authenticate the user interacting with AWS. | |
89+
| `scalar.db.dynamo.endpoint_override` | Amazon DynamoDB endpoint with which ScalarDB should communicate. This is primarily used for testing with a local instance instead of an AWS service. | |
90+
| `scalar.db.dynamo.table_metadata.namespace` | Namespace name for the table metadata used for ScalarDB. | `scalardb` |
91+
| `scalar.db.dynamo.namespace.prefix` | Prefix for the user namespaces and metadata namespace names. Since AWS requires having unique tables names in a single AWS region, this is useful if you want to use multiple ScalarDB environments (development, production, etc.) in a single AWS region. | |
9292
</TabItem>
9393
<TabItem value="JDBC_databases" label="JDBC databases">
9494
The following configurations are available for JDBC databases:
@@ -103,9 +103,9 @@ Select a database to see the configurations available for each storage.
103103
| `scalar.db.jdbc.connection_pool.max_idle` | Maximum number of connections that can remain idle in the connection pool. | `50` |
104104
| `scalar.db.jdbc.connection_pool.max_total` | Maximum total number of idle and borrowed connections that can be active at the same time for the connection pool. Use a negative value for no limit. | `100` |
105105
| `scalar.db.jdbc.prepared_statements_pool.enabled` | Setting this property to `true` enables prepared-statement pooling. | `false` |
106-
| `scalar.db.jdbc.prepared_statements_pool.max_open` | Maximum number of open statements that can be allocated from the statement pool at the same time. Use a negative value for no limit. | `-1` |
106+
| `scalar.db.jdbc.prepared_statements_pool.max_open` | Maximum number of open statements that can be allocated from the statement pool at the same time. Use a negative value for no limit. | `-1` |
107107
| `scalar.db.jdbc.isolation_level` | Isolation level for JDBC. `READ_UNCOMMITTED`, `READ_COMMITTED`, `REPEATABLE_READ`, or `SERIALIZABLE` can be specified. | Underlying-database specific |
108-
| `scalar.db.jdbc.table_metadata.schema` | Schema name for the table metadata used for ScalarDB. | `scalardb` |
108+
| `scalar.db.jdbc.table_metadata.schema` | Schema name for the table metadata used for ScalarDB. | `scalardb` |
109109
| `scalar.db.jdbc.table_metadata.connection_pool.min_idle` | Minimum number of idle connections in the connection pool for the table metadata. | `5` |
110110
| `scalar.db.jdbc.table_metadata.connection_pool.max_idle` | Maximum number of connections that can remain idle in the connection pool for the table metadata. | `10` |
111111
| `scalar.db.jdbc.table_metadata.connection_pool.max_total` | Maximum total number of idle and borrowed connections that can be active at the same time for the connection pool for the table metadata. Use a negative value for no limit. | `25` |

‎versioned_docs/version-3.8/getting-started-with-scalardb-by-using-kotlin.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ For a list of databases that ScalarDB supports, see [Supported Databases](scalar
5050
<TabItem value="Cassandra" label="Cassandra" default>
5151
Confirm that you have Cassandra installed. If Cassandra isn't installed, visit [Downloading Cassandra](https://cassandra.apache.org/_/download.html).
5252

53-
### Configure Cassandra
53+
**Configure Cassandra**
5454

5555
Open **cassandra.yaml** in your preferred IDE. Then, change `commitlog_sync` from `periodic` to `batch` so that you don't lose data if a quorum of replica nodes goes down.
5656

57-
### Configure ScalarDB
57+
**Configure ScalarDB**
5858

5959
The following instructions assume that you have properly installed and configured the JDK and Cassandra in your local environment, and Cassandra is running on your localhost.
6060

@@ -78,16 +78,16 @@ For a list of databases that ScalarDB supports, see [Supported Databases](scalar
7878
<TabItem value="Cosmos_DB_for_NoSQL" label="Cosmos DB for NoSQL">
7979
To use Azure Cosmos DB for NoSQL, you must have an Azure account. If you don't have an Azure account, visit [Create an Azure Cosmos DB account](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/quickstart-portal#create-account).
8080

81-
### Configure Cosmos DB for NoSQL
81+
**Configure Cosmos DB for NoSQL**
8282

8383
Set the **default consistency level** to **Strong** according to the official document at [Configure the default consistency level](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/how-to-manage-consistency#configure-the-default-consistency-level).
8484

85-
### Configure ScalarDB
85+
**Configure ScalarDB**
8686

87-
The following instructions assume that you have properly installed and configured the JDK in your local environment and properly configured your Cosmos DB for NoSQL account in Azure.
87+
The following instructions assume that you have properly installed and configured the JDK in your local environment and properly configured your Cosmos DB for NoSQL account in Azure.
8888

8989
The **scalardb.properties** file in the `docs/getting-started-kotlin` directory holds database configurations for ScalarDB. Be sure to change the values for `scalar.db.contact_points` and `scalar.db.password` as described.
90-
90+
9191
```properties
9292
# The Cosmos DB for NoSQL storage implementation is used for Consensus Commit.
9393
scalar.db.storage=cosmos
@@ -108,7 +108,7 @@ You can use a primary key or a secondary key as the value for `scalar.db.passwor
108108
<TabItem value="DynamoDB" label="DynamoDB">
109109
To use Amazon DynamoDB, you must have an AWS account. If you don't have an AWS account, visit [Getting started: Are you a first-time AWS user?](https://docs.aws.amazon.com/accounts/latest/reference/welcome-first-time-user.html).
110110

111-
### Configure ScalarDB
111+
**Configure ScalarDB**
112112

113113
The following instructions assume that you have properly installed and configured the JDK in your local environment.
114114

@@ -129,11 +129,11 @@ You can use a primary key or a secondary key as the value for `scalar.db.passwor
129129
<TabItem value="JDBC_databases" label="JDBC databases">
130130
Confirm that you have a JDBC database installed. For a list of supported JDBC databases, see [Supported Databases](scalardb-supported-databases.mdx).
131131

132-
### Configure ScalarDB
132+
**Configure ScalarDB**
133133

134134
The following instructions assume that you have properly installed and configured the JDK and JDBC database in your local environment, and the JDBC database is running on your localhost.
135135

136-
The **scalardb.properties** file in the `docs/getting-started-kotlin` directory holds database configurations for ScalarDB. The following is a basic configuration for JDBC databases.
136+
The **scalardb.properties** file in the `docs/getting-started-kotlin` directory holds database configurations for ScalarDB. The following is a basic configuration for JDBC databases.
137137

138138
:::note
139139

0 commit comments

Comments
 (0)