(Deprecated) Guidelines for creating an EKS cluster for ScalarDB Server
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
ScalarDB GraphQL Server is now deprecated. Please use ScalarDB Cluster instead.
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
This guide explains how to deploy ScalarDB Server on Azure Kubernetes Service (AKS).
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
ScalarDB GraphQL Server is now deprecated. Please use ScalarDB Cluster instead.
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
The ScalarDB 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.
This page provides a list of error codes related to authentication and authorization.
This guide explains how to create a transactionally consistent backup of managed databases that ScalarDB or ScalarDL uses in a Kubernetes environment. Please note that, when using a NoSQL database or multiple databases, you must pause ScalarDB or ScalarDL to create a transactionally consistent backup.
This guide explains how to create a backup of a single relational database (RDB) that ScalarDB or ScalarDL uses in a Kubernetes environment. Please note that this guide assumes that you are using a managed database from a cloud services provider.
This guide explains how to back up and restore databases that are used by ScalarDB.
This guide explains how to backup and restore ScalarDB or ScalarDL data in a Kubernetes environment. Please note that this guide assumes that you are using a managed database from a cloud services provider as the backend database for ScalarDB or ScalarDL. The following is a list of the managed databases that this guide assumes you might be using:
This document explains how to deploy Grafana Loki and Promtail on Kubernetes with Helm. After following this document, you can collect logs of Scalar products on your Kubernetes environment.
Most of the components deployed by manual deployment guides are self-healing with the help of the managed Kubernetes services and Kubernetes self-healing capability. There are also configured alerts that occur when some unexpected behavior happens. Thus, there shouldn't be so many things to do day by day for the deployment of Scalar products on the managed Kubernetes cluster. However, it is recommended to check the status of a system on a regular basis to see if everything is working fine. Here is the list of things you might want to do on a regular basis.
This document explains how to configure the underlying databases of ScalarDB to make applications that use ScalarDB work correctly and efficiently.
This document explains how to create your custom values file for the Scalar Admin for Kubernetes chart. For details on the parameters, see the README of the Scalar Admin for Kubernetes chart.
This document explains how to create your custom values file for the Scalar Envoy chart. If you want to know the details of the parameters, please refer to the README of the Scalar Envoy chart.
When you deploy Scalar products using Scalar Helm Charts, you must prepare your custom values file based on your environment. Please refer to the following documents for more details on how to a create custom values file for each product.
This document explains how to create your custom values file for the ScalarDB Cluster chart. For details on the parameters, see the README of the ScalarDB Cluster chart.
This document explains how to create a bastion server and install some tools for the deployment of Scalar products.
This tutorial describes how to create a sample application that supports microservice transactions in ScalarDB.
This tutorial describes how to create a sample application that supports the multi-storage transactions feature in ScalarDB.
In this category, you can follow guides to help you become more familiar with deploying ScalarDB, specifically ScalarDB Cluster and ScalarDB Analytics, in local and cloud-based Kubernetes environments.
This document explains how to deploy Scalar products using Scalar Helm Charts. If you want to test Scalar products on your local environment using a minikube cluster, please refer to the following getting started guide.
This guide explains how to deploy ScalarDB Cluster on Amazon Elastic Kubernetes Service (EKS).
This guide explains how to deploy ScalarDB Server on Amazon Elastic Kubernetes Service (EKS).
In this category, you can follow guides to help you become more familiar with ScalarDB, specifically with how to run transactions, analytical queries, and non-transactional storage operations.
ScalarDB Cluster provides a Java API for developing applications.
EnvoyClusterDown
When executing a transaction, you will also need to handle exceptions properly.
The ScalarDB Cluster .NET Client SDK supports Dependency Injection in frameworks like ASP.NET Core.
The ScalarDB Cluster .NET Client SDK supports authentication and authorization, which allows you to authenticate and authorize your requests to ScalarDB Cluster.
The ScalarDB Cluster .NET Client SDK supports the distributed transaction functionality of ScalarDB Cluster. The SDK includes transaction and manager abstractions for easier communication within a cluster.
The ScalarDB Cluster .NET Client SDK supports transactions with the two-phase commit interface in ScalarDB. The SDK includes transaction and manager abstractions for enhanced communication within a cluster.
This tutorial explains how to get started with ScalarDB Cluster with TLS configurations by using Helm Charts and cert-manager on a Kubernetes cluster in a test environment. Before starting, you should already have a Mac or Linux environment for testing. In addition, although this tutorial mentions using minikube, the steps described should work in any Kubernetes cluster.
This tutorial explains how to get started with ScalarDB Cluster with TLS configurations by using Helm Charts on a Kubernetes cluster in a test environment. Before starting, you should already have a Mac or Linux environment for testing. In addition, although this tutorial mentions using minikube, the steps described should work in any Kubernetes cluster.
This document explains how to get started with Scalar Helm Chart on a Kubernetes cluster as a test environment. Here, we assume that you already have a Mac or Linux environment for testing. We use Minikube in this document, but the steps we will show should work in any Kubernetes cluster.
This getting started tutorial explains how to configure your preferred database in ScalarDB and illustrates the process of creating a sample e-commerce application, where items can be ordered and paid for with a credit card by using ScalarDB. The sample e-commerce application shows how users can order and pay for items by using a line of credit.
This getting started tutorial explains how to configure your preferred database in ScalarDB and set up a basic electronic money application by using Kotlin. Since Kotlin has Java interoperability, you can use ScalarDB directly from Kotlin.
This tutorial describes how to create a sample application that uses ScalarDB Cluster through the Java API.
Classes in the ScalarDB Cluster .NET Client SDK
The ScalarDB Cluster .NET Client SDK supports the Administrative API of ScalarDB Cluster. By using this API, you can manage ScalarDB Cluster from .NET applications.
This document explains how to write gRPC client code for ScalarDB Cluster by using Go.
This document explains how to write gRPC client code for ScalarDB Cluster by using Python.
To create an Azure Kubernetes Service (AKS) cluster for Scalar products, refer to the following:
This document explains the requirements and recommendations for creating an Azure Kubernetes Service (AKS) cluster for ScalarDB Server deployment. For details on how to deploy ScalarDB Server on an AKS cluster, see Deploy ScalarDB Server on AKS.
To create an Amazon Elastic Kubernetes Service (EKS) cluster for Scalar products, refer to the following:
This document explains the requirements and recommendations for creating an Amazon Elastic Kubernetes Service (EKS) cluster for ScalarDB Cluster deployment. For details on how to deploy ScalarDB Cluster on an EKS cluster, see Deploy ScalarDB Cluster on Amazon EKS.
Since ScalarDB provides transaction capabilities on top of non-transactional or transactional databases non-invasively, you need to take special care to back up and restore the databases in a transactionally consistent way.
To run Scalar products, you must create a .properties file and add your product license key and a certificate to the file. In your .properties file, copy one of the following configurations, based on the product you're using, and paste the contents in the .properties file, replacing `` with your license key.
This guide explains how to create private key and certificate files for TLS connections in ScalarDB Cluster and ScalarDL. When you enable the TLS feature, you must prepare private key and certificate files.
This document explains how to deploy Scalar Admin for Kubernetes by using Scalar Helm Charts. For details on the custom values file for Scalar Admin for Kubernetes, see Configure a custom values file for Scalar Admin for Kubernetes.
This document explains how to deploy ScalarDB Cluster by using Scalar Helm Charts. For details on the custom values file for ScalarDB Cluster, see Configure a custom values file for ScalarDB Cluster.
This guide provides instructions on how to deploy ScalarDB Cluster by using a Helm Chart on a local Kubernetes cluster, specifically designed for a test environment.
You can get the container images of Scalar products in several ways. Please choose one of the following methods.
Scalar products (ScalarDB, ScalarDL, and their tools) are available in the AWS Marketplace as container images. This guide explains how to install Scalar products through the AWS Marketplace.
Scalar products are currently not available in Azure Marketplace. For details on other ways to get the container images of Scalar products, please see How to get the container images of Scalar products.
This guide explains how to scale ScalarDB. The contents of this guide assume that you used Scalar Helm Chart to deploy ScalarDB Cluster, which is the recommended way.
This guide explains how to upgrade to a newer version of ScalarDB.
You can pass credentials like username or password as environment variables via a Secret resource in Kubernetes. The docker images for previous versions of Scalar products use the dockerize command for templating properties files. The docker images for the latest versions of Scalar products get values directly from environment variables.
You can pull the container images from the public container repository. You must configure the license key and the certificate in your .properties file if you use the container images.
You might want to use ScalarDB (e.g., for database-spanning transactions) with your existing databases. In that case, you can import those databases under the ScalarDB control using ScalarDB Schema Loader. ScalarDB Schema Loader automatically adds ScalarDB-internal metadata columns in each existing table and metadata tables to enable various ScalarDB functionalities including transaction management across multiple databases.
This document explains how to make ScalarDB or ScalarDL deployed in a Kubernetes cluster environment available from applications. To make ScalarDB or ScalarDL available from applications, you can use Scalar Envoy via a Kubernetes service resource named -envoy. You can use -envoy in several ways, such as:
Data modeling (or in other words, designing your database schemas) is the process of conceptualizing and visualizing how data will be stored and used by identifying the patterns used to access data and the types of queries to be performed within business operations.
This document explains how to deploy Prometheus Operator on Kubernetes with Helm. After following this document, you can use Prometheus, Alertmanager, and Grafana for monitoring Scalar products on your Kubernetes environment.
You can mount any files or volumes on Scalar product pods when you use ScalarDB Server, ScalarDB Cluster, ScalarDB Analytics with PostgreSQL, or ScalarDL Helm Charts (ScalarDL Ledger and ScalarDL Auditor).
ScalarDB transactions can span multiple storages or databases while maintaining ACID compliance by using a feature called multi-storage transactions.
To make your deployment ready for production, refer to the following:
This checklist provides recommendations when deploying ScalarDB Cluster in a production environment.
In this category, you can follow quickstart tutorials for how to get started with running transactions and queries through ScalarDB.
This page describes Scalar's support policy for major and minor version releases of ScalarDB.
This page describes the required tools and their versions to use ScalarDB correctly.
This guide explains how to restore databases that ScalarDB or ScalarDL uses in a Kubernetes environment. Please note that this guide assumes that you are using a managed database from a cloud services provider as the backend database for ScalarDB or ScalarDL.
This guide explains how to run non-transactional storage operations through ScalarDB Cluster.
This guide explains how to run non-transactional storage operations through the ScalarDB core library.
This page explains how to run non-transactional storage operations through the primitive CRUD interface, also known as the Storage API. This guide assumes that you have an advanced understanding of ScalarDB.
This guide explains how to configure your ScalarDB properties file and create schemas to run transactions through a one-phase or a two-phase commit interface by using ScalarDB Cluster.
This guide explains how to configure your ScalarDB properties file and create schemas to run transactions through a one-phase or a two-phase commit interface by using the ScalarDB core library.
This section covers the types of alerts and what actions need to be taken.
ScalarDB is a cross-database HTAP engine. It achieves ACID transactions and real-time analytics across diverse databases to simplify the complexity of managing multiple databases.
This page includes a list of release notes for ScalarDB 3.13.
ScalarDB Cluster is a clustering solution for ScalarDB that consists of a set of cluster nodes, each of which provides ScalarDB functionality. Each cluster node has a routing mechanism that directs transaction requests to the appropriate cluster node within the cluster.
The ScalarDB Cluster .NET Client SDK enables applications to connect to ScalarDB Cluster by using gRPC.
This reference provides details on how the ScalarDB Cluster .NET Client SDK works.
This document shows the compatibility of ScalarDB Cluster versions among client SDK versions.
This document describes the configurations for ScalarDB Cluster.
This page provides a list of error codes in ScalarDB Cluster.
This document describes the ScalarDB Cluster gRPC API.
Instead of setting up a Kubernetes cluster and deploying ScalarDB Cluster on top of it by using a Helm Chart, you can run ScalarDB Cluster in standalone mode, which simplifies development and testing processes. A primary use case for this would be when you want to start ScalarDB Cluster in standalone mode via Docker on your local machine and use it for development and testing.
This page describes the available configurations for ScalarDB.
This document briefly explains the design and implementation of ScalarDB. For what ScalarDB is and its use cases, see ScalarDB Overview.
This page provides a list of error codes in ScalarDB.
The ScalarDB Java API is mainly composed of the Administrative API and Transactional API. This guide briefly explains what kinds of APIs exist, how to use them, and related topics like how to handle exceptions.
This page describes what ScalarDB is and its primary use cases.
This roadmap provides a look into the proposed future of ScalarDB. The purpose of this roadmap is to provide visibility into what changes may be coming so that you can more closely follow progress, learn about key milestones, and give feedback during development. This roadmap will be updated as new versions of ScalarDB are released.
The following are sample applications for ScalarDB:
ScalarDB has its own data model and schema that maps to the implementation-specific data model and schema. In addition, ScalarDB stores internal metadata, such as transaction IDs, record versions, and transaction statuses, to manage transaction logs and statuses when you use the Consensus Commit transaction manager.
This guide explains how to set up a database for ScalarDB/ScalarDL deployment on cloud services.
This guide explains how to set up a database for ScalarDB/ScalarDL deployment on AWS.
This guide explains how to set up a database for ScalarDB/ScalarDL deployment on Azure.
ScalarDB supports executing transactions with a two-phase commit interface. With the two-phase commit interface, you can execute a transaction that spans multiple processes or applications, like in a microservice architecture.