rdst 0.1.234

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

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

• Readyset Documentation
• GitHub Repository
• Report Issues

License

MIT License - see LICENSE file for details