Skip to content

AUTO: Docs repo sync - ScalarDB #1513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2025
Merged

AUTO: Docs repo sync - ScalarDB #1513

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
140 changes: 0 additions & 140 deletions versioned_docs/version-3.13/requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,143 +534,3 @@ ScalarDB Cluster is provided as a cluster consisting of one or more Pods on the
#### Package manager

- **[Helm](https://helm.sh/):** 3.5+

## Analytics

ScalarDB Analytics is a component that provides scalable analytical processing for the data managed by the Core component or managed by applications that don’t use ScalarDB. For more information, see [ScalarDB Design](./design.mdx).

### Spark

ScalarDB Analytics uses [Apache Spark](https://spark.apache.org/) for the query engine. It supports the following versions of Spark.

| ScalarDB Analytics Version | Spark Versions | Scala Versions |
| :------------------------- | :------------- | :------------- |
| 3.16 | 3.5, 3.4 | 2.13, 2.12 |
| 3.15 | 3.5, 3.4 | 2.13, 2.12 |
| 3.14 | 3.5, 3.4 | 2.13, 2.12 |

### Languages and runtimes

ScalarDB Analytics provides a Java library for running federated queries on Spark. It also provides a tool called ScalarDB Analytics CLI, which runs on the Java Virtual Machine (JVM).

:::note

Since Spark and Scala may be incompatible among different minor versions, the library offers different artifacts for various Spark and Scala versions, named in the format `scalardb-analytics-spark-all-<SPARK_VERSION>_<SCALA_VERSION>`. Make sure that you select the artifact matching the Spark and Scala versions you're using. For example, if you're using Spark 3.5 with Scala 2.13, you must specify `scalardb-analytics-spark-all-3.5_2.13`.

:::

#### Java

The library is available on the Maven Central Repository. You need to specify the library when setting up Spark. For more details, see [Set up ScalarDB Analytics in the Spark configuration](scalardb-analytics/run-analytical-queries.mdx#set-up-scalardb-analytics-in-the-spark-configuration).

:::note

The ScalarDB Analytics library is built with JDK 11 to be able to be integrated with various Spark environments.

:::

For running ScalarDB Analytics CLI, the following JREs are verified and supported:

- **[Oracle JDK](https://www.oracle.com/java/):** 21
- **[OpenJDK](https://openjdk.org/) ([Eclipse Temurin](https://adoptium.net/temurin/), [Amazon Corretto](https://aws.amazon.com/corretto/), or [Microsoft Build of OpenJDK](https://learn.microsoft.com/en-us/java/openjdk/)):** 21

### Databases

ScalarDB Analytics runs on top of the following databases and their versions.

#### ScalarDB

ScalarDB Analytics can run analytical queries on the databases managed by ScalarDB Core and Cluster. It uses the ScalarDB Core library of the same version to interact with these databases, as shown below.

| ScalarDB Analytics version | ScalarDB Core version |
| :------------------------- | :-------------------- |
| 3.16 | 3.16 |
| 3.15 | 3.15 |
| 3.14 | 3.14 |

For the supported databases and their versions, see [Databases](#databases).

#### Relational databases

ScalarDB Analytics can run analytical queries on the following relational databases **not** managed by ScalarDB Core and Cluster.

<Tabs groupId="RDBs" queryString>
<TabItem value="Oracle_Database" label="Oracle Database" default>

| Version | Oracle Database 23ai |
| :-------------------------- | :------------------- |
| **ScalarDB Analytics 3.16** | ✅ |
| **ScalarDB Analytics 3.15** | ✅ |
| **ScalarDB Analytics 3.14** | ✅ |

</TabItem>
<TabItem value="MySQL" label="MySQL">

| Version | MySQL 8.0 |
| :-------------------------- | :-------- |
| **ScalarDB Analytics 3.16** | ✅ |
| **ScalarDB Analytics 3.15** | ✅ |
| **ScalarDB Analytics 3.14** | ✅ |

</TabItem>
<TabItem value="PostgreSQL" label="PostgreSQL">

| Version | PostgreSQL 16 |
| :-------------------------- | :------------ |
| **ScalarDB Analytics 3.16** | ✅ |
| **ScalarDB Analytics 3.15** | ✅ |
| **ScalarDB Analytics 3.14** | ✅ |

</TabItem>
<TabItem value="SQL_Server" label="SQL Server">

| Version | SQL Server 2019 |
| :-------------------------- | :-------------- |
| **ScalarDB Analytics 3.16** | ✅ |
| **ScalarDB Analytics 3.15** | ✅ |
| **ScalarDB Analytics 3.14** | ✅ |

</TabItem>
</Tabs>

#### NoSQL databases

ScalarDB Analytics can run analytical queries on the following NoSQL databases **not** managed by ScalarDB Core and Cluster.

<Tabs groupId="NoSQL" queryString>
<TabItem value="Amazon_DynamoDB" label="Amazon DynamoDB" default>

| Version | DynamoDB |
| :-------------------------- | :------- |
| **ScalarDB Analytics 3.16** | ✅ |
| **ScalarDB Analytics 3.15** | ✅ |
| **ScalarDB Analytics 3.14** | ✅ |

</TabItem>
</Tabs>

### Database permission requirements

ScalarDB Analytics requires read permissions to perform its operations on the underlying databases.

For databases managed under ScalarDB Core and Cluster, the databases are already configured according to [Database permission requirements](requirements.mdx#database-permission-requirements), so no additional configuration is required.

For databases **not** managed under ScalarDB Core and Cluster, make sure you register your data sources with users who have read permission on the data sources. For instructions on registering your data sources, see [Create your catalog](scalardb-analytics/create-scalardb-analytics-catalog#create-your-catalog).

The ScalarDB Analytics server also requires permissions to manage catalog information in its database.
Create a user with permission according to [Database permission requirements](requirements.mdx#database-permission-requirements) and set the user to the ScalarDB Analytics server configuration.

### Kubernetes

The server component of ScalarDB Analytics (ScalarDB Analytics server) is provided as a Pod on the Kubernetes platform in production environments. ScalarDB Analytics supports the following platforms and tools.

#### Platform

- **[Kubernetes](https://kubernetes.io/):** 1.28 - 1.32
- **[Amazon Elastic Kubernetes Service (EKS)](https://aws.amazon.com/eks/)**
- **[Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-us/products/kubernetes-service)**
- **[Red Hat OpenShift](https://www.redhat.com/en/technologies/cloud-computing/openshift):** TBD

#### Package manager

- **[Helm](https://helm.sh/):** 3.5+