Skip to content

Commit 82264a2

Browse files
github-actions[bot]josh-wong
github-actions[bot]
and
josh-wong
authored
AUTO: Sync ScalarDB docs in English to docs site repo (#883)
Co-authored-by: josh-wong <[email protected]>
1 parent 3424350 commit 82264a2

11 files changed

+62
-40
lines changed

‎versioned_docs/version-3.10/scalardb-benchmarks/README.mdx‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
tags:
33
- Community
4+
- Enterprise Standard
5+
- Enterprise Premium
46
---
57

68
# ScalarDB Benchmarking Tools
@@ -64,9 +66,11 @@ To build the benchmarking tools, run the following command:
6466

6567
### Load the schema
6668

67-
Before loading the initial data, the tables must be defined by using the [ScalarDB Schema Loader](../schema-loader.mdx). To apply the schema, go to the [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases) page and download the ScalarDB Schema Loader that matches the version of ScalarDB that you are using to the `scalardb-benchmarks` root folder.
69+
Before loading the initial data, the tables must be defined by using the [ScalarDB Schema Loader](../schema-loader.mdx). You can download the ScalarDB Schema Loader on the [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases) page. Select the Schema Loader based on how you access ScalarDB:
70+
- **Using the ScalarDB Core library (Community edition)?:** Choose `scalardb-schema-loader-<VERSION>.jar` for the version of ScalarDB that you're using. Then, save the `.jar` file in the `scalardb-benchmarks` root directory.
71+
- **Using ScalarDB Cluster (Enterprise edition)?:** Choose `scalardb-cluster-schema-loader-<VERSION>-all.jar` for the version of ScalarDB Cluster that you're using. Then, save the `.jar` file in the `scalardb-benchmarks` root directory.
6872

69-
In addition, you need a properties file that contains database configurations for ScalarDB. For details about configuring the ScalarDB properties file, see [ScalarDB Configurations](../configurations.mdx).
73+
In addition, you need a properties file for accessing ScalarDB via the Java CRUD interface. For details about configuring the ScalarDB properties file, see [ScalarDB Configurations](../configurations.mdx) or [ScalarDB Cluster Client Configurations](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#client-configurations).
7074

7175
After applying the schema and configuring the properties file, select a benchmark and follow the instructions to create the tables.
7276

@@ -77,20 +81,38 @@ After applying the schema and configuring the properties file, select a benchmar
7781
```console
7882
java -jar scalardb-schema-loader-<VERSION>.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f tpcc-schema.json --coordinator
7983
```
84+
85+
If you are using ScalarDB Cluster, run the following command instead:
86+
87+
```console
88+
java -jar scalardb-cluster-schema-loader-<VERSION>-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f tpcc-schema.json --coordinator
89+
```
8090
</TabItem>
8191
<TabItem value="YCSB" label="YCSB">
8292
To create tables for YCSB benchmarking ([`ycsb-schema.json`](https://github.com/scalar-labs/scalardb-benchmarks/blob/master/ycsb-schema.json)), run the following command, replacing the contents in the angle brackets as described:
8393

8494
```console
8595
java -jar scalardb-schema-loader-<VERSION>.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-schema.json --coordinator
8696
```
97+
98+
If you are using ScalarDB Cluster, run the following command instead:
99+
100+
```console
101+
java -jar scalardb-cluster-schema-loader-<VERSION>-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-schema.json --coordinator
102+
```
87103
</TabItem>
88104
<TabItem value="multi-storage_YCSB" label="Multi-storage YCSB">
89105
To create tables for multi-storage YCSB benchmarking ([`ycsb-multi-storage-schema.json`](https://github.com/scalar-labs/scalardb-benchmarks/blob/master/ycsb-multi-storage-schema.json)), run the following command, replacing the contents in the angle brackets as described:
90106

91107
```console
92108
java -jar scalardb-schema-loader-<VERSION>.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-multi-storage-schema.json --coordinator
93109
```
110+
111+
If you are using ScalarDB Cluster, run the following command instead:
112+
113+
```console
114+
java -jar scalardb-cluster-schema-loader-<VERSION>-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-multi-storage-schema.json --coordinator
115+
```
94116
</TabItem>
95117
</Tabs>
96118

‎versioned_docs/version-3.10/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ To add a dependency on ScalarDB Cluster Client by using Gradle, use the followin
117117

118118
```gradle
119119
dependencies {
120-
implementation 'com.scalar-labs:scalardb-cluster-client:3.10.6'
120+
implementation 'com.scalar-labs:scalardb-cluster-client:3.10.7'
121121
}
122122
```
123123

@@ -127,7 +127,7 @@ To add a dependency by using Maven, use the following:
127127
<dependency>
128128
<groupId>com.scalar-labs</groupId>
129129
<artifactId>scalardb-cluster-client</artifactId>
130-
<version>3.10.6</version>
130+
<version>3.10.7</version>
131131
</dependency>
132132
```
133133

@@ -222,11 +222,11 @@ scalar.db.contact_points=direct-kubernetes:ns/scalardb-cluster
222222

223223
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster).
224224
Using the Schema Loader for Cluster is basically the same as using the [ScalarDB Schema Loader](../schema-loader.mdx) except the name of the JAR file is different.
225-
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.6).
225+
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.7).
226226
After downloading the JAR file, you can run Schema Loader for Cluster with the following command:
227227

228228
```console
229-
java -jar scalardb-cluster-schema-loader-3.10.6-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
229+
java -jar scalardb-cluster-schema-loader-3.10.7-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
230230
```
231231

232232
## ScalarDB Cluster SQL
@@ -266,8 +266,8 @@ To add the dependencies on the ScalarDB Cluster JDBC driver by using Gradle, use
266266

267267
```gradle
268268
dependencies {
269-
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.10.6'
270-
implementation 'com.scalar-labs:scalardb-cluster-client:3.10.6'
269+
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.10.7'
270+
implementation 'com.scalar-labs:scalardb-cluster-client:3.10.7'
271271
}
272272
```
273273

@@ -278,12 +278,12 @@ To add the dependencies by using Maven, use the following:
278278
<dependency>
279279
<groupId>com.scalar-labs</groupId>
280280
<artifactId>scalardb-sql-jdbc</artifactId>
281-
<version>3.10.6</version>
281+
<version>3.10.7</version>
282282
</dependency>
283283
<dependency>
284284
<groupId>com.scalar-labs</groupId>
285285
<artifactId>scalardb-cluster-client</artifactId>
286-
<version>3.10.6</version>
286+
<version>3.10.7</version>
287287
</dependency>
288288
</dependencies>
289289
```
@@ -301,8 +301,8 @@ To add the dependencies by using Gradle, use the following:
301301

302302
```gradle
303303
dependencies {
304-
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.10.6'
305-
implementation 'com.scalar-labs:scalardb-cluster-client:3.10.6'
304+
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.10.7'
305+
implementation 'com.scalar-labs:scalardb-cluster-client:3.10.7'
306306
}
307307
```
308308

@@ -313,12 +313,12 @@ To add the dependencies by using Maven, use the following:
313313
<dependency>
314314
<groupId>com.scalar-labs</groupId>
315315
<artifactId>scalardb-sql-spring-data</artifactId>
316-
<version>3.10.6</version>
316+
<version>3.10.7</version>
317317
</dependency>
318318
<dependency>
319319
<groupId>com.scalar-labs</groupId>
320320
<artifactId>scalardb-cluster-client</artifactId>
321-
<version>3.10.6</version>
321+
<version>3.10.7</version>
322322
</dependency>
323323
</dependencies>
324324
```
@@ -363,18 +363,18 @@ For details about how to configure Spring Data JDBC for ScalarDB, see [Configura
363363

364364
Like other SQL databases, ScalarDB SQL also provides a CLI tool where you can issue SQL statements interactively in a command-line shell.
365365

366-
You can download the SQL CLI for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.6). After downloading the JAR file, you can run the SQL CLI with the following command:
366+
You can download the SQL CLI for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.7). After downloading the JAR file, you can run the SQL CLI with the following command:
367367

368368
```console
369-
java -jar scalardb-cluster-sql-cli-3.10.6-all.jar --config <PATH_TO_CONFIG_FILE>
369+
java -jar scalardb-cluster-sql-cli-3.10.7-all.jar --config <PATH_TO_CONFIG_FILE>
370370
```
371371

372372
#### Usage
373373

374374
You can see the CLI usage with the `-h` option as follows:
375375

376376
```console
377-
java -jar scalardb-cluster-sql-cli-3.10.6-all.jar -h
377+
java -jar scalardb-cluster-sql-cli-3.10.7-all.jar -h
378378
Usage: scalardb-sql-cli [-hs] -c=PROPERTIES_FILE [-e=COMMAND] [-f=FILE]
379379
[-l=LOG_FILE] [-o=<outputFormat>]
380380
Starts ScalarDB SQL CLI.

‎versioned_docs/version-3.10/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,11 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
105105

106106
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster).
107107
Using the Schema Loader for Cluster is basically the same as using the [Schema Loader for ScalarDB](../schema-loader.mdx) except the name of the JAR file is different.
108-
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.6).
108+
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.7).
109109
After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
110110

111111
```console
112-
java -jar scalardb-cluster-schema-loader-3.10.6-all.jar --config database.properties -f schema.json --coordinator
112+
java -jar scalardb-cluster-schema-loader-3.10.7-all.jar --config database.properties -f schema.json --coordinator
113113
```
114114

115115
## Step 4. Run operations from GraphiQL

‎versioned_docs/version-3.10/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
107107

108108
## Step 3. Load a schema
109109

110-
To load a schema, you need to use [the SQL CLI](developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli). You can download the SQL CLI from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.6). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
110+
To load a schema, you need to use [the SQL CLI](developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli). You can download the SQL CLI from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.7). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
111111

112112
```console
113-
java -jar scalardb-cluster-sql-cli-3.10.6-all.jar --config scalardb-sql.properties --file schema.sql
113+
java -jar scalardb-cluster-sql-cli-3.10.7-all.jar --config scalardb-sql.properties --file schema.sql
114114
```
115115

116116
## Step 4. Load the initial data

‎versioned_docs/version-3.10/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
106106

107107
## Step 3. Load a schema
108108

109-
To load a schema, you need to use [the SQL CLI](developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli). You can download the SQL CLI from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.6). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
109+
To load a schema, you need to use [the SQL CLI](developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli). You can download the SQL CLI from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.7). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
110110

