Skip to main content

Readyset Data and SQL Toolkit - CLI tool for database diagnostics and query optimization

Project description

RDST - Readyset Data and SQL Toolkit

A command-line tool for database diagnostics, query analysis, performance tuning, and caching optimization with Readyset.

What is RDST?

RDST helps you:

  • Analyze SQL queries for caching opportunities
  • Identify slow queries in real-time
  • Get optimization suggestions
  • Evaluate query compatibility with Readyset cache
  • Manage database connection profiles

Installation

Using uvx (recommended - no installation required)

Run RDST directly without installing:

uvx rdst --help
uvx rdst analyze "SELECT * FROM users WHERE id = 1"

Using pipx (persistent installation)

Install globally:

# Install
pipx install rdst

# Run
rdst --help

# Upgrade to latest version
pipx upgrade rdst

Using pip

pip install rdst

After installing, run rdst init to configure your first database connection.

Quick Start

  1. Initialize RDST:

    rdst init
    # Or with uvx (no installation needed):
    uvx rdst init
    
  2. Configure database connection:

    rdst configure add-target mydb \
      --host localhost \
      --port 5432 \
      --database myapp \
      --user postgres
    
  3. Analyze queries:

    # Analyze a specific query
    rdst analyze "SELECT * FROM users WHERE active = true"
    
    # With uvx:
    uvx rdst analyze "SELECT * FROM users WHERE active = true"
    
    # Analyze with Readyset cache evaluation
    rdst analyze --readyset-cache "SELECT * FROM products ORDER BY created_at"
    
  4. Monitor slow queries:

    rdst top
    # Or: uvx rdst top
    

Commands

All commands can be run with rdst (if installed) or uvx rdst (no installation):

  • rdst configure - Manage database targets and connection profiles
  • rdst analyze - Analyze SQL queries and evaluate caching opportunities
  • rdst top - Live view of slow queries
  • rdst tune - Get query optimization suggestions
  • rdst query - Manage query registry
  • rdst init - First-time setup wizard
  • rdst version - Show version information

Example with uvx:

uvx rdst analyze "SELECT * FROM orders WHERE status = 'pending'"

Requirements

  • Python 3.11 or higher
  • PostgreSQL or MySQL database access

About Readyset

Readyset is a SQL caching engine that sits between your application and database, automatically caching query results to improve performance. Learn more at readyset.io.

Documentation

License

MIT License - see LICENSE file for details

Project details


Download files

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

Source Distribution

rdst-0.1.766.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

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

rdst-0.1.766-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file rdst-0.1.766.tar.gz.

File metadata

  • Download URL: rdst-0.1.766.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for rdst-0.1.766.tar.gz
Algorithm Hash digest
SHA256 9dbcb6958a034d62e77426166bbf6b1e6c7d63a53371b3beadc86c0c35259174
MD5 39e820b5ae8a495dd0a5e717b8ab76af
BLAKE2b-256 394900753b92ba0a7fee03d124803b917b6c484b9ab31c054af174fddc776407

See more details on using hashes here.

File details

Details for the file rdst-0.1.766-py3-none-any.whl.

File metadata

  • Download URL: rdst-0.1.766-py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for rdst-0.1.766-py3-none-any.whl
Algorithm Hash digest
SHA256 fbac742b5bd3156ae237c469c41f37a4fbcd260def1ed0efe7aba4fbef7ab308
MD5 d6944e16e8efff2ab6aaf384762e049c
BLAKE2b-256 2046a9cae9469398682d72cb237767e5e744aea353356bf2d3ea8f58b156b6e0

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