User Guides

Task-based guides for common usage scenarios

We recommend running through a get started on your favorite platform before running through user guides.

VSchema and Query Serving

Configuring VSchema for serving queries

• Overview
• Sharding Guidelines
• Unsharded Keyspace
• Sharded Keyspace
• Sequences
• Shared Vindexes and Foreign Keys
• Foreign Keys in Vitess
• Unique Lookup Vindexes
• Non-Unique Lookup Vindexes
• Lookup as Primary Vindex
• More…

Running in Production

Instructions and guidelines for running Vitess in a production environment

• Collations and Character sets
• Planning
• Global TopoServer
• vtctld
• Creating a cell
• Keyspaces and Shards
• VTOrc
• VTTablet and MySQL
• Initialize Shard Primary
• Durability Policy
• More…

Migration

User guides covering data migrations into Vitess

• Migrating Data Into Vitess
• Move Tables
• Materialize
• Troubleshooting

SQL Statement Analysis

User guides covering analyzing SQL statements

• Analyzing a SQL statement using VEXPLAIN
• Analyzing a SQL statement using VTEXPLAIN
• Analyzing SQL statements in bulk using VTEXPLAIN

Advanced Configuration

User guides covering advanced configuration concepts

• User Management and Authentication
• File based authentication
• LDAP authentication
• Authorization
• VTGate Buffering Scenarios
• Resharding
• Reparenting
• Region Based Sharding
• Creating a LookupVindex
• Comment Directives
• More…

Operational

User guides covering operational aspects of Vitess

• Backup and Restore
• Upgrading Vitess

Making Schema Changes

• Unmanaged Schema Changes
• Managed, Online Schema Changes
• Online DDL strategies
• ddl_strategy flags
• Table lifecycle
• Applying, auditing, and controlling Online DDL
• Declarative migrations
• Postponed migrations
• Recoverable, failover agnostic migrations
• Revertible migrations
• More…