README.md

TQDBProxy Documentation

Welcome to the TQDBProxy documentation. TQDBProxy is a unified data layer that sits between applications and their databases, providing a single intelligent gateway for MariaDB and PostgreSQL.

Index

• Configuration
• System Components
  • Cache
  • Metrics
  • MariaDB Protocol
  • PostgreSQL Protocol
  • SQL Parser
  • Replica Management
  • Write Batching
• Client Libraries
• Special Topics
  • Batch Hint Quick Start
  • Batch Hint Implementation Analysis
  • Production Readiness

---

System Components

TQDBProxy is composed of several modular components:

• Cache: In-memory caching with thundering herd protection using TQMemory.
• Metrics: Collects and exposes Prometheus-compatible metrics.
• MariaDB: Handles the MariaDB-specific wire protocol and query interception.
• PostgreSQL: Handles the PostgreSQL-specific wire protocol and query interception.
• Parser: Extracts metadata and hints from SQL queries.
• Replica: Manages database connection pools and health checks.
• Write Batching: Batches write operations for improved throughput using hint-based grouping.

---

Client Libraries

Currently, TQDBProxy provides client libraries for:

• Go
• PHP
• TypeScript

See the Clients Documentation for usage instructions.