Skip to content

Commit 02f0dd3

Browse files
authored
Add ScalarDB 3.14 docs (#734)
* Create 3.14.tsx * Enable some redirects; remove other redirects * Add version 3.14 as `latest`; make versioned * Remove docs that no longer exist * Remove unnecessary comments * Add encryption-related docs * Add `3.13` * Update README.mdx * Move file to 3.13 folder * Add 3.14; update the support dates for 3.13 * Create version-3.13-sidebars.json * Create README.mdx * Update index.mdx * Delete release-notes.mdx * Create release-notes.mdx * Add doc
1 parent b4c552f commit 02f0dd3

File tree

275 files changed

+41514
-335
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

275 files changed

+41514
-335
lines changed

docs/api-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,7 @@ And if you need to check if a value of a column is null, you can use the `isNull
580580
boolean isNull = result.isNull("<COLUMN_NAME>");
581581
```
582582

583-
For more details, see the `Result` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.13.1/index.html) of the version of ScalarDB that you're using.
583+
For more details, see the `Result` page in the [Javadoc](https://javadoc.io/doc/com.scalar-labs/scalardb/3.14.0/index.html) of the version of ScalarDB that you're using.
584584

585585
###### Execute `Get` by using a secondary index
586586

docs/configurations.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -203,11 +203,11 @@ For details about client configurations, see the [ScalarDB Cluster client config
203203

204204
The following are additional configurations available for ScalarDB:
205205

206-
| Name | Description | Default |
207-
|------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
208-
| `scalar.db.metadata.cache_expiration_time_secs` | ScalarDB has a metadata cache to reduce the number of requests to the database. This setting specifies the expiration time of the cache in seconds. | `-1` (no expiration) |
209-
| `scalar.db.active_transaction_management.expiration_time_millis` | ScalarDB maintains ongoing transactions, which can be resumed by using a transaction ID. This setting specifies the expiration time of this transaction management feature in milliseconds. | `-1` (no expiration) |
210-
| `scalar.db.default_namespace_name` | The given namespace name will be used by operations that do not already specify a namespace. | |
206+
| Name | Description | Default |
207+
|------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
208+
| `scalar.db.metadata.cache_expiration_time_secs` | ScalarDB has a metadata cache to reduce the number of requests to the database. This setting specifies the expiration time of the cache in seconds. If you specify `-1`, the cache will never expire. | `60` |
209+
| `scalar.db.active_transaction_management.expiration_time_millis` | ScalarDB maintains ongoing transactions, which can be resumed by using a transaction ID. This setting specifies the expiration time of this transaction management feature in milliseconds. | `-1` (no expiration) |
210+
| `scalar.db.default_namespace_name` | The given namespace name will be used by operations that do not already specify a namespace. | |
211211

212212
## Placeholder usage
213213

docs/design.mdx

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,35 @@ tags:
55
- Enterprise Premium
66
---
77

8-
# ScalarDB Design Document
8+
# ScalarDB Design
99

10-
For details about the design and implementation of ScalarDB, please see the following documents, which we presented at the VLDB 2023 conference:
10+
This document briefly explains the design and implementation of ScalarDB. For what ScalarDB is and its use cases, see [ScalarDB Overview](./overview.mdx).
11+
12+
## Overall architecture
13+
14+
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.
15+
16+
![ScalarDB architecture](images/scalardb-architecture.png)
17+
18+
## Components
19+
20+
The following subsections explain each component one by one.
21+
22+
### Core
23+
24+
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+
26+
### Cluster
27+
28+
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.
29+
30+
### Analytics
31+
32+
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.
33+
34+
## See also
35+
36+
For details about the design and implementation of ScalarDB, see the following documents, which were presented at the VLDB 2023 conference:
1137

1238
- **Speakerdeck presentation:** [ScalarDB: Universal Transaction Manager for Polystores](https://speakerdeck.com/scalar/scalardb-universal-transaction-manager-for-polystores-vldb23)
1339
- **Detailed paper:** [ScalarDB: Universal Transaction Manager for Polystores](https://www.vldb.org/pvldb/vol16/p3768-yamada.pdf)

docs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags:
77

88
# ScalarDB
99

10-
import { CardRowAbout, CardRowGettingStarted, CardRowSamples, CardRowDevelop, CardRowDeploy, CardRowManage, CardRowReference } from '/src/components/Cards/3.13';
10+
import { CardRowAbout, CardRowGettingStarted, CardRowSamples, CardRowDevelop, CardRowDeploy, CardRowManage, CardRowReference } from '/src/components/Cards/3.14';
1111

1212
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.
1313

docs/quick-start-overview.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,11 @@ ScalarDB Cluster is available only in the Enterprise edition.
2525

2626
## Try running analytical queries through ScalarDB Analytics
2727

28-
In this sub-category, you can see tutorials on how to run analytical queries over the databases that you write through ScalarDB by using a component called ScalarDB Analytics.
29-
ScalarDB Analytics currently targets only ScalarDB-managed databases, updated through ScalarDB transactions, but will target non-ScalarDB-managed databases in the future.
28+
In this sub-category, you can see tutorials on how to run analytical queries over the databases that you write to by using a component called ScalarDB Analytics. ScalarDB Analytics targets both ScalarDB-managed databases, which are updated through ScalarDB transactions, and non-ScalarDB-managed databases.
3029

3130
:::note
3231

3332
- ScalarDB Analytics with PostgreSQL is available only under the Apache 2 License and doesn't require a commercial license.
34-
- ScalarDB Analytics with Spark is in private preview.
33+
- ScalarDB Analytics with Spark is in public preview.
3534

36-
:::
35+
:::

0 commit comments

Comments
 (0)