AUTO: Sync ScalarDB docs in English to docs site repo

scalar-labs · Dec 24, 2024 · ed44fac · ed44fac
1 parent 8282424
commit ed44fac
Show file tree

Hide file tree

Showing 82 changed files with 201 additions and 1 deletion.
diff --git a/docs/add-scalardb-to-your-build.mdx b/docs/add-scalardb-to-your-build.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Add ScalarDB to Your Build

diff --git a/docs/api-guide.mdx b/docs/api-guide.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB Java API Guide

diff --git a/docs/backup-restore.mdx b/docs/backup-restore.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # How to Back Up and Restore Databases Used Through ScalarDB

diff --git a/docs/configurations.mdx b/docs/configurations.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB Configurations

diff --git a/docs/data-modeling.mdx b/docs/data-modeling.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Model Your Data

diff --git a/docs/database-configurations.mdx b/docs/database-configurations.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Configurations for the Underlying Databases of ScalarDB

diff --git a/docs/deploy-overview.mdx b/docs/deploy-overview.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Deploy Overview

diff --git a/docs/design.mdx b/docs/design.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB Design

diff --git a/docs/develop-overview.mdx b/docs/develop-overview.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Develop Overview

diff --git a/docs/getting-started-with-scalardb-by-using-kotlin.mdx b/docs/getting-started-with-scalardb-by-using-kotlin.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Getting Started with ScalarDB by Using Kotlin

diff --git a/docs/getting-started-with-scalardb.mdx b/docs/getting-started-with-scalardb.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Getting Started with ScalarDB

diff --git a/docs/glossary.mdx b/docs/glossary.mdx
@@ -0,0 +1,119 @@
+---
+tags:
+  - Community
+  - Enterprise Standard
+  - Enterprise Premium
+displayed_sidebar: docsEnglish
+---
+
+# Glossary
+
+This glossary includes database and distributed-system terms that are often used when using ScalarDB.
+
+## ACID
+
+Atomicity, consistency, isolation, and durability (ACID) is a set of properties that ensure database transactions are processed reliably, maintaining integrity even in cases of errors or system failures.
+
+## concurrency control
+
+Concurrency control in databases ensures that multiple transactions can occur simultaneously without causing data inconsistency, usually through mechanisms like locking or timestamp ordering.
+
+## consensus
+
+Consensus in distributed systems refers to the process of achieving agreement among multiple computers or nodes on a single data value or system state.
+
+## data federation
+
+Data federation is the process of integrating data from different sources without moving the data, creating a unified view for querying and analysis.
+
+## data mesh
+
+A data mesh is a decentralized data architecture that enables domain teams to independently perform cross-domain analysis, addressing scalability and ownership challenges.
+
+## data virtualization
+
+Data virtualization is similar to data federation in many aspects, meaning that it virtualizes multiple data sources into a unified view, simplifying queries without moving the data.
+
+## database anomalies
+
+Database anomalies are inconsistencies or errors in data that can occur when operations such as insertions, updates, or deletions are performed without proper transaction management.
+
+## federation engine
+
+A federation engine facilitates data integration and querying across multiple disparate data sources, often as part of a data federation architecture.
+
+## global transaction
+
+A global transaction spans multiple databases or distributed systems and ensures that all involved systems commit or roll back changes as a single unit.
+
+## heterogeneous databases
+
+Heterogeneous databases refer to systems composed of different database technologies that may have distinct data models, query languages, and transaction mechanisms.
+
+## HTAP
+
+Hybrid transactional/analytical processing (HTAP) refers to a system that can handle both transactional and analytical workloads concurrently on the same data set, removing the need for separate databases.
+
+## JDBC
+
+Java Database Connectivity (JDBC) is an API that allows Java applications to interact with databases, providing methods for querying and updating data in relational databases.
+
+## linearizability
+
+Linearizability is a strong consistency model in distributed systems where operations appear to occur atomically in some order, and each operation takes effect between its start and end.
+
+## NoSQL databases
+
+NoSQL databases are non-relational databases designed for specific data models, such as document, key-value, wide-column, or graph stores, often used for handling large-scale, distributed data.
+
+## Paxos
+
+Paxos is a family of protocols used in distributed systems to achieve consensus, even in the presence of node failures.
+
+## PITR
+
+Point-in-time recovery (PITR) allows a database to be restored to a previous state at any specific time, usually after an unintended event like data corruption.
+
+## polystores
+
+Polystores are database architectures that allow users to interact with multiple, heterogeneous data stores, each optimized for a specific workload or data type, as if they were a single system.
+
+## read-committed isolation
+
+Read-committed isolation is an isolation level where each transaction sees only committed data, preventing dirty reads but allowing non-repeatable reads.
+
+## relational databases
+
+Relational databases store data in tables with rows and columns, using a structured query language (SQL) to define, query, and manipulate the data.
+
+## replication
+
+Replication in databases involves copying and distributing data across multiple machines or locations to ensure reliability, availability, and fault tolerance.
+
+## Saga
+
+The Saga pattern is a method for managing long-running transactions in a distributed system, where each operation in the transaction is followed by a compensating action in case of failure.
+
+## serializable isolation
+
+Serializable isolation (serializability) is the highest isolation level in transactional systems, ensuring that the outcome of concurrently executed transactions is the same as if they were executed sequentially.
+
+## snapshot isolation
+
+Snapshot isolation is an isolation level that allows transactions to read a consistent snapshot of the database, protecting them from seeing changes made by other transactions until they complete.
+
+## TCC
+
+Try-Confirm/Cancel (TCC) is a pattern for distributed transactions that splits an operation into three steps, allowing for coordination and recovery across multiple systems.
+
+## transaction
+
+A transaction in databases is a sequence of operations treated as a single logical unit of work, ensuring consistency and integrity, typically conforming to ACID properties.
+
+## transaction manager
+
+A transaction manager coordinates the execution of transactions across multiple systems or databases, ensuring that all steps of the transaction succeed or fail as a unit.
+
+## two-phase commit
+
+Two-phase commit is a protocol for ensuring all participants in a distributed transaction either commit or roll back the transaction, ensuring consistency across systems.
diff --git a/docs/manage-backup-and-restore.mdx b/docs/manage-backup-and-restore.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Back Up and Restore Databases

