AUTO: Sync ScalarDB docs in English to docs site repo

scalar-labs · Oct 15, 2024 · d2b0c55 · d2b0c55
1 parent c7a1743
commit d2b0c55
Show file tree

Hide file tree

Showing 18 changed files with 70 additions and 64 deletions.
diff --git a/docs/api-guide.mdx b/docs/api-guide.mdx
@@ -580,7 +580,7 @@ And if you need to check if a value of a column is null, you can use the `isNull
 boolean isNull = result.isNull("<COLUMN_NAME>");
 ```
 
-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.
+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.
 
 ###### Execute `Get` by using a secondary index
 
@@ -787,7 +787,7 @@ For details about the `WHERE` clause, see [Use the `WHERE` clause](#use-the-wher
 
 :::note
 
-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.
+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.
 
 :::
 
@@ -1232,7 +1232,7 @@ For details about the `Scan` operation, see [`Scan` operation](#scan-operation).
 
 :::note
 
-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.
+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.
 
 :::
 

diff --git a/docs/run-non-transactional-storage-operations-through-library.mdx b/docs/run-non-transactional-storage-operations-through-library.mdx
@@ -236,7 +236,7 @@ Select your build tool, and follow the instructions to add the build dependency
 
     ```gradle
     dependencies {
-        implementation 'com.scalar-labs:scalardb:3.13.0'
+        implementation 'com.scalar-labs:scalardb:3.13.1'
     }
     ```
   </TabItem>
@@ -247,7 +247,7 @@ Select your build tool, and follow the instructions to add the build dependency
     <dependency>
         <groupId>com.scalar-labs</groupId>
         <artifactId>scalardb</artifactId>
-        <version>3.13.0</version>
+        <version>3.13.1</version>
     </dependency>
     ```
   </TabItem>
@@ -268,4 +268,4 @@ The following limitations apply to non-transactional storage operations:
 
 ### Learn more
 
-- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.0/index.html)
+- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.1/index.html)
diff --git a/docs/scalardb-cluster/compatibility.mdx b/docs/scalardb-cluster/compatibility.mdx
@@ -1,3 +1,9 @@
+---
+tags:
+  - Enterprise Standard
+  - Enterprise Premium
+---
+
 # ScalarDB Cluster Compatibility Matrix
 
 This document shows the compatibility of ScalarDB Cluster versions among client SDK versions.

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
@@ -17,7 +17,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.13.0'
+    implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
 }
 ```
 
@@ -27,7 +27,7 @@ To add a dependency by using Maven, use the following:
 <dependency>
   <groupId>com.scalar-labs</groupId>
   <artifactId>scalardb-cluster-java-client-sdk</artifactId>
-  <version>3.13.0</version>
+  <version>3.13.1</version>
 </dependency>
 ```
 
@@ -120,11 +120,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.13.0).
+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 Schema Loader for Cluster with the following command:
 
 ```console
-java -jar scalardb-cluster-schema-loader-3.13.0-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
+java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
 ```
 
 ## ScalarDB Cluster SQL
@@ -164,8 +164,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.13.0'
-    implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.0'
+    implementation 'com.scalar-labs:scalardb-sql-jdbc:3.13.1'
+    implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
 }
 ```
 
@@ -176,12 +176,12 @@ To add the dependencies by using Maven, use the following:
     <dependency>
         <groupId>com.scalar-labs</groupId>
         <artifactId>scalardb-sql-jdbc</artifactId>
-        <version>3.13.0</version>
+        <version>3.13.1</version>
     </dependency>
     <dependency>
         <groupId>com.scalar-labs</groupId>
         <artifactId>scalardb-cluster-java-client-sdk</artifactId>
-        <version>3.13.0</version>
+        <version>3.13.1</version>
     </dependency>
 </dependencies>
 ```
@@ -199,8 +199,8 @@ To add the dependencies by using Gradle, use the following:
 
 ```gradle
 dependencies {
-    implementation 'com.scalar-labs:scalardb-sql-spring-data:3.13.0'
-    implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.0'
+    implementation 'com.scalar-labs:scalardb-sql-spring-data:3.13.1'
+    implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
 }
 ```
 
@@ -211,12 +211,12 @@ To add the dependencies by using Maven, use the following:
     <dependency>
         <groupId>com.scalar-labs</groupId>
         <artifactId>scalardb-sql-spring-data</artifactId>
-        <version>3.13.0</version>
+        <version>3.13.1</version>
     </dependency>
     <dependency>
         <groupId>com.scalar-labs</groupId>
         <artifactId>scalardb-cluster-java-client-sdk</artifactId>
-        <version>3.13.0</version>
+        <version>3.13.1</version>
     </dependency>
 </dependencies>
 ```
@@ -261,18 +261,18 @@ 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.13.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.13.1). After downloading the JAR file, you can run the SQL CLI with the following command:
 
 ```console
-java -jar scalardb-cluster-sql-cli-3.13.0-all.jar --config <PATH_TO_CONFIG_FILE>
+java -jar scalardb-cluster-sql-cli-3.13.1-all.jar --config <PATH_TO_CONFIG_FILE>
 ```
 
 #### Usage
 
 You can see the CLI usage with the `-h` option as follows:
 
 ```console
-java -jar scalardb-cluster-sql-cli-3.13.0-all.jar -h
+java -jar scalardb-cluster-sql-cli-3.13.1-all.jar -h
 Usage: scalardb-sql-cli [-hs] -c=PROPERTIES_FILE [-e=COMMAND] [-f=FILE]
                         [-l=LOG_FILE] [-o=<outputFormat>] [-p=PASSWORD]
                         [-u=USERNAME]
@@ -303,6 +303,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.13.0/index.html)
-* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.13.0/index.html)
-* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.13.0/index.html)
+* [ScalarDB Cluster Java Client SDK](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-java-client-sdk/3.13.1/index.html)
+* [ScalarDB Cluster Common](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-common/3.13.1/index.html)
+* [ScalarDB Cluster RPC](https://javadoc.io/doc/com.scalar-labs/scalardb-cluster-rpc/3.13.1/index.html)
diff --git a/docs/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx b/docs/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.13.0).
+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:
 
 ```console
-java -jar scalardb-cluster-schema-loader-3.13.0-all.jar --config database.properties -f schema.json --coordinator
+java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
 ```
 
 ## Step 4. Run operations from GraphiQL
@@ -192,7 +192,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.13.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.13.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
@@ -87,10 +87,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.13.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.13.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.13.0-all.jar --config scalardb-sql.properties --file schema.sql
+java -jar scalardb-cluster-sql-cli-3.13.1-all.jar --config scalardb-sql.properties --file schema.sql
 ```
 
 ## Step 4. Load the initial data

diff --git a/...scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx b/...scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx
@@ -87,10 +87,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.13.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.13.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.13.0-all.jar --config scalardb-sql.properties --file schema.sql
+java -jar scalardb-cluster-sql-cli-3.13.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
@@ -121,7 +121,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.13.0'
+    implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
 }
 ```
 
@@ -167,12 +167,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.13.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.13.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.13.0-all.jar --config database.properties -f schema.json --coordinator
+java -jar scalardb-cluster-schema-loader-3.13.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
@@ -72,10 +72,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.13.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.13.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.13.0-all.jar --config database.properties -f schema.json --coordinator
+java -jar scalardb-cluster-schema-loader-3.13.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
@@ -72,10 +72,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.13.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.13.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.13.0-all.jar --config database.properties -f schema.json --coordinator
+java -jar scalardb-cluster-schema-loader-3.13.1-all.jar --config database.properties -f schema.json --coordinator
 ```
 
 ## Step 4. Set up a Python environment

