Skip to content

Commit

Permalink
AUTO: Sync ScalarDB docs in English to docs site repo (#643)
Browse files Browse the repository at this point in the history
Co-authored-by: josh-wong <[email protected]>
  • Loading branch information
github-actions[bot] and josh-wong authored Oct 15, 2024
1 parent 42b4011 commit 66e9310
Show file tree
Hide file tree
Showing 10 changed files with 38 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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'
}
```

Expand All @@ -127,7 +127,7 @@ To add a dependency by using Maven, use the following:
<dependency>
<groupId>com.scalar-labs</groupId>
<artifactId>scalardb-cluster-client</artifactId>
<version>3.9.6</version>
<version>3.9.7</version>
</dependency>
```

Expand Down Expand Up @@ -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 <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
java -jar scalardb-cluster-schema-loader-3.9.7-all.jar --config <PATH_TO_CONFIG_FILE> -f <PATH_TO_SCHEMA_FILE> --coordinator
```

## ScalarDB Cluster SQL
Expand Down Expand Up @@ -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'
}
```

Expand All @@ -278,12 +278,12 @@ To add the dependencies by using Maven, use the following:
<dependency>
<groupId>com.scalar-labs</groupId>
<artifactId>scalardb-sql-jdbc</artifactId>
<version>3.9.6</version>
<version>3.9.7</version>
</dependency>
<dependency>
<groupId>com.scalar-labs</groupId>
<artifactId>scalardb-cluster-client</artifactId>
<version>3.9.6</version>
<version>3.9.7</version>
</dependency>
</dependencies>
```
Expand All @@ -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'
}
```

Expand All @@ -313,12 +313,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.9.6</version>
<version>3.9.7</version>
</dependency>
<dependency>
<groupId>com.scalar-labs</groupId>
<artifactId>scalardb-cluster-client</artifactId>
<version>3.9.6</version>
<version>3.9.7</version>
</dependency>
</dependencies>
```
Expand Down Expand Up @@ -363,18 +363,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.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 <PATH_TO_CONFIG_FILE>
java -jar scalardb-cluster-sql-cli-3.9.7-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.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=<outputFormat>]
Starts ScalarDB SQL CLI.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
}
```

Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```

Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-3.9/scalardb-sql/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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'
}
```

Expand All @@ -104,14 +104,14 @@ To add a dependency using Maven:
<dependency>
<groupId>com.scalar-labs</groupId>
<artifactId>scalardb-sql-direct-mode</artifactId>
<version>3.9.6</version>
<version>3.9.7</version>
</dependency>

<!-- For Server mode -->
<dependency>
<groupId>com.scalar-labs</groupId>
<artifactId>scalardb-sql-server-mode</artifactId>
<version>3.9.6</version>
<version>3.9.7</version>
</dependency>
</dependencies>
```
Expand Down
10 changes: 5 additions & 5 deletions versioned_docs/version-3.9/scalardb-sql/sql-api-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -191,7 +191,7 @@ boolean isNullGottenByName = record.isNull("<column name>");
boolean isNullGottenByIndex = record.isNull(<column index>);
```

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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 66e9310

Please sign in to comment.