Skip to main content

SQLSaber - Agentic SQL assistant like Claude Code

Project description

SQLSaber

Use the agent Luke!

SQLSaber is an agentic SQL assistant. Think Claude Code but for SQL.

Ask your questions in natural language and it will gather the right context automatically and answer your query by writing SQL and analyzing the results.

Table of Contents

Features

  • Natural language to SQL conversion
  • 🔍 Automatic database schema introspection
  • 🛡️ Safe query execution (read-only by default)
  • 🧠 Memory management
  • 💬 Interactive REPL mode
  • 🎨 Beautiful formatted output with syntax highlighting
  • 🗄️ Support for PostgreSQL, SQLite, and MySQL
  • 🔌 MCP (Model Context Protocol) server support

Installation

uv

uv tool install sqlsaber

pipx

pipx install sqlsaber

brew

brew install uv
uv tool install sqlsaber

Configuration

Database Connection

Set your database connection URL:

saber db add DB_NAME

This will ask you some questions about your database connection

AI Model Configuration

SQLSaber uses Sonnet-4 by default. You can change it using:

saber models set

# for more model settings run:
saber models --help

Memory Management

You can add specific context about your database to the model using the memory feature. This is similar to how you add memory/context in Claude Code.

saber memory add 'always convert dates to string for easier formating'

View all memories

saber memory list

You can also add memories in an interactive query session by starting with the # sign

Usage

Interactive Mode

Start an interactive session:

saber

You can also add memories in an interactive session by starting your message with the # sign

Single Query

Execute a single natural language query:

saber "show me all users created this month"

You can also pipe queries from stdin:

echo "show me all users created this month" | saber
cat query.txt | saber

Database Selection

Use a specific database connection:

# Interactive mode with specific database
saber -d mydb

# Single query with specific database
saber -d mydb "count all orders"

Examples

# Show database schema
saber "what tables are in my database?"

# Count records
saber "how many active users do we have?"

# Complex queries with joins
saber "show me orders with customer details for this week"

# Aggregations
saber "what's the total revenue by product category?"

# Date filtering
saber "list users who haven't logged in for 30 days"

# Data exploration
saber "show me the distribution of customer ages"

# Business analytics
saber "which products had the highest sales growth last quarter?"

# Start interactive mode
saber

MCP Server Integration

SQLSaber includes an MCP (Model Context Protocol) server that allows AI agents like Claude Code to directly leverage tools available in SQLSaber.

Starting the MCP Server

Run the MCP server using uvx:

uvx --from sqlsaber saber-mcp

Configuring MCP Clients

Claude Code

Add SQLSaber as an MCP server in Claude Code:

claude mcp add -- uvx --from sqlsaber saber-mcp

Other MCP Clients

For other MCP clients, configure them to run the command: uvx --from sqlsaber saber-mcp

Available MCP Tools

Once connected, the MCP client will have access to these tools:

  • get_databases() - Lists all configured databases
  • list_tables(database) - Get all tables in a database with row counts
  • introspect_schema(database, table_pattern?) - Get detailed schema information
  • execute_sql(database, query, limit?) - Execute SQL queries (read-only)

The MCP server uses your existing SQLSaber database configurations, so make sure to set up your databases using saber db add first.

How It Works

SQLSaber uses a multi-step process to gather the right context, provide it to the model, and execute SQL queries to get the right answers:

🔍 Discovery Phase

  1. List Tables Tool: Quickly discovers available tables with row counts
  2. Pattern Matching: Identifies relevant tables based on your query

📋 Schema Analysis

  1. Smart Schema Introspection: Analyzes only the specific table structures needed for your query

⚡ Execution Phase

  1. SQL Generation: Creates optimized SQL queries based on natural language input
  2. Safe Execution: Runs read-only queries with built-in protections against destructive operations
  3. Result Formatting: Presents results with explanations in tables and optionally, visualizes using plots

Contributing

Contributions are welcome! Please feel free to open an issue to discuss your ideas or report bugs.

License

This project is licensed under Apache-2.0 License - see the LICENSE file for details.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqlsaber-0.11.0.tar.gz (263.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqlsaber-0.11.0-py3-none-any.whl (71.8 kB view details)

Uploaded Python 3

File details

Details for the file sqlsaber-0.11.0.tar.gz.

File metadata

  • Download URL: sqlsaber-0.11.0.tar.gz
  • Upload date:
  • Size: 263.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.20

File hashes

Hashes for sqlsaber-0.11.0.tar.gz
Algorithm Hash digest
SHA256 fb7d32a1620e91e06c54b2a9d34a3e12a62d07db1e8f77454845ffb45c694fbb
MD5 1b378b307bc9314418c0559ba3e871e2
BLAKE2b-256 cfdf7896de6704f41ffbba5c85bb087f2c31ad1c135336a743d14461262adad0

See more details on using hashes here.

File details

Details for the file sqlsaber-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: sqlsaber-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 71.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.20

File hashes

Hashes for sqlsaber-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b148e9aaa7a5fab21742a3ada6ec9c87052fd13dd21f5ce941cd470ad46bfcca
MD5 9d15262aafd08a4c5a55da0dfcac54a3
BLAKE2b-256 a8dd2b55bd1f860e155329fba16451088b959894edd4a53a65d02d8a114a1c85

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page