Skip to content

NarixHine/uni-chem / .agents/skills/prisma-cli

prisma-cli

Verified

Prisma ORM CLI commands reference covering init, generate, migrate, db, dev, studio, validate, format, debug, and mcp. Use for ORM/database CLI workflows, not Prisma Compute app deployment. For Prisma Compute, `@prisma/cli app deploy`, `compute:deploy`, `create-prisma --deploy`, apps, deployments, logs, or domains, use the `prisma-compute` skill instead. Triggers on "prisma init", "prisma generate", "prisma migrate", "prisma db", "prisma studio", "prisma mcp".

FileKindSize
SKILL.mdskill md7.6 KB
references/db-execute.mdmarkdown1.9 KB
references/db-pull.mdmarkdown4.1 KB
references/db-push.mdmarkdown3.1 KB
references/db-seed.mdmarkdown3.5 KB
references/debug.mdmarkdown1.1 KB
references/dev.mdmarkdown2.8 KB
references/format.mdmarkdown1.1 KB
references/generate.mdmarkdown3.7 KB
references/init.mdmarkdown3.5 KB
references/mcp.mdmarkdown1.1 KB
references/migrate-deploy.mdmarkdown2.8 KB
references/migrate-dev.mdmarkdown3.4 KB
references/migrate-diff.mdmarkdown2.2 KB
references/migrate-reset.mdmarkdown1.6 KB
references/migrate-resolve.mdmarkdown1.8 KB
references/migrate-status.mdmarkdown1.6 KB
references/studio.mdmarkdown2.9 KB
references/validate.mdmarkdown964 B

references/db-pull.md

View on GitHub
# prisma db pull

Introspects an existing database and updates your Prisma schema to reflect its structure.

## Command

```bash
prisma db pull [options]
```

## What It Does

- Connects to your database
- Reads the database schema (tables, columns, relations, indexes)
- Updates `schema.prisma` with corresponding Prisma models
- For MongoDB, samples data to infer schema

## Options

| Option                   | Description                                                                             |
| ------------------------ | --------------------------------------------------------------------------------------- |
| `--force`                | Ignore current Prisma schema file                                                       |
| `--print`                | Print the introspected Prisma schema to stdout                                          |
| `--schema`               | Custom path to your Prisma schema                                                       |
| `--config`               | Custom path to your Prisma config file                                                  |
| `--url`                  | Override the datasource URL from the Prisma config file                                 |
| `--composite-type-depth` | Specify the depth for introspecting composite types (default: -1 for infinite, 0 = off) |
| `--schemas`              | Specify the database schemas to introspect                                              |
| `--local-d1`             | Generate a Prisma schema from a local Cloudflare D1 database                            |

## Examples

### Basic introspection

```bash
prisma db pull
```

### Preview without writing

```bash
prisma db pull --print
```

Outputs schema to terminal for review.

### Force overwrite

```bash
prisma db pull --force
```

Replaces schema file, losing any manual customizations.

## Prerequisites

Configure database connection in `prisma.config.ts`:

```typescript
import 'dotenv/config'
import { defineConfig, env } from 'prisma/config'

export default defineConfig({
    schema: 'prisma/schema.prisma',
    datasource: {
        url: env('DATABASE_URL'),
    },
})
```

## Workflow

### Starting from existing database

1. Initialize Prisma:

    ```bash
    prisma init
    ```

2. Configure database URL

3. Pull schema:

    ```bash
    prisma db pull
    ```

4. Review and customize generated schema

5. Generate client:
    ```bash
    prisma generate
    ```

### Syncing changes from database

When database changes are made outside Prisma:

```bash
prisma db pull
prisma generate
```

## Generated Schema Example

Database tables become Prisma models:

```sql
-- Database tables
CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  email VARCHAR(255) UNIQUE NOT NULL,
  name VARCHAR(100)
);

CREATE TABLE posts (
  id SERIAL PRIMARY KEY,
  title VARCHAR(255) NOT NULL,
  author_id INTEGER REFERENCES users(id)
);
```

Becomes:

```prisma
model users {
  id    Int     @id @default(autoincrement())
  email String  @unique @db.VarChar(255)
  name  String? @db.VarChar(100)
  posts posts[]
}

model posts {
  id        Int    @id @default(autoincrement())
  title     String @db.VarChar(255)
  author_id Int?
  users     users? @relation(fields: [author_id], references: [id])
}
```

## Post-Introspection Cleanup

After `db pull`, consider:

1. **Rename models** to PascalCase:

    ```prisma
    model User {  // Was: users
      @@map("users")
    }
    ```

2. **Rename fields** to camelCase:

    ```prisma
    authorId Int? @map("author_id")
    ```

3. **Add relation names** for clarity:

    ```prisma
    author User? @relation("PostAuthor", fields: [authorId], references: [id])
    ```

4. **Add documentation**:
    ```prisma
    /// User account information
    model User {
      /// Primary email for authentication
      email String @unique
    }
    ```

## MongoDB Introspection

For MongoDB, `db pull` samples documents to infer schema:

```bash
prisma db pull
```

May require manual refinement since MongoDB is schemaless.

## Warning

`db pull` overwrites your schema file. Always:

- Commit current schema before pulling
- Use `--print` to preview first
- Backup customizations you want to keep
finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the workStars: 322kUpdated Claude CodeCodexVerifiedInstall
systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixesStars: 322kUpdated Claude CodeCodexVerifiedInstall
test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation codeStars: 322kUpdated Claude CodeCodexVerifiedInstall
skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.Stars: 198kUpdated Claude CodeCodexVerifiedInstall