From d377bbfb27331f65270f03f9e95f2e71d9b1c3ee Mon Sep 17 00:00:00 2001 From: josh-wong Date: Thu, 23 Jan 2025 06:31:59 +0000 Subject: [PATCH] AUTO: Sync ScalarDB docs in English to docs site repo --- ...evelop-run-analytical-queries-overview.mdx | 15 +++++++++++ docs/deploy-overview.mdx | 8 +++--- docs/develop-overview.mdx | 24 ++++++++++++----- ...-non-transactional-operations-overview.mdx | 23 ++++++++++++++++ docs/develop-run-transactions-overview.mdx | 19 ++++++++++++++ ...anager.mdx => manage-monitor-overview.mdx} | 5 ++-- docs/manage-overview.mdx | 26 +++++++++++++++++++ docs/migrate-overview.mdx | 14 ++++++++++ ...t-overview.mdx => quickstart-overview.mdx} | 14 +++++++--- ...quickstart-scalardb-analytics-overview.mdx | 14 ++++++++++ docs/quickstart-scalardb-cluster-overview.mdx | 15 +++++++++++ docs/quickstart-scalardb-core-overview.mdx | 14 ++++++++++ ...nal-storage-operations-through-library.mdx | 4 +-- ...sactions-through-scalardb-core-library.mdx | 2 +- docs/scalardb-samples/README.mdx | 9 ++++--- 15 files changed, 181 insertions(+), 25 deletions(-) create mode 100644 docs/_develop-run-analytical-queries-overview.mdx create mode 100644 docs/develop-run-non-transactional-operations-overview.mdx create mode 100644 docs/develop-run-transactions-overview.mdx rename docs/{monitor-by-using-scalar-manager.mdx => manage-monitor-overview.mdx} (78%) create mode 100644 docs/manage-overview.mdx create mode 100644 docs/migrate-overview.mdx rename docs/{quick-start-overview.mdx => quickstart-overview.mdx} (51%) create mode 100644 docs/quickstart-scalardb-analytics-overview.mdx create mode 100644 docs/quickstart-scalardb-cluster-overview.mdx create mode 100644 docs/quickstart-scalardb-core-overview.mdx diff --git a/docs/_develop-run-analytical-queries-overview.mdx b/docs/_develop-run-analytical-queries-overview.mdx new file mode 100644 index 00000000..dfcf5fdb --- /dev/null +++ b/docs/_develop-run-analytical-queries-overview.mdx @@ -0,0 +1,15 @@ +--- +tags: + - Community + - Enterprise Option + - Public Preview +displayed_sidebar: docsEnglish +--- + +# Run Analytical Queries Overview + +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. + +To learn how to run analytical queries, see the following guides: + +- [Run Analytical Queries on Sample Data by Using ScalarDB Analytics with PostgreSQL](scalardb-samples/scalardb-analytics-postgresql-sample/README.mdx) diff --git a/docs/deploy-overview.mdx b/docs/deploy-overview.mdx index 5272ccda..ccc2f31b 100644 --- a/docs/deploy-overview.mdx +++ b/docs/deploy-overview.mdx @@ -10,10 +10,10 @@ displayed_sidebar: docsEnglish 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 ScalarDB in your local Kubernetes environment +## Deploy ScalarDB Cluster in a local Kubernetes environment -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. +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). -## Deploy ScalarDB in a cloud-based Kubernetes environment +## Deploy ScalarDB Cluster in a cloud-based Kubernetes environment -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. \ No newline at end of file +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). diff --git a/docs/develop-overview.mdx b/docs/develop-overview.mdx index 275a8994..9075ae4f 100644 --- a/docs/develop-overview.mdx +++ b/docs/develop-overview.mdx @@ -10,20 +10,30 @@ displayed_sidebar: docsEnglish 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. +To get started with developing applications for ScalarDB, see the following sub-categories. + ## Run transactions -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. +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. -You can also learn how to create correct, secure, and well-performing ScalarDB-based applications. +For an overview of this sub-category, see [Run Transactions Overview](develop-run-transactions-overview.mdx). ## Run analytical queries -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. +:::note + +Coming soon. + +::: + +## Run non-transactional operations + +In this sub-category, you can learn how to run such non-transactional storage operations. -## Run non-transactional storage operations +For an overview of this sub-category, see [Run Non-Transactional Operations Overview](develop-run-non-transactional-operations-overview.mdx). -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 sample applications -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. +In this sub-category, you can learn how to run various sample applications that take advantage of ScalarDB. -In this sub-category, you can learn how to run such non-transactional storage operations. \ No newline at end of file +For an overview of this sub-category, see [Run Sample Applications Overview](scalardb-samples/README.mdx). diff --git a/docs/develop-run-non-transactional-operations-overview.mdx b/docs/develop-run-non-transactional-operations-overview.mdx new file mode 100644 index 00000000..65af298e --- /dev/null +++ b/docs/develop-run-non-transactional-operations-overview.mdx @@ -0,0 +1,23 @@ +--- +tags: + - Community + - Enterprise Standard + - Enterprise Premium +displayed_sidebar: docsEnglish +--- + +# 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. + +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. + +In this sub-category, you can learn how to run such non-transactional storage operations. + +To learn how to run analytical queries, see the following guides: + +- Run Through the CRUD Interface + - [Use the ScalarDB Core Library](run-non-transactional-storage-operations-through-library.mdx) + - [Use ScalarDB Cluster](run-non-transactional-storage-operations-through-scalardb-cluster.mdx) +- [Run Through the SQL Interface](scalardb-cluster/run-non-transactional-storage-operations-through-sql-interface.mdx) +- [Run Through the Primitive CRUD Interface](run-non-transactional-storage-operations-through-primitive-crud-interface.mdx) diff --git a/docs/develop-run-transactions-overview.mdx b/docs/develop-run-transactions-overview.mdx new file mode 100644 index 00000000..a5481a1b --- /dev/null +++ b/docs/develop-run-transactions-overview.mdx @@ -0,0 +1,19 @@ +--- +tags: + - Community + - Enterprise Standard + - Enterprise Premium +displayed_sidebar: docsEnglish +--- + +# 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. + +To learn how to create correct, secure, and well-performing ScalarDB-based applications, see the following guides: + +- [Model Your Data](data-modeling.mdx) +- Run Through the CRUD Interface + - [Use the ScalarDB Core Library](run-transactions-through-scalardb-core-library.mdx) + - [Use ScalarDB Cluster](scalardb-cluster/run-transactions-through-scalardb-cluster.mdx) +- [Run Through the SQL Interface](scalardb-cluster/run-transactions-through-scalardb-cluster-sql.mdx) diff --git a/docs/monitor-by-using-scalar-manager.mdx b/docs/manage-monitor-overview.mdx similarity index 78% rename from docs/monitor-by-using-scalar-manager.mdx rename to docs/manage-monitor-overview.mdx index a9b9ad89..d120478c 100644 --- a/docs/monitor-by-using-scalar-manager.mdx +++ b/docs/manage-monitor-overview.mdx @@ -4,7 +4,7 @@ tags: displayed_sidebar: docsEnglish --- -# Monitor ScalarDB by Using Scalar Manager +# Monitor Overview Scalar Manager is a centralized management and monitoring solution for ScalarDB within Kubernetes cluster environments that allows you to: @@ -18,5 +18,4 @@ For more details about Scalar Manager, see [Scalar Manager Overview](scalar-mana You can deploy Scalar Manager by using a Helm Chart. -For details on how to deploy Scalar Manager, see [How to Deploy Scalar Manager](helm-charts/how-to-deploy-scalar-manager.mdx). - +For details on how to deploy Scalar Manager, see [Deploy Scalar Manager](helm-charts/getting-started-scalar-manager.mdx). diff --git a/docs/manage-overview.mdx b/docs/manage-overview.mdx new file mode 100644 index 00000000..4bfab364 --- /dev/null +++ b/docs/manage-overview.mdx @@ -0,0 +1,26 @@ +--- +tags: + - Community + - Enterprise Standard + - Enterprise Premium +displayed_sidebar: docsEnglish +--- + +# Manage Overview + +In this category, you can follow guides to help you manage ScalarDB. + +- For details on how to scale ScalarDB, see [Scale](scalar-kubernetes/HowToScaleScalarDB.mdx). +- For details on how to upgrade ScalarDB, see [Upgrade](scalar-kubernetes/HowToUpgradeScalarDB.mdx). + +## Monitor + +In this sub-category, you can learn how to monitor your ScalarDB deployment. + +For an overview of this sub-category, see [Monitor](manage-monitor-overview.mdx). + +## Back up and restore + +In this sub-category, you can learn how to back up and restore the databases that are connected to your ScalarDB deployment. + +For an overview of this sub-category, see [Back Up and Restore Databases](manage-backup-and-restore.mdx). diff --git a/docs/migrate-overview.mdx b/docs/migrate-overview.mdx new file mode 100644 index 00000000..5b67453f --- /dev/null +++ b/docs/migrate-overview.mdx @@ -0,0 +1,14 @@ +--- +tags: + - Community + - Enterprise Standard + - Enterprise Premium +displayed_sidebar: docsEnglish +--- + +# Migrate Overview + +For details on importing your tables or migrating your applications and databases to a ScalarDB-based environment, see the following guides: + +- [Importing Existing Tables to ScalarDB by Using ScalarDB Schema Loader](schema-loader-import.mdx) +- [How to Migrate Your Applications and Databases into a ScalarDB-Based Environment](scalardb-sql/migration-guide.mdx) diff --git a/docs/quick-start-overview.mdx b/docs/quickstart-overview.mdx similarity index 51% rename from docs/quick-start-overview.mdx rename to docs/quickstart-overview.mdx index cdc40769..f7a71e52 100644 --- a/docs/quick-start-overview.mdx +++ b/docs/quickstart-overview.mdx @@ -10,13 +10,17 @@ displayed_sidebar: docsEnglish In this category, you can follow quickstart tutorials for how to get started with running transactions and queries through ScalarDB. -## Try running transactions through the ScalarDB core library +## Try running transactions through the ScalarDB Core library -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. +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. + +For an overview of this sub-category, see [ScalarDB Core Quickstart Overview](quickstart-scalardb-core-overview.mdx). ## Try running transactions through ScalarDB Cluster -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. +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. + +For an overview of this sub-category, see [ScalarDB Cluster Quickstart Overview](quickstart-scalardb-cluster-overview.mdx). :::note @@ -26,7 +30,9 @@ ScalarDB Cluster is available only in the Enterprise edition. ## Try running analytical queries through ScalarDB Analytics -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. +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. + +For an overview of this sub-category, see [ScalarDB Analytics Quickstart Overview](quickstart-scalardb-analytics-overview.mdx). :::note diff --git a/docs/quickstart-scalardb-analytics-overview.mdx b/docs/quickstart-scalardb-analytics-overview.mdx new file mode 100644 index 00000000..c81e0be3 --- /dev/null +++ b/docs/quickstart-scalardb-analytics-overview.mdx @@ -0,0 +1,14 @@ +--- +tags: + - Community + - Enterprise Option + - Public Preview +displayed_sidebar: docsEnglish +--- + +# ScalarDB Analytics Quickstart Overview + +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. + +- To try running analytical queries through PostgreSQL, see [Getting Started with ScalarDB Analytics with PostgreSQL](scalardb-analytics-postgresql/getting-started.mdx). +- To try running analytical queries through Spark, see [Getting Started with ScalarDB Analytics](scalardb-samples/scalardb-analytics-spark-sample/README.mdx). diff --git a/docs/quickstart-scalardb-cluster-overview.mdx b/docs/quickstart-scalardb-cluster-overview.mdx new file mode 100644 index 00000000..6d5538ca --- /dev/null +++ b/docs/quickstart-scalardb-cluster-overview.mdx @@ -0,0 +1,15 @@ +--- +tags: + - Enterprise Standard + - Enterprise Premium +displayed_sidebar: docsEnglish +--- + +# 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](https://grpc.io/) server that wraps the ScalarDB Core library. + +- To try running transactions, see [Getting Started with ScalarDB Cluster](scalardb-cluster/getting-started-with-scalardb-cluster.mdx). +- To try running transactions through the SQL interface via JDBC, see [Getting Started with ScalarDB Cluster SQL via JDBC](scalardb-cluster/getting-started-with-scalardb-cluster-sql-jdbc.mdx). +- To try running transactions through the SQL interface via Spring Data JDBC, see [Getting Started with ScalarDB Cluster SQL via Spring Data JDBC for ScalarDB](scalardb-cluster/getting-started-with-scalardb-cluster-sql-spring-data-jdbc.mdx). +- To try running transactions through the GraphQL interface, see [Getting Started with ScalarDB Cluster GraphQL](scalardb-cluster/getting-started-with-scalardb-cluster-graphql.mdx). diff --git a/docs/quickstart-scalardb-core-overview.mdx b/docs/quickstart-scalardb-core-overview.mdx new file mode 100644 index 00000000..36a59c55 --- /dev/null +++ b/docs/quickstart-scalardb-core-overview.mdx @@ -0,0 +1,14 @@ +--- +tags: + - Community + - Enterprise Standard + - Enterprise Premium +displayed_sidebar: docsEnglish +--- + +# 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. + +- To try running transactions, see [Getting Started with ScalarDB](getting-started-with-scalardb.mdx). +- To try running transactions by using Kotlin, see [Getting Started with ScalarDB by Using Kotlin](getting-started-with-scalardb-by-using-kotlin.mdx). diff --git a/docs/run-non-transactional-storage-operations-through-library.mdx b/docs/run-non-transactional-storage-operations-through-library.mdx index 48e33446..6d36329f 100644 --- a/docs/run-non-transactional-storage-operations-through-library.mdx +++ b/docs/run-non-transactional-storage-operations-through-library.mdx @@ -11,7 +11,7 @@ displayed_sidebar: docsEnglish import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This guide explains how to run non-transactional storage operations through the ScalarDB core library. +This guide explains how to run non-transactional storage operations through the ScalarDB Core library. ## Preparation @@ -223,7 +223,7 @@ ScalarDB has its own data model and schema that maps to the implementation-speci ## Create your Java application -This section describes how to add the ScalarDB core library to your project and how to configure it to run non-transactional storage operations by using Java. +This section describes how to add the ScalarDB Core library to your project and how to configure it to run non-transactional storage operations by using Java. ### Add ScalarDB to your project diff --git a/docs/run-transactions-through-scalardb-core-library.mdx b/docs/run-transactions-through-scalardb-core-library.mdx index 34ba4374..d6579d15 100644 --- a/docs/run-transactions-through-scalardb-core-library.mdx +++ b/docs/run-transactions-through-scalardb-core-library.mdx @@ -11,7 +11,7 @@ displayed_sidebar: docsEnglish import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -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. +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. ## Preparation diff --git a/docs/scalardb-samples/README.mdx b/docs/scalardb-samples/README.mdx index 74e8a64c..a2157779 100644 --- a/docs/scalardb-samples/README.mdx +++ b/docs/scalardb-samples/README.mdx @@ -6,13 +6,14 @@ tags: displayed_sidebar: docsEnglish --- -# ScalarDB Samples +# Run Sample Applications Overview -The following are sample applications for ScalarDB: +In this sub-category, you can learn how to run various sample applications that take advantage of ScalarDB. + +To set up and run the sample applications, see the following guides: - [Multi-storage Transaction Sample](multi-storage-transaction-sample/README.mdx) - [Microservice Transaction Sample](microservice-transaction-sample/README.mdx) -- [ScalarDB Analytics with PostgreSQL](scalardb-analytics-postgresql-sample/README.mdx) -- [ScalarDB Analytics with Spark](scalardb-analytics-spark-sample/README.mdx) - [Spring Data JDBC for ScalarDB with Multi-storage Transaction Sample](spring-data-multi-storage-transaction-sample/README.mdx) - [Spring Data JDBC for ScalarDB with Microservice Transaction Sample](spring-data-microservice-transaction-sample/README.mdx) +- [Analytical Queries by Using ScalarDB Analytics with PostgreSQL](scalardb-analytics-postgresql-sample/README.mdx)