Skip to content

Commit fa1ddd4

Browse files
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent b312a51 commit fa1ddd4

20 files changed

+68
-68
lines changed

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

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

314314
```gradle
315315
dependencies {
316-
implementation 'com.scalar-labs:scalardb:3.17.0'
316+
implementation 'com.scalar-labs:scalardb:3.17.1'
317317
}
318318
```
319319
</TabItem>
@@ -324,7 +324,7 @@ Select your build tool, and follow the instructions to add the build dependency
324324
<dependency>
325325
<groupId>com.scalar-labs</groupId>
326326
<artifactId>scalardb</artifactId>
327-
<version>3.17.0</version>
327+
<version>3.17.1</version>
328328
</dependency>
329329
```
330330
</TabItem>
@@ -345,4 +345,4 @@ The following limitations apply to non-transactional storage operations:
345345

346346
### Learn more
347347

348-
- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.17.0/index.html)
348+
- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.17.1/index.html)

docs/scalardb-analytics/configurations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ scalar.db.analytics.client.server.host=localhost
284284
#### Spark configuration (`spark-defaults.conf`)
285285

286286
```properties
287-
spark.jars.packages com.scalar-labs:scalardb-analytics-spark-all-3.5_2.12:3.17.0
287+
spark.jars.packages com.scalar-labs:scalardb-analytics-spark-all-3.5_2.12:3.17.1
288288
spark.extraListeners com.scalar.db.analytics.spark.metering.ScalarDbAnalyticsListener
289289
spark.sql.catalog.analytics com.scalar.db.analytics.spark.ScalarDbAnalyticsCatalog
290290
spark.sql.catalog.analytics.server.host localhost
@@ -334,7 +334,7 @@ scalar.db.analytics.client.server.tls.ca_root_cert_path=/path/to/cert.pem
334334
#### Spark configuration (`spark-defaults.conf`)
335335

336336
```properties
337-
spark.jars.packages com.scalar-labs:scalardb-analytics-spark-all-3.5_2.12:3.17.0
337+
spark.jars.packages com.scalar-labs:scalardb-analytics-spark-all-3.5_2.12:3.17.1
338338
spark.extraListeners com.scalar.db.analytics.spark.metering.ScalarDbAnalyticsListener
339339
spark.sql.catalog.analytics com.scalar.db.analytics.spark.ScalarDbAnalyticsCatalog
340340
spark.sql.catalog.analytics.server.host analytics.example.com

docs/scalardb-analytics/deployment-local.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ metadata:
159159
spec:
160160
containers:
161161
- name: analytics-server-cli
162-
image: ghcr.io/scalar-labs/scalardb-analytics-cli:3.17.0
162+
image: ghcr.io/scalar-labs/scalardb-analytics-cli:3.17.1
163163
command: ['sleep']
164164
args: ['inf']
165165
restartPolicy: Never

docs/scalardb-analytics/run-analytical-queries.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The following describes what you should change the content in the angle brackets
5858

5959
- `<SPARK_VERSION>`: Your Spark version (for example, `3.5` or `3.4`)
6060
- `<SCALA_VERSION>`: Your Scala version (for example, `2.13` or `2.12`)
61-
- `<SCALARDB_ANALYTICS_VERSION>`: The ScalarDB Analytics version (for example, `3.17.0`)
61+
- `<SCALARDB_ANALYTICS_VERSION>`: The ScalarDB Analytics version (for example, `3.17.1`)
6262

6363
In this example:
6464

@@ -177,7 +177,7 @@ The following describes what you should change the content in the angle brackets
177177
- `<SCALA_VERSION>`: The major and minor version of Scala that matches your Spark installation (`2.12` or `2.13`)
178178
- `<SPARK_FULL_VERSION>`: The full version of Spark you are using (for example, `3.5.7`)
179179
- `<SPARK_VERSION>`: The major and minor version of Spark you are using (`3.4` or `3.5`)
180-
- `<SCALARDB_ANALYTICS_VERSION>`: The version of ScalarDB Analytics (for example, `3.17.0`)
180+
- `<SCALARDB_ANALYTICS_VERSION>`: The version of ScalarDB Analytics (for example, `3.17.1`)
181181

182182
:::note
183183

docs/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx

Lines changed: 20 additions & 20 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.17.0'
21+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.17.1'
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.17.0</version>
31+
<version>3.17.1</version>
3232
</dependency>
3333
```
3434

