Skip to main content
Version: 3.18
Features and pricing

Requirements

This page outlines the requirements for using each ScalarDB component, including the programming languages and their versions, supported databases and their versions, and the necessary configurations.

Core​

ScalarDB Core is a key component of ScalarDB, providing a database manager with an abstraction layer that abstracts underlying databases. For more information, see ScalarDB Design.

Languages and runtimes​

ScalarDB Core provides a Java client SDK for interacting with ScalarDB. It also includes tools, such as Schema Loader and Data Loader, which run on the Java Virtual Machine (JVM).

Java​

The ScalarDB Core library is available on the Maven Central Repository. You can add the library as a build dependency to your application by using Gradle or Maven. For more details, see Add ScalarDB to Your Build.

For building applications that integrate with the library, the following Java Development Kits (JDKs) are verified and supported.

Java Runtime Environments (JREs) of these JDKs are also supported for running the tools.

Databases​

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

Relational databases​

VersionDb2 12.1Db2 11.5
ScalarDB 3.18✅✅
ScalarDB 3.17✅✅
ScalarDB 3.16✅✅
ScalarDB 3.15❌❌
ScalarDB 3.14❌❌
note

Only Linux, UNIX, and Windows versions of Db2 are supported. The z/OS version is not currently supported.

NewSQL databases​

VersionAlloyDB 16AlloyDB 15
ScalarDB 3.18✅✅
ScalarDB 3.17✅✅
ScalarDB 3.16❌❌
ScalarDB 3.15❌❌
ScalarDB 3.14❌❌

NoSQL databases​

VersionDynamoDB
ScalarDB 3.18✅
ScalarDB 3.17✅
ScalarDB 3.16✅
ScalarDB 3.15✅
ScalarDB 3.14✅

Object Storage​

note

Object Storage support is currently in Private Preview. For more details, please contact us or wait for this feature to become publicly available in a future version.

VersionS3
ScalarDB 3.18✅
ScalarDB 3.17✅
ScalarDB 3.16❌
ScalarDB 3.15❌
ScalarDB 3.14❌
note

For details on how to configure each database, see Configurations for the Underlying Databases of ScalarDB.

Database permission requirements​

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

note

ScalarDB assumes that the same underlying database user account is used for all administrative and CRUD operations.

Relational databases​

This section describes the permission requirements for relational databases.

If you're using Db2, the following authority must be granted.

  • DBADM

NewSQL databases​

This section describes the permission requirements for NewSQL databases.

If you're using AlloyDB, the following database privilege must be granted.

  • CREATE

NoSQL databases​

This section describes the permission requirements for NoSQL databases.

If you're using Amazon DynamoDB, the following actions must be granted.

  • dynamodb:ConditionCheckItem
  • dynamodb:PutItem
  • dynamodb:ListTables
  • dynamodb:DeleteItem
  • dynamodb:Scan
  • dynamodb:Query
  • dynamodb:UpdateItem
  • dynamodb:DeleteTable
  • dynamodb:UpdateContinuousBackups
  • dynamodb:CreateTable
  • dynamodb:DescribeTable
  • dynamodb:GetItem
  • dynamodb:DescribeContinuousBackups
  • dynamodb:UpdateTable
  • application-autoscaling:RegisterScalableTarget
  • application-autoscaling:DeleteScalingPolicy
  • application-autoscaling:PutScalingPolicy
  • application-autoscaling:DeregisterScalableTarget
  • application-autoscaling:TagResource

Object Storage​

This section describes the permission requirements for object storage.

If you're using Amazon S3 as Object Storage, the following actions must be granted:

  • s3:PutObject
  • s3:GetObject
  • s3:DeleteObject
  • s3:ListBucket

Cluster​

ScalarDB Cluster is a component that provides a clustering solution for the Core component to work as a clustered server. For more information, see ScalarDB Design.

Languages and runtimes​

ScalarDB Cluster provides Java and .NET client SDKs that wrap gRPC-generated clients for ease of use.

Java​

The Java client SDK for ScalarDB Cluster is available on the Maven Central Repository. You can add the library as a build dependency to your application by using Gradle or Maven. For more details, see Add ScalarDB Cluster Java Client SDK to your build.

For building applications that integrate with the library, the following Java Development Kits (JDKs) are verified and supported:

note

The ScalarDB Cluster Embedding Java Client SDK library requires Java 17 or 21 from one of the vendors listed above.

.NET​

The .NET client SDK for ScalarDB Cluster is available as a NuGet package. For more details, see Install the SDK.

For building applications that integrate with the library, the following .NET versions are verified and supported:

Other languages​

Since ScalarDB Cluster uses gRPC, you can also create your own client in your preferred language by using the generated clients from the proto file. If you need the proto file, please contact support.

Databases​

Since ScalarDB Cluster uses Core to interact with databases, the requirements for databases are the same as those for Core. For more information, see Databases.

Required ports​

