Skip to content

Commit 02ec1dc

Browse files
josh-wongjosh-wong
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 15a0b8b commit 02ec1dc

15 files changed

+199
-22
lines changed

‎docs/_develop-run-analytical-queries-overview.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
tags:
3+
- Community
4+
- Enterprise Option
5+
- Public Preview
6+
displayed_sidebar: docsEnglish
7+
---
8+
9+
# Run Analytical Queries Overview
10+
11+
In this sub-category, you can learn how to set up and configure ScalarDB Analytics, an analytics component of ScalarDB. Then, you can run analytical queries over ScalarDB-managed databases, which are updated through ScalarDB transactions, and non-ScalarDB-managed databases.
12+
13+
To learn how to run analytical queries, see the following guides:
14+
15+
- [Run Analytical Queries on Sample Data by Using ScalarDB Analytics with PostgreSQL](scalardb-samples/scalardb-analytics-postgresql-sample/README.mdx)

‎docs/deploy-overview.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ displayed_sidebar: docsEnglish
1010

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

13-
## Deploy ScalarDB in your local Kubernetes environment
13+
## Deploy ScalarDB Cluster in a local Kubernetes environment
1414

15-
In this sub-category, you can learn how to deploy ScalarDB in your local Kubernetes environment. The primary focus of this sub-category is learning to use Scalar Helm Charts. Because of this, a particular database (PostgreSQL) is specified for simplicity.
15+
To learn how to deploy ScalarDB Cluster in a local Kubernetes environment by using a Helm Chart and a PostgreSQL database, see [Deploy ScalarDB Cluster Locally](scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx).
1616

17-
## Deploy ScalarDB in a cloud-based Kubernetes environment
17+
## Deploy ScalarDB Cluster in a cloud-based Kubernetes environment
1818

19-
In this sub-category, you can learn how to deploy ScalarDB in a cloud-based Kubernetes environment. This sub-category describes how to use Scalar Helm Charts and other steps that are required to run ScalarDB in a cloud-based Kubernetes environment.
19+
To learn how to deploy ScalarDB Cluster in a cloud-based Kubernetes environment by using a Helm Chart, see [Deploy ScalarDB Cluster on Amazon Elastic Kubernetes Service (EKS)](scalar-kubernetes/ManualDeploymentGuideScalarDBClusterOnEKS.mdx).

‎docs/develop-overview.mdx‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,30 @@ displayed_sidebar: docsEnglish
1010

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

13+
To get started with developing applications for ScalarDB, see the following sub-categories.
14+
1315
## Run transactions
1416

15-
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.
17+
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.
1618

17-
You can also learn how to create correct, secure, and well-performing ScalarDB-based applications.
19+
For an overview of this sub-category, see [Run Transactions Overview](develop-run-transactions-overview.mdx).
1820

1921
## Run analytical queries
2022

21-
In this section, you can learn how to set up and configure ScalarDB Analytics, an analytics component of ScalarDB. Then, you run analytical queries over the databases you write through ScalarDB transactions.
23+
:::note
24+
25+
Coming soon.
26+
27+
:::
28+
29+
## Run non-transactional operations
30+
31+
In this sub-category, you can learn how to run such non-transactional storage operations.
2232

23-
## Run non-transactional storage operations
33+
For an overview of this sub-category, see [Run Non-Transactional Operations Overview](develop-run-non-transactional-operations-overview.mdx).
2434

25-
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.
35+
## Run sample applications
2636

27-
ScalarDB can be configured to provide only the unified abstraction, without transaction capabilities, so that it only runs non-transactional operations on the underlying database and storage. Since ScalarDB doesn't guarantee ACID across multiple operations, you can perform operations with better performance.
37+
In this sub-category, you can learn how to run various sample applications that take advantage of ScalarDB.
2838

29-
In this sub-category, you can learn how to run such non-transactional storage operations.
39+
For an overview of this sub-category, see [Run Sample Applications Overview](scalardb-samples/README.mdx).

‎docs/develop-run-non-transactional-operations-overview.mdx‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
tags:
3+
- Community
4+
- Enterprise Standard
5+
- Enterprise Premium
6+
displayed_sidebar: docsEnglish
7+
---
8+
9+
# Run Non-Transactional Storage Operations Overview
10+
11+
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.
12+
13+
ScalarDB can be configured to provide only the unified abstraction, without transaction capabilities, so that it only runs non-transactional operations on the underlying database and storage. Since ScalarDB in this configuration doesn't guarantee ACID across multiple operations, you can perform operations with better performance.
14+
15+
In this sub-category, you can learn how to run such non-transactional storage operations.
16+
17+
To learn how to run analytical queries, see the following guides:
18+
19+
- Run Through the CRUD Interface
20+
- [Use the ScalarDB Core Library](run-non-transactional-storage-operations-through-library.mdx)
21+
- [Use ScalarDB Cluster](run-non-transactional-storage-operations-through-scalardb-cluster.mdx)
22+
- [Run Through the SQL Interface](run-non-transactional-storage-operations-through-sql-interface.mdx)
23+
- [Run Through the Primitive CRUD Interface](run-non-transactional-storage-operations-through-primitive-crud-interface.mdx)

