Skip to content

Commit df19efe

Browse files
AUTO: Sync ScalarDB docs in English to docs site repo (#1276)
Co-authored-by: josh-wong <[email protected]>
1 parent 8dc8332 commit df19efe

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

versioned_docs/version-3.14/design.mdx

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The following subsections explain each component one by one.
2222

2323
### Core
2424

25-
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.
25+
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](./consensus-commit.mdx). Core is provided as a library that offers a simple CRUD interface.
2626

2727
### Cluster
2828

@@ -32,6 +32,41 @@ ScalarDB Cluster, which is licensed under a commercial license, is a component t
3232

3333
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.
3434

35+
## Metadata tables
36+
37+
ScalarDB manages various types of metadata in the underlying databases to provide its capabilities. The following table summarizes the metadata managed by each component.
38+
39+
| Component | Metadata tables | Purpose | Location |
40+
| --------- | -------- | --------- | --------- |
41+
| Core | `scalardb.metadata` | For database schema information | In all the databases under ScalarDB |
42+
| Core | `coordinator.state` | For transaction statuses | In one designated database specified to store the Coordinator table |
43+
| Core | Application-managed tables | For WAL information | In all the tables accessed by Consensus Commit |
44+
| Cluster | `scalardb.users`, `scalardb.namespace_privileges`, `scalardb.table_privileges`, `scalardb.auth_tokens` | For [authentication and authorization](./scalardb-cluster/scalardb-auth-with-sql.mdx) | In one designated database specified to store the scalardb namespace |
45+
| Cluster | `scalardb.encrypted_columns` | For [encryption at rest](./scalardb-cluster/encrypt-data-at-rest.mdx) | In one designated database specified to store the scalardb namespace |
46+
| Analytics | All the tables managed by the catalog server | For [data catalog](./scalardb-analytics/design.mdx#universal-data-catalog) | In the catalog server database |
47+
48+
:::note
49+
50+
If you need to take backups of the databases accessed by ScalarDB, you will also need to take backups of the metadata managed by ScalarDB. For more details, see [How to Back Up and Restore Databases Used Through ScalarDB](./backup-restore.mdx).
51+
52+
:::
53+
54+
## Limitations
55+
56+
ScalarDB operates between applications and databases, which leads to certain limitations. This section summarizes the limitations of ScalarDB.
57+
58+
### Applications cannot bypass ScalarDB to run transactions and analytical queries
59+
60+
ScalarDB Core offers a database-agnostic transaction capability that operates outside of databases. Therefore, applications must interact with ScalarDB to execute transactions; otherwise, ScalarDB cannot ensure transaction correctness, such as snapshot and serializable isolation. For more details, see [Consensus Commit](./consensus-commit.mdx).
61+
62+
Likewise, ScalarDB Analytics offers a scalable analytical query processing capability that operates outside of databases. Therefore, applications must interact with ScalarDB Analytics to execute analytical queries; otherwise, ScalarDB cannot ensure correctness, such as read-committed isolation. For more details, see [ScalarDB Analytics Design](./scalardb-analytics/design.mdx).
63+
64+
### Applications cannot use all the capabilities of the underlying databases
65+
66+
ScalarDB serves as an abstraction layer over the underlying databases, which means that applications cannot use all the capabilities and data types of these databases. For instance, ScalarDB does not support database-specific features such as Oracle PL/SQL.
67+
68+
ScalarDB has been enhanced to provide features that are commonly found in most supported databases. For a list of features, see [ScalarDB Features](./features.mdx). To learn about the features planned for future releases, see [Roadmap](./roadmap.mdx).
69+
3570
## Further reading
3671

3772
For more details about the design and implementation of ScalarDB, see the following documents:

0 commit comments

Comments
 (0)