Skip to main content

CLI for QueryShield

Project description

queryshield

Command-line tool for database query performance analysis.

Analyze Django, SQLAlchemy, and FastAPI applications for N+1 queries, missing indexes, slow queries, and other performance issues.

Installation

pip install queryshield

Quick Start

# Analyze Django tests
queryshield analyze --framework django

# With API key to upload to SaaS
queryshield analyze --framework django --api-key sk_xxx

# Monitor production queries
queryshield production-monitor

Features

  • Multi-framework support (Django, SQLAlchemy, FastAPI)
  • N+1 query detection
  • EXPLAIN plan analysis
  • Query budget enforcement
  • SaaS integration for report storage
  • Production query monitoring
  • Performance regression detection
  • AI-powered root cause analysis

Configuration

Create a queryshield.yml in your project root:

version: 1

# Test mode configuration
test:
  budget:
    query_count: 50
    total_time_ms: 1000
  enabled: true

# Production monitoring configuration
production:
  sample_rate: 0.01
  slow_query_threshold_ms: 500
  api_key: sk_xxx
  enabled: true

Commands

  • queryshield analyze - Analyze test queries
  • queryshield production-monitor - Start production monitoring daemon
  • queryshield config - Show current configuration

Documentation

See the main QueryShield documentation for more information.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

queryshield-0.3.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file queryshield-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: queryshield-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for queryshield-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b606dfd3ad6a7f6711deb9c55070ea12e731d08051c7c9c064f496215b1a1fc
MD5 1b411649f8300cb8ec6013f92b2e23e6
BLAKE2b-256 a4359cf60e457ace4ef7dd7affcec1a573903ff4a7bfef6dc983acb424bac2e1

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