Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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("<COLUMN_NAME>");
```

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
}
```
</TabItem>
Expand All @@ -248,7 +248,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.14.0</version>
<version>3.14.1</version>
</dependency>
```
</TabItem>
Expand All @@ -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)
26 changes: 24 additions & 2 deletions docs/scalardb-benchmarks/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
tags:
- Community
- Enterprise Standard
- Enterprise Premium
displayed_sidebar: docsEnglish
---

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

Expand All @@ -78,20 +82,38 @@ After applying the schema and configuring the properties file, select a benchmar
```console
java -jar scalardb-schema-loader-<VERSION>.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f tpcc-schema.json --coordinator
```

If you are using ScalarDB Cluster, run the following command instead:

```console
java -jar scalardb-cluster-schema-loader-<VERSION>-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f tpcc-schema.json --coordinator
```
</TabItem>
<TabItem value="YCSB" label="YCSB">
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:

```console
java -jar scalardb-schema-loader-<VERSION>.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-schema.json --coordinator
```

If you are using ScalarDB Cluster, run the following command instead:

```console
java -jar scalardb-cluster-schema-loader-<VERSION>-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-schema.json --coordinator
```
</TabItem>
<TabItem value="multi-storage_YCSB" label="Multi-storage YCSB">
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:

```console
java -jar scalardb-schema-loader-<VERSION>.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -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-<VERSION>-all.jar --config <PATH_TO_SCALARDB_PROPERTIES_FILE> -f ycsb-multi-storage-schema.json --coordinator
```
</TabItem>
</Tabs>

Expand Down
1 change: 1 addition & 0 deletions docs/scalardb-cluster/compatibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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* |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
}
```

Expand All @@ -28,7 +28,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.14.0</version>
<version>3.14.1</version>
</dependency>
```

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

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

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

Expand All @@ -212,12 +212,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.14.0</version>
<version>3.14.1</version>
</dependency>
<dependency>
<groupId>com.scalar-labs</groupId>
<artifactId>scalardb-cluster-java-client-sdk</artifactId>
<version>3.14.0</version>
<version>3.14.1</version>
</dependency>
</dependencies>
```
Expand Down Expand Up @@ -262,18 +262,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.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 <PATH_TO_CONFIG_FILE>
java -jar scalardb-cluster-sql-cli-3.14.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.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=<outputFormat>] [-p=PASSWORD]
[-u=USERNAME]
Expand Down Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/scalardb-cluster/encrypt-data-at-rest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

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

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