Skip to content

Commit 1bc7dd1

Browse files
josh-wongjosh-wong
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 41f7509 commit 1bc7dd1

6 files changed

+298
-0
lines changed

‎docs/getting-started-with-scalardb.mdx‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,52 @@ For a list of databases that ScalarDB supports, see [Databases](requirements.mdx
166166
scalar.db.password=db2inst1
167167
```
168168
</TabItem>
169+
<TabItem value="TiDB" label="TiDB">
170+
<h3>Run TiDB locally</h3>
171+
172+
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).
173+
174+
To start TiDB, run the following command:
175+
176+
```console
177+
tiup playground v8.5 --without-monitor
178+
```
179+
180+
<h3>Configure ScalarDB</h3>
181+
182+
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:
183+
184+
```properties
185+
# For TiDB
186+
scalar.db.storage=jdbc
187+
scalar.db.contact_points=jdbc:mysql://localhost:4000/
188+
scalar.db.username=root
189+
scalar.db.password=
190+
```
191+
</TabItem>
192+
<TabItem value="AlloyDB" label="AlloyDB">
193+
<h3>Run AlloyDB locally</h3>
194+
195+
You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yml` file in the `scalardb-samples/scalardb-sample` directory.
196+
197+
To start AlloyDB Omni, run the following command:
198+
199+
```console
200+
docker compose up -d alloydb
201+
```
202+
203+
<h3>Configure ScalarDB</h3>
204+
205+
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:
206+
207+
```properties
208+
# For AlloyDB
209+
scalar.db.storage=jdbc
210+
scalar.db.contact_points=jdbc:postgresql://localhost:5432/
211+
scalar.db.username=postgres
212+
scalar.db.password=postgres
213+
```
214+
</TabItem>
169215
<TabItem value="DynamoDB" label="DynamoDB">
170216
<h3>Run Amazon DynamoDB Local</h3>
171217

@@ -302,6 +348,28 @@ The `--coordinator` option is specified because a table with `transaction` set t
302348

303349
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).
304350

351+
:::
352+
</TabItem>
353+
<TabItem value="TiDB" label="TiDB">
354+
```console
355+
java -jar scalardb-schema-loader-<VERSION>.jar --config database.properties --schema-file schema.json --coordinator
356+
```
357+
358+
:::note
359+
360+
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).
361+
362+
:::
363+
</TabItem>
364+
<TabItem value="AlloyDB" label="AlloyDB">
365+
```console
366+
java -jar scalardb-schema-loader-<VERSION>.jar --config database.properties --schema-file schema.json --coordinator
367+
```
368+
369+
:::note
370+
371+
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).
372+
305373
:::
306374
</TabItem>
307375
<TabItem value="DynamoDB" label="DynamoDB">

