Skip to content

Commit 1fd27f0

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

20 files changed

+82
-532
lines changed

‎versioned_docs/version-3.13/api-guide.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ And if you need to check if a value of a column is null, you can use the `isNull
581581
boolean isNull = result.isNull("<COLUMN_NAME>");
582582
```
583583

584-
For more details, see the `Result` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.1/index.html) of the version of ScalarDB that you're using.
584+
For more details, see the `Result` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.2/index.html) of the version of ScalarDB that you're using.
585585

586586
###### Execute `Get` by using a secondary index
587587

‎versioned_docs/version-3.13/run-non-transactional-storage-operations-through-library.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ Select your build tool, and follow the instructions to add the build dependency
237237

238238
```gradle
239239
dependencies {
240-
implementation 'com.scalar-labs:scalardb:3.13.1'
240+
implementation 'com.scalar-labs:scalardb:3.13.2'
241241
}
242242
```
243243
</TabItem>
@@ -248,7 +248,7 @@ Select your build tool, and follow the instructions to add the build dependency
248248
<dependency>
249249
<groupId>com.scalar-labs</groupId>
250250
<artifactId>scalardb</artifactId>
251-
<version>3.13.1</version>
251+
<version>3.13.2</version>
252252
</dependency>
253253
```
254254
</TabItem>
@@ -269,4 +269,4 @@ The following limitations apply to non-transactional storage operations:
269269

270270
### Learn more
271271

272-
- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.1/index.html)
272+
- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.2/index.html)

‎versioned_docs/version-3.13/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
displayed_sidebar: docsEnglish
57
---
68

@@ -65,9 +67,11 @@ To build the benchmarking tools, run the following command:
6567

6668
### Load the schema
6769

68-
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.
70+
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:
71+
- **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.
72+
- **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.
6973

70-
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).
74+
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).
7175

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

@@ -78,20 +82,38 @@ After applying the schema and configuring the properties file, select a benchmar
7882
```console
7983
java -jar scalardb-schema-loader-<VERSION>.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f tpcc-schema.json --coordinator
8084
```
85+
86+
If you are using ScalarDB Cluster, run the following command instead:
87+
88+
```console
89+
java -jar scalardb-cluster-schema-loader-<VERSION>-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f tpcc-schema.json --coordinator
90+
```
8191
</TabItem>
8292
<TabItem value="YCSB" label="YCSB">
8393
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:
8494

8595
```console
8696
java -jar scalardb-schema-loader-<VERSION>.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-schema.json --coordinator
8797
```
98+
99+
If you are using ScalarDB Cluster, run the following command instead:
100+
101+
```console
102+
java -jar scalardb-cluster-schema-loader-<VERSION>-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-schema.json --coordinator
103+
```
88104
</TabItem>
89105
<TabItem value="multi-storage_YCSB" label="Multi-storage YCSB">
90106
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:
91107

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

‎versioned_docs/version-3.13/scalardb-cluster/compatibility.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This document shows the compatibility of ScalarDB Cluster versions among client
1313

1414
| ScalarDB Cluster version | ScalarDB Cluster Java Client SDK version | ScalarDB Cluster .NET Client SDK version |
1515
|:-------------------------|:-----------------------------------------|:-----------------------------------------|
16+
| 3.15 | 3.9 - 3.15 | 3.12* - 3.15 |
1617
| 3.14 | 3.9 - 3.14 | 3.12* - 3.14 |
1718
| 3.13 | 3.9 - 3.13 | 3.12* - 3.13 |
1819
| 3.12 | 3.9 - 3.12 | 3.12* |

‎versioned_docs/version-3.13/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
@@ -18,7 +18,7 @@ To add a dependency on the ScalarDB Cluster Java Client SDK by using Gradle, use
1818

1919
```gradle
2020
dependencies {
21-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
21+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.2'
2222
}
2323
```
2424

@@ -28,7 +28,7 @@ To add a dependency by using Maven, use the following:
2828
<dependency>
2929
<groupId>com.scalar-labs</groupId>
3030
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
31-
<version>3.13.1</version>
31+
<version>3.13.2</version>
3232
</dependency>
3333
```
3434

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

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

127127
```console
128-
java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
128+
java -jar scalardb-cluster-schema-loader-3.13.2-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
129129
```
130130

131131
## ScalarDB Cluster SQL
@@ -165,8 +165,8 @@ To add the dependencies on the ScalarDB Cluster JDBC driver by using Gradle, use
165165

166166
```gradle
167167
dependencies {
168-
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.13.1'
169-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
168+
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.13.2'
169+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.2'
170170
}
171171
```
172172

