# CockroachDB Client

Execute SQL queries and statements against CockroachDB databases with full type safety and runtime validation.

## Methods

| Method                                      | Description                                                                |
| ------------------------------------------- | -------------------------------------------------------------------------- |
| `query<T>(sql, schema, params?, metadata?)` | Execute a SELECT query and return validated, typed results                 |
| `execute(sql, params?, metadata?)`          | Execute a statement (INSERT, UPDATE, DELETE) and return affected row count |

## Usage

### Basic Query with Schema Validation

```typescript
import { api, z, cockroachdb } from "@superblocksteam/sdk-api";

// Integration ID from the integrations panel
const PROD_COCKROACHDB = "a1b2c3d4-5678-90ab-cdef-cockroac0001";

const UserSchema = z.object({
  id: z.string(), // UUIDs are common in CockroachDB
  name: z.string(),
  email: z.string().email(),
  created_at: z.string(),
});

export default api({
  name: "CockroachDBExample",
  integrations: {
    db: cockroachdb(PROD_COCKROACHDB),
  },
  input: z.object({
    status: z.string(),
  }),
  output: z.object({
    users: z.array(UserSchema),
  }),
  async run(ctx, { status }) {
    const users = await ctx.integrations.db.query(
      "SELECT id, name, email, created_at FROM users WHERE status = $1",
      UserSchema,
      [status],
    );

    return { users };
  },
});
```

### Executing INSERT, UPDATE, DELETE Statements

```typescript
// INSERT with RETURNING
await ctx.integrations.db.execute(
  "INSERT INTO users (name, email) VALUES ($1, $2)",
  ["John Doe", "john@example.com"],
);

// UPDATE
const updateResult = await ctx.integrations.db.execute(
  "UPDATE users SET last_login = now() WHERE id = $1",
  [userId],
);
console.log(`Updated ${updateResult.rowCount} rows`);

// DELETE
const deleteResult = await ctx.integrations.db.execute(
  "DELETE FROM sessions WHERE expires_at < now()",
);
console.log(`Deleted ${deleteResult.rowCount} expired sessions`);
```

### Array Parameters

CockroachDB supports PostgreSQL-style arrays:

```typescript
const items = await ctx.integrations.db.query(
  "SELECT * FROM items WHERE id = ANY($1)",
  ItemSchema,
  [[1, 2, 3]],
);
```

## Trace Metadata

All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.

## Common Pitfalls

### UUID Primary Keys

CockroachDB commonly uses UUIDs for primary keys:

```typescript
const schema = z.object({
  id: z.string().uuid(),
  name: z.string(),
});
```

### DECIMAL Values Returned as Strings

```typescript
const schema = z.object({
  balance: z.string().transform((val) => parseFloat(val)),
});
```

### Schema Parameter is Required

```typescript
// CORRECT - Schema is required
const users = await ctx.integrations.db.query(
  "SELECT * FROM users",
  UserSchema,
);
```

### NULL Handling

```typescript
const schema = z.object({
  name: z.string(),
  bio: z.string().nullable(),
});
```

## Error Handling

```typescript
import { QueryValidationError } from "@superblocksteam/sdk-api";

try {
  const users = await ctx.integrations.db.query(
    "SELECT * FROM users",
    UserSchema,
  );
} catch (error) {
  if (error instanceof QueryValidationError) {
    console.error("Row index:", error.details.rowIndex);
    console.error("Validation errors:", error.details.errors);
  }
}
```

## API Reference

- [CockroachDB Documentation](https://www.cockroachlabs.com/docs/)
- [CockroachDB SQL Reference](https://www.cockroachlabs.com/docs/stable/sql-statements.html)
- [CockroachDB Data Types](https://www.cockroachlabs.com/docs/stable/data-types.html)