The Vitess Documentation

Everything you need to know about the world’s most scalable open-source MySQL platform

Overview

High-level information about Vitess

• What Is Vitess
• Architecture
• Supported Databases
• Scalability Philosophy
• Cloud Native
• History

Get Started

Deploy Vitess on your favorite platform

• Local Install via Docker
• Local Install
• Local Install via Homebrew
• Vitess Operator for Kubernetes
• Vttestserver Docker Image

Concepts

Learn core Vitess concepts and terminology

• Cell
• Execution Plans
• Keyspace
• Keyspace ID
• MoveTables
• Query Rewriting
• Replication Graph
• Shard
• Tablet
• Topology Service
• More…

User Guides

Task-based guides for common usage scenarios

• VSchema and Query Serving
• Running in Production
• Migration
• SQL Statement Analysis
• Advanced Configuration
• Operational
• Legacy
• Making Schema Changes

Reference

Detailed information about specific Vitess functionality

• Features
• VReplication
• Programs
• Compatibility
• Errors

Contribute

Get involved with Vitess development

• Build on CentOS
• Build on macOS
• Build on Ubuntu/Debian
• Coding Standards
• GitHub Workflow
• References

Design Docs

Collection of design docs for some sections of Vitess

• Query Serving
• Table Lifecycle
• VTTablet
• VReplication
• Build And Process
• Benchmark
• Online DDL Scheduler

Troubleshoot

Debug common issues with Vitess

• Elevated query latency on primary
• Primary starts up read-only
• Vitess sees the wrong tablet as primary

FAQ

Frequently Asked Questions about Vitess

Resources

Additional resources including Presentations and Roadmap

• Presentations and Videos
• Vitess Roadmap

Older Version Docs

PDFs of vitess.io/docs at the time of previous versions