From 13c91b388e6c90d0f694ef988ba05ce1aa2c2d4f Mon Sep 17 00:00:00 2001 From: josh-wong Date: Thu, 21 Nov 2024 07:39:52 +0000 Subject: [PATCH] AUTO: Sync ScalarDB docs in English to docs site repo --- versioned_docs/version-3.11/design.mdx | 30 ++------------------------ 1 file changed, 2 insertions(+), 28 deletions(-) diff --git a/versioned_docs/version-3.11/design.mdx b/versioned_docs/version-3.11/design.mdx index 10474d91..d900065c 100644 --- a/versioned_docs/version-3.11/design.mdx +++ b/versioned_docs/version-3.11/design.mdx @@ -5,35 +5,9 @@ tags: - Enterprise Premium --- -# ScalarDB Design +# ScalarDB Design Document -This document briefly explains the design and implementation of ScalarDB. For what ScalarDB is and its use cases, see [ScalarDB Overview](./overview.mdx). - -## Overall architecture - -ScalarDB is hybrid transaction/analytical processing (HTAP) middleware that sits in between applications and databases. As shown in the following figure, ScalarDB consists of three components: Core, Cluster, and Analytics. ScalarDB basically employs a layered architecture, so the Cluster and Analytics components use the Core component to interact with underlying databases but sometimes bypass the Core component for performance optimization without sacrificing correctness. Likewise, each component also consists of several layers. - -![ScalarDB architecture](images/scalardb-architecture.png) - -## Components - -The following subsections explain each component one by one. - -### Core - -ScalarDB Core, which is provided as open-source software under the Apache 2 License, is an integral part of ScalarDB. Core provides a database manager that has an abstraction layer that abstracts underlying databases and adapters (or shims) that implement the abstraction for each database. In addition, it provides a transaction manager on top of the database abstraction that achieves database-agnostic transaction management based on Scalar's novel distributed transaction protocol called Consensus Commit. Core is provided as a library that offers a simple CRUD interface. - -### Cluster - -ScalarDB Cluster, which is licensed under a commercial license, is a component that provides a clustering solution for the Core component to work as a clustered server. Cluster is mainly designed for OLTP workloads, which have many small, transactional and non-transactional reads and writes. In addition, it provides several enterprise features such as authentication, authorization, encryption at rest, and fine-grained access control (still under development). Not only does Cluster offer the same CRUD interface as the Core component, but it also offers SQL and GraphQL interfaces. Since Cluster is provided as a container in a Kubernetes Pod, you can increase performance and availability by having more containers. - -### Analytics - -ScalarDB Analytics, which is licensed under a commercial license, 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. Analytics is mainly designed for OLAP workloads, which have a small number of large, analytical read queries. In addition, it offers a SQL and DataSet API through Spark. Since the Analytics component is provided as a Java package that can be installed on Apache Spark engines, you can increase performance by having more Spark worker nodes. - -## See also - -For details about the design and implementation of ScalarDB, see the following documents, which were presented at the VLDB 2023 conference: +For details about the design and implementation of ScalarDB, please see the following documents, which we presented at the VLDB 2023 conference: - **Speakerdeck presentation:** [ScalarDB: Universal Transaction Manager for Polystores](https://speakerdeck.com/scalar/scalardb-universal-transaction-manager-for-polystores-vldb23) - **Detailed paper:** [ScalarDB: Universal Transaction Manager for Polystores](https://www.vldb.org/pvldb/vol16/p3768-yamada.pdf)