111111
```console
112-
java -jar scalardb-cluster-sql-cli-3.10.6-all.jar --config scalardb-sql.properties --file schema.sql
112+
java -jar scalardb-cluster-sql-cli-3.10.7-all.jar --config scalardb-sql.properties --file schema.sql
113113
```
114114

115115
## Step 4. Modify `application.properties`

‎versioned_docs/version-3.10/scalardb-cluster/getting-started-with-scalardb-cluster.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Then, delete the existing dependency for `com.scalar-labs:scalardb` from the `de
162162
dependencies {
163163
...
164164
165-
implementation 'com.scalar-labs:scalardb-cluster-client:3.10.6'
165+
implementation 'com.scalar-labs:scalardb-cluster-client:3.10.7'
166166
}
167167
```
168168

@@ -208,12 +208,12 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
208208

209209
The database schema (the method in which the data will be organized) for the sample application has already been defined in [`schema.json`](https://github.com/scalar-labs/scalardb-samples/tree/main/scalardb-sample/schema.json).
210210

211-
To apply the schema, go to [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.6) and download the ScalarDB Cluster Schema Loader to the `scalardb-samples/scalardb-sample` folder.
211+
To apply the schema, go to [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.7) and download the ScalarDB Cluster Schema Loader to the `scalardb-samples/scalardb-sample` folder.
212212

213213
Then, run the following command:
214214

215215
```console
216-
java -jar scalardb-cluster-schema-loader-3.10.6-all.jar --config database.properties -f schema.json --coordinator
216+
java -jar scalardb-cluster-schema-loader-3.10.7-all.jar --config database.properties -f schema.json --coordinator
217217
```
218218

219219
#### Schema details

‎versioned_docs/version-3.10/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
7777

7878
## Step 3. Load a schema
7979

80-
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster). Using the Schema Loader for Cluster is basically the same as using the [Schema Loader for ScalarDB](../schema-loader.mdx) except the name of the JAR file is different. You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.6). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
80+
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster). Using the Schema Loader for Cluster is basically the same as using the [Schema Loader for ScalarDB](../schema-loader.mdx) except the name of the JAR file is different. You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.7). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
8181

