From 1bc7dd1e92eeaa2f2516c1f0a9e3af0ebba9b95c Mon Sep 17 00:00:00 2001
From: josh-wong <joshua.wong@scalar-labs.com>
Date: Wed, 10 Dec 2025 04:29:25 +0000
Subject: [PATCH] AUTO: Sync ScalarDB docs in English to docs site repo

---
 docs/getting-started-with-scalardb.mdx        | 68 +++++++++++++++++++
 ...nal-storage-operations-through-library.mdx | 46 +++++++++++++
 ...sactions-through-scalardb-core-library.mdx | 46 +++++++++++++
 ...ge-operations-through-scalardb-cluster.mdx | 46 +++++++++++++
 ...nsactions-through-scalardb-cluster-sql.mdx | 46 +++++++++++++
 ...-transactions-through-scalardb-cluster.mdx | 46 +++++++++++++
 6 files changed, 298 insertions(+)

diff --git a/docs/getting-started-with-scalardb.mdx b/docs/getting-started-with-scalardb.mdx
index 31d1cc7a6..39027c177 100644
--- a/docs/getting-started-with-scalardb.mdx
+++ b/docs/getting-started-with-scalardb.mdx
@@ -166,6 +166,52 @@ For a list of databases that ScalarDB supports, see [Databases](requirements.mdx
     scalar.db.password=db2inst1
     ```
   </TabItem>
+  <TabItem value="TiDB" label="TiDB">
+    <h3>Run TiDB locally</h3>
+    
+    You can run TiDB locally by using the TiUP tool. For installation instructions, see [Install TiUP](https://docs.pingcap.com/tidb/stable/tiup-overview/#install-tiup).
+
+    To start TiDB, run the following command:
+    
+    ```console
+    tiup playground v8.5 --without-monitor
+    ```
+
+    <h3>Configure ScalarDB</h3>
+
+    The **database.properties** file in the `scalardb-samples/scalardb-sample` directory contains database configurations for ScalarDB. Please uncomment the properties for TiDB in the **database.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For TiDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:mysql://localhost:4000/
+    scalar.db.username=root
+    scalar.db.password=
+    ```
+  </TabItem>
+  <TabItem value="AlloyDB" label="AlloyDB">
+    <h3>Run AlloyDB locally</h3>
+
+    You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yml` file in the `scalardb-samples/scalardb-sample` directory.
+
+    To start AlloyDB Omni, run the following command:
+
+    ```console
+    docker compose up -d alloydb
+    ```
+
+    <h3>Configure ScalarDB</h3>
+
+    The **database.properties** file in the `scalardb-samples/scalardb-sample` directory contains database configurations for ScalarDB. Please uncomment the properties for AlloyDB in the **database.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For AlloyDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:postgresql://localhost:5432/
+    scalar.db.username=postgres
+    scalar.db.password=postgres
+    ```
+  </TabItem>
   <TabItem value="DynamoDB" label="DynamoDB">
     <h3>Run Amazon DynamoDB Local</h3>
 
@@ -302,6 +348,28 @@ The `--coordinator` option is specified because a table with `transaction` set t
 
 The `--coordinator` option is specified because a table with `transaction` set to `true` exists in the schema. For details about configuring and loading a schema, see [ScalarDB Schema Loader](schema-loader.mdx).
 
+:::
+  </TabItem>
+  <TabItem value="TiDB" label="TiDB">
+    ```console
+    java -jar scalardb-schema-loader-<VERSION>.jar --config database.properties --schema-file schema.json --coordinator
+    ```
+
+:::note
+
+The `--coordinator` option is specified because a table with `transaction` set to `true` exists in the schema. For details about configuring and loading a schema, see [ScalarDB Schema Loader](schema-loader.mdx).
+
+:::
+  </TabItem>
+  <TabItem value="AlloyDB" label="AlloyDB">
+    ```console
+    java -jar scalardb-schema-loader-<VERSION>.jar --config database.properties --schema-file schema.json --coordinator
+    ```
+
+:::note
+
+The `--coordinator` option is specified because a table with `transaction` set to `true` exists in the schema. For details about configuring and loading a schema, see [ScalarDB Schema Loader](schema-loader.mdx).
+
 :::
   </TabItem>
   <TabItem value="DynamoDB" label="DynamoDB">
diff --git a/docs/run-non-transactional-storage-operations-through-library.mdx b/docs/run-non-transactional-storage-operations-through-library.mdx
index 896373998..349394d25 100644
--- a/docs/run-non-transactional-storage-operations-through-library.mdx
+++ b/docs/run-non-transactional-storage-operations-through-library.mdx
@@ -153,6 +153,52 @@ For a list of databases that ScalarDB supports, see [Databases](requirements.mdx
     scalar.db.password=db2inst1
     ```
   </TabItem>
+  <TabItem value="TiDB" label="TiDB">
+    <h3>Run TiDB locally</h3>
+    
+    You can run TiDB locally by using the TiUP tool. For installation instructions, see [Install TiUP](https://docs.pingcap.com/tidb/stable/tiup-overview/#install-tiup).
+
+    To start TiDB, run the following command:
+    
+    ```console
+    tiup playground v8.5 --without-monitor
+    ```
+
+    <h3>Configure ScalarDB</h3>
+
+    The **database.properties** file in the `scalardb-samples/scalardb-sample` directory contains database configurations for ScalarDB. Please uncomment the properties for TiDB in the **database.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For TiDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:mysql://localhost:4000/
+    scalar.db.username=root
+    scalar.db.password=
+    ```
+  </TabItem>
+  <TabItem value="AlloyDB" label="AlloyDB">
+    <h3>Run AlloyDB locally</h3>
+
+    You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yml` file in the `scalardb-samples/scalardb-sample` directory.
+
+    To start AlloyDB Omni, run the following command:
+
+    ```console
+    docker compose up -d alloydb
+    ```
+
+    <h3>Configure ScalarDB</h3>
+
+    The **database.properties** file in the `scalardb-samples/scalardb-sample` directory contains database configurations for ScalarDB. Please uncomment the properties for AlloyDB in the **database.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For AlloyDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:postgresql://localhost:5432/
+    scalar.db.username=postgres
+    scalar.db.password=postgres
+    ```
+  </TabItem>
   <TabItem value="DynamoDB" label="DynamoDB">
     <h3>Run Amazon DynamoDB Local</h3>
 
diff --git a/docs/run-transactions-through-scalardb-core-library.mdx b/docs/run-transactions-through-scalardb-core-library.mdx
index 9841e6bd2..2a33fd7b6 100644
--- a/docs/run-transactions-through-scalardb-core-library.mdx
+++ b/docs/run-transactions-through-scalardb-core-library.mdx
@@ -153,6 +153,52 @@ For a list of databases that ScalarDB supports, see [Databases](requirements.mdx
     scalar.db.password=db2inst1
     ```
   </TabItem>
+  <TabItem value="TiDB" label="TiDB">
+    <h3>Run TiDB locally</h3>
+    
+    You can run TiDB locally by using the TiUP tool. For installation instructions, see [Install TiUP](https://docs.pingcap.com/tidb/stable/tiup-overview/#install-tiup).
+
+    To start TiDB, run the following command:
+    
+    ```console
+    tiup playground v8.5 --without-monitor
+    ```
+
+    <h3>Configure ScalarDB</h3>
+
+    The **database.properties** file in the `scalardb-samples/scalardb-sample` directory contains database configurations for ScalarDB. Please uncomment the properties for TiDB in the **database.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For TiDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:mysql://localhost:4000/
+    scalar.db.username=root
+    scalar.db.password=
+    ```
+  </TabItem>
+  <TabItem value="AlloyDB" label="AlloyDB">
+    <h3>Run AlloyDB locally</h3>
+
+    You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yml` file in the `scalardb-samples/scalardb-sample` directory.
+
+    To start AlloyDB Omni, run the following command:
+
+    ```console
+    docker compose up -d alloydb
+    ```
+
+    <h3>Configure ScalarDB</h3>
+
+    The **database.properties** file in the `scalardb-samples/scalardb-sample` directory contains database configurations for ScalarDB. Please uncomment the properties for AlloyDB in the **database.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For AlloyDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:postgresql://localhost:5432/
+    scalar.db.username=postgres
+    scalar.db.password=postgres
+    ```
+  </TabItem>
   <TabItem value="DynamoDB" label="DynamoDB">
     <h3>Run Amazon DynamoDB Local</h3>
 
diff --git a/docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx b/docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx
index baac92a2a..2c9a5ba9a 100644
--- a/docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx
+++ b/docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx
@@ -164,6 +164,52 @@ For a list of databases that ScalarDB supports, see [Databases](../requirements.
     scalar.db.password=db2inst1
     ```
   </TabItem>
+  <TabItem value="TiDB" label="TiDB">
+    <h3>Run TiDB locally</h3>
+    
+    You can run TiDB locally by using the TiUP tool. For installation instructions, see [Install TiUP](https://docs.pingcap.com/tidb/stable/tiup-overview/#install-tiup).
+
+    To start TiDB, run the following command:
+    
+    ```console
+    tiup playground v8.5 --without-monitor
+    ```
+
+    <h3>Configure ScalarDB Cluster</h3>
+
+    The **scalardb-cluster-node.properties** file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory contains database configurations for ScalarDB Cluster. Please uncomment the properties for TiDB in the **scalardb-cluster-node.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For TiDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:mysql://host.docker.internal:4000/
+    scalar.db.username=root
+    scalar.db.password=
+    ```
+  </TabItem>
+  <TabItem value="AlloyDB" label="AlloyDB">
+    <h3>Run AlloyDB locally</h3>
+
+    You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yaml` file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory.
+
+    To start AlloyDB Omni, run the following command:
+
+    ```console
+    docker compose up -d alloydb
+    ```
+
+    <h3>Configure ScalarDB Cluster</h3>
+
+    The **scalardb-cluster-node.properties** file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory contains database configurations for ScalarDB Cluster. Please uncomment the properties for AlloyDB in the **scalardb-cluster-node.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For AlloyDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:postgresql://alloydb-1:5432/
+    scalar.db.username=postgres
+    scalar.db.password=postgres
+    ```
+  </TabItem>
   <TabItem value="DynamoDB" label="DynamoDB">
     <h3>Run Amazon DynamoDB Local</h3>
 
diff --git a/docs/scalardb-cluster/run-transactions-through-scalardb-cluster-sql.mdx b/docs/scalardb-cluster/run-transactions-through-scalardb-cluster-sql.mdx
index fb129f556..fef8e0a59 100644
--- a/docs/scalardb-cluster/run-transactions-through-scalardb-cluster-sql.mdx
+++ b/docs/scalardb-cluster/run-transactions-through-scalardb-cluster-sql.mdx
@@ -163,6 +163,52 @@ For a list of databases that ScalarDB supports, see [Databases](../requirements.
     scalar.db.password=db2inst1
     ```
   </TabItem>
+  <TabItem value="TiDB" label="TiDB">
+    <h3>Run TiDB locally</h3>
+    
+    You can run TiDB locally by using the TiUP tool. For installation instructions, see [Install TiUP](https://docs.pingcap.com/tidb/stable/tiup-overview/#install-tiup).
+
+    To start TiDB, run the following command:
+    
+    ```console
+    tiup playground v8.5 --without-monitor
+    ```
+
+    <h3>Configure ScalarDB Cluster</h3>
+
+    The **scalardb-cluster-node.properties** file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory contains database configurations for ScalarDB Cluster. Please uncomment the properties for TiDB in the **scalardb-cluster-node.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For TiDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:mysql://host.docker.internal:4000/
+    scalar.db.username=root
+    scalar.db.password=
+    ```
+  </TabItem>
+  <TabItem value="AlloyDB" label="AlloyDB">
+    <h3>Run AlloyDB locally</h3>
+
+    You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yaml` file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory.
+
+    To start AlloyDB Omni, run the following command:
+
+    ```console
+    docker compose up -d alloydb
+    ```
+
+    <h3>Configure ScalarDB Cluster</h3>
+
+    The **scalardb-cluster-node.properties** file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory contains database configurations for ScalarDB Cluster. Please uncomment the properties for AlloyDB in the **scalardb-cluster-node.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For AlloyDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:postgresql://alloydb-1:5432/
+    scalar.db.username=postgres
+    scalar.db.password=postgres
+    ```
+  </TabItem>
   <TabItem value="DynamoDB" label="DynamoDB">
     <h3>Run Amazon DynamoDB Local</h3>
 
diff --git a/docs/scalardb-cluster/run-transactions-through-scalardb-cluster.mdx b/docs/scalardb-cluster/run-transactions-through-scalardb-cluster.mdx
index 0bd4ffd5c..bf67f958b 100644
--- a/docs/scalardb-cluster/run-transactions-through-scalardb-cluster.mdx
+++ b/docs/scalardb-cluster/run-transactions-through-scalardb-cluster.mdx
@@ -164,6 +164,52 @@ For a list of databases that ScalarDB supports, see [Databases](../requirements.
     scalar.db.password=db2inst1
     ```
   </TabItem>
+  <TabItem value="TiDB" label="TiDB">
+    <h3>Run TiDB locally</h3>
+    
+    You can run TiDB locally by using the TiUP tool. For installation instructions, see [Install TiUP](https://docs.pingcap.com/tidb/stable/tiup-overview/#install-tiup).
+
+    To start TiDB, run the following command:
+    
+    ```console
+    tiup playground v8.5 --without-monitor
+    ```
+
+    <h3>Configure ScalarDB Cluster</h3>
+
+    The **scalardb-cluster-node.properties** file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory contains database configurations for ScalarDB Cluster. Please uncomment the properties for TiDB in the **scalardb-cluster-node.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For TiDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:mysql://host.docker.internal:4000/
+    scalar.db.username=root
+    scalar.db.password=
+    ```
+  </TabItem>
+  <TabItem value="AlloyDB" label="AlloyDB">
+    <h3>Run AlloyDB locally</h3>
+
+    You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yaml` file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory.
+
+    To start AlloyDB Omni, run the following command:
+
+    ```console
+    docker compose up -d alloydb
+    ```
+
+    <h3>Configure ScalarDB Cluster</h3>
+
+    The **scalardb-cluster-node.properties** file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory contains database configurations for ScalarDB Cluster. Please uncomment the properties for AlloyDB in the **scalardb-cluster-node.properties** file so that the configuration looks as follows:
+
+    ```properties
+    # For AlloyDB
+    scalar.db.storage=jdbc
+    scalar.db.contact_points=jdbc:postgresql://alloydb-1:5432/
+    scalar.db.username=postgres
+    scalar.db.password=postgres
+    ```
+  </TabItem>
   <TabItem value="DynamoDB" label="DynamoDB">
     <h3>Run Amazon DynamoDB Local</h3>