From dab7ea635c6fbfa69ed7e4b7e24b0f38f69633c2 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Tue, 28 Jan 2025 03:18:55 +0000 Subject: [PATCH] AUTO: Sync ScalarDB docs in English to docs site repo --- docs/api-guide.mdx | 2 +- ...nal-storage-operations-through-library.mdx | 6 ++-- docs/scalardb-benchmarks/README.mdx | 26 ++++++++++++-- docs/scalardb-cluster/compatibility.mdx | 1 + ...ide-for-scalardb-cluster-with-java-api.mdx | 36 +++++++++---------- .../scalardb-cluster/encrypt-data-at-rest.mdx | 4 +-- ...-started-with-scalardb-cluster-graphql.mdx | 6 ++-- ...started-with-scalardb-cluster-sql-jdbc.mdx | 4 +-- ...-scalardb-cluster-sql-spring-data-jdbc.mdx | 4 +-- .../getting-started-with-scalardb-cluster.mdx | 6 ++-- ...ted-with-using-go-for-scalardb-cluster.mdx | 4 +-- ...with-using-python-for-scalardb-cluster.mdx | 4 +-- ...ge-operations-through-scalardb-cluster.mdx | 6 ++-- ...orage-operations-through-sql-interface.mdx | 18 +++++----- .../scalardb-auth-with-sql.mdx | 6 ++-- ...ster-on-kubernetes-by-using-helm-chart.mdx | 2 +- docs/scalardb-sql/jdbc-guide.mdx | 2 +- docs/scalardb-sql/spring-data-guide.mdx | 2 +- docs/scalardb-sql/sql-api-guide.mdx | 12 +++---- 19 files changed, 87 insertions(+), 64 deletions(-) diff --git a/docs/api-guide.mdx b/docs/api-guide.mdx index a608e92f..242455f1 100644 --- a/docs/api-guide.mdx +++ b/docs/api-guide.mdx @@ -581,7 +581,7 @@ And if you need to check if a value of a column is null, you can use the `isNull boolean isNull = result.isNull(""); ``` -For more details, see the `Result` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.0/index.html) of the version of ScalarDB that you're using. +For more details, see the `Result` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.1/index.html) of the version of ScalarDB that you're using. ###### Execute `Get` by using a secondary index diff --git a/docs/run-non-transactional-storage-operations-through-library.mdx b/docs/run-non-transactional-storage-operations-through-library.mdx index 6d36329f..87f365eb 100644 --- a/docs/run-non-transactional-storage-operations-through-library.mdx +++ b/docs/run-non-transactional-storage-operations-through-library.mdx @@ -237,7 +237,7 @@ Select your build tool, and follow the instructions to add the build dependency ```gradle dependencies { - implementation 'com.scalar-labs:scalardb:3.14.0' + implementation 'com.scalar-labs:scalardb:3.14.1' } ``` @@ -248,7 +248,7 @@ Select your build tool, and follow the instructions to add the build dependency com.scalar-labs scalardb - 3.14.0 + 3.14.1 ``` @@ -269,4 +269,4 @@ The following limitations apply to non-transactional storage operations: ### Learn more -- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.0/index.html) +- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.1/index.html) diff --git a/docs/scalardb-benchmarks/README.mdx b/docs/scalardb-benchmarks/README.mdx index 58ac6bd9..010d3e9d 100644 --- a/docs/scalardb-benchmarks/README.mdx +++ b/docs/scalardb-benchmarks/README.mdx @@ -1,6 +1,8 @@ --- tags: - Community + - Enterprise Standard + - Enterprise Premium displayed_sidebar: docsEnglish --- @@ -65,9 +67,11 @@ To build the benchmarking tools, run the following command: ### Load the schema -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. +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: +- **Using the ScalarDB Core library (Community edition)?:** Choose `scalardb-schema-loader-.jar` for the version of ScalarDB that you're using. Then, save the `.jar` file in the `scalardb-benchmarks` root directory. +- **Using ScalarDB Cluster (Enterprise edition)?:** Choose `scalardb-cluster-schema-loader--all.jar` for the version of ScalarDB Cluster that you're using. Then, save the `.jar` file in the `scalardb-benchmarks` root directory. -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). +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). After applying the schema and configuring the properties file, select a benchmark and follow the instructions to create the tables. @@ -78,6 +82,12 @@ After applying the schema and configuring the properties file, select a benchmar ```console java -jar scalardb-schema-loader-.jar --config -f tpcc-schema.json --coordinator ``` + + If you are using ScalarDB Cluster, run the following command instead: + + ```console + java -jar scalardb-cluster-schema-loader--all.jar --config -f tpcc-schema.json --coordinator + ``` 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: @@ -85,6 +95,12 @@ After applying the schema and configuring the properties file, select a benchmar ```console java -jar scalardb-schema-loader-.jar --config -f ycsb-schema.json --coordinator ``` + + If you are using ScalarDB Cluster, run the following command instead: + + ```console + java -jar scalardb-cluster-schema-loader--all.jar --config -f ycsb-schema.json --coordinator + ``` 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: @@ -92,6 +108,12 @@ After applying the schema and configuring the properties file, select a benchmar ```console java -jar scalardb-schema-loader-.jar --config -f ycsb-multi-storage-schema.json --coordinator ``` + + If you are using ScalarDB Cluster, run the following command instead: + + ```console + java -jar scalardb-cluster-schema-loader--all.jar --config -f ycsb-multi-storage-schema.json --coordinator + ``` diff --git a/docs/scalardb-cluster/compatibility.mdx b/docs/scalardb-cluster/compatibility.mdx index 2a7f30ec..0b469206 100644 --- a/docs/scalardb-cluster/compatibility.mdx +++ b/docs/scalardb-cluster/compatibility.mdx @@ -13,6 +13,7 @@ This document shows the compatibility of ScalarDB Cluster versions among client | ScalarDB Cluster version | ScalarDB Cluster Java Client SDK version | ScalarDB Cluster .NET Client SDK version | |:-------------------------|:-----------------------------------------|:-----------------------------------------| +| 3.15 | 3.9 - 3.15 | 3.12* - 3.15 | | 3.14 | 3.9 - 3.14 | 3.12* - 3.14 | | 3.13 | 3.9 - 3.13 | 3.12* - 3.13 | | 3.12 | 3.9 - 3.12 | 3.12* | diff --git a/docs/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx b/docs/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx index c65a9796..32edf384 100644 --- a/docs/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx +++ b/docs/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx @@ -18,7 +18,7 @@ To add a dependency on the ScalarDB Cluster Java Client SDK by using Gradle, use ```gradle dependencies { - implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.0' + implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.1' } ``` @@ -28,7 +28,7 @@ To add a dependency by using Maven, use the following: com.scalar-labs scalardb-cluster-java-client-sdk - 3.14.0 + 3.14.1 ``` @@ -121,11 +121,11 @@ scalar.db.contact_points=direct-kubernetes:ns/scalardb-cluster 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 [ScalarDB Schema Loader](../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.14.0). +You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.14.1). After downloading the JAR file, you can run Schema Loader for Cluster with the following command: ```console -java -jar scalardb-cluster-schema-loader-3.14.0-all.jar --config -f --coordinator +java -jar scalardb-cluster-schema-loader-3.14.1-all.jar --config -f --coordinator ``` ## ScalarDB Cluster SQL @@ -165,8 +165,8 @@ To add the dependencies on the ScalarDB Cluster JDBC driver by using Gradle, use ```gradle dependencies { - implementation 'com.scalar-labs:scalardb-sql-jdbc:3.14.0' - implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.0' + implementation 'com.scalar-labs:scalardb-sql-jdbc:3.14.1' + implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.1' } ``` @@ -177,12 +177,12 @@ To add the dependencies by using Maven, use the following: com.scalar-labs scalardb-sql-jdbc - 3.14.0 + 3.14.1 com.scalar-labs scalardb-cluster-java-client-sdk - 3.14.0 + 3.14.1 ``` @@ -200,8 +200,8 @@ To add the dependencies by using Gradle, use the following: ```gradle dependencies { - implementation 'com.scalar-labs:scalardb-sql-spring-data:3.14.0' - implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.0' + implementation 'com.scalar-labs:scalardb-sql-spring-data:3.14.1' + implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.1' } ``` @@ -212,12 +212,12 @@ To add the dependencies by using Maven, use the following: com.scalar-labs scalardb-sql-spring-data - 3.14.0 + 3.14.1 com.scalar-labs scalardb-cluster-java-client-sdk - 3.14.0 + 3.14.1 ``` @@ -262,10 +262,10 @@ For details about how to configure Spring Data JDBC for ScalarDB, see [Configura Like other SQL databases, ScalarDB SQL also provides a CLI tool where you can issue SQL statements interactively in a command-line shell. -You can download the SQL CLI for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.14.0). After downloading the JAR file, you can run the SQL CLI with the following command: +You can download the SQL CLI for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.14.1). After downloading the JAR file, you can run the SQL CLI with the following command: ```console -java -jar scalardb-cluster-sql-cli-3.14.0-all.jar --config +java -jar scalardb-cluster-sql-cli-3.14.1-all.jar --config ``` #### Usage @@ -273,7 +273,7 @@ java -jar scalardb-cluster-sql-cli-3.14.0-all.jar --config You can see the CLI usage with the `-h` option as follows: ```console -java -jar scalardb-cluster-sql-cli-3.14.0-all.jar -h +java -jar scalardb-cluster-sql-cli-3.14.1-all.jar -h Usage: scalardb-sql-cli [-hs] -c=PROPERTIES_FILE [-e=COMMAND] [-f=FILE] [-l=LOG_FILE] [-o=] [-p=PASSWORD] [-u=USERNAME] @@ -304,6 +304,6 @@ For details about the ScalarDB Cluster gRPC API, refer to the following: JavaDocs are also available: -* [ScalarDB Cluster Java Client SDK](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-java-client-sdk/3.14.0/index.html) -* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.14.0/index.html) -* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.14.0/index.html) +* [ScalarDB Cluster Java Client SDK](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-java-client-sdk/3.14.1/index.html) +* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.14.1/index.html) +* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.14.1/index.html) diff --git a/docs/scalardb-cluster/encrypt-data-at-rest.mdx b/docs/scalardb-cluster/encrypt-data-at-rest.mdx index 79f83c3d..68d39a5f 100644 --- a/docs/scalardb-cluster/encrypt-data-at-rest.mdx +++ b/docs/scalardb-cluster/encrypt-data-at-rest.mdx @@ -172,7 +172,7 @@ services: scalardb-cluster-standalone: container_name: "scalardb-cluser-node" - image: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium:3.14.0" + image: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium:3.14.1" ports: - 60053:60053 - 9080:9080 @@ -230,7 +230,7 @@ scalar.db.sql.cluster_mode.contact_points=indirect:localhost Then, start the SQL CLI by running the following command. ```console -java -jar scalardb-cluster-sql-cli-3.14.0-all.jar --config scalardb-cluster-sql-cli.properties +java -jar scalardb-cluster-sql-cli-3.14.1-all.jar --config scalardb-cluster-sql-cli.properties ``` To begin, create the Coordinator tables required for ScalarDB transaction execution. diff --git a/docs/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx b/docs/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx index ebc5c6e1..9674a82b 100644 --- a/docs/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx +++ b/docs/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx @@ -106,11 +106,11 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi 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.14.0). +You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.14.1). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command: ```console -java -jar scalardb-cluster-schema-loader-3.14.0-all.jar --config database.properties -f schema.json --coordinator +java -jar scalardb-cluster-schema-loader-3.14.1-all.jar --config database.properties -f schema.json --coordinator ``` ## Step 4. Run operations from GraphiQL @@ -187,7 +187,7 @@ You should get the following result in the right pane: ### Mappings between GraphQL API and ScalarDB Java API 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. -These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.0/com/scalar/db/api/DistributedTransaction.html) interface. +These operations are designed to match the ScalarDB APIs defined in the [`DistributedTransaction`](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.1/com/scalar/db/api/DistributedTransaction.html) interface. Assuming you have an `account` table in a namespace, the following queries and mutations will be generated: diff --git a/docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx b/docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx index 1ed2dee0..c4529a7b 100644 --- a/docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx +++ b/docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx @@ -86,10 +86,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi ## Step 3. Load a schema -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.14.0). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command: +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.14.1). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command: ```console -java -jar scalardb-cluster-sql-cli-3.14.0-all.jar --config scalardb-sql.properties --file schema.sql +java -jar scalardb-cluster-sql-cli-3.14.1-all.jar --config scalardb-sql.properties --file schema.sql ``` ## Step 4. Load the initial data diff --git a/docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx b/docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx index 6b7080d5..0b074674 100644 --- a/docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx +++ b/docs/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx @@ -86,10 +86,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi ## Step 3. Load a schema -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.14.0). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command: +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.14.1). After downloading the JAR file, you can use SQL CLI for Cluster by running the following command: ```console -java -jar scalardb-cluster-sql-cli-3.14.0-all.jar --config scalardb-sql.properties --file schema.sql +java -jar scalardb-cluster-sql-cli-3.14.1-all.jar --config scalardb-sql.properties --file schema.sql ``` ## Step 4. Modify `application.properties` diff --git a/docs/scalardb-cluster/getting-started-with-scalardb-cluster.mdx b/docs/scalardb-cluster/getting-started-with-scalardb-cluster.mdx index 4b46001a..7598863b 100644 --- a/docs/scalardb-cluster/getting-started-with-scalardb-cluster.mdx +++ b/docs/scalardb-cluster/getting-started-with-scalardb-cluster.mdx @@ -120,7 +120,7 @@ To use ScalarDB Cluster, open `build.gradle` in your preferred text editor. Then dependencies { ... - implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.0' + implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.1' } ``` @@ -166,12 +166,12 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi 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). -To apply the schema, go to [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.14.0) and download the ScalarDB Cluster Schema Loader to the `scalardb-samples/scalardb-sample` folder. +To apply the schema, go to [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.14.1) and download the ScalarDB Cluster Schema Loader to the `scalardb-samples/scalardb-sample` folder. Then, run the following command: ```console -java -jar scalardb-cluster-schema-loader-3.14.0-all.jar --config database.properties -f schema.json --coordinator +java -jar scalardb-cluster-schema-loader-3.14.1-all.jar --config database.properties -f schema.json --coordinator ``` #### Schema details diff --git a/docs/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx b/docs/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx index 6f714abe..8dceb4c0 100644 --- a/docs/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx +++ b/docs/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx @@ -73,10 +73,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi ## Step 3. Load a schema -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.14.0). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command: +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.14.1). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command: ```console -java -jar scalardb-cluster-schema-loader-3.14.0-all.jar --config database.properties -f schema.json --coordinator +java -jar scalardb-cluster-schema-loader-3.14.1-all.jar --config database.properties -f schema.json --coordinator ``` ## Step 4. Set up a Go environment diff --git a/docs/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx b/docs/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx index 47b4505a..748558ca 100644 --- a/docs/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx +++ b/docs/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx @@ -73,10 +73,10 @@ For details about the client modes, see [Developer Guide for ScalarDB Cluster wi ## Step 3. Load a schema -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.14.0). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command: +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.14.1). After downloading the JAR file, you can run the Schema Loader for Cluster with the following command: ```console -java -jar scalardb-cluster-schema-loader-3.14.0-all.jar --config database.properties -f schema.json --coordinator +java -jar scalardb-cluster-schema-loader-3.14.1-all.jar --config database.properties -f schema.json --coordinator ``` ## Step 4. Set up a Python environment diff --git a/docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx b/docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx index 89fa8a6e..6c6b7cc3 100644 --- a/docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx +++ b/docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx @@ -271,7 +271,7 @@ Select your build tool, and follow the instructions to add the build dependency ```gradle dependencies { - implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.0' + implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.1' } ``` @@ -282,7 +282,7 @@ Select your build tool, and follow the instructions to add the build dependency com.scalar-labs scalardb-cluster-java-client-sdk - 3.14.0 + 3.14.1 ``` @@ -307,5 +307,5 @@ The following limitations apply to non-transactional storage operations: ### Learn more -- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.0/index.html) +- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.1/index.html) - [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.mdx) diff --git a/docs/scalardb-cluster/run-non-transactional-storage-operations-through-sql-interface.mdx b/docs/scalardb-cluster/run-non-transactional-storage-operations-through-sql-interface.mdx index 10977801..592708fb 100644 --- a/docs/scalardb-cluster/run-non-transactional-storage-operations-through-sql-interface.mdx +++ b/docs/scalardb-cluster/run-non-transactional-storage-operations-through-sql-interface.mdx @@ -276,8 +276,8 @@ Also, for a list of supported DDLs, see [ScalarDB SQL Grammar](../scalardb-sql/g ```gradle dependencies { - implementation 'com.scalar-labs:scalardb-sql-jdbc:3.14.0' - implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.0' + implementation 'com.scalar-labs:scalardb-sql-jdbc:3.14.1' + implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.1' } ``` @@ -289,12 +289,12 @@ Also, for a list of supported DDLs, see [ScalarDB SQL Grammar](../scalardb-sql/g com.scalar-labs scalardb-sql-jdbc - 3.14.0 + 3.14.1 com.scalar-labs scalardb-cluster-java-client-sdk - 3.14.0 + 3.14.1 ``` @@ -341,8 +341,8 @@ The following limitations apply to non-transactional storage operations: ```gradle dependencies { - implementation 'com.scalar-labs:scalardb-sql:3.14.0' - implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.0' + implementation 'com.scalar-labs:scalardb-sql:3.14.1' + implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.14.1' } ``` @@ -354,12 +354,12 @@ The following limitations apply to non-transactional storage operations: com.scalar-labs scalardb-sql - 3.14.0 + 3.14.1 com.scalar-labs scalardb-cluster-java-client-sdk - 3.14.0 + 3.14.1 ``` @@ -387,7 +387,7 @@ The following limitations apply to non-transactional storage operations:

Learn more

- - [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb-sql/3.14.0/index.html) + - [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb-sql/3.14.1/index.html) diff --git a/docs/scalardb-cluster/scalardb-auth-with-sql.mdx b/docs/scalardb-cluster/scalardb-auth-with-sql.mdx index 6046c9b2..ef9e93b2 100644 --- a/docs/scalardb-cluster/scalardb-auth-with-sql.mdx +++ b/docs/scalardb-cluster/scalardb-auth-with-sql.mdx @@ -190,7 +190,7 @@ services: scalardb-cluster-standalone: container_name: "scalardb-cluser-node" - image: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium:3.14.0" + image: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium:3.14.1" ports: - 60053:60053 - 9080:9080 @@ -228,7 +228,7 @@ scalar.db.cluster.auth.enabled=true Then, start the SQL CLI by running the following command. ```console -java -jar scalardb-cluster-sql-cli-3.14.0-all.jar --config scalardb-cluster-sql-cli.properties +java -jar scalardb-cluster-sql-cli-3.14.1-all.jar --config scalardb-cluster-sql-cli.properties ``` Enter the username and password as `admin` and `admin`, respectively. @@ -317,7 +317,7 @@ You can see that `user1` has been granted the `SELECT`, `INSERT`, and `UPDATE` p Log in as `user1` and execute SQL statements. ```console -java -jar scalardb-cluster-sql-cli-3.14.0-all.jar --config scalardb-cluster-sql-cli.properties +java -jar scalardb-cluster-sql-cli-3.14.1-all.jar --config scalardb-cluster-sql-cli.properties ``` Enter the username and password as `user1` and `user1`, respectively. diff --git a/docs/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx b/docs/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx index 93eb0a98..8d95c44a 100644 --- a/docs/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx +++ b/docs/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx @@ -170,7 +170,7 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows. 5. Set the chart version of ScalarDB Cluster. ```console - SCALAR_DB_CLUSTER_VERSION=3.14.0 + SCALAR_DB_CLUSTER_VERSION=3.14.1 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) ``` diff --git a/docs/scalardb-sql/jdbc-guide.mdx b/docs/scalardb-sql/jdbc-guide.mdx index b3b72722..327a0d14 100644 --- a/docs/scalardb-sql/jdbc-guide.mdx +++ b/docs/scalardb-sql/jdbc-guide.mdx @@ -192,4 +192,4 @@ Please see also [ScalarDB SQL API Guide](sql-api-guide.mdx) for more details on - [Java JDBC API](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) - [ScalarDB SQL API Guide](sql-api-guide.mdx) -- [Javadoc for ScalarDB JDBC](https://javadoc.io/doc/com.scalar-labs/scalardb-sql-jdbc/3.14.0/index.html) +- [Javadoc for ScalarDB JDBC](https://javadoc.io/doc/com.scalar-labs/scalardb-sql-jdbc/3.14.1/index.html) diff --git a/docs/scalardb-sql/spring-data-guide.mdx b/docs/scalardb-sql/spring-data-guide.mdx index 9d09f270..1ae85d9a 100644 --- a/docs/scalardb-sql/spring-data-guide.mdx +++ b/docs/scalardb-sql/spring-data-guide.mdx @@ -814,4 +814,4 @@ In order to use Spring Data JDBC for ScalarDB, the following features are implem - [Spring Data JDBC - Reference Documentation](https://docs.spring.io/spring-data/jdbc/docs/3.0.x/reference/html/) - [ScalarDB JDBC Guide](jdbc-guide.mdx) -- [Javadoc for Spring Data JDBC for ScalarDB](https://javadoc.io/doc/com.scalar-labs/scalardb-sql-spring-data/3.14.0/index.html) +- [Javadoc for Spring Data JDBC for ScalarDB](https://javadoc.io/doc/com.scalar-labs/scalardb-sql-spring-data/3.14.1/index.html) diff --git a/docs/scalardb-sql/sql-api-guide.mdx b/docs/scalardb-sql/sql-api-guide.mdx index 278180b4..896fec60 100644 --- a/docs/scalardb-sql/sql-api-guide.mdx +++ b/docs/scalardb-sql/sql-api-guide.mdx @@ -111,7 +111,7 @@ ResultSet resultSet = sqlSession.execute(statement); ``` `Statement` objects can be built by `StatementBuilder` that has factory methods for corresponding SQLs. -Please see [the Javadoc of `StatementBuilder`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.0/com/scalar/db/sql/statement/builder/StatementBuilder.html) and [ScalarDB SQL Grammar](grammar.mdx) for more details. +Please see [the Javadoc of `StatementBuilder`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.1/com/scalar/db/sql/statement/builder/StatementBuilder.html) and [ScalarDB SQL Grammar](grammar.mdx) for more details. ### Handle ResultSet objects @@ -142,7 +142,7 @@ If you want to get the metadata of the `ResultSet` object, you can use the `getC ColumnDefinitions columnDefinitions = resultSet.getColumnDefinitions(); ``` -Please see [the Javadoc of `ColumnDefinitions`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.0/com/scalar/db/sql/ColumnDefinition.html) for more details. +Please see [the Javadoc of `ColumnDefinitions`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.1/com/scalar/db/sql/ColumnDefinition.html) for more details. ### Handle Record objects @@ -192,7 +192,7 @@ boolean isNullGottenByName = record.isNull(""); boolean isNullGottenByIndex = record.isNull(); ``` -Please see also [the Javadoc of `Record`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.0/com/scalar/db/sql/Record.html) for more details. +Please see also [the Javadoc of `Record`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.1/com/scalar/db/sql/Record.html) for more details. ### Prepared Statements @@ -237,7 +237,7 @@ preparedStatement2 .execute(); ``` -Please see also [the Javadoc of `PreparedStatement`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.0/com/scalar/db/sql/PreparedStatement.html) for more details. +Please see also [the Javadoc of `PreparedStatement`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.1/com/scalar/db/sql/PreparedStatement.html) for more details. ## Execute transactions @@ -351,10 +351,10 @@ You can get metadata with the `SqlSession.getMetadata()` method as follows: Metadata metadata = sqlSession.getMetadata(); ``` -Please see [the Javadoc of `Metadata`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.0/com/scalar/db/sql/metadata/Metadata.html) for the details. +Please see [the Javadoc of `Metadata`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.14.1/com/scalar/db/sql/metadata/Metadata.html) for the details. ## References - [ScalarDB SQL Grammar](grammar.mdx) - [Two-phase Commit Transactions](../two-phase-commit-transactions.mdx) -- [Javadoc for ScalarDB SQL](https://javadoc.io/doc/com.scalar-labs/scalardb-sql/3.14.0/index.html) +- [Javadoc for ScalarDB SQL](https://javadoc.io/doc/com.scalar-labs/scalardb-sql/3.14.1/index.html)