8282
```console
83-
java -jar scalardb-cluster-schema-loader-3.10.6-all.jar --config database.properties -f schema.json --coordinator
83+
java -jar scalardb-cluster-schema-loader-3.10.7-all.jar --config database.properties -f schema.json --coordinator
8484
```
8585

8686
## Step 4. Set up a Go environment

‎versioned_docs/version-3.10/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
7777

7878
## Step 3. Load a schema
7979

80-
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster). Using the Schema Loader for Cluster is basically the same as using the [Schema Loader for ScalarDB](../schema-loader.mdx) except the name of the JAR file is different. You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.6). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
80+
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster). Using the Schema Loader for Cluster is basically the same as using the [Schema Loader for ScalarDB](../schema-loader.mdx) except the name of the JAR file is different. You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.10.7). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
8181

8282
```console
83-
java -jar scalardb-cluster-schema-loader-3.10.6-all.jar --config database.properties -f schema.json --coordinator
83+
java -jar scalardb-cluster-schema-loader-3.10.7-all.jar --config database.properties -f schema.json --coordinator
8484
```
8585

8686
## Step 4. Set up a Python environment

‎versioned_docs/version-3.10/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows:
165165
5. Set the chart version of ScalarDB Cluster.
166166

167167
```console
168-
SCALAR_DB_CLUSTER_VERSION=3.12.4
168+
SCALAR_DB_CLUSTER_VERSION=3.12.5
169169
SCALAR_DB_CLUSTER_CHART_VERSION=$(helm search repo scalar-labs/scalardb-cluster -l | grep -F "${SCALAR_DB_CLUSTER_VERSION}" | awk '{print $2}' | sort --version-sort -r | head -n 1)
170170
```
171171

