Skip to content

Commit

Permalink
Merge pull request #141 from scalar-labs/add-updated-docs
Browse files Browse the repository at this point in the history
Add updated docs for ScalarDB, ScalarDB Cluster, the ScalarDB Cluster .NET Client SDK, and Helm Charts
  • Loading branch information
josh-wong authored Feb 21, 2024
2 parents 8808f94 + 15effa9 commit 8990289
Show file tree
Hide file tree
Showing 32 changed files with 92 additions and 230 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,11 @@ This section explains the optional configurations when setting up a custom value
### CronJob configurations (optional based on your environment)
By default, the Scalar Admin for Kubernetes chart creates a [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) resource to run the Scalar Admin for Kubernetes CLI tool once. If you want to run the Scalar Admin for Kubernetes CLI tool periodically by using [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/), you can set `scalarAdminForKubernetes.cronJob.enabled` to `true`. Also, you can set some configurations for the CronJob resource.
By default, the Scalar Admin for Kubernetes chart creates a [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) resource to run the Scalar Admin for Kubernetes CLI tool once. If you want to run the Scalar Admin for Kubernetes CLI tool periodically by using [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/), you can set `scalarAdminForKubernetes.jobType` to `cronjob`. Also, you can set some configurations for the CronJob resource.

```yaml
scalarAdminForKubernetes:
cronJob:
enabled: true
timeZone: "Etc/UTC"
schedule: "0 0 * * *"
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ First, in a new working directory, create a directory named `scalardb-cluster`,
$ mkdir scalardb-cluster
```

