Official ProxySQL Documentation
ProxySQL is a high-performance, high-availability, protocol-aware proxy for MySQL, PostgreSQL, and their forks and variants.
Quick Guides
These introductory guides for new users to ProxySQL, cover basic configuration concepts and primary use cases.
- Download and Install ProxySQL
- First steps after installing
- MySQL Users - How to configure ProxySQL for the first time
- PostgreSQL Users How to configure ProxySQL for the first time
- How to set up ProxySQL for Read/Write Spliting
- How to set up ProxySQL Sharding
Reference Manual
The Basics
Core foundational documentation:
- Multi Layer Configuration System
- Configuration file
- Startup options
- Backend Server Configuration
- MySQL Backend Server Monitoring
- PostgreSQL Backend Server Monitoring
- Global Variables
- Error Log
- Query Rewrite
Security
Configuration topics for ProxySQL security functions:
- User configuration
- Password management
- Authentication methods
- SSL configuration
- SPIFFE configuration
- Audit Logging
- Firewall Whitelisting
- SQL Injection Engine
Features
Advanced functionality documentation:
- Connection Multiplexing
- ProxySQL Cluster
- Query Cache
- Query Logging
- Advanced Event and Query Logging
- Query Annotations
- Prepared Statement Caching
- Mirroring
- Scheduler
- HTTP Web UI Statistic Graphs
- ProxySQL REST API
- ProxySQL Threads
- Thread Watchdog
- Client Error Limit
- MySQL BinLog Reader
- DNS Cache
- Prometheus Exporter
- ProxySQL Bootstrap Mode
- ProxySQL Internal Session
- Coredumper Support
- PostgreSQL Extended Query Protocol
- PostgreSQL Prepared Statement Cache
- Applying Query Rules in Extended Query Protocol
- Proxy Protocol
ProxySQL Admin
Configuration management via ProxySQL Admin DB:
- ProxySQL Configuration CLI
- Main (runtime) tables
- Disk (persisted)
- Stats (statistics)
- Stats (history)
Miscellaneous
- Information about MySQL 8.0
- ProxySQL Design Goals
- Packaging ProxySQL
- Version Checking
- ProxySQL Admin Backups
- Memory Leak Detection
- Error Codes
- Frequently Asked Questions
Commercial Support
| Service | Description |
|---|---|
| Enterprise Support | SLA-backed support with defined response times |
| DBRE Services | Dedicated database reliability engineering |
| Consulting | Architecture reviews and migration planning |
| Training | Structured programs for engineering teams |
| Feature Development | Custom feature development |
Complete Documentation Index
Guides
- Download & Install
- Step-by-Step Installation
- First Steps
- First-Time MySQL Configuration
- Read/Write Split
- Sharding
- ClickHouse Configuration
- DNS Cache
Configuration System
- Configuring ProxySQL
- Multi-Layer Configuration System
- The ProxySQL Configuration File
- ProxySQL Startup Options
- Bootstrap Mode
- ProxySQL Internal Session
- Backend Server Configuration
- Main Runtime
- Configuration Tables
- MCP Tables
MySQL
- MySQL Tables
- MySQL Variables
- MySQL Monitor Variables
- MySQL Monitor Module
- MySQL Users Management
- MySQL Password Management
- MySQL Authentication
- Galera
- Group Replication
- AWS Aurora
- Prepared Statements Architecture
- Prepared Statements Lifecycle
- Prepared Statements Pooling & Caching
PostgreSQL
- How to Configure ProxySQL for PostgreSQL
- PostgreSQL Extended Query
- PostgreSQL Tables
- PostgreSQL Variables
- PostgreSQL Monitor Variables
- PostgreSQL Monitor Module
- PostgreSQL Users Management
- PostgreSQL Authentication
- Extended Query Protocol
- Applying Query Rules in Extended Query Protocol
- PostgreSQL Prepared Statement Cache
- Extended Query Architecture
- Extended Query Lifecycle
- Extended Query Pooling & Caching
Generative AI
- RAG Overview
- Full-Text Search (FTS)
- MCP Autodiscovery
- MCP Catalog
- MCP Endpoints
- MCP Integration
- MCP Query Tools
- MCP RAG Tools
- MCP Server
- MCP Stats
- Natural Language To SQL (NL2SQL)
- RAG Ingest CLI
- Upcoming MCP Tools
ProxySQL Admin
Stats / Statistics
Security
- Security Overview
- User Configuration
- Authentication Methods
- SSL Configuration
- SPIFFE Configuration
- Audit Logging
- Firewall Whitelisting
- SQL Injection Engine
ProxySQL Cluster
Query Handling
Prepared Statements
Features
- Client Error Limit
- ProxySQL Threads
- Watchdog
- Fast Forward Traffic Observer (FFTO)
- HTTP Web Server
- REST API
- Scheduler
- SQLite3 Server
MySQL Binlog Reader
Jemalloc
Coredumper Support
Proxy Protocol
Monitoring & Stats
Error Log
Global Variables
- Admin Variables
- Global Variables
- Global Variables Quick Reference
- MCP Variables
- SQLite3 Server Variables