Skip to content

Commit 97f4eea

Browse files
AUTO: Sync ScalarDB docs in English to docs site repo (#1098)
Co-authored-by: josh-wong <[email protected]>
1 parent bad4c6c commit 97f4eea

File tree

2 files changed

+4
-24
lines changed

2 files changed

+4
-24
lines changed

docs/scalardb-cluster/getting-started-with-vector-search.mdx

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,7 @@ This tutorial has been tested with OpenJDK from Eclipse Temurin. ScalarDB itself
6161
Create the following configuration file as `scalardb-cluster-node.properties`, replacing `<YOUR_LICENSE_KEY>` and `<LICENSE_CHECK_CERT_PEM>` with your ScalarDB license key and license check certificate values. For more information about the license key and certificate, see [How to Configure a Product License Key](../scalar-licensing/README.mdx).
6262

6363
```yaml
64-
# Storage configurations
65-
scalar.db.storage=jdbc
66-
scalar.db.contact_points=jdbc:postgresql://postgresql:5432/postgres
67-
scalar.db.username=postgres
68-
scalar.db.password=postgres
64+
scalar.db.transaction.enabled=false
6965

7066
# Enable the standalone mode
7167
scalar.db.cluster.node.standalone_mode.enabled=true
@@ -333,20 +329,6 @@ Create the following configuration file as `docker-compose.yaml`.
333329

334330
```yaml
335331
services:
336-
postgresql:
337-
container_name: "postgresql"
338-
image: "postgres:15"
339-
ports:
340-
- 5432:5432
341-
environment:
342-
- POSTGRES_PASSWORD=postgres
343-
healthcheck:
344-
test: ["CMD-SHELL", "pg_isready || exit 1"]
345-
interval: 1s
346-
timeout: 10s
347-
retries: 60
348-
start_period: 30s
349-
350332
scalardb-cluster-standalone:
351333
container_name: "scalardb-cluster-node"
352334
image: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium:3.15.2"
@@ -355,14 +337,11 @@ services:
355337
- 9080:9080
356338
volumes:
357339
- ./scalardb-cluster-node.properties:/scalardb-cluster/node/scalardb-cluster-node.properties
358-
depends_on:
359-
postgresql:
360-
condition: service_healthy
361340
```
362341
363-
### 3. Start PostgreSQL and ScalarDB Cluster
342+
### 3. Start ScalarDB Cluster
364343
365-
Run the following command to start PostgreSQL and ScalarDB Cluster in standalone mode.
344+
Run the following command to start ScalarDB Cluster in standalone mode.
366345
367346
```console
368347
docker compose up -d

docs/scalardb-cluster/scalardb-cluster-configurations.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The basic configurations for a cluster node are as follows:
3232
| `scalar.db.metadata.cache_expiration_time_secs` | ScalarDB has a metadata cache to reduce the number of requests to the database. This setting specifies the expiration time of the cache in seconds. If you specify `-1`, the cache will never expire. | `60` |
3333
| `scalar.db.active_transaction_management.expiration_time_millis` | ScalarDB Cluster nodes maintain ongoing transactions, which can be resumed by using a transaction ID. This configuration specifies the expiration time of this transaction management feature in milliseconds. | `60000` (60 seconds) |
3434
| `scalar.db.system_namespace_name` | The given namespace name will be used by ScalarDB internally. | `scalardb` |
35+
| `scalar.db.transaction.enabled` | Whether the transaction feature is enabled. For example, if you use only the embedding feature, you can set this property to `false`. | `true` |
3536

3637
## Transaction manager configurations
3738

0 commit comments

Comments
 (0)