diff --git a/docs/monitor-by-using-scalar-manager.mdx b/docs/monitor-by-using-scalar-manager.mdx
@@ -1,6 +1,7 @@
 ---
 tags:
   - Enterprise Option
+displayed_sidebar: docsEnglish
 ---
 
 # Monitor ScalarDB by Using Scalar Manager

diff --git a/docs/multi-storage-transactions.mdx b/docs/multi-storage-transactions.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Multi-Storage Transactions

diff --git a/docs/overview.mdx b/docs/overview.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB Overview

diff --git a/docs/quick-start-overview.mdx b/docs/quick-start-overview.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Quickstart Overview

diff --git a/docs/requirements.mdx b/docs/requirements.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Requirements

diff --git a/docs/roadmap.mdx b/docs/roadmap.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB Roadmap

diff --git a/docs/run-non-transactional-storage-operations-through-library.mdx b/docs/run-non-transactional-storage-operations-through-library.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Run Non-Transactional Storage Operations Through the Core Library

diff --git a/docs/run-non-transactional-storage-operations-through-primitive-crud-interface.mdx b/docs/run-non-transactional-storage-operations-through-primitive-crud-interface.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Run Non-Transactional Storage Operations Through the Primitive CRUD Interface

diff --git a/docs/run-transactions-through-scalardb-core-library.mdx b/docs/run-transactions-through-scalardb-core-library.mdx
@@ -3,6 +3,7 @@ tags:
   - Community
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Run Transactions Through the ScalarDB Core Library

diff --git a/docs/scalardb-analytics-postgresql/getting-started.mdx b/docs/scalardb-analytics-postgresql/getting-started.mdx
@@ -1,6 +1,7 @@
 ---
 tags:
   - Community
+displayed_sidebar: docsEnglish
 ---
 
 # Getting Started with ScalarDB Analytics with PostgreSQL

diff --git a/docs/scalardb-analytics-postgresql/installation.mdx b/docs/scalardb-analytics-postgresql/installation.mdx
@@ -1,6 +1,7 @@
 ---
 tags:
   - Community
