psqlc

User Guide

  • Installation
    • System Requirements
    • Installation Methods
      • Using pip (Recommended)
      • From Source
      • Development Installation
    • Dependencies
      • Core Dependencies
      • Optional Dependencies
    • Verifying Installation
    • Configuration Files
    • Troubleshooting
      • Common Issues
    • Uninstallation
    • Next Steps
  • Quick Start
    • First Command
    • Common Workflows
      • 1. Create New User and Database
      • 2. View Database Information
      • 3. Execute Queries
      • 4. Monitor Connections
      • 5. Manage Users
      • 6. Database Backup
    • Using Auto-Detection
      • From Django Settings
      • From .env Files
      • From JSON/YAML Config
    • Command-Line Options
      • Global Options
      • Database-Specific Options
      • Examples with Options
    • Best Practices
    • Quick Reference
    • Next Steps
  • Contributing
    • Development Setup
    • Running Tests
    • Code Style
    • Building Documentation
    • Pull Requests
    • Guidelines
    • Bug Reports
    • Feature Requests
    • License
    • MIT License
  • Commands
    • Command Overview
    • Show Commands
      • show dbs
      • show tables
      • show users
      • show connections
      • show indexes
      • show size
    • Create Commands
      • create
    • Query Commands
      • describe
      • query
    • Backup Commands
      • backup
    • Drop Commands
      • drop database
      • drop user
    • Global Options
      • Connection Options
      • Debug Options
    • Environment Variables
    • Auto-Detection
    • Error Handling
  • Examples
    • Real-World Usage Examples
      • Django Project Setup
      • Production Database Management
      • Data Analysis
      • Database Migration
      • Multi-Database Management
      • Performance Monitoring
      • Automated Backup Script
      • Development Workflow
      • CI/CD Integration
      • Docker Integration
    • Troubleshooting Common Issues
      • Connection Issues
      • Permission Issues
      • Large Database Queries
    • Performance Tips

API Reference

  • API Modules
    • backup_database()
    • create_user_db()
    • describe_table()
    • drop_database()
    • drop_user()
    • execute_query()
    • find_settings_recursive()
    • get_connection()
    • get_db_config_or_args()
    • get_version()
    • load_settings_from_path()
    • main()
    • parse_django_settings()
    • print_exception()
    • rich_print()
    • show_connections()
    • show_databases()
    • show_indexes()
    • show_size()
    • show_tables()
    • show_users()
    • Core Functions
      • Connection Management
        • get_connection()
        • get_db_config_or_args()
      • Configuration
        • parse_django_settings()
        • find_settings_recursive()
        • load_settings_from_path()
      • Database Operations
        • show_databases()
        • show_tables()
        • show_users()
        • show_connections()
        • show_indexes()
        • show_size()
      • Query Operations
        • describe_table()
        • execute_query()
      • Management Operations
        • create_user_db()
        • drop_database()
        • drop_user()
        • backup_database()
      • Utility Functions
        • rich_print()
        • print_exception()
        • get_version()

Additional Information

  • Changelog
    • Version 1.0.6 (2025-11-20)
      • Major Release
        • New Features
        • Commands Added
        • Improvements
    • Version 1.0 (2024-10-14)
      • Initial Release
  • Contributing
    • Development Setup
    • Running Tests
    • Code Style
    • Building Documentation
    • Pull Requests
    • Guidelines
    • Bug Reports
    • Feature Requests
    • License
  • License
    • MIT License
psqlc
  • Search

© Copyright 2025, Hadi Cahyadi.

Built with Sphinx using a theme provided by Read the Docs.