Insomma CLI Tool

AI-powered CLI tool to generate ORM schemas from PostgreSQL and MySQL databases using advanced language models.

Features

• Multi-Database Support: Works with both PostgreSQL and MySQL databases
• Multi-ORM Support: Generate schemas for Prisma, TypeORM, Drizzle, and Zod
• Complete Metadata Extraction: Tables, columns, relationships, indexes, enums, and constraints
• AI-Powered Generation: Uses Meta's Llama 3.3 70B model via DeepInfra
• Auto-Detection: Automatically detects database type from connection string
• Flexible Output: Write to file or output to stdout
• Connection Testing: Verify database connectivity before processing
• Comprehensive CLI: Multiple commands for different use cases

Installation

Global Installation

1npm install -g insomma

Run with npx

1npx insomma --help

Run with bunx

1bunx insomma --help

Setup

Get DeepInfra API Key

1. Sign up at DeepInfra
2. Get your API key from the dashboard
3. Set it as an environment variable or pass it as an option

Set Environment Variable (Recommended)

1export DEEPINFRA_API_KEY="your-api-key-here"

Usage

PostgreSQL Examples

Basic Schema Generation

1insomma \
2  --connection "postgres://user:password@localhost:5432/mydb" \
3  --orm prisma \
4  --output schema.prisma

Generate TypeORM Entities

1insomma \
2  --connection "postgres://user:pass@host:port/db" \
3  --orm typeorm \
4  --output entities.ts

MySQL Examples

Basic Schema Generation

1insomma \
2  --connection "mysql://user:password@localhost:3306/mydb" \
3  --orm prisma \
4  --output schema.prisma

Generate Drizzle Schema

1insomma \
2  --connection "mysql://user:pass@host:port/db" \
3  --orm drizzle \
4  --output schema.ts

Universal Examples

Generate Zod Validation Schemas

1insomma \
2  --connection "postgres://user:pass@host:port/db" \
3  --orm zod \
4  --output validations.ts

Output to Console

1insomma \
2  --connection "mysql://user:pass@host:port/db" \
3  --orm prisma

Specify Database Type Explicitly

1insomma \
2  --connection "some-custom-connection-string" \
3  --type mysql \
4  --orm prisma

Test Database Connection

1# Auto-detect database type
2insomma test-connection \
3  --connection "postgres://user:pass@host:port/db"
4
5# Specify database type
6insomma test-connection \
7  --connection "mysql://user:pass@host:port/db" \
8  --type mysql

List Database Tables

1# PostgreSQL
2insomma list-tables \
3  --connection "postgres://user:pass@host:port/db"
4
5# MySQL
6insomma list-tables \
7  --connection "mysql://user:pass@host:port/db"

Command Options

Main Command

• -c, --connection <string> - Database connection string (required)
• -t, --type <string> - Database type (postgres, mysql, auto) [default: auto]
• -o, --orm <string> - Target ORM (prisma, typeorm, drizzle, zod) [default: prisma]
• -f, --output <string> - Output file path (optional)
• --api-key <string> - DeepInfra API key (optional if env var set)
• --verbose - Enable verbose logging

Test Connection Command

• -c, --connection <string> - Database connection string (required)
• -t, --type <string> - Database type (postgres, mysql, auto) [default: auto]

List Tables Command

• -c, --connection <string> - Database connection string (required)
• -t, --type <string> - Database type (postgres, mysql, auto) [default: auto]

Connection String Formats

PostgreSQL

postgres://username:password@hostname:port/database
postgresql://username:password@hostname:port/database

Examples:

1# Local database
2postgres://postgres:password@localhost:5432/myapp
3
4# Remote database
5postgres://user:pass@db.example.com:5432/production
6
7# With SSL
8postgres://user:pass@host:5432/db?sslmode=require

MySQL

mysql://username:password@hostname:port/database

Examples:

1# Local database
2mysql://root:password@localhost:3306/myapp
3
4# Remote database
5mysql://user:pass@db.example.com:3306/production
6
7# With SSL
8mysql://user:pass@host:3306/db?ssl=true

Database Type Detection

The tool automatically detects the database type from the connection string:

