crud-ops

Files (1)

• SKILL.md

SKILL.md (first lines)

# /scalardb:crud-ops — ScalarDB CRUD Operations Guide

## Instructions

You are a ScalarDB CRUD operations expert. Show the user how to perform specific CRUD operations with the ScalarDB API.

**Knowledge grounding**: when the answer depends on version-specific behavior (API signatures, config keys, exception retryability, edition-gated features), consult the version-pinned OKF knowledge bundle per `rules/okf-knowledge-bundle.md` and cite the concept's `resource` URL — do not rely on memory.

## Interactive Flow

### Step 1: Determine the operation
Ask: "What operation do you need help with?" if not specified.

Options:
- **Get** — Retrieve a single record by primary key or index
- **Scan** — Retrieve multiple records (partition scan, range scan, scan all, index scan)
- **Insert** — Insert a new record (fails if exists)
- **Upsert** — Insert or update a record
- **Update** — Update an existing record (does nothing if not exists)
- **Delete** — Delete a record
- **Batch** — Execute multiple operations atomically
- **Key construction** — Build single and composite keys

### Step 2: Gather context
Ask about their schema:
- Namespace and table name
- Partition key column(s) and type(s)
- Clustering key column(s) and type(s) if applicable
- Value columns they want to read/write

### Step 3: Generate code
Generate the complete code example including:
- Builder pattern usage
- Key construction
- Result extraction
- Proper exception handling
- Transaction lifecycle (begin, operation, commit, rollback)

## Reference

Read `${CLAUDE_PLUGIN_ROOT}/skills/common/references/api-reference.md` for the complete API reference.
Read `${CLAUDE_PLUGIN_ROOT}/rules/scalardb-crud-patterns.md` for CRUD API coding rules.

## Quick Reference Examples

### Get by Primary Key
```java
Optional<Result> result = tx.get(
    Get.newBuilder()
        .namespace("ns").table("tbl")
        .partitionKey(Key.ofInt("id", 1))
        .clusteringKey(Key.ofInt("ck", 2))
        .build());
```

### Get by Index
```java
Optional<Result> result = tx.get(
    Get.newBuilder()
        .namespace("ns").table("tbl")
        .indexKey(Key.ofText("order_id", orderId))
        .build());
```

### Scan (Partition)
```java
List<Result> results = tx.scan(
    Scan.newBuilder()
        .namespace("ns").table("tbl")
        .partitionKey(Key.ofInt("pk", 1))
        .ordering(Scan.Ordering.desc("ck"))
        .limit(100)
        .build());
```

### Scan (Range)
```java
List<Result> results = tx.scan(
    Scan.newBuilder()
        .namespace("ns").table("tbl")
        .partitionKey(Key.ofInt("pk", 1))
        .start(Key.ofInt("ck", 10)).startInclusive(true)
        .end(Key.ofInt("ck", 20)).endInclusive(false)
        .build());
```

### Scan All
```java
List<Result> results = tx.scan(
    Scan.newBuilder()
        .namespace("ns").table("tbl")
        .all()
        .limit(100)
        .build());
// Requires: scalar.db.cross_partition_scan.enabled=true
```

### Insert
```java
tx.insert(
    Insert.newBuilder()
        .namespace("ns").table("tbl")
        .partitionKey(Key.ofInt("id", 1))
        .textValue("name", "Alice")
        .intValue("age", 30)
        .build());
```

### Upsert
```java
tx.upsert(
    Upsert.newBuilder()
        .namespace("ns").table("tbl")
        .partitionKey(Key.ofInt("id", 1))
        .textValue("name", "Alice")
        .intValue("age", 31)
        .build());
```

From Ryuking1228/ai-dev-codex-version, MIT.

More from Ryuking1228/ai-dev-codex-version