Merge pull request #131 from scalar-labs/add-updated-docs

Add updated docs for ScalarDB and the ScalarDB Cluster .NET Client SDK
scalar-labs · Jan 29, 2024 · a0c94cf · a0c94cf
2 parents 4a1ac6b + 9aa7d2b
commit a0c94cf
Show file tree

Hide file tree

Showing 29 changed files with 117 additions and 219 deletions.
diff --git a/docs/3.10/api-guide.md b/docs/3.10/api-guide.md
@@ -580,8 +580,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)

diff --git a/docs/3.10/getting-started-kotlin/build.gradle.kts b/docs/3.10/getting-started-kotlin/build.gradle.kts
@@ -13,7 +13,7 @@ repositories {
 }
 
 dependencies {
-    implementation("com.scalar-labs", "scalardb", "3.10.1")
+    implementation("com.scalar-labs", "scalardb", "3.10.2")
     testImplementation(kotlin("test"))
 }
 

diff --git a/docs/3.10/getting-started/build.gradle b/docs/3.10/getting-started/build.gradle
@@ -9,7 +9,7 @@ repositories {
 mainClassName = "sample.ElectronicMoneyMain"
 
 dependencies {
-    implementation 'com.scalar-labs:scalardb:3.10.1'
+    implementation 'com.scalar-labs:scalardb:3.10.2'
     implementation 'org.slf4j:slf4j-simple:1.7.30'
 }
 

diff --git a/docs/3.10/index.md b/docs/3.10/index.md
@@ -13,7 +13,7 @@ You can install it in your application using your build tool such as Gradle and
 To add a dependency on ScalarDB using Gradle, use the following:
 ```gradle
 dependencies {
-    implementation 'com.scalar-labs:scalardb:3.10.1'
+    implementation 'com.scalar-labs:scalardb:3.10.2'
 }
 ```
 
@@ -22,7 +22,7 @@ To add a dependency using Maven:
 <dependency>
   <groupId>com.scalar-labs</groupId>
   <artifactId>scalardb</artifactId>
-  <version>3.10.1</version>
+  <version>3.10.2</version>
 </dependency>
 ```
 

diff --git a/docs/3.10/storage-abstraction.md b/docs/3.10/storage-abstraction.md
@@ -521,8 +521,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)

diff --git a/docs/3.11/api-guide.md b/docs/3.11/api-guide.md
@@ -599,8 +599,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)

diff --git a/docs/3.11/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.md b/docs/3.11/scalardb-cluster/getting-started-with-scalardb-cluster-graphql.md
@@ -4,11 +4,21 @@ This tutorial describes how to use ScalarDB Cluster GraphQL.
 
 ## Prerequisites
 
-In this tutorial, we assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
+- One of the following Java Development Kits (JDKs):
+  - [Oracle JDK](https://www.oracle.com/java/technologies/downloads/) LTS version (8, 11, or 17)
+  - [OpenJDK](https://openjdk.org/install/) LTS version (8, 11, or 17)
+- ScalarDB Cluster running on a Kubernetes cluster
+  - We assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
 
-In addition, you need access to the [ScalarDB Cluster GitHub repository](https://github.com/scalar-labs/scalardb-cluster).
-This repository is available only to users with a commercial license and permission.
-To get a license and permission, please [contact us](https://scalar-labs.com/contact_us/).
+{% capture notice--info %}
+**Note**
+
+We recommend using the LTS versions mentioned above, but other non-LTS versions may work.
+
+In addition, other JDKs should work with ScalarDB, but we haven't tested them.
+{% endcapture %}
+
+<div class="notice--info">{{ notice--info | markdownify }}</div>
 
 ## Sample application
 

diff --git a/docs/3.11/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.md b/docs/3.11/scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.md
@@ -5,30 +5,21 @@ You'll be using the same sample application as found in the [ScalarDB SQL (JDBC)
 
 ## Prerequisites
 
-- Java (OpenJDK 8 or higher)
-- Gradle
+- One of the following Java Development Kits (JDKs):
+  - [Oracle JDK](https://www.oracle.com/java/technologies/downloads/) LTS version (8, 11, or 17)
+  - [OpenJDK](https://openjdk.org/install/) LTS version (8, 11, or 17)
+- ScalarDB Cluster running on a Kubernetes cluster
+  - We assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
 
-In this tutorial, we assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
+{% capture notice--info %}
+**Note**
 
-In addition, you need access to the [ScalarDB Cluster GitHub repository](https://github.com/scalar-labs/scalardb-cluster), [packages in the ScalarDB Cluster repository](https://github.com/orgs/scalar-labs/packages?repo_name=scalardb-cluster), and [packages in the ScalarDB SQL repository](https://github.com/orgs/scalar-labs/packages?repo_name=scalardb-sql).
-These repositories are available only to users with a commercial license and permission.
-To get a license and permission, please [contact us](https://scalar-labs.com/contact_us/).
+We recommend using the LTS versions mentioned above, but other non-LTS versions may work.
 
-You also need to set the `gpr.user` property to your GitHub username and the `gpr.key` property to your personal access token.
-To do so, you must either add these properties in `~/.gradle/gradle.properties` or specify the properties by using the `-P` option when running the `./gradlew` command as follows:
+In addition, other JDKs should work with ScalarDB, but we haven't tested them.
+{% endcapture %}
 
-```shell
-$ ./gradlew run ... -Pgpr.user=<YOUR_GITHUB_USERNAME> -Pgpr.key=<YOUR_PERSONAL_ACCESS_TOKEN>
-```
-
-Or you can use environment variables, such as `USERNAME` for your GitHub username and `TOKEN` for your personal access token.
-
-```shell
-$ export USERNAME=<YOUR_GITHUB_USERNAME>
-$ export TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN>
-```
-
-For more details, see [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.md).
+<div class="notice--info">{{ notice--info | markdownify }}</div>
 
 ## Sample application
 

diff --git a/.../scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.md b/.../scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.md
@@ -5,30 +5,21 @@ You'll be using the same sample application as found in the [Sample application
 
 ## Prerequisites
 
-- Java (OpenJDK 8 or higher)
-- Gradle
+- One of the following Java Development Kits (JDKs):
+  - [Oracle JDK](https://www.oracle.com/java/technologies/downloads/) LTS version (8, 11, or 17)
+  - [OpenJDK](https://openjdk.org/install/) LTS version (8, 11, or 17)
+- ScalarDB Cluster running on a Kubernetes cluster
+  - We assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
 
-In this tutorial, we assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
+{% capture notice--info %}
+**Note**
 
-In addition, you need access to the [ScalarDB Cluster GitHub repository](https://github.com/scalar-labs/scalardb-cluster), [packages in the ScalarDB Cluster repository](https://github.com/orgs/scalar-labs/packages?repo_name=scalardb-cluster), and [packages in the ScalarDB SQL repository](https://github.com/orgs/scalar-labs/packages?repo_name=scalardb-sql).
-These repositories are available only to users with a commercial license and permission.
-To get a license and permission, please [contact us](https://scalar-labs.com/contact_us/).
+We recommend using the LTS versions mentioned above, but other non-LTS versions may work.
 
-You also need to set the `gpr.user` property to your GitHub username and the `gpr.key` property to your personal access token.
-To do so, you must either add these properties in `~/.gradle/gradle.properties` or specify the properties by using the `-P` option when running the `./gradlew` command as follows:
+In addition, other JDKs should work with ScalarDB, but we haven't tested them.
+{% endcapture %}
 
-```shell
-$ ./gradlew run ... -Pgpr.user=<YOUR_GITHUB_USERNAME> -Pgpr.key=<YOUR_PERSONAL_ACCESS_TOKEN>
-```
-
-Or you can use environment variables, such as `USERNAME` for your GitHub username and `TOKEN` for your personal access token.
-
-```shell
-$ export USERNAME=<YOUR_GITHUB_USERNAME>
-$ export TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN>
-```
-
-For more details, see [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.md).
+<div class="notice--info">{{ notice--info | markdownify }}</div>
 
 ## Sample application
 

diff --git a/docs/3.11/scalardb-cluster/getting-started-with-scalardb-cluster.md b/docs/3.11/scalardb-cluster/getting-started-with-scalardb-cluster.md
@@ -75,7 +75,7 @@ The sample application supports the following types of transactions:
   - [Oracle JDK](https://www.oracle.com/java/technologies/downloads/) LTS version (8, 11, or 17)
   - [OpenJDK](https://openjdk.org/install/) LTS version (8, 11, or 17)
 - ScalarDB Cluster running on a Kubernetes cluster
-  - If you don't have ScalarDB Cluster set up, please follow the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
+  - We assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
 
 {% capture notice--info %}
 **Note**
@@ -87,39 +87,6 @@ In addition, other JDKs should work with ScalarDB, but we haven't tested them.
 
 <div class="notice--info">{{ notice--info | markdownify }}</div>
 
-In addition, you need access to the [ScalarDB Cluster GitHub repository](https://github.com/scalar-labs/scalardb-cluster) and the [packages in the ScalarDB Cluster repository](https://github.com/orgs/scalar-labs/packages?repo_name=scalardb-cluster), which are private. The packages and repository are available only those who are using ScalarDB Enterprise. If you need a license for ScalarDB Enterprise, please [contact us](https://scalar-labs.com/contact_us/).
-
-After confirming that you have access to the ScalarDB SQL repository and its packages, you will need to set your GitHub username and your personal access token. To specify these properties, you can do one of the following:
-
-<div id="tabset-1">
-<div class="tab">
-  <button class="tablinks" onclick="openTab(event, 'Gradle_properties_via_command', 'tabset-1')" id="defaultOpen-1">Add to Gradle properties via Terminal</button>
-  <button class="tablinks" onclick="openTab(event, 'Environment_variables', 'tabset-1')">Add as environment variables</button>
-</div>
-
-<div id="Gradle_properties_via_command" class="tabcontent" markdown="1">
-
-Specify the properties with the `-P` option by running the `./gradlew` command as follows, replacing `<YOUR_GITHUB_USERNAME>` with your GitHub username and `<YOUR_PERSONAL_ACCESS_TOKEN>` with your personal access token:
-
-```console
-$ ./gradlew run ... -Pgpr.user=<YOUR_GITHUB_USERNAME> -Pgpr.key=<YOUR_PERSONAL_ACCESS_TOKEN>
-```
-
-</div>
-<div id="Environment_variables" class="tabcontent" markdown="1">
-
-Specify the properties as environment variables by running the following commands, replacing `<YOUR_GITHUB_USERNAME>` with your GitHub username and `<YOUR_PERSONAL_ACCESS_TOKEN>` with your personal access token:
-
-```console
-$ export USERNAME=<YOUR_GITHUB_USERNAME>
-$ export TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN>
-```
-
-</div>
-</div>
-
-For more details, see [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.md).
-
 ## Set up ScalarDB Cluster
 
 The following sections describe how to set up the sample e-commerce application.

diff --git a/docs/3.11/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.md b/docs/3.11/scalardb-cluster/getting-started-with-using-go-for-scalardb-cluster.md
@@ -4,14 +4,9 @@ This document explains how to write gRPC client code for ScalarDB Cluster by usi
 
 ## Prerequisites
 
-- ScalarDB Cluster 3.9.0 or later
-- Go: any one of the three latest major releases
-
-In this tutorial, we assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
-
-In addition, you need access to the [ScalarDB Cluster GitHub repository](https://github.com/scalar-labs/scalardb-cluster).
-This repository is available only to users with a commercial license and permission.
-To get a license and permission, please [contact us](https://scalar-labs.com/contact_us/).
+- [Go](https://go.dev/dl/) (any one of the three latest major releases)
+- ScalarDB Cluster running on a Kubernetes cluster
+  - We assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
 
 ## Sample application
 

diff --git a/...3.11/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.md b/...3.11/scalardb-cluster/getting-started-with-using-python-for-scalardb-cluster.md
@@ -4,14 +4,9 @@ This document explains how to write gRPC client code for ScalarDB Cluster by usi
 
 ## Prerequisites
 
-- ScalarDB Cluster 3.9.0 or later
-- Python 3.7 or later
-
-In this tutorial, we assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
-
-In addition, you need access to the [ScalarDB Cluster GitHub repository](https://github.com/scalar-labs/scalardb-cluster).
-This repository is available only to users with a commercial license and permission.
-To get a license and permission, please [contact us](https://scalar-labs.com/contact_us/).
+- [Python](https://www.python.org/downloads) 3.7 or later
+- ScalarDB Cluster running on a Kubernetes cluster
+  - We assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in [Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart](setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.md).
 
 ## Sample application
 

diff --git a/docs/3.11/storage-abstraction.md b/docs/3.11/storage-abstraction.md
@@ -521,8 +521,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)

diff --git a/docs/3.8/api-guide.md b/docs/3.8/api-guide.md
@@ -559,8 +559,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)

diff --git a/docs/3.8/getting-started/build.gradle b/docs/3.8/getting-started/build.gradle
@@ -9,7 +9,7 @@ repositories {
 mainClassName = "sample.ElectronicMoneyMain"
 
 dependencies {
-    implementation 'com.scalar-labs:scalardb:3.8.3'
+    implementation 'com.scalar-labs:scalardb:3.8.4'
 }
 
 sourceCompatibility = 1.8 

diff --git a/docs/3.8/index.md b/docs/3.8/index.md
@@ -13,7 +13,7 @@ You can install it in your application using your build tool such as Gradle and
 To add a dependency on ScalarDB using Gradle, use the following:
 ```gradle
 dependencies {
-    implementation 'com.scalar-labs:scalardb:3.8.3'
+    implementation 'com.scalar-labs:scalardb:3.8.4'
 }
 ```
 
@@ -22,7 +22,7 @@ To add a dependency using Maven:
 <dependency>
   <groupId>com.scalar-labs</groupId>
   <artifactId>scalardb</artifactId>
-  <version>3.8.3</version>
+  <version>3.8.4</version>
 </dependency>
 ```
 
@@ -38,7 +38,7 @@ To add a dependency using Maven:
 * [Requirements and Recommendations for the Underlying Databases of ScalarDB](requirements.md)
 * [How to Back up and Restore](backup-restore.md)
 * [ScalarDB supported databases](scalardb-supported-databases.md)
-* [ScalarDB Configurations](configurations.md)
+* [Configurations for Consensus Commit](configurations-for-consensus-commit.md)
 * [Storage abstraction](storage-abstraction.md)
 * Slides
     * [Making Cassandra more capable, faster, and more reliable](https://speakerdeck.com/scalar/making-cassandra-more-capable-faster-and-more-reliable-at-apachecon-at-home-2020) at ApacheCon@Home 2020

diff --git a/docs/3.8/storage-abstraction.md b/docs/3.8/storage-abstraction.md
@@ -521,8 +521,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)

diff --git a/docs/3.9/api-guide.md b/docs/3.9/api-guide.md
@@ -582,8 +582,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)