‎docs/develop-run-transactions-overview.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
tags:
3+
- Community
4+
- Enterprise Standard
5+
- Enterprise Premium
6+
displayed_sidebar: docsEnglish
7+
---
8+
9+
# Run Transactions Overview
10+
11+
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.
12+
13+
To learn how to create correct, secure, and well-performing ScalarDB-based applications, see the following guides:
14+
15+
- [Model Your Data](data-modeling.mdx)
16+
- Run Through the CRUD Interface
17+
- [Use the ScalarDB Core Library](run-transactions-through-scalardb-core-library.mdx)
18+
- [Use ScalarDB Cluster](scalardb-cluster/run-transactions-through-scalardb-cluster.mdx)
19+
- [Run Through the SQL Interface](scalardb-cluster/run-transactions-through-scalardb-cluster-sql.mdx)

‎docs/manage-monitor-overview.mdx‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
tags:
3+
- Enterprise Option
4+
displayed_sidebar: docsEnglish
5+
---
6+
7+
# Monitor Overview
8+
9+
Scalar Manager is a centralized management and monitoring solution for ScalarDB within Kubernetes cluster environments that allows you to:
10+
11+
- Check the availability of ScalarDB.
12+
- Schedule or execute pausing jobs that create transactionally consistent periods in the databases used by ScalarDB.
13+
- Check the time-series metrics and logs of ScalarDB through Grafana dashboards.
14+
15+
For more details about Scalar Manager, see [Scalar Manager Overview](scalar-manager/overview.mdx).
16+
17+
## Deploy Scalar Manager
18+
19+
You can deploy Scalar Manager by using a Helm Chart.
20+
21+
For details on how to deploy Scalar Manager, see [How to Deploy Scalar Manager](helm-charts/how-to-deploy-scalar-manager.mdx).

‎docs/manage-overview.mdx‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
tags:
3+
- Community
4+
- Enterprise Standard
5+
- Enterprise Premium
6+
displayed_sidebar: docsEnglish
7+
---
8+
9+
# Manage Overview
10+
11+
In this category, you can follow guides to help you manage ScalarDB.
12+
13+
- For details on how to scale ScalarDB, see [Scale](scalar-kubernetes/HowToScaleScalarDB.mdx).
14+
- For details on how to upgrade ScalarDB, see [Upgrade](scalar-kubernetes/HowToUpgradeScalarDB.mdx).
15+
16+
## Monitor
17+
18+
In this sub-category, you can learn how to monitor your ScalarDB deployment.
19+
20+
For an overview of this sub-category, see [Monitor](manage-monitor-overview.mdx).
21+
22+
## Back up and restore
23+
24+
In this sub-category, you can learn how to back up and restore the databases that are connected to your ScalarDB deployment.
25+
26+
For an overview of this sub-category, see [Back Up and Restore Databases](manage-backup-and-restore.mdx).

‎docs/migrate-overview.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
tags:
3+
- Community
4+
- Enterprise Standard
5+
- Enterprise Premium
6+
displayed_sidebar: docsEnglish
7+
---
8+
9+
# Migrate Overview
10+
11+
For details on importing your tables or migrating your applications and databases to a ScalarDB-based environment, see the following guides:
12+
13+
- [Importing Existing Tables to ScalarDB by Using ScalarDB Schema Loader](schema-loader-import.mdx)
14+
- [How to Migrate Your Applications and Databases into a ScalarDB-Based Environment](scalardb-sql/migration-guide.mdx)

‎docs/quick-start-overview.mdx‎ renamed to ‎docs/quickstart-overview.mdx‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,17 @@ displayed_sidebar: docsEnglish
1010

1111
In this category, you can follow quickstart tutorials for how to get started with running transactions and queries through ScalarDB.
1212

13-
## Try running transactions through the ScalarDB core library
13+
## Try running transactions through the ScalarDB Core library
1414

15-
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.
15+
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.
16+
17+
For an overview of this sub-category, see [ScalarDB Core Quickstart Overview](quickstart-scalardb-core-overview.mdx).
1618

1719
## Try running transactions through ScalarDB Cluster
1820

19-
In this sub-category, you can see tutorials on how to run ACID transactions through ScalarDB Cluster, which is a [gRPC](https://grpc.io/) server that wraps the ScalarDB core library.
21+
In this sub-category, you can see tutorials on how to run ACID transactions through ScalarDB Cluster, which is a [gRPC](https://grpc.io/) server that wraps the ScalarDB Core library.
22+
23+
For an overview of this sub-category, see [ScalarDB Cluster Quickstart Overview](quickstart-scalardb-cluster-overview.mdx).
2024

2125
:::note
2226

@@ -26,7 +30,9 @@ ScalarDB Cluster is available only in the Enterprise edition.
2630

2731
## Try running analytical queries through ScalarDB Analytics
2832

29-
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.
33+
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. ScalarDB Analytics targets both ScalarDB-managed databases, which are updated through ScalarDB transactions, and non-ScalarDB-managed databases.
34+
35+
For an overview of this sub-category, see [ScalarDB Analytics Quickstart Overview](quickstart-scalardb-analytics-overview.mdx).
3036

3137
:::note
3238

‎docs/quickstart-scalardb-analytics-overview.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
tags:
3+
- Community
4+
- Enterprise Option
5+
- Public Preview
6+
displayed_sidebar: docsEnglish
7+
---
8+
9+
# ScalarDB Analytics Quickstart Overview
10+
11+
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.
12+
13+
- To try running analytical queries through PostgreSQL, see [Getting Started with ScalarDB Analytics with PostgreSQL](scalardb-analytics-postgresql/getting-started.mdx).
14+
- To try running analytical queries through Spark, see [Getting Started with ScalarDB Analytics](scalardb-samples/scalardb-analytics-spark-sample/README.mdx).

0 commit comments

Comments
 (0)