117 docs tagged with "Enterprise Standard"
View all tags(Deprecated) Guidelines for creating an EKS cluster for ScalarDB Server
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
[Deprecated] Configure a custom values file for ScalarDB GraphQL
ScalarDB GraphQL Server is now deprecated. Please use ScalarDB Cluster instead.
[Deprecated] Configure a custom values file for ScalarDB Server
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
[Deprecated] Deploy ScalarDB Server on Azure Kubernetes Service (AKS)
This guide explains how to deploy ScalarDB Server on Azure Kubernetes Service (AKS).
[Deprecated] Getting Started with Helm Charts (ScalarDB Server)
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
[Deprecated] How to deploy ScalarDB GraphQL
ScalarDB GraphQL Server is now deprecated. Please use ScalarDB Cluster instead.
[Deprecated] How to deploy ScalarDB Server
ScalarDB Server is now deprecated. Please use ScalarDB Cluster instead.
Add ScalarDB to Your Build
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.
Authentication and Authorization Error Codes
This page provides a list of error codes related to authentication and authorization.
Back up a NoSQL database in a Kubernetes environment
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.
Back up an RDB in a Kubernetes environment
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.
Back Up and Restore Databases
This guide explains how to back up and restore databases that are used by ScalarDB.
Back up and restore ScalarDB or ScalarDL data in a Kubernetes environment
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:
Collecting logs from Scalar products on a Kubernetes cluster
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.
Components to Regularly Check When Running in a 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.
Configurations for the Underlying Databases of ScalarDB
This document explains how to configure the underlying databases of ScalarDB to make applications that use ScalarDB work correctly and efficiently.
Configure a custom values file for Scalar Admin for Kubernetes
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.
Configure a custom values file for Scalar Envoy
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.
Configure a custom values file for Scalar Helm Charts
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.
Configure a custom values file for ScalarDB Cluster
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.
Consensus Commit Protocol
Consensus Commit is the transaction protocol used in ScalarDB and is designed for executing transactions spanning multiple diverse databases. Its uniqueness is that the protocol achieves ACID transactions without relying on the transaction capabilities of the underlying databases, unlike X/Open XA-based solutions. This document explains the details of the protocol, including how it works, the guaranteed isolation levels, the interfaces, the performance optimization that it employs, and its limitations.
Create a bastion server
This document explains how to create a bastion server and install some tools for the deployment of Scalar products.
Create a Sample Application That Supports Microservice Transactions
This tutorial describes how to create a sample application that supports microservice transactions in ScalarDB.
Create a Sample Application That Supports Multi-Storage Transactions
This tutorial describes how to create a sample application that supports the multi-storage transactions feature in ScalarDB.
Deploy Overview
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.
Deploy Scalar products using Scalar Helm Charts
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.
Deploy ScalarDB Cluster on Amazon Elastic Kubernetes Service (EKS)
This guide explains how to deploy ScalarDB Cluster on Amazon Elastic Kubernetes Service (EKS).
Deploy ScalarDB Server on Amazon Elastic Kubernetes Service (EKS)
This guide explains how to deploy ScalarDB Server on Amazon Elastic Kubernetes Service (EKS).
Develop Overview
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.
Developer Guide for ScalarDB Cluster with the Java API
ScalarDB Cluster provides a Java API for developing applications.
Envoy Alerts
EnvoyClusterDown
Exception Handling in the ScalarDB Cluster .NET Client SDK
When executing a transaction, you will also need to handle exceptions properly.
Getting Started with ASP.NET Core and Dependency Injection in the ScalarDB Cluster .NET Client SDK
The ScalarDB Cluster .NET Client SDK supports dependency injection (DI) in frameworks like ASP.NET Core.
Getting Started with Authentication and Authorization by Using ScalarDB Cluster .NET Client SDK
The ScalarDB Cluster .NET Client SDK supports authentication and authorization, which allows you to authenticate and authorize your requests to ScalarDB Cluster.
Getting Started with Distributed Transactions in the ScalarDB Cluster .NET Client SDK
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.
Getting Started with Distributed Transactions with a Two-Phase Commit Interface in the ScalarDB Cluster .NET Client SDK
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.
Getting started with Export
This document explains how you can get started with the ScalarDB Data Loader Export function.
Getting Started with Helm Charts (ScalarDB Cluster with TLS by Using cert-manager)
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.
Getting Started with Helm Charts (ScalarDB Cluster with TLS)
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.
Getting started with Import
This document explains how you can get started with the ScalarDB Data Loader Import function.
Getting Started with Scalar Helm Charts
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.
Getting Started with ScalarDB
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.
Getting Started with ScalarDB by Using Kotlin
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.
Getting Started with ScalarDB Cluster
This tutorial describes how to create a sample application that uses ScalarDB Cluster through the Java API.
Getting Started with ScalarDB Cluster via .NET
This tutorial describes how to create a sample application that uses ScalarDB Cluster through the .NET API.
Getting Started with Tables as C# Classes in the ScalarDB Cluster .NET Client SDK
Classes in the ScalarDB Cluster .NET Client SDK
Getting Started with the Administrative API 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.
Getting Started with Using Go for ScalarDB Cluster
This document explains how to write gRPC client code for ScalarDB Cluster by using Go.
Getting Started with Using Python for ScalarDB Cluster
This document explains how to write gRPC client code for ScalarDB Cluster by using Python.
Glossary
This glossary includes database and distributed-system terms that are often used when using ScalarDB.
Guidelines for creating an AKS cluster for Scalar products
To create an Azure Kubernetes Service (AKS) cluster for Scalar products, refer to the following:
Guidelines for creating an AKS cluster for ScalarDB Server
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.
Guidelines for creating an Amazon EKS cluster for Scalar products
To create an Amazon Elastic Kubernetes Service (EKS) cluster for Scalar products, refer to the following:
Guidelines for creating an EKS cluster for ScalarDB Cluster
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.
How to Back Up and Restore Databases Used Through ScalarDB
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.
How to Configure a Product License Key
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.
How to Create Private Key and Certificate Files for TLS Connections in Scalar Products
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.
How to deploy Scalar Admin for Kubernetes
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.
How to deploy ScalarDB Cluster
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.
How to Deploy ScalarDB Cluster Locally
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.
How to get the container images of Scalar products
You can get the container images of Scalar products in several ways. Please choose one of the following methods.
How to install Scalar products through AWS Marketplace
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.
How to install Scalar products through Azure 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.
How to Scale ScalarDB
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.
How to Upgrade ScalarDB
This guide explains how to upgrade to a newer version of ScalarDB.
How to use Secret resources to pass credentials as environment variables into the properties file
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.
How to use the container images
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.
Importing Existing Tables to ScalarDB by Using ScalarDB Schema Loader
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.
Make ScalarDB or ScalarDL deployed in a Kubernetes cluster environment available from applications
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:
Manage Overview
In this category, you can follow guides to help you manage ScalarDB.
Migrate Overview
For details on importing your tables or migrating your applications and databases to a ScalarDB-based environment, see the following guides:
Model Your Data
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.
Monitoring Scalar products on a Kubernetes cluster
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.
Mount any files or volumes on Scalar product pods
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).
Multi-Storage Transactions
ScalarDB transactions can span multiple storages or databases while maintaining ACID compliance by using a feature called multi-storage transactions.
Production checklist for Scalar products
To make your deployment ready for production, refer to the following:
Production checklist for ScalarDB Cluster
This checklist provides recommendations when deploying ScalarDB Cluster in a production environment.
Quickstart Overview
In this category, you can follow quickstart tutorials for how to get started with running transactions and queries through ScalarDB.
Release Support Policy
This page describes Scalar's support policy for major and minor version releases of ScalarDB.
Requirements
This page describes the required tools and their versions to use ScalarDB correctly.
Restore databases in a Kubernetes environment
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.
Run Non-Transactional Storage Operations Overview
ScalarDB was initially designed to provide a unified abstraction between diverse databases and transactions across such databases. However, there are cases where you only need the unified abstraction to simplify your applications that use multiple, possibly diverse, databases.
Run Non-Transactional Storage Operations Through ScalarDB Cluster
This guide explains how to run non-transactional storage operations through ScalarDB Cluster.
Run Non-Transactional Storage Operations Through the Core Library
This guide explains how to run non-transactional storage operations through the ScalarDB Core library.
Run Sample Applications Overview
In this sub-category, you can learn how to run various sample applications that take advantage of ScalarDB.
Run Transactions Overview
In this sub-category, you can learn how to model your data based on the ScalarDB data model and create schemas. Then, you can learn how to run transactions through the ScalarDB Core library and ScalarDB Cluster, a gRPC server that wraps the Core library.
Run Transactions Through 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 ScalarDB Cluster.
Run Transactions Through the ScalarDB Core Library
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.
Scalar Alerts
This section covers the types of alerts and what actions need to be taken.
ScalarDB 3.16 Release Notes
This page includes a list of release notes for ScalarDB 3.16.
ScalarDB Benchmarking Tools
This tutorial describes how to run benchmarking tools for ScalarDB. Database benchmarking is helpful for evaluating how databases perform against a set of standards.
ScalarDB Cluster
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.
ScalarDB Cluster .NET Client SDK Overview
The ScalarDB Cluster .NET Client SDK enables applications to connect to ScalarDB Cluster by using gRPC.
ScalarDB Cluster .NET Client SDK Reference
This reference provides details on how the ScalarDB Cluster .NET Client SDK works.
ScalarDB Cluster Compatibility Matrix
This document shows the compatibility of ScalarDB Cluster versions among client SDK versions.
ScalarDB Cluster Configurations
This document describes the configurations for ScalarDB Cluster. ScalarDB Cluster consists of multiple cluster nodes, each of which needs to be configured. The configurations need to be specified in the properties file.
ScalarDB Cluster Deployment Patterns for Microservices
When building microservice applications that use ScalarDB Cluster, there are two patterns you can choose for how to deploy ScalarDB Cluster: shared-cluster pattern and separated-cluster pattern.
ScalarDB Cluster Error Codes
This page provides a list of error codes in ScalarDB Cluster.
ScalarDB Cluster gRPC API Guide
This document describes the ScalarDB Cluster gRPC API.
ScalarDB Cluster Quickstart Overview
In this sub-category, you can see tutorials on how to run ACID transactions through ScalarDB Cluster, which is a gRPC server that wraps the ScalarDB Core library.
ScalarDB Cluster Standalone Mode
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.
ScalarDB Core Configurations
This page describes the available configurations for ScalarDB Core.
ScalarDB Core Error Codes
This page provides a list of error codes in ScalarDB Core.
ScalarDB Core Quickstart Overview
In this sub-category, you can follow tutorials on how to run ACID transactions through the ScalarDB Core library, which is publicly available under the Apache 2 license.
ScalarDB Data Loader Error Codes
This page provides a list of error codes in ScalarDB Data Loader.
ScalarDB Design
This document briefly explains the design and implementation of ScalarDB. For what ScalarDB is and its use cases, see ScalarDB Overview.
ScalarDB Features
This document briefly explains which features are available in which editions of ScalarDB.
ScalarDB Java API Guide
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.
ScalarDB Overview
This page describes what ScalarDB is and its primary use cases.
ScalarDB Roadmap
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.
ScalarDB Schema Loader
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.
ScalarDB Schema Loader Error Codes
This page provides a list of error codes in ScalarDB Schema Loader.
Set up a database for ScalarDB/ScalarDL deployment
This guide explains how to set up a database for ScalarDB/ScalarDL deployment on cloud services.
Set up a database for ScalarDB/ScalarDL deployment on AWS
This guide explains how to set up a database for ScalarDB/ScalarDL deployment on AWS.
Set up a database for ScalarDB/ScalarDL deployment on Azure
This guide explains how to set up a database for ScalarDB/ScalarDL deployment on Azure.
Transactions with a Two-Phase Commit Interface
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.