@@ -177,12 +177,12 @@ To add the dependencies by using Maven, use the following:
177177
<dependency>
178178
<groupId>com.scalar-labs</groupId>
179179
<artifactId>scalardb-sql-jdbc</artifactId>
180-
<version>3.13.1</version>
180+
<version>3.13.2</version>
181181
</dependency>
182182
<dependency>
183183
<groupId>com.scalar-labs</groupId>
184184
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
185-
<version>3.13.1</version>
185+
<version>3.13.2</version>
186186
</dependency>
187187
</dependencies>
188188
```
@@ -200,8 +200,8 @@ To add the dependencies by using Gradle, use the following:
200200

201201
```gradle
202202
dependencies {
203-
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.13.1'
204-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
203+
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.13.2'
204+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.2'
205205
}
206206
```
207207

@@ -212,12 +212,12 @@ To add the dependencies by using Maven, use the following:
212212
<dependency>
213213
<groupId>com.scalar-labs</groupId>
214214
<artifactId>scalardb-sql-spring-data</artifactId>
215-
<version>3.13.1</version>
215+
<version>3.13.2</version>
216216
</dependency>
217217
<dependency>
218218
<groupId>com.scalar-labs</groupId>
219219
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
220-
<version>3.13.1</version>
220+
<version>3.13.2</version>
221221
</dependency>
222222
</dependencies>
223223
```
@@ -262,18 +262,18 @@ For details about how to configure Spring Data JDBC for ScalarDB, see [Configura
262262

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

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

267267
```console
268-
java -jar scalardb-cluster-sql-cli-3.13.1-all.jar --config <PATH_TO_CONFIG_FILE>
268+
java -jar scalardb-cluster-sql-cli-3.13.2-all.jar --config <PATH_TO_CONFIG_FILE>
269269
```
270270

271271
#### Usage
272272

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

275275
```console
276-
java -jar scalardb-cluster-sql-cli-3.13.1-all.jar -h
276+
java -jar scalardb-cluster-sql-cli-3.13.2-all.jar -h
277277
Usage: scalardb-sql-cli [-hs] -c=PROPERTIES_FILE [-e=COMMAND] [-f=FILE]
278278
[-l=LOG_FILE] [-o=<outputFormat>] [-p=PASSWORD]
279279
[-u=USERNAME]
@@ -304,6 +304,6 @@ For details about the ScalarDB Cluster gRPC API, refer to the following:
304304

305305
JavaDocs are also available:
306306

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

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

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

107107
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster).
108108
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.
109-
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.13.1).
109+
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.13.2).
110110
After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
111111

112112
```console
113-
java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
113+
java -jar scalardb-cluster-schema-loader-3.13.2-all.jar --config database.properties -f schema.json --coordinator
114114
```
115115

116116
## Step 4. Run operations from GraphiQL
@@ -187,7 +187,7 @@ You should get the following result in the right pane:
187187
### Mappings between GraphQL API and ScalarDB Java API
188188

189189
The automatically generated GraphQL schema defines queries, mutations, and object types for input/output to allow you to run CRUD operations for all the tables in the target namespaces.
190-
These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.1/com/scalar/db/api/DistributedTransaction.html) interface.
190+
These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.2/com/scalar/db/api/DistributedTransaction.html) interface.
191191

192192
Assuming you have an `account` table in a namespace, the following queries and mutations will be generated:
193193

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

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

8787
## Step 3. Load a schema
8888

89-
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.13.1). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
89+
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.13.2). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
9090

9191
```console
92-
java -jar scalardb-cluster-sql-cli-3.13.1-all.jar --config scalardb-sql.properties --file schema.sql
92+
java -jar scalardb-cluster-sql-cli-3.13.2-all.jar --config scalardb-sql.properties --file schema.sql
9393
```
9494

9595
## Step 4. Load the initial data

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

8787
## Step 3. Load a schema
8888

89-
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.13.1). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
89+
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.13.2). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:
9090

9191
```console
92-
java -jar scalardb-cluster-sql-cli-3.13.1-all.jar --config scalardb-sql.properties --file schema.sql
92+
java -jar scalardb-cluster-sql-cli-3.13.2-all.jar --config scalardb-sql.properties --file schema.sql
9393
```
9494

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

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

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

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

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

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

171171
Then, run the following command:
172172

173173
```console
174-
java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
174+
java -jar scalardb-cluster-schema-loader-3.13.2-all.jar --config database.properties -f schema.json --coordinator
175175
```
176176

177177
#### Schema details

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

7474
## Step 3. Load a schema
7575

76-
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.13.1). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
76+
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.13.2). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command:
7777

7878
```console
79-
java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
79+
java -jar scalardb-cluster-schema-loader-3.13.2-all.jar --config database.properties -f schema.json --coordinator
8080
```
8181

8282
## Step 4. Set up a Go environment

0 commit comments

Comments
 (0)