Skip to content

Commit 3b6e75b

Browse files
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 3424350 commit 3b6e75b

13 files changed

+68
-46
lines changed

versioned_docs/version-3.11/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.11/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To add a dependency on the ScalarDB Cluster Java Client SDK by using Gradle, use
1717

1818
```gradle
1919
dependencies {
20-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.11.4'
20+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.11.5'
2121
}
2222
```
2323

@@ -27,7 +27,7 @@ To add a dependency by using Maven, use the following:
2727
<dependency>
2828
<groupId>com.scalar-labs</groupId>
2929
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
30-
<version>3.11.4</version>
30+
<version>3.11.5</version>
3131
</dependency>
3232
```
3333

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

121121
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster).
122122
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.
123-
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.11.4).
123+
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.11.5).
124124
After downloading the JAR file, you can run Schema Loader for Cluster with the following command:
125125

126126
```console
127-
java -jar scalardb-cluster-schema-loader-3.11.4-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
127+
java -jar scalardb-cluster-schema-loader-3.11.5-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
128128
```
129129

130130
## ScalarDB Cluster SQL
@@ -164,8 +164,8 @@ To add the dependencies on the ScalarDB Cluster JDBC driver by using Gradle, use
164164

165165
```gradle
166166
dependencies {
167-
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.11.4'
168-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.11.4'
167+
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.11.5'
168+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.11.5'
169169
}
170170
```
171171

@@ -176,12 +176,12 @@ To add the dependencies by using Maven, use the following:
176176
<dependency>
177177
<groupId>com.scalar-labs</groupId>
178178
<artifactId>scalardb-sql-jdbc</artifactId>
179-
<version>3.11.4</version>
179+
<version>3.11.5</version>
180180
</dependency>
181181
<dependency>
182182
<groupId>com.scalar-labs</groupId>
183183
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
184-
<version>3.11.4</version>
184+
<version>3.11.5</version>
185185
</dependency>
186186
</dependencies>
187187
```
@@ -199,8 +199,8 @@ To add the dependencies by using Gradle, use the following:
199199

200200
```gradle
201201
dependencies {
202-
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.11.4'
203-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.11.4'
202+
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.11.5'
203+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.11.5'
204204
}
205205
```
206206

@@ -211,12 +211,12 @@ To add the dependencies by using Maven, use the following:
211211
<dependency>
212212
<groupId>com.scalar-labs</groupId>
213213
<artifactId>scalardb-sql-spring-data</artifactId>
214-
<version>3.11.4</version>
214+
<version>3.11.5</version>
215215
</dependency>
216216
<dependency>
217217
<groupId>com.scalar-labs</groupId>
218218
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
219-
<version>3.11.4</version>
219+
<version>3.11.5</version>
220220
</dependency>
221221
</dependencies>
222222
```
@@ -261,18 +261,18 @@ For details about how to configure Spring Data JDBC for ScalarDB, see [Configura
261261

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

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

266266
```console
267-
java -jar scalardb-cluster-sql-cli-3.11.4-all.jar --config <PATH_TO_CONFIG_FILE>
267+
java -jar scalardb-cluster-sql-cli-3.11.5-all.jar --config <PATH_TO_CONFIG_FILE>
268268
```
269269

270270
#### Usage
271271

272272
You can see the CLI usage with the `-h` option as follows:
273273

274274
```console
275-
java -jar scalardb-cluster-sql-cli-3.11.4-all.jar -h
275+
java -jar scalardb-cluster-sql-cli-3.11.5-all.jar -h
276276
Usage: scalardb-sql-cli [-hs] -c=PROPERTIES_FILE [-e=COMMAND] [-f=FILE]
277277
[-l=LOG_FILE] [-o=<outputFormat>] [-p=PASSWORD]
278278
[-u=USERNAME]
@@ -303,6 +303,6 @@ For details about the ScalarDB Cluster gRPC API, refer to the following:
303303

304304
JavaDocs are also available:
305305

306-
* [ScalarDB Cluster Java Client SDK](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-java-client-sdk/3.11.4/index.html)
307-
* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.11.4/index.html)
308-
* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.11.4/index.html)
306+
* [ScalarDB Cluster Java Client SDK](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-java-client-sdk/3.11.5/index.html)
307+
* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.11.5/index.html)
308+
* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.11.5/index.html)

