diff --git a/docs/getting-started-with-scalardb.mdx b/docs/getting-started-with-scalardb.mdx index 31d1cc7a..39027c17 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 ``` + +

Run TiDB locally

+ + 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 + ``` + +

Configure ScalarDB

+ + 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= + ``` +
+ +

Run AlloyDB locally

+ + 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 + ``` + +

Configure ScalarDB

+ + 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 + ``` +

Run Amazon DynamoDB Local

@@ -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). +::: +
+ + ```console + java -jar scalardb-schema-loader-.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). + +::: + + + ```console + java -jar scalardb-schema-loader-.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). + ::: diff --git a/docs/run-non-transactional-storage-operations-through-library.mdx b/docs/run-non-transactional-storage-operations-through-library.mdx index 89637399..349394d2 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 ``` + +

Run TiDB locally

+ + 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 + ``` + +

Configure ScalarDB

+ + 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= + ``` +
+ +

Run AlloyDB locally

+ + 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 + ``` + +

Configure ScalarDB

+ + 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 + ``` +

Run Amazon DynamoDB Local

diff --git a/docs/run-transactions-through-scalardb-core-library.mdx b/docs/run-transactions-through-scalardb-core-library.mdx index 9841e6bd..2a33fd7b 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 ```
+ +

Run TiDB locally

+ + 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 + ``` + +

Configure ScalarDB

+ + 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= + ``` +
+ +

Run AlloyDB locally

+ + 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 + ``` + +

Configure ScalarDB

+ + 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 + ``` +

Run Amazon DynamoDB Local

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 baac92a2..2c9a5ba9 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 ```
+ +

Run TiDB locally

+ + 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 + ``` + +

Configure ScalarDB Cluster

+ + 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= + ``` +
+ +

Run AlloyDB locally

+ + 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 + ``` + +

Configure ScalarDB Cluster

+ + 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 + ``` +

Run Amazon DynamoDB Local

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 fb129f55..fef8e0a5 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 ```
+ +

Run TiDB locally

+ + 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 + ``` + +

Configure ScalarDB Cluster

+ + 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= + ``` +
+ +

Run AlloyDB locally

+ + 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 + ``` + +

Configure ScalarDB Cluster

+ + 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 + ``` +

Run Amazon DynamoDB Local

diff --git a/docs/scalardb-cluster/run-transactions-through-scalardb-cluster.mdx b/docs/scalardb-cluster/run-transactions-through-scalardb-cluster.mdx index 0bd4ffd5..bf67f958 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 ```
+ +

Run TiDB locally

+ + 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 + ``` + +

Configure ScalarDB Cluster

+ + 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= + ``` +
+ +

Run AlloyDB locally

+ + 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 + ``` + +

Configure ScalarDB Cluster

+ + 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 + ``` +

Run Amazon DynamoDB Local