‎versioned_docs/version-3.10/scalardb-sql/index.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,10 @@ To add a dependency on ScalarDB SQL using Gradle, use the following:
9090
```gradle
9191
dependencies {
9292
// For Direct mode
93-
implementation 'com.scalar-labs:scalardb-sql-direct-mode:3.10.6'
93+
implementation 'com.scalar-labs:scalardb-sql-direct-mode:3.10.7'
9494
9595
// For Server mode
96-
implementation 'com.scalar-labs:scalardb-sql-server-mode:3.10.6'
96+
implementation 'com.scalar-labs:scalardb-sql-server-mode:3.10.7'
9797
}
9898
```
9999

@@ -104,14 +104,14 @@ To add a dependency using Maven:
104104
<dependency>
105105
<groupId>com.scalar-labs</groupId>
106106
<artifactId>scalardb-sql-direct-mode</artifactId>
107-
<version>3.10.6</version>
107+
<version>3.10.7</version>
108108
</dependency>
109109

110110
<!-- For Server mode -->
111111
<dependency>
112112
<groupId>com.scalar-labs</groupId>
113113
<artifactId>scalardb-sql-server-mode</artifactId>
114-
<version>3.10.6</version>
114+
<version>3.10.7</version>
115115
</dependency>
116116
</dependencies>
117117
```

0 commit comments

Comments
 (0)