@@ -94,17 +94,17 @@ The following section describes the Schema Loader for ScalarDB Cluster.
9494

9595
To load a schema via ScalarDB Cluster, you need to use the dedicated Schema Loader for ScalarDB Cluster (Schema Loader for Cluster).
9696
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.
97-
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.17.0).
97+
You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.17.1).
9898
After downloading the JAR file, you can run Schema Loader for Cluster with the following command:
9999

100100
```console
101-
java -jar scalardb-cluster-schema-loader-3.17.0-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> --schema-file <PATH_TO_SCHEMA_FILE> --coordinator
101+
java -jar scalardb-cluster-schema-loader-3.17.1-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> --schema-file <PATH_TO_SCHEMA_FILE> --coordinator
102102
```
103103

104104
You can also pull the Docker image from the [Scalar container registry](https://github.com/orgs/scalar-labs/packages/container/package/scalardb-cluster-schema-loader) by running the following command, replacing the contents in the angle brackets as described:
105105

106106
```console
107-
docker run --rm -v <PATH_TO_YOUR_LOCAL_SCALARDB_PROPERTIES_FILE>:/scalardb.properties -v <PATH_TO_YOUR_LOCAL_SCHEMA_FILE>:/schema.json ghcr.io/scalar-labs/scalardb-cluster-schema-loader:3.17.0 --config /scalardb.properties --schema-file /schema.json --coordinator
107+
docker run --rm -v <PATH_TO_YOUR_LOCAL_SCALARDB_PROPERTIES_FILE>:/scalardb.properties -v <PATH_TO_YOUR_LOCAL_SCHEMA_FILE>:/schema.json ghcr.io/scalar-labs/scalardb-cluster-schema-loader:3.17.1 --config /scalardb.properties --schema-file /schema.json --coordinator
108108
```
109109

110110
## ScalarDB Cluster SQL
@@ -144,8 +144,8 @@ To add the dependencies on the ScalarDB Cluster JDBC driver by using Gradle, use
144144

145145
```gradle
146146
dependencies {
147-
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.17.0'
148-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.17.0'
147+
implementation 'com.scalar-labs:scalardb-sql-jdbc:3.17.1'
148+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.17.1'
149149
}
150150
```
151151

@@ -156,12 +156,12 @@ To add the dependencies by using Maven, use the following:
156156
<dependency>
157157
<groupId>com.scalar-labs</groupId>
158158
<artifactId>scalardb-sql-jdbc</artifactId>
159-
<version>3.17.0</version>
159+
<version>3.17.1</version>
160160
</dependency>
161161
<dependency>
162162
<groupId>com.scalar-labs</groupId>
163163
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
164-
<version>3.17.0</version>
164+
<version>3.17.1</version>
165165
</dependency>
166166
</dependencies>
167167
```
@@ -179,8 +179,8 @@ To add the dependencies by using Gradle, use the following:
179179

180180
```gradle
181181
dependencies {
182-
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.17.0'
183-
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.17.0'
182+
implementation 'com.scalar-labs:scalardb-sql-spring-data:3.17.1'
183+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.17.1'
184184
}
185185
```
186186

@@ -191,12 +191,12 @@ To add the dependencies by using Maven, use the following:
191191
<dependency>
192192
<groupId>com.scalar-labs</groupId>
193193
<artifactId>scalardb-sql-spring-data</artifactId>
194-
<version>3.17.0</version>
194+
<version>3.17.1</version>
195195
</dependency>
196196
<dependency>
197197
<groupId>com.scalar-labs</groupId>
198198
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
199-
<version>3.17.0</version>
199+
<version>3.17.1</version>
200200
</dependency>
201201
</dependencies>
202202
```
@@ -208,24 +208,24 @@ For details about Spring Data JDBC for ScalarDB, see [Guide of Spring Data JDBC
208208

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

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

213213
```console
214-
java -jar scalardb-cluster-sql-cli-3.17.0-all.jar --config <PATH_TO_SCALARDB_SQL_PROPERTIES_FILE>
214+
java -jar scalardb-cluster-sql-cli-3.17.1-all.jar --config <PATH_TO_SCALARDB_SQL_PROPERTIES_FILE>
215215
```
216216

217217
You can also pull the Docker image from the [Scalar container registry](https://github.com/orgs/scalar-labs/packages/container/package/scalardb-cluster-sql-cli) by running the following command, replacing the contents in the angle brackets as described:
218218

219219
```console
220-
docker run --rm -it -v <PATH_TO_YOUR_LOCAL_SCALARDB_SQL_PROPERTIES_FILE>:/scalardb-sql.properties ghcr.io/scalar-labs/scalardb-cluster-sql-cli:3.17.0 --config /scalardb-sql.properties
220+
docker run --rm -it -v <PATH_TO_YOUR_LOCAL_SCALARDB_SQL_PROPERTIES_FILE>:/scalardb-sql.properties ghcr.io/scalar-labs/scalardb-cluster-sql-cli:3.17.1 --config /scalardb-sql.properties
221221
```
222222

223223
#### Usage
224224

225225
You can see the CLI usage with the `-h` option as follows:
226226

227227
```console
228-
java -jar scalardb-cluster-sql-cli-3.17.0-all.jar -h
228+
java -jar scalardb-cluster-sql-cli-3.17.1-all.jar -h
229229
Usage: scalardb-sql-cli [-hs] -c=PROPERTIES_FILE [-e=COMMAND] [-f=FILE]
230230
[-l=LOG_FILE] [-o=<outputFormat>] [-p=PASSWORD]
231231
[-u=USERNAME]
@@ -256,6 +256,6 @@ For details about the ScalarDB Cluster gRPC API, refer to the following:
256256

257257
JavaDocs are also available:
258258

259-
* [ScalarDB Cluster Java Client SDK](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-java-client-sdk/3.17.0/index.html)
260-
* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.17.0/index.html)
261-
* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.17.0/index.html)
259+
* [ScalarDB Cluster Java Client SDK](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-java-client-sdk/3.17.1/index.html)
260+
* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.17.1/index.html)
261+
* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.17.1/index.html)

docs/scalardb-cluster/encrypt-data-at-rest.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ services:
185185

186186
scalardb-cluster-standalone:
187187
container_name: "scalardb-cluster-node"
188-
image: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium:3.17.0"
188+
image: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium:3.17.1"
189189
ports:
190190
- 60053:60053
191191
- 9080:9080
@@ -243,7 +243,7 @@ scalar.db.sql.cluster_mode.contact_points=indirect:localhost
243243
Then, start the SQL CLI by running the following command.
244244

245245
```console
246-
java -jar scalardb-cluster-sql-cli-3.17.0-all.jar --config scalardb-cluster-sql-cli.properties
246+
java -jar scalardb-cluster-sql-cli-3.17.1-all.jar --config scalardb-cluster-sql-cli.properties
247247
```
248248

249249
To begin, create the Coordinator tables required for ScalarDB transaction execution.

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

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

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

114114
```console
115-
java -jar scalardb-cluster-schema-loader-3.17.0-all.jar --config database.properties -f schema.json --coordinator
115+
java -jar scalardb-cluster-schema-loader-3.17.1-all.jar --config database.properties -f schema.json --coordinator
116116
```
117117

118118
## Step 4. Run operations from GraphiQL

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
@@ -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.17.0). 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.17.1). 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.17.0-all.jar --config scalardb-sql.properties --file schema.sql
92+
java -jar scalardb-cluster-sql-cli-3.17.1-all.jar --config scalardb-sql.properties --file schema.sql
9393
```
9494

9595
## 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
@@ -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.17.0). 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.17.1). 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.17.0-all.jar --config scalardb-sql.properties --file schema.sql
92+
java -jar scalardb-cluster-sql-cli-3.17.1-all.jar --config scalardb-sql.properties --file schema.sql
9393
```
9494

9595
## 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
@@ -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.17.0'
123+
implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.17.1'
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.17.0) 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.17.1) 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.17.0-all.jar --config database.properties -f schema.json --coordinator
174+
java -jar scalardb-cluster-schema-loader-3.17.1-all.jar --config database.properties -f schema.json --coordinator
175175
```
176176

177177
#### Schema details

0 commit comments

Comments
 (0)