splurge-sql-runner 2025.5.0

A Python utility for executing SQL files against databases with support for multiple statements, comments, and pretty-printed results

splurge-sql-runner

A robust, secure, and user-friendly Python utility for executing SQL files against databases with support for multiple statements, comments, and formatted results.

✨ Key Features

• 🔧 Multi-Statement Execution: Process SQL files containing multiple statements
• 🗄️ Database Agnostic: Support for SQLite, PostgreSQL, MySQL, Oracle, and more
• 🔒 Security First: Configurable validation for SQL content and database URLs
• 📊 Smart Output: Pretty tables, JSON format, and verbose logging
• ⚙️ Flexible Configuration: CLI args, JSON files, and environment variables
• 🛡️ Error Recovery: Continue processing on errors with detailed reporting

🚀 Quick Start

Installation

pip install splurge-sql-runner

Basic Usage

# Execute a single SQL file
splurge-sql-runner -c "sqlite:///database.db" -f "script.sql"

# Execute multiple SQL files using a pattern
splurge-sql-runner -c "sqlite:///database.db" -p "*.sql"

# With verbose output
splurge-sql-runner -c "sqlite:///database.db" -f "script.sql" -v

# JSON output for scripting
splurge-sql-runner -c "sqlite:///database.db" -f "query.sql" --json

📚 Documentation

• 📖 Detailed Documentation - Complete feature guide, configuration options, and examples
• 🔧 CLI Reference - Comprehensive command-line options and usage
• 📋 Changelog - Version history and release notes

📋 Requirements

• Python: 3.10 or higher
• SQLAlchemy: Database connectivity
• splurge-safe-io: Secure file I/O operations

🤝 Contributing

We welcome contributions! Please see our detailed documentation for development setup and contribution guidelines.

📄 License

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

---

For the complete documentation, visit docs/README-DETAILS.md