ScalarDB Cluster requires the following ports to be accessible. These default port numbers can be configured via the corresponding properties as needed:

  • 60053 (Administrative API / Transactional API / SQL API / administrator service; configurable via scalar.db.cluster.node.port)
  • 60054 (internal gRPC communication between cluster nodes; configurable via scalar.db.cluster.internal.node.port. This port only needs to be reachable between cluster nodes and should typically be restricted from client and public networks.)
  • 8080 (GraphQL; configurable via scalar.db.graphql.port)
  • 9080 (metrics; configurable via scalar.db.cluster.node.prometheus_exporter_port)
note

If you configure scalar.db.cluster.node.admin.port to run the administrator service (pause, unpause, and checkPaused) on a dedicated port, that dedicated port will also need to be accessible. In this case, only the administrator service runs on that port instead of the port specified by scalar.db.cluster.node.port; the port specified by scalar.db.cluster.node.port must still remain accessible for the other gRPC APIs, including the Administrative API, Transactional API, and SQL API.

Kubernetes​

ScalarDB Cluster is provided as a cluster consisting of one or more Pods on the Kubernetes platform in production environments. ScalarDB Cluster supports the following platforms and tools.

Platform​

  • Kubernetes: 1.32 - 1.35

  • Red Hat OpenShift: 4.18 - 4.21

    note
    • ScalarDB Cluster does not support Extended Update Support (EUS) versions of Red Hat OpenShift.
    • ScalarDB Cluster for Red Hat OpenShift is provided as a container image based on Red Hat Universal Base Images (UBI), which uses Red Hat Build of OpenJDK.
    • If you plan to use Red Hat OpenShift, it is your responsibility to ensure you have a valid subscription. Please contact Red Hat directly for more information. Red Hat offers various subscription options for Red Hat OpenShift, and you may also need to purchase a separate subscription for Red Hat Build of OpenJDK.

Package manager​

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.

Spark​

ScalarDB Analytics uses Apache Spark for the query engine. It supports the following versions of Spark. Cloud-managed Spark services, such as Amazon EMR, Azure Synapse Analytics, and Databricks, are also supported as long as they use the Spark versions listed in the following table.

ScalarDB Analytics VersionSpark VersionsScala Versions
3.183.5, 3.42.13, 2.12
3.173.5, 3.42.13, 2.12
3.163.5, 3.42.13, 2.12
3.153.5, 3.42.13, 2.12
3.143.5, 3.42.13, 2.12

Languages and runtimes​

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

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.

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​

For using the library on Spark, the following JREs are verified and supported:

note

The Java runtime versions available for Spark on each cloud service are based on those supported by Apache Spark. For reference, the following shows the Spark service versions and corresponding Java runtime versions on major cloud services:

  • Amazon EMR: EMR 7.x: Spark 3.5 (Java 17); EMR 6.x: Spark 3.4 (Java 8)
  • Azure Synapse Analytics: Spark 3.5 (Java 17); Spark 3.4 (Java 11)
  • Databricks: Runtime 16.4 LTS: Spark 3.5 (Java 17); Runtime 15.4 LTS: Spark 3.5 (Java 8); Runtime 14.3 LTS: Spark 3.5 (Java 8); Runtime 13.3 LTS: Spark 3.4 (Java 8)

For detailed information, please refer to the documentation for the cloud service you are using.

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

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 versionScalarDB Core version
3.183.18
3.173.17
3.163.16
3.153.15
3.143.14

For the supported databases and their versions, see Databases.

Relational databases​

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

VersionMySQL 8.4MySQL 8.0
ScalarDB Analytics 3.18✅✅
ScalarDB Analytics 3.17✅✅
ScalarDB Analytics 3.16❌✅
ScalarDB Analytics 3.15❌✅
ScalarDB Analytics 3.14❌✅

NoSQL databases​

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

VersionDynamoDB
ScalarDB Analytics 3.18✅
ScalarDB Analytics 3.17✅
ScalarDB Analytics 3.16✅
ScalarDB Analytics 3.15✅
ScalarDB Analytics 3.14✅

Analytical platforms​

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

VersionDatabricks
ScalarDB Analytics 3.18✅
ScalarDB Analytics 3.17✅
ScalarDB Analytics 3.16✅
ScalarDB Analytics 3.15❌
ScalarDB Analytics 3.14❌
note

ScalarDB Analytics supports running queries on Databricks by using both SQL warehouses and compute. For compute, all default compute policies are supported.

ScalarDB Analytics server database​

The ScalarDB Analytics server manages catalog information in its database using ScalarDB Core. You can use any database supported by ScalarDB Core for this purpose. For the supported databases and their versions, see Databases.

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, 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.

Since ScalarDB Analytics server uses ScalarDB Core to manage catalog information, you need to configure a database user for ScalarDB Analytics server according to the Database permission requirements documentation for ScalarDB Core.

Required ports​

ScalarDB Analytics requires the following ports to be accessible. These default port numbers can be configured as needed:

  • 11051 (catalog service)
  • 11052 (metering service)
  • The port number that Apache Spark uses depends on how you deploy the Spark cluster. For details on which ports you need to make accessible, please refer to your Spark service provider's documentation.

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​

Package manager​

Contact technical support
Available only to customers with a commercial license.
Report doc issue
If you have any feedback about this page, please submit an issue.