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 and answer your query by writing SQL and analyzing the results.

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

Installation

uv tool install sqlsaber

or

pipx 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 query

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 query "show me all users created this month"

Database Selection

Use a specific database connection:

# Use named database from config
saber query -d mydb "count all orders"

Examples

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

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

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

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

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

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

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

How It Works

SQLSaber uses an intelligent three-step process optimized for minimal token usage:

🔍 Discovery Phase

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

📋 Schema Analysis

  1. Smart Introspection: Analyzes only the specific table structures needed for your query
  2. Selective Loading: Fetches schema information only for relevant tables

⚡ Execution Phase

  1. SQL Generation: Creates optimized SQL queries based on natural language input
  2. Safe Execution: Runs queries with built-in protections against destructive operations
  3. Result Formatting: Presents results with syntax highlighting and explanations

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.2.0.tar.gz (60.4 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.2.0-py3-none-any.whl (44.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sqlsaber-0.2.0.tar.gz
Algorithm Hash digest
SHA256 4fe90f2454551533d3dd1b043c42a4e975edbad0071cd955c513064404e7750c
MD5 03f1002037fd3bce4ce24185890cb534
BLAKE2b-256 b9cfdffba99fa60e0820638671f3c7af36e7810d72511d60dc2989682df8b79f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sqlsaber-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 253a8863123d068a9da0c24466e272daa6126bbafbd1c2528e9804c9fcc7ee10
MD5 953c798a96c85fbc4890e46a3587e89a
BLAKE2b-256 0d821564465485503202a79938aaa7667834c6fc641345b87400f2871305bec1

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