‎docs/run-non-transactional-storage-operations-through-library.mdx‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,52 @@ For a list of databases that ScalarDB supports, see [Databases](requirements.mdx
153153
scalar.db.password=db2inst1
154154
```
155155
</TabItem>
156+
<TabItem value="TiDB" label="TiDB">
157+
<h3>Run TiDB locally</h3>
158+
159+
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).
160+
161+
To start TiDB, run the following command:
162+
163+
```console
164+
tiup playground v8.5 --without-monitor
165+
```
166+
167+
<h3>Configure ScalarDB</h3>
168+
169+
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:
170+
171+
```properties
172+
# For TiDB
173+
scalar.db.storage=jdbc
174+
scalar.db.contact_points=jdbc:mysql://localhost:4000/
175+
scalar.db.username=root
176+
scalar.db.password=
177+
```
178+
</TabItem>
179+
<TabItem value="AlloyDB" label="AlloyDB">
180+
<h3>Run AlloyDB locally</h3>
181+
182+
You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yml` file in the `scalardb-samples/scalardb-sample` directory.
183+
184+
To start AlloyDB Omni, run the following command:
185+
186+
```console
187+
docker compose up -d alloydb
188+
```
189+
190+
<h3>Configure ScalarDB</h3>
191+
192+
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:
193+
194+
```properties
195+
# For AlloyDB
196+
scalar.db.storage=jdbc
197+
scalar.db.contact_points=jdbc:postgresql://localhost:5432/
198+
scalar.db.username=postgres
199+
scalar.db.password=postgres
200+
```
201+
</TabItem>
156202
<TabItem value="DynamoDB" label="DynamoDB">
157203
<h3>Run Amazon DynamoDB Local</h3>
158204

‎docs/run-transactions-through-scalardb-core-library.mdx‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,52 @@ For a list of databases that ScalarDB supports, see [Databases](requirements.mdx
153153
scalar.db.password=db2inst1
154154
```
155155
</TabItem>
156+
<TabItem value="TiDB" label="TiDB">
157+
<h3>Run TiDB locally</h3>
158+
159+
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).
160+
161+
To start TiDB, run the following command:
162+
163+
```console
164+
tiup playground v8.5 --without-monitor
165+
```
166+
167+
<h3>Configure ScalarDB</h3>
168+
169+
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:
170+
171+
```properties
172+
# For TiDB
173+
scalar.db.storage=jdbc
174+
scalar.db.contact_points=jdbc:mysql://localhost:4000/
175+
scalar.db.username=root
176+
scalar.db.password=
177+
```
178+
</TabItem>
179+
<TabItem value="AlloyDB" label="AlloyDB">
180+
<h3>Run AlloyDB locally</h3>
181+
182+
You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yml` file in the `scalardb-samples/scalardb-sample` directory.
183+
184+
To start AlloyDB Omni, run the following command:
185+
186+
```console
187+
docker compose up -d alloydb
188+
```
189+
190+
<h3>Configure ScalarDB</h3>
191+
192+
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:
193+
194+
```properties
195+
# For AlloyDB
196+
scalar.db.storage=jdbc
197+
scalar.db.contact_points=jdbc:postgresql://localhost:5432/
198+
scalar.db.username=postgres
199+
scalar.db.password=postgres
200+
```
201+
</TabItem>
156202
<TabItem value="DynamoDB" label="DynamoDB">
157203
<h3>Run Amazon DynamoDB Local</h3>
158204

‎docs/scalardb-cluster/run-non-transactional-storage-operations-through-scalardb-cluster.mdx‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,52 @@ For a list of databases that ScalarDB supports, see [Databases](../requirements.
164164
scalar.db.password=db2inst1
165165
```
166166
</TabItem>
167+
<TabItem value="TiDB" label="TiDB">
168+
<h3>Run TiDB locally</h3>
169+
170+
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).
171+
172+
To start TiDB, run the following command:
173+
174+
```console
175+
tiup playground v8.5 --without-monitor
176+
```
177+
178+
<h3>Configure ScalarDB Cluster</h3>
179+
180+
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:
181+
182+
```properties
183+
# For TiDB
184+
scalar.db.storage=jdbc
185+
scalar.db.contact_points=jdbc:mysql://host.docker.internal:4000/
186+
scalar.db.username=root
187+
scalar.db.password=
188+
```
189+
</TabItem>
190+
<TabItem value="AlloyDB" label="AlloyDB">
191+
<h3>Run AlloyDB locally</h3>
192+
193+
You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yaml` file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory.
194+
195+
To start AlloyDB Omni, run the following command:
196+
197+
```console
198+
docker compose up -d alloydb
199+
```
200+
201+
<h3>Configure ScalarDB Cluster</h3>
202+
203+
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:
204+
205+
```properties
206+
# For AlloyDB
207+
scalar.db.storage=jdbc
208+
scalar.db.contact_points=jdbc:postgresql://alloydb-1:5432/
209+
scalar.db.username=postgres
210+
scalar.db.password=postgres
211+
```
212+
</TabItem>
167213
<TabItem value="DynamoDB" label="DynamoDB">
168214
<h3>Run Amazon DynamoDB Local</h3>
169215

‎docs/scalardb-cluster/run-transactions-through-scalardb-cluster-sql.mdx‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,52 @@ For a list of databases that ScalarDB supports, see [Databases](../requirements.
163163
scalar.db.password=db2inst1
164164
```
165165
</TabItem>
166+
<TabItem value="TiDB" label="TiDB">
167+
<h3>Run TiDB locally</h3>
168+
169+
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).
170+
171+
To start TiDB, run the following command:
172+
173+
```console
174+
tiup playground v8.5 --without-monitor
175+
```
176+
177+
<h3>Configure ScalarDB Cluster</h3>
178+
179+
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:
180+
181+
```properties
182+
# For TiDB
183+
scalar.db.storage=jdbc
184+
scalar.db.contact_points=jdbc:mysql://host.docker.internal:4000/
185+
scalar.db.username=root
186+
scalar.db.password=
187+
```
188+
</TabItem>
189+
<TabItem value="AlloyDB" label="AlloyDB">
190+
<h3>Run AlloyDB locally</h3>
191+
192+
You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yaml` file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory.
193+
194+
To start AlloyDB Omni, run the following command:
195+
196+
```console
197+
docker compose up -d alloydb
198+
```
199+
200+
<h3>Configure ScalarDB Cluster</h3>
201+
202+
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:
203+
204+
```properties
205+
# For AlloyDB
206+
scalar.db.storage=jdbc
207+
scalar.db.contact_points=jdbc:postgresql://alloydb-1:5432/
208+
scalar.db.username=postgres
209+
scalar.db.password=postgres
210+
```
211+
</TabItem>
166212
<TabItem value="DynamoDB" label="DynamoDB">
167213
<h3>Run Amazon DynamoDB Local</h3>
168214

‎docs/scalardb-cluster/run-transactions-through-scalardb-cluster.mdx‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,52 @@ For a list of databases that ScalarDB supports, see [Databases](../requirements.
164164
scalar.db.password=db2inst1
165165
```
166166
</TabItem>
167+
<TabItem value="TiDB" label="TiDB">
168+
<h3>Run TiDB locally</h3>
169+
170+
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).
171+
172+
To start TiDB, run the following command:
173+
174+
```console
175+
tiup playground v8.5 --without-monitor
176+
```
177+
178+
<h3>Configure ScalarDB Cluster</h3>
179+
180+
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:
181+
182+
```properties
183+
# For TiDB
184+
scalar.db.storage=jdbc
185+
scalar.db.contact_points=jdbc:mysql://host.docker.internal:4000/
186+
scalar.db.username=root
187+
scalar.db.password=
188+
```
189+
</TabItem>
190+
<TabItem value="AlloyDB" label="AlloyDB">
191+
<h3>Run AlloyDB locally</h3>
192+
193+
You can run AlloyDB Omni in Docker Compose by using the `docker-compose.yaml` file in the `scalardb-samples/scalardb-cluster-standalone-mode` directory.
194+
195+
To start AlloyDB Omni, run the following command:
196+
197+
```console
198+
docker compose up -d alloydb
199+
```
200+
201+
<h3>Configure ScalarDB Cluster</h3>
202+
203+
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:
204+
205+
```properties
206+
# For AlloyDB
207+
scalar.db.storage=jdbc
208+
scalar.db.contact_points=jdbc:postgresql://alloydb-1:5432/
209+
scalar.db.username=postgres
210+
scalar.db.password=postgres
211+
```
212+
</TabItem>
167213
<TabItem value="DynamoDB" label="DynamoDB">
168214
<h3>Run Amazon DynamoDB Local</h3>
169215

0 commit comments

Comments
 (0)