Skip to content

Commit 77e7a8e

Browse files
AUTO: Sync ScalarDB docs in English to docs site repo (#646)
Co-authored-by: josh-wong <[email protected]>
1 parent 06a442c commit 77e7a8e

18 files changed

+70
-64
lines changed

docs/api-guide.mdx

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

583-
For more details, see the `Result` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.0/index.html) of the version of ScalarDB that you're using.
583+
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.
584584

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

@@ -787,7 +787,7 @@ For details about the `WHERE` clause, see [Use the `WHERE` clause](#use-the-wher
787787

788788
:::note
789789

790-
The `Put` operation is deprecated as of ScalarDB 3.13.0 and will be removed in a future release. Instead of using the `Put` operation, use the `Insert` operation, the `Upsert` operation, or the `Update` operation.
790+
The `Put` operation is deprecated as of ScalarDB 3.13.1 and will be removed in a future release. Instead of using the `Put` operation, use the `Insert` operation, the `Upsert` operation, or the `Update` operation.
791791

792792
:::
793793

@@ -1232,7 +1232,7 @@ For details about the `Scan` operation, see [`Scan` operation](#scan-operation).
12321232

12331233
:::note
12341234

1235-
The `Put` operation is deprecated as of ScalarDB 3.13.0 and will be removed in a future release. Instead of using the `Put` operation, use the `Insert` operation, the `Upsert` operation, or the `Update` operation.
1235+
The `Put` operation is deprecated as of ScalarDB 3.13.1 and will be removed in a future release. Instead of using the `Put` operation, use the `Insert` operation, the `Upsert` operation, or the `Update` operation.
12361236

12371237
:::
12381238

docs/run-non-transactional-storage-operations-through-library.mdx

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

237237
```gradle
238238
dependencies {
239-
implementation 'com.scalar-labs:scalardb:3.13.0'
239+
implementation 'com.scalar-labs:scalardb:3.13.1'
240240
}
241241
```
242242
</TabItem>
@@ -247,7 +247,7 @@ Select your build tool, and follow the instructions to add the build dependency
247247
<dependency>
248248
<groupId>com.scalar-labs</groupId>
249249
<artifactId>scalardb</artifactId>
250-
<version>3.13.0</version>
250+
<version>3.13.1</version>
251251
</dependency>
252252
```
253253
</TabItem>
@@ -268,4 +268,4 @@ The following limitations apply to non-transactional storage operations:
268268

269269
### Learn more
270270

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

docs/scalardb-cluster/compatibility.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
tags:
3+
- Enterprise Standard
4+
- Enterprise Premium
5+
---
6+
17
# ScalarDB Cluster Compatibility Matrix
28

39
This document shows the compatibility of ScalarDB Cluster versions among client SDK versions.

docs/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.13.0'
20+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
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.13.0</version>
30+
<version>3.13.1</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.13.0).
123+
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.13.1).
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.13.0-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
127+
java -jar scalardb-cluster-schema-loader-3.13.1-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.13.0'
168-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.0'
167+
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.13.1'
168+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
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.13.0</version>
179+
<version>3.13.1</version>
180180
</dependency>
181181
<dependency>
182182
<groupId>com.scalar-labs</groupId>
183183
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
184-
<version>3.13.0</version>
184+
<version>3.13.1</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.13.0'
203-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.0'
202+
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.13.1'
203+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
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.13.0</version>
214+
<version>3.13.1</version>
215215
</dependency>
216216
<dependency>
217217
<groupId>com.scalar-labs</groupId>
218218
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
219-
<version>3.13.0</version>
219+
<version>3.13.1</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.13.0). 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.13.1). 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.13.0-all.jar --config <PATH_TO_CONFIG_FILE>
267+
java -jar scalardb-cluster-sql-cli-3.13.1-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.13.0-all.jar -h
275+
java -jar scalardb-cluster-sql-cli-3.13.1-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.13.0/index.html)
307-
* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.13.0/index.html)
308-
* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.13.0/index.html)
306+
* [ScalarDB Cluster Java Client SDK](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-java-client-sdk/3.13.1/index.html)
307+
* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.13.1/index.html)
308+
* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.13.1/index.html)

docs/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx

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

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

117117
```console
118-
java -jar scalardb-cluster-schema-loader-3.13.0-all.jar --config database.properties -f schema.json --coordinator
118+
java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
119119
```
120120

121121
## Step 4. Run operations from GraphiQL
@@ -192,7 +192,7 @@ You should get the following result in the right pane:
192192
### Mappings between GraphQL API and ScalarDB Java API
193193

194194
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.
195-
These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.0/com/scalar/db/api/DistributedTransaction.html) interface.
195+
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.
196196

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

docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx

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

8888
## Step 3. Load a schema
8989

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

9292
```console
93-
java -jar scalardb-cluster-sql-cli-3.13.0-all.jar --config scalardb-sql.properties --file schema.sql
93+
java -jar scalardb-cluster-sql-cli-3.13.1-all.jar --config scalardb-sql.properties --file schema.sql
9494
```
9595

9696
## Step 4. Load the initial data

docs/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
@@ -87,10 +87,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi
8787

8888
## Step 3. Load a schema
8989

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

9292
```console
93-
java -jar scalardb-cluster-sql-cli-3.13.0-all.jar --config scalardb-sql.properties --file schema.sql
93+
java -jar scalardb-cluster-sql-cli-3.13.1-all.jar --config scalardb-sql.properties --file schema.sql
9494
```
9595

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

docs/scalardb-cluster/getting-started-with-scalardb-cluster.mdx

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

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

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

170-
To apply the schema, go to [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.13.0) and download the ScalarDB Cluster Schema Loader to the `scalardb-samples/scalardb-sample` folder.
170+
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.
171171

172172
Then, run the following command:
173173

174174
```console
175-
java -jar scalardb-cluster-schema-loader-3.13.0-all.jar --config database.properties -f schema.json --coordinator
175+
java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
176176
```
177177

178178
#### Schema details

docs/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.13.0). 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.13.1). 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.13.0-all.jar --config database.properties -f schema.json --coordinator
78+
java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
7979
```
8080

8181
## Step 4. Set up a Go environment

docs/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.13.0). 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.13.1). 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.13.0-all.jar --config database.properties -f schema.json --coordinator
78+
java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
7979
```
8080

8181
## Step 4. Set up a Python environment

0 commit comments

Comments
 (0)