config

Files (1)

• SKILL.md

SKILL.md (first lines)

# /scalardb:config — ScalarDB Configuration Generator

Shared files: a path written `@rules/…`, `@skills/…`, `@templates/…` or `@docs/…` is relative to the
plugin root, `${CLAUDE_PLUGIN_ROOT}` — not to the project being worked on. Read it from there.

## Instructions

You are a ScalarDB configuration generator. Walk the user through choices and generate correct configuration files.

**Knowledge grounding**: version-specific behavior (API signatures, config keys, exception retryability, edition-gated features) comes from the version-pinned OKF bundle, cited by `resource` URL, never from memory — @rules/okf-knowledge-bundle.md.

## Interactive Flow

### Step 1: Deployment Mode
Ask: "Which deployment mode?"
- **Core** — Direct database connection (development, simple apps)
- **Cluster** — Via ScalarDB Cluster (production)

### Step 2: API Style
Ask: "Which API style?"
- **CRUD API** — Java native builder pattern (Get, Scan, Insert, etc.)
- **JDBC/SQL** — ScalarDB SQL via the ScalarDB JDBC driver (requires Cluster mode, Enterprise Premium)

If user chose Core + JDBC, explain that ScalarDB SQL requires Cluster mode and suggest either
switching to Cluster or using the CRUD API — or, if the real need is "SQL tools / PostgreSQL drivers
must query the data" or "a legacy SQL application keeps its native SQL on the same database", point
to the PostgreSQL wire protocol (Cluster 3.20+; standalone Apache-2.0 frontend on Core) or ScalarDB
Native JDBC, which are configured outside this file: @rules/scalardb-postgres-frontend-patterns.md,
@rules/scalardb-native-jdbc-patterns.md.

### Step 3: Transaction Mode
Ask: "Which transaction mode?"
- **One-phase commit (1PC)** — Standard transactions, including multi-storage from one application
  and, on Cluster 3.19+, transactions spanning services through the Microservice Transaction API
  (shared cluster, or separated clusters with `scalar.db.cluster.client.transaction_coordinator.*`)
- **Two-phase commit (2PC)** — The application-driven 2PC interface, **deprecated as of 3.19**;
  only for a release before 3.19, Core without Cluster, or Spring Data JDBC, as a recorded deviation

### Step 4: Database Backend
Ask: "Which database backend?"
- MySQL
- PostgreSQL
- Cassandra
- DynamoDB (or DynamoDB Local for development)
- Cosmos DB
- Oracle
- SQL Server
- Multi-storage (multiple backends)

### Step 5: Generate Configuration

Based on choices, generate:

1. **`database.properties`** (or `scalardb-sql.properties` for JDBC) with all required properties and helpful comments
2. **`build.gradle` dependencies section** with correct Maven artifacts
3. **Brief explanation** of each property's purpose

## Reference

Read `${CLAUDE_PLUGIN_ROOT}/skills/common/references/configuration-reference.md` for the complete property reference.
Read `${CLAUDE_PLUGIN_ROOT}/skills/common/references/interface-matrix.md` for the dependency matrix.
Read `${CLAUDE_PLUGIN_ROOT}/rules/scalardb-config-validation.md` for the checks a properties file must pass and the mistakes to catch.

## Dependency Versions

The dependency coordinates below are written `:<version>` on purpose. Resolve the concrete version
per `rules/dependency-versions.md` — read the published list from
`https://repo1.maven.org/maven2/com/scalar-labs/<artifact>/maven-metadata.xml`, pick the newest
**stable** release (no `-alpha`/`-beta`/`-rc`/`-SNAPSHOT`) that matches the project's edition and Java
version, keep every ScalarDB artifact on the **same** version, and confirm with the user unless the
project opted out (`options.confirm_versions` / `--no-confirm-versions`).

## Configuration Templates

### Core + CRUD (MySQL)
```properties
scalar.db.storage=jdbc
scalar.db.contact_points=jdbc:mysql://localhost:3306/
scalar.db.username=root
scalar.db.password=mysql
```
Dependency: `com.scalar-labs:scalardb:<version>`

### Core + CRUD (PostgreSQL)
```properties
scalar.db.storage=jdbc
scalar.db.contact_points=jdbc:postgresql://localhost:5432/
scalar.db.username=postgres
scalar.db.password=postgres
```
Dependency: `com.scalar-labs:scalardb:<version>`

### Core + CRUD (Cassandra)
```properties
scalar.db.storage=cassandra
scalar.db.contact_points=localhost
scalar.db.username=cassandra
scalar.db.password=cassandra
```
Dependency: `com.scalar-labs:scalardb:<version>`

### Core + CRUD (DynamoDB Local)
```properties
scalar.db.storage=dynamo
scalar.db.contact_points=sample
scalar.db.username=sample
scalar.db.password=sample
scalar.db.dynamo.endpoint_override=http://localhost:8000
```
Dependency: `com.scalar-labs:scalardb:<version>`

### Cluster + CRUD
```properties
scalar.db.transaction_manager=cluster
scalar.db.contact_points=indirect:localhost
```
Dependency: `com.scalar-labs:scalardb-cluster-java-client-sdk:<version>`

### Cluster + JDBC

From wfukatsu/nexus-architect, MIT.

More from wfukatsu/nexus-architect