Then, download the [`scalardb-cluster.proto`](https://github.com/scalar-labs/scalardb-cluster/blob/v3.10.2/rpc/src/main/proto/scalardb-cluster.proto) file and save it in the directory that you created.
Then, download the `scalardb-cluster.proto` file and save it in the directory that you created. For ScalarDB Cluster users who have a commercial license, please [contact us](https://www.scalar-labs.com/contact) if you need the `scalardb-cluster.proto` file.

Generate the gRPC code by running the following command:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ $ pip install grpcio grpcio-tools

To communicate with the gRPC server for ScalarDB Cluster, you will need to generate the stub code from the proto file.

First, download the [`scalardb-cluster.proto`](https://github.com/scalar-labs/scalardb-cluster/blob/v3.10.2/rpc/src/main/proto/scalardb-cluster.proto) file, then save it in the working directory.
First, download the `scalardb-cluster.proto` file, then save it in the working directory. For ScalarDB Cluster users who have a commercial license, please [contact us](https://www.scalar-labs.com/contact) if you need the `scalardb-cluster.proto` file.

You can generate the stub code by running the following command:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ScalarDB Cluster provides a Java API that uses the gRPC API internally.
If you use Java or a JVM language, you can use the Java API instead of the ScalarDB Cluster gRPC API directly.
For details about the Java API, see [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.md).

For details about the services and messages for the ScalarDB Cluster gRPC API, see the definitions in [scalardb-cluster.proto](../rpc/src/main/proto/scalardb-cluster.proto).
For details about the services and messages for the ScalarDB Cluster gRPC API, see the definitions in the `scalardb-cluster.proto` file. For ScalarDB Cluster users who have a commercial license, please [contact us](https://www.scalar-labs.com/contact) if you need the `scalardb-cluster.proto` file.

ScalarDB Cluster gRPC API is composed of the following services:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ScalarDB Cluster SQL provides a Java API that uses the gRPC API internally.
If you use Java or a JVM language, you can use the Java API instead of the ScalarDB Cluster SQL gRPC API directly.
For details about the Java API, see [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.md).

For details about the services and messages for the ScalarDB Cluster gRPC API, see the definitions in [scalardb-cluster.proto](../rpc/src/main/proto/scalardb-cluster.proto).
For details about the services and messages for the ScalarDB Cluster SQL gRPC API, see the definitions in the `scalardb-cluster-sql.proto` file. For ScalarDB Cluster users who have a commercial license, please [contact us](https://www.scalar-labs.com/contact) if you need the `scalardb-cluster-sql.proto` file.

ScalarDB Cluster SQL gRPC API is composed of the following services:

Expand Down
44 changes: 11 additions & 33 deletions docs/3.10/scalardb-supported-databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@ ScalarDB supports the following databases and their versions.

| Version | DynamoDB |
|:------------------|:----------|
| **ScalarDB 3.12** ||
| **ScalarDB 3.11** ||
| **ScalarDB 3.10** ||
| **ScalarDB 3.9** ||
| **ScalarDB 3.8** ||
| **ScalarDB 3.7** ||
| **ScalarDB 3.6** ||
| **ScalarDB 3.5** ||
| **ScalarDB 3.4** ||

## Apache Cassandra

Expand All @@ -27,27 +25,23 @@ For requirements when using Cassandra or Cassandra-compatible databases, see [Ca

| Version | Cassandra 4.1 | Cassandra 4.0 | Cassandra 3.11 | Cassandra 3.0 |
|:------------------|:---------------|:---------------|:----------------|:---------------|
| **ScalarDB 3.12** |||||
| **ScalarDB 3.11** |||||
| **ScalarDB 3.10** |||||
| **ScalarDB 3.9** |||||
| **ScalarDB 3.8** |||||
| **ScalarDB 3.7** |||||
| **ScalarDB 3.6** |||||
| **ScalarDB 3.5** |||||
| **ScalarDB 3.4** |||||

## Azure Cosmos DB for NoSQL

| Version | Cosmos DB for NoSQL |
|:------------------|:---------------------|
| **ScalarDB 3.12** ||
| **ScalarDB 3.11** ||
| **ScalarDB 3.10** ||
| **ScalarDB 3.9** ||
| **ScalarDB 3.8** ||
| **ScalarDB 3.7** ||
| **ScalarDB 3.6** ||
| **ScalarDB 3.5** ||
| **ScalarDB 3.4** ||

## JDBC databases

Expand All @@ -63,102 +57,86 @@ For recommendations when using JDBC databases, see [JDBC database recommendation

| Version | Aurora MySQL 3 | Aurora MySQL 2 |
|:------------------|:----------------|:----------------|
| **ScalarDB 3.12** |||
| **ScalarDB 3.11** |||
| **ScalarDB 3.10** |||
| **ScalarDB 3.9** |||
| **ScalarDB 3.8** |||
| **ScalarDB 3.7** |||
| **ScalarDB 3.6** |||
| **ScalarDB 3.5** |||
| **ScalarDB 3.4** |||

### Amazon Aurora PostgreSQL

| Version | Aurora PostgreSQL 15 | Aurora PostgreSQL 14 | Aurora PostgreSQL 13 | Aurora PostgreSQL 12 |
|:------------------|:----------------------|:----------------------|:----------------------|:----------------------|
| **ScalarDB 3.12** |||||
| **ScalarDB 3.11** |||||
| **ScalarDB 3.10** |||||
| **ScalarDB 3.9** |||||
| **ScalarDB 3.8** |||||
| **ScalarDB 3.7** |||||
| **ScalarDB 3.6** |||||
| **ScalarDB 3.5** |||||
| **ScalarDB 3.4** |||||

### MariaDB

| Version | MariaDB 10.11 |
|:------------------|:--------------|
| **ScalarDB 3.12** ||
| **ScalarDB 3.11** ||
| **ScalarDB 3.10** ||
| **ScalarDB 3.9** ||
| **ScalarDB 3.8** ||
| **ScalarDB 3.7** ||
| **ScalarDB 3.6** ||
| **ScalarDB 3.5** ||
| **ScalarDB 3.4** ||

### Microsoft SQL Server

| Version | SQL Server 2022 | SQL Server 2019 | SQL Server 2017 |
|:------------------|:-----------------|:-----------------|:-----------------|
| **ScalarDB 3.12** ||||
| **ScalarDB 3.11** ||||
| **ScalarDB 3.10** ||||
| **ScalarDB 3.9** ||||
| **ScalarDB 3.8** ||||
| **ScalarDB 3.7** ||||
| **ScalarDB 3.6** ||||
| **ScalarDB 3.5** ||||
| **ScalarDB 3.4** ||||

### MySQL

| Version | MySQL 8.1 | MySQL 8.0 | MySQL 5.7 |
|:------------------|:-----------|:-----------|:-----------|
| **ScalarDB 3.12** ||||
| **ScalarDB 3.11** ||||
| **ScalarDB 3.10** ||||
| **ScalarDB 3.9** ||||
| **ScalarDB 3.8** ||||
| **ScalarDB 3.7** ||||
| **ScalarDB 3.6** ||||
| **ScalarDB 3.5** ||||
| **ScalarDB 3.4** ||||

### Oracle

| Version | Oracle 23.2.0-free | Oracle 21.3.0-xe | Oracle 18.4.0-xe |
|:------------------|:--------------------|:------------------|:------------------|
| **ScalarDB 3.12** ||||
| **ScalarDB 3.11** ||||
| **ScalarDB 3.10** ||||
| **ScalarDB 3.9** ||||
| **ScalarDB 3.8** ||||
| **ScalarDB 3.7** ||||
| **ScalarDB 3.6** ||||
| **ScalarDB 3.5** ||||
| **ScalarDB 3.4** ||||

### PostgreSQL

| Version | PostgreSQL 15 | PostgreSQL 14 | PostgreSQL 13 | PostgreSQL 12 |
|:------------------|:---------------|:---------------|:---------------|:---------------|
| **ScalarDB 3.12** |||||
| **ScalarDB 3.11** |||||
| **ScalarDB 3.10** |||||
| **ScalarDB 3.9** |||||
| **ScalarDB 3.8** |||||
| **ScalarDB 3.7** |||||
| **ScalarDB 3.6** |||||
| **ScalarDB 3.5** |||||
| **ScalarDB 3.4** |||||

### SQLite

| Version | SQLite 3 |
|:------------------|:----------|
| **ScalarDB 3.12** ||
| **ScalarDB 3.11** ||
| **ScalarDB 3.10** ||
| **ScalarDB 3.9** ||
| **ScalarDB 3.8** ||
| **ScalarDB 3.7** ||
| **ScalarDB 3.6** ||
| **ScalarDB 3.5** ||
| **ScalarDB 3.4** ||
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,11 @@ This section explains the optional configurations when setting up a custom value
### CronJob configurations (optional based on your environment)
By default, the Scalar Admin for Kubernetes chart creates a [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) resource to run the Scalar Admin for Kubernetes CLI tool once. If you want to run the Scalar Admin for Kubernetes CLI tool periodically by using [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/), you can set `scalarAdminForKubernetes.cronJob.enabled` to `true`. Also, you can set some configurations for the CronJob resource.
By default, the Scalar Admin for Kubernetes chart creates a [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) resource to run the Scalar Admin for Kubernetes CLI tool once. If you want to run the Scalar Admin for Kubernetes CLI tool periodically by using [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/), you can set `scalarAdminForKubernetes.jobType` to `cronjob`. Also, you can set some configurations for the CronJob resource.

```yaml
scalarAdminForKubernetes:
cronJob:
enabled: true
timeZone: "Etc/UTC"
schedule: "0 0 * * *"
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ First, in a new working directory, create a directory named `scalardb-cluster`,
$ mkdir scalardb-cluster
```

Then, download the [`scalardb-cluster.proto`](https://github.com/scalar-labs/scalardb-cluster/blob/v3.11.0/rpc/src/main/proto/scalardb-cluster.proto) file and save it in the directory that you created.
Then, download the `scalardb-cluster.proto` file and save it in the directory that you created. For ScalarDB Cluster users who have a commercial license, please [contact us](https://www.scalar-labs.com/contact) if you need the `scalardb-cluster.proto` file.

Generate the gRPC code by running the following command:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ $ pip install grpcio grpcio-tools

To communicate with the gRPC server for ScalarDB Cluster, you will need to generate the stub code from the proto file.

First, download the [`scalardb-cluster.proto`](https://github.com/scalar-labs/scalardb-cluster/blob/v3.11.0/rpc/src/main/proto/scalardb-cluster.proto) file, then save it in the working directory.
First, download the `scalardb-cluster.proto` file, then save it in the working directory. For ScalarDB Cluster users who have a commercial license, please [contact us](https://www.scalar-labs.com/contact) if you need the `scalardb-cluster.proto` file.

You can generate the stub code by running the following command:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ScalarDB Cluster provides a Java API that uses the gRPC API internally.
If you use Java or a JVM language, you can use the Java API instead of the ScalarDB Cluster gRPC API directly.
For details about the Java API, see [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.md).

For details about the services and messages for the ScalarDB Cluster gRPC API, see the definitions in [scalardb-cluster.proto](../rpc/src/main/proto/scalardb-cluster.proto).
For details about the services and messages for the ScalarDB Cluster gRPC API, see the definitions in the `scalardb-cluster.proto` file. For ScalarDB Cluster users who have a commercial license, please [contact us](https://www.scalar-labs.com/contact) if you need the `scalardb-cluster.proto` file.

ScalarDB Cluster gRPC API is composed of the following services:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ScalarDB Cluster SQL provides a Java API that uses the gRPC API internally.
If you use Java or a JVM language, you can use the Java API instead of the ScalarDB Cluster SQL gRPC API directly.
For details about the Java API, see [Developer Guide for ScalarDB Cluster with the Java API](developer-guide-for-scalardb-cluster-with-java-api.md).

For details about the services and messages for the ScalarDB Cluster gRPC API, see the definitions in [scalardb-cluster.proto](../rpc/src/main/proto/scalardb-cluster.proto).
For details about the services and messages for the ScalarDB Cluster SQL gRPC API, see the definitions in the `scalardb-cluster-sql.proto` file. For ScalarDB Cluster users who have a commercial license, please [contact us](https://www.scalar-labs.com/contact) if you need the `scalardb-cluster-sql.proto` file.

ScalarDB Cluster SQL gRPC API is composed of the following services:

Expand Down
Loading

0 comments on commit 8990289

Please sign in to comment.