• PostgreSQL: Detected by postgres://, postgresql:// prefixes or port :5432
• MySQL: Detected by mysql:// prefix or port :3306
• Manual Override: Use --type option to specify explicitly

Supported ORMs

Prisma

Generates complete Prisma schema with:

• Generator and datasource blocks (PostgreSQL/MySQL specific)
• Proper data type mappings for each database
• Relationships with @relation
• Constraints and indexes
• Database-specific features

TypeORM

Generates TypeScript entity classes with:

• Proper decorators (@Entity, @Column, etc.)
• Database-specific type mappings
• Relationship definitions
• Column constraints
• Auto-increment handling

Drizzle

Generates Drizzle schema with:

• Database-specific imports (pg-core/mysql-core)
• Table definitions using pgTable/mysqlTable
• Proper column types for each database
• Foreign key relationships
• Constraints and indexes

Zod

Generates validation schemas with:

• Type-safe validations
• Database-appropriate Zod types
• Optional/required field handling
• Custom validations
• Database-specific field handling

Examples by Database

E-commerce PostgreSQL to Prisma

1insomma \
2  --connection "postgres://admin:secret@localhost:5432/ecommerce" \
3  --orm prisma \
4  --output prisma/schema.prisma \
5  --verbose

Blog MySQL to TypeORM

1insomma \
2  --connection "mysql://blogger:pass123@blog-db:3306/blog" \
3  --orm typeorm \
4  --output src/entities/index.ts

Analytics PostgreSQL to Drizzle

1insomma \
2  --connection "postgres://analyst:data@analytics.internal:5432/metrics" \
3  --orm drizzle \
4  --output lib/schema.ts

CRM MySQL to Zod

1insomma \
2  --connection "mysql://crm:secure@crm.company.com:3306/customer_data" \
3  --orm zod \
4  --output lib/validations.ts

Metadata Extraction

The tool extracts comprehensive database metadata including:

PostgreSQL

• Tables: Names, schemas, comments
• Columns: Data types, constraints, defaults, comments
• Relationships: Foreign keys with cascade rules
• Indexes: Custom indexes (excluding primary keys)
• Enums: PostgreSQL enum types and values
• Constraints: Primary keys, unique constraints, check constraints

MySQL

• Tables: Names, schemas, comments
• Columns: Data types, constraints, defaults, comments, auto-increment
• Relationships: Foreign keys with cascade rules
• Indexes: Custom indexes (excluding primary keys)
• Enums: ENUM and SET column types
• Constraints: Primary keys, unique constraints

Database-Specific Features

PostgreSQL Features

• Full schema support
• Custom enum types
• Advanced constraint types
• UUID and serial types
• JSONB support

MySQL Features

• Auto-increment columns
• ENUM and SET types
• Unsigned integer types
• MySQL-specific data types
• Storage engine considerations

Error Handling

The tool provides clear error messages for:

• Invalid connection strings
• Unsupported database types
• Network connectivity issues
• API authentication problems
• Unsupported database features
• File system permissions

Troubleshooting

Connection Issues

1# Test your connection first
2insomma test-connection --connection "your-connection-string"
3
4# Specify database type if auto-detection fails
5insomma test-connection --connection "your-connection-string" --type mysql

Database Type Detection Issues

1# Force database type
2insomma --type postgres --connection "..." --orm prisma
3insomma --type mysql --connection "..." --orm prisma

API Key Issues

1# Verify your API key is set
2echo $DEEPINFRA_API_KEY
3
4# Or pass it directly
5insomma --api-key "your-key" --connection "..." --orm prisma

Verbose Logging

1# Enable verbose output for debugging
2insomma --verbose --connection "..." --orm prisma

Requirements

• Node.js 16 or higher
• PostgreSQL or MySQL database access
• DeepInfra API key
• Internet connection for AI generation

Supported Database Versions

PostgreSQL

• PostgreSQL 10+
• All major cloud providers (AWS RDS, Google Cloud SQL, Azure Database)

MySQL

• MySQL 5.7+
• MySQL 8.0+
• MariaDB 10.3+
• All major cloud providers (AWS RDS, Google Cloud SQL, Azure Database)

License

MIT License - see LICENSE file for details.