Sharp-DB

A CLI tool and Claude Code Skill for querying databases (PostgreSQL, MySQL, SQLite) and inspecting schema metadata.

Features

• Execute SQL queries and get results as markdown tables
• List tables and views with primary keys, foreign keys, and descriptions
• Inspect table columns with data types, constraints, and foreign key references
• Multi-database support: PostgreSQL, MySQL, SQLite
• Schema-aware: Optional schema filtering for databases that support schemas

Installation

Install skills

npx skills add beginor/sharp-db

Source code

git clone https://github.com/beginor/sharp-db
cd sharp-db
dotnet build src/SharpDb/SharpDb.csproj

The binary is at src/SharpDb/bin/Debug/net10.0/sharp-db.

Usage

Query — Execute SQL

sharp-db query --db-type postgres --connection "host=localhost;port=5432;database=mydb;username=postgres;password=pass" --sql "SELECT id, name FROM users"

Tables — List tables and views

sharp-db tables --db-type postgres --connection "host=localhost;port=5432;database=mydb;username=postgres;password=pass"

Optional --schema parameter to filter by schema:

sharp-db tables --db-type postgres --connection "..." --schema public

Columns — Inspect table columns

sharp-db columns --db-type postgres --connection "..." --table users

Optional --schema parameter:

sharp-db columns --db-type postgres --connection "..." --table users --schema public

Execute — Run a SQL file

Execute a SQL file within a transaction. Requires interactive confirmation before running. Rolls back on error.

sharp-db execute --db-type postgres --connection "..." --file migrate.sql

The tool prompts Execute? [y/N] before running. Only y or yes proceeds; anything else aborts. stdin must be a terminal (redirected stdin is rejected for safety).

As a Claude Code Skill

This project includes a Skill at .claude/skills/sharp-db/SKILL.md. When working in Claude Code, you can use /sharp-db to invoke database queries directly.

Example usage in Claude Code

/sharp-db query --db-type sqlite --connection "Data Source=test.db" --sql "SELECT * FROM users"

Supported databases

Database	Driver	Connection string example
PostgreSQL	Npgsql	host=localhost;port=5432;database=mydb;username=postgres;password=pass
MySQL	MySql.Data	server=localhost;port=3306;database=mydb;user=root;password=pass
SQLite	Microsoft.Data.Sqlite	Data Source=/path/to/db.sqlite

Development

Build

dotnet build

Test

dotnet test

Project structure

src/SharpDb/
├── Metadata/
│   ├── IMetadataProvider.cs         # Provider interface
│   ├── BaseMetadataProvider.cs      # Shared execution logic
│   ├── PostgresMetadataProvider.cs  # PostgreSQL SQL
│   ├── MySQLMetadataProvider.cs     # MySQL SQL
│   ├── SqliteMetadataProvider.cs    # SQLite SQL
│   └── MetadataProviderFactory.cs   # Factory by dbType
├── DatabaseOptions.cs               # Connection parameters
├── DbConnectionFactory.cs           # Connection creation
├── MarkdownTableFormatter.cs        # Result formatting
├── MetadataQueryService.cs          # Metadata queries
├── Program.cs                       # CLI entry point
└── QueryExecutor.cs                 # SQL execution

test/SharpDbTest/
└── QueryExecutorTests.cs            # Tests (SQLite in-memory)

License

MIT