diff --git a/docs/3.9/getting-started/build.gradle b/docs/3.9/getting-started/build.gradle
@@ -9,7 +9,7 @@ repositories {
 mainClassName = "sample.ElectronicMoneyMain"
 
 dependencies {
-    implementation 'com.scalar-labs:scalardb:3.9.2'
+    implementation 'com.scalar-labs:scalardb:3.9.3'
     implementation 'org.slf4j:slf4j-simple:1.7.30'
 }
 

diff --git a/docs/3.9/index.md b/docs/3.9/index.md
@@ -13,7 +13,7 @@ You can install it in your application using your build tool such as Gradle and
 To add a dependency on ScalarDB using Gradle, use the following:
 ```gradle
 dependencies {
-    implementation 'com.scalar-labs:scalardb:3.9.2'
+    implementation 'com.scalar-labs:scalardb:3.9.3'
 }
 ```
 
@@ -22,7 +22,7 @@ To add a dependency using Maven:
 <dependency>
   <groupId>com.scalar-labs</groupId>
   <artifactId>scalardb</artifactId>
-  <version>3.9.2</version>
+  <version>3.9.3</version>
 </dependency>
 ```
 

diff --git a/docs/3.9/storage-abstraction.md b/docs/3.9/storage-abstraction.md
@@ -521,8 +521,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)

diff --git a/docs/latest/api-guide.md b/docs/latest/api-guide.md
@@ -599,8 +599,8 @@ Scan scan =
         .namespace("ns")
         .table("tbl")
         .partitionKey(partitionKey)
-        .start(startClusteringKey)
-        .end(endClusteringKey)
+        .start(startClusteringKey, true)    // Include startClusteringKey
+        .end(endClusteringKey, false)       // Exclude endClusteringKey
         .projections("c1", "c2", "c3", "c4")
         .orderings(Scan.Ordering.desc("c2"), Scan.Ordering.asc("c3"))
         .limit(10)