Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions docs/getting-started-with-scalardb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down Expand Up @@ -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">
Expand Down
46 changes: 46 additions & 0 deletions docs/run-non-transactional-storage-operations-through-library.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
46 changes: 46 additions & 0 deletions docs/run-transactions-through-scalardb-core-library.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down