versioned_docs/version-3.11/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.11.4).
108+
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.11.5).
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.11.4-all.jar --config database.properties -f schema.json --coordinator
112+
java -jar scalardb-cluster-schema-loader-3.11.5-all.jar --config database.properties -f schema.json --coordinator
113113
```
114114

115115
## Step 4. Run operations from GraphiQL

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

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

8686
## Step 3. Load a schema
8787

88-
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.11.4). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
88+
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.11.5). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
8989

9090
```console
91-
java -jar scalardb-cluster-sql-cli-3.11.4-all.jar --config scalardb-sql.properties --file schema.sql
91+
java -jar scalardb-cluster-sql-cli-3.11.5-all.jar --config scalardb-sql.properties --file schema.sql
9292
```
9393

9494
## Step 4. Load the initial data

versioned_docs/version-3.11/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
@@ -85,10 +85,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
8585

8686
## Step 3. Load a schema
8787

88-
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.11.4). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
88+
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.11.5). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
8989

9090
```console
91-
java -jar scalardb-cluster-sql-cli-3.11.4-all.jar --config scalardb-sql.properties --file schema.sql
91+
java -jar scalardb-cluster-sql-cli-3.11.5-all.jar --config scalardb-sql.properties --file schema.sql
9292
```
9393

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

versioned_docs/version-3.11/scalardb-cluster/getting-started-with-scalardb-cluster.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ To use ScalarDB Cluster, open `build.gradle` in your preferred text editor. Then
119119
dependencies {
120120
...
121121
122-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.11.4'
122+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.11.5'
123123
}
124124
```
125125

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

166166
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).
167167

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

170170
Then, run the following command:
171171

172172
```console
173-
java -jar scalardb-cluster-schema-loader-3.11.4-all.jar --config database.properties -f schema.json --coordinator
173+
java -jar scalardb-cluster-schema-loader-3.11.5-all.jar --config database.properties -f schema.json --coordinator
174174
```
175175

176176
#### Schema details

versioned_docs/version-3.11/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
@@ -72,10 +72,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
7272

7373
## Step 3. Load a schema
7474

75-
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.11.4). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
75+
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.11.5). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
7676

7777
```console
78-
java -jar scalardb-cluster-schema-loader-3.11.4-all.jar --config database.properties -f schema.json --coordinator
78+
java -jar scalardb-cluster-schema-loader-3.11.5-all.jar --config database.properties -f schema.json --coordinator
7979
```
8080

8181
## Step 4. Set up a Go environment

versioned_docs/version-3.11/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
@@ -72,10 +72,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
7272

7373
## Step 3. Load a schema
7474

75-
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.11.4). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
75+
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.11.5). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
7676

7777
```console
78-
java -jar scalardb-cluster-schema-loader-3.11.4-all.jar --config database.properties -f schema.json --coordinator
78+
java -jar scalardb-cluster-schema-loader-3.11.5-all.jar --config database.properties -f schema.json --coordinator
7979
```
8080

8181
## Step 4. Set up a Python environment

versioned_docs/version-3.11/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.11/scalardb-sql/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ To add a dependency on ScalarDB SQL using Gradle, use the following:
8888
```gradle
8989
dependencies {
9090
// For Direct mode
91-
implementation 'com.scalar-labs:scalardb-sql-direct-mode:3.11.4'
91+
implementation 'com.scalar-labs:scalardb-sql-direct-mode:3.11.5'
9292
9393
// For Server mode
94-
implementation 'com.scalar-labs:scalardb-sql-server-mode:3.11.4'
94+
implementation 'com.scalar-labs:scalardb-sql-server-mode:3.11.5'
9595
}
9696
```
9797

@@ -102,14 +102,14 @@ To add a dependency using Maven:
102102
<dependency>
103103
<groupId>com.scalar-labs</groupId>
104104
<artifactId>scalardb-sql-direct-mode</artifactId>
105-
<version>3.11.4</version>
105+
<version>3.11.5</version>
106106
</dependency>
107107

108108
<!-- For Server mode -->
109109
<dependency>
110110
<groupId>com.scalar-labs</groupId>
111111
<artifactId>scalardb-sql-server-mode</artifactId>
112-
<version>3.11.4</version>
112+
<version>3.11.5</version>
113113
</dependency>
114114
</dependencies>
115115
```

0 commit comments

Comments
 (0)