diff --git a/...b-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx b/...b-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx
@@ -270,7 +270,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.13.0'
+      implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
     }
     ```
   </TabItem>
@@ -281,7 +281,7 @@ Select your build tool, and follow the instructions to add the build dependency
     <dependency>
       <groupId>com.scalar-labs</groupId>
       <artifactId>scalardb-cluster-java-client-sdk</artifactId>
-      <version>3.13.0</version>
+      <version>3.13.1</version>
     </dependency>
     ```
   </TabItem>
@@ -306,5 +306,5 @@ The following limitations apply to non-transactional storage operations:
 
 ### Learn more
 
-- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.0/index.html)
+- [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.1/index.html)
 - [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.mdx)
diff --git a/...ardb-cluster/run-non-transactional-storage-operations-through-sql-interface.mdx b/...ardb-cluster/run-non-transactional-storage-operations-through-sql-interface.mdx
@@ -275,8 +275,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.13.0'
-            implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.0'
+            implementation 'com.scalar-labs:scalardb-sql-jdbc:3.13.1'
+            implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
         }
         ```
       </TabItem>
@@ -288,12 +288,12 @@ Also, for a list of supported DDLs, see [ScalarDB SQL Grammar](../scalardb-sql/g
             <dependency>
                 <groupId>com.scalar-labs</groupId>
                 <artifactId>scalardb-sql-jdbc</artifactId>
-                <version>3.13.0</version>
+                <version>3.13.1</version>
             </dependency>
             <dependency>
                 <groupId>com.scalar-labs</groupId>
                 <artifactId>scalardb-cluster-java-client-sdk</artifactId>
-                <version>3.13.0</version>
+                <version>3.13.1</version>
             </dependency>
         </dependencies>
         ```
@@ -340,8 +340,8 @@ The following limitations apply to non-transactional storage operations:
 
         ```gradle
         dependencies {
-            implementation 'com.scalar-labs:scalardb-sql:3.13.0'
-            implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.0'
+            implementation 'com.scalar-labs:scalardb-sql:3.13.1'
+            implementation 'com.scalar-labs:scalardb-cluster-java-client-sdk:3.13.1'
         }
         ```
       </TabItem>
@@ -353,12 +353,12 @@ The following limitations apply to non-transactional storage operations:
             <dependency>
                 <groupId>com.scalar-labs</groupId>
                 <artifactId>scalardb-sql</artifactId>
-                <version>3.13.0</version>
+                <version>3.13.1</version>
             </dependency>
             <dependency>
                 <groupId>com.scalar-labs</groupId>
                 <artifactId>scalardb-cluster-java-client-sdk</artifactId>
-                <version>3.13.0</version>
+                <version>3.13.1</version>
             </dependency>
         </dependencies>
         ```
@@ -386,7 +386,7 @@ The following limitations apply to non-transactional storage operations:
 
     <h3>Learn more</h3>
 
-    - [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb-sql/3.13.0/index.html)
+    - [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb-sql/3.13.1/index.html)
 
   </TabItem>
 </Tabs>