+displayed_sidebar: docsEnglish
 ---
 
 # How to Install ScalarDB Analytics with PostgreSQL in Your Local Environment by Using Docker

diff --git a/docs/scalardb-analytics-postgresql/scalardb-fdw.mdx b/docs/scalardb-analytics-postgresql/scalardb-fdw.mdx
@@ -1,6 +1,7 @@
 ---
 tags:
   - Community
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB FDW

diff --git a/docs/scalardb-analytics-postgresql/schema-importer.mdx b/docs/scalardb-analytics-postgresql/schema-importer.mdx
@@ -1,6 +1,7 @@
 ---
 tags:
   - Community
+displayed_sidebar: docsEnglish
 ---
 
 # Schema Importer

diff --git a/docs/scalardb-analytics-spark/README.mdx b/docs/scalardb-analytics-spark/README.mdx
@@ -2,6 +2,7 @@
 tags:
   - Enterprise Option
   - Public Preview
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB Analytics

diff --git a/docs/scalardb-analytics-spark/version-compatibility.mdx b/docs/scalardb-analytics-spark/version-compatibility.mdx
@@ -2,6 +2,7 @@
 tags:
   - Enterprise Option
   - Public Preview
+displayed_sidebar: docsEnglish
 ---
 
 # Version Compatibility of ScalarDB Analytics with Spark

diff --git a/docs/scalardb-benchmarks/README.mdx b/docs/scalardb-benchmarks/README.mdx
@@ -1,6 +1,7 @@
 ---
 tags:
   - Community
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB Benchmarking Tools

diff --git a/docs/scalardb-cluster-dotnet-client-sdk/common-reference.mdx b/docs/scalardb-cluster-dotnet-client-sdk/common-reference.mdx
@@ -2,6 +2,7 @@
 tags:
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # ScalarDB Cluster .NET Client SDK Reference

diff --git a/docs/scalardb-cluster-dotnet-client-sdk/exception-handling.mdx b/docs/scalardb-cluster-dotnet-client-sdk/exception-handling.mdx
@@ -2,6 +2,7 @@
 tags:
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Exception Handling in the ScalarDB Cluster .NET Client SDK

diff --git a/docs/scalardb-cluster-dotnet-client-sdk/getting-started-with-admin-api.mdx b/docs/scalardb-cluster-dotnet-client-sdk/getting-started-with-admin-api.mdx
@@ -2,6 +2,7 @@
 tags:
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Getting Started with the Administrative API in the ScalarDB Cluster .NET Client SDK

diff --git a/docs/scalardb-cluster-dotnet-client-sdk/getting-started-with-aspnet-and-di.mdx b/docs/scalardb-cluster-dotnet-client-sdk/getting-started-with-aspnet-and-di.mdx
@@ -2,6 +2,7 @@
 tags:
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Getting Started with ASP.NET Core and Dependency Injection in the ScalarDB Cluster .NET Client SDK

diff --git a/docs/scalardb-cluster-dotnet-client-sdk/getting-started-with-auth.mdx b/docs/scalardb-cluster-dotnet-client-sdk/getting-started-with-auth.mdx
@@ -2,6 +2,7 @@
 tags:
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Getting Started with Authentication and Authorization by Using ScalarDB Cluster .NET Client SDK

diff --git a/...cluster-dotnet-client-sdk/getting-started-with-distributed-sql-transactions.mdx b/...cluster-dotnet-client-sdk/getting-started-with-distributed-sql-transactions.mdx
@@ -1,6 +1,7 @@
 ---
 tags:
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Getting Started with Distributed SQL Transactions in the ScalarDB Cluster .NET Client SDK

diff --git a/...rdb-cluster-dotnet-client-sdk/getting-started-with-distributed-transactions.mdx b/...rdb-cluster-dotnet-client-sdk/getting-started-with-distributed-transactions.mdx
@@ -2,6 +2,7 @@
 tags:
   - Enterprise Standard
   - Enterprise Premium
+displayed_sidebar: docsEnglish
 ---
 
 # Getting Started with Distributed Transactions in the ScalarDB Cluster .NET Client SDK