From f87306932c4dae25a2019d4c9c2c7ef40ef0180b Mon Sep 17 00:00:00 2001 From: josh-wong Date: Tue, 15 Oct 2024 05:27:08 +0000 Subject: [PATCH] AUTO: Sync ScalarDB docs in English to docs site repo --- ...ide-for-scalardb-cluster-with-java-api.mdx | 30 +++++++++---------- ...-started-with-scalardb-cluster-graphql.mdx | 4 +-- ...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 +-- ...ster-on-kubernetes-by-using-helm-chart.mdx | 2 +- .../version-3.9/scalardb-sql/index.mdx | 8 ++--- .../scalardb-sql/sql-api-guide.mdx | 10 +++---- 10 files changed, 38 insertions(+), 38 deletions(-) diff --git a/versioned_docs/version-3.9/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx b/versioned_docs/version-3.9/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx index ecf04c6f..91757a03 100644 --- a/versioned_docs/version-3.9/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx +++ b/versioned_docs/version-3.9/scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx @@ -117,7 +117,7 @@ To add a dependency on ScalarDB Cluster Client by using Gradle, use the followin ```gradle dependencies { - implementation 'com.scalar-labs:scalardb-cluster-client:3.9.6' + implementation 'com.scalar-labs:scalardb-cluster-client:3.9.7' } ``` @@ -127,7 +127,7 @@ To add a dependency by using Maven, use the following: com.scalar-labs scalardb-cluster-client - 3.9.6 + 3.9.7 ``` @@ -222,11 +222,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.9.6). +You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.9.7). After downloading the JAR file, you can run Schema Loader for Cluster with the following command: ```console -java -jar scalardb-cluster-schema-loader-3.9.6-all.jar --config -f --coordinator +java -jar scalardb-cluster-schema-loader-3.9.7-all.jar --config -f --coordinator ``` ## ScalarDB Cluster SQL @@ -266,8 +266,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.9.6' - implementation 'com.scalar-labs:scalardb-cluster-client:3.9.6' + implementation 'com.scalar-labs:scalardb-sql-jdbc:3.9.7' + implementation 'com.scalar-labs:scalardb-cluster-client:3.9.7' } ``` @@ -278,12 +278,12 @@ To add the dependencies by using Maven, use the following: com.scalar-labs scalardb-sql-jdbc - 3.9.6 + 3.9.7 com.scalar-labs scalardb-cluster-client - 3.9.6 + 3.9.7 ``` @@ -301,8 +301,8 @@ To add the dependencies by using Gradle, use the following: ```gradle dependencies { - implementation 'com.scalar-labs:scalardb-sql-spring-data:3.9.6' - implementation 'com.scalar-labs:scalardb-cluster-client:3.9.6' + implementation 'com.scalar-labs:scalardb-sql-spring-data:3.9.7' + implementation 'com.scalar-labs:scalardb-cluster-client:3.9.7' } ``` @@ -313,12 +313,12 @@ To add the dependencies by using Maven, use the following: com.scalar-labs scalardb-sql-spring-data - 3.9.6 + 3.9.7 com.scalar-labs scalardb-cluster-client - 3.9.6 + 3.9.7 ``` @@ -363,10 +363,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.9.6). 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.9.7). After downloading the JAR file, you can run the SQL CLI with the following command: ```console -java -jar scalardb-cluster-sql-cli-3.9.6-all.jar --config +java -jar scalardb-cluster-sql-cli-3.9.7-all.jar --config ``` #### Usage @@ -374,7 +374,7 @@ java -jar scalardb-cluster-sql-cli-3.9.6-all.jar --config You can see the CLI usage with the `-h` option as follows: ```console -java -jar scalardb-cluster-sql-cli-3.9.6-all.jar -h +java -jar scalardb-cluster-sql-cli-3.9.7-all.jar -h Usage: scalardb-sql-cli [-hs] -c=PROPERTIES_FILE [-e=COMMAND] [-f=FILE] [-l=LOG_FILE] [-o=] Starts ScalarDB SQL CLI. diff --git a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx index df4684ce..2226f905 100644 --- a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx +++ b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx @@ -111,11 +111,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.9.6). +You can download the Schema Loader for Cluster from [ScalarDB Releases](https://github.com/scalar-labs/scalardb/releases/tag/v3.9.7). 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.9.6-all.jar --config database.properties -f schema.json --coordinator +java -jar scalardb-cluster-schema-loader-3.9.7-all.jar --config database.properties -f schema.json --coordinator ``` ## Step 4. Run operations from GraphiQL diff --git a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx index 1fe1e948..d31d9f21 100644 --- a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx +++ b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx @@ -109,10 +109,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.9.6). 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.9.7). 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.9.6-all.jar --config scalardb-sql.properties --file schema.sql +java -jar scalardb-cluster-sql-cli-3.9.7-all.jar --config scalardb-sql.properties --file schema.sql ``` ## Step 4. Load the initial data diff --git a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx index 6e69f1be..3ee36e6d 100644 --- a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx +++ b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx @@ -109,10 +109,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.9.6). 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.9.7). 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.9.6-all.jar --config scalardb-sql.properties --file schema.sql +java -jar scalardb-cluster-sql-cli-3.9.7-all.jar --config scalardb-sql.properties --file schema.sql ``` ## Step 4. Modify `application.properties` diff --git a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster.mdx b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster.mdx index d5f5b67d..8b92e5bd 100644 --- a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster.mdx +++ b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-scalardb-cluster.mdx @@ -170,7 +170,7 @@ Then, delete the existing dependency for `com.scalar-labs:scalardb` from the `de dependencies { ... - implementation 'com.scalar-labs:scalardb-cluster-client:3.9.6' + implementation 'com.scalar-labs:scalardb-cluster-client:3.9.7' } ``` @@ -216,12 +216,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.9.6) 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.9.7) 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.9.6-all.jar --config database.properties -f schema.json --coordinator +java -jar scalardb-cluster-schema-loader-3.9.7-all.jar --config database.properties -f schema.json --coordinator ``` #### Schema details diff --git a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx index dd7e8816..4a65003b 100644 --- a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx +++ b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.mdx @@ -77,10 +77,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.9.6). 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.9.7). 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.9.6-all.jar --config database.properties -f schema.json --coordinator +java -jar scalardb-cluster-schema-loader-3.9.7-all.jar --config database.properties -f schema.json --coordinator ``` ## Step 4. Set up a Go environment diff --git a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx index 8bf6b696..72c3b08b 100644 --- a/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx +++ b/versioned_docs/version-3.9/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.mdx @@ -77,10 +77,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.9.6). 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.9.7). 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.9.6-all.jar --config database.properties -f schema.json --coordinator +java -jar scalardb-cluster-schema-loader-3.9.7-all.jar --config database.properties -f schema.json --coordinator ``` ## Step 4. Set up a Python environment diff --git a/versioned_docs/version-3.9/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx b/versioned_docs/version-3.9/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx index 551f3f36..ebfbd62d 100644 --- a/versioned_docs/version-3.9/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx +++ b/versioned_docs/version-3.9/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx @@ -165,7 +165,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.13.0 + SCALAR_DB_CLUSTER_VERSION=3.12.4 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/versioned_docs/version-3.9/scalardb-sql/index.mdx b/versioned_docs/version-3.9/scalardb-sql/index.mdx index bf2f6c91..de1fe66d 100644 --- a/versioned_docs/version-3.9/scalardb-sql/index.mdx +++ b/versioned_docs/version-3.9/scalardb-sql/index.mdx @@ -90,10 +90,10 @@ To add a dependency on ScalarDB SQL using Gradle, use the following: ```gradle dependencies { // For Direct mode - implementation 'com.scalar-labs:scalardb-sql-direct-mode:3.9.6' + implementation 'com.scalar-labs:scalardb-sql-direct-mode:3.9.7' // For Server mode - implementation 'com.scalar-labs:scalardb-sql-server-mode:3.9.6' + implementation 'com.scalar-labs:scalardb-sql-server-mode:3.9.7' } ``` @@ -104,14 +104,14 @@ To add a dependency using Maven: com.scalar-labs scalardb-sql-direct-mode - 3.9.6 + 3.9.7 com.scalar-labs scalardb-sql-server-mode - 3.9.6 + 3.9.7 ``` diff --git a/versioned_docs/version-3.9/scalardb-sql/sql-api-guide.mdx b/versioned_docs/version-3.9/scalardb-sql/sql-api-guide.mdx index a8a41611..96ba881b 100644 --- a/versioned_docs/version-3.9/scalardb-sql/sql-api-guide.mdx +++ b/versioned_docs/version-3.9/scalardb-sql/sql-api-guide.mdx @@ -110,7 +110,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.13.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.11.4/com/scalar/db/sql/statement/builder/StatementBuilder.html) and [ScalarDB SQL Grammar](grammar.mdx) for more details. ### Handle ResultSet objects @@ -141,7 +141,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.13.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.11.4/com/scalar/db/sql/ColumnDefinition.html) for more details. ### Handle Record objects @@ -191,7 +191,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.13.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.11.4/com/scalar/db/sql/Record.html) for more details. ### Prepared Statements @@ -236,7 +236,7 @@ preparedStatement2 .execute(); ``` -Please see also [the Javadoc of `PreparedStatement`](https://javadoc.io/static/com.scalar-labs/scalardb-sql/3.13.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.11.4/com/scalar/db/sql/PreparedStatement.html) for more details. ## Execute transactions @@ -350,7 +350,7 @@ 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.13.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.11.4/com/scalar/db/sql/metadata/Metadata.html) for the details. ## References