User Guides

Task-based guides for common usage scenarios

VSchema and Query Serving

Configuring VSchema for serving queries

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

Running in Production

Instructions and guidelines for running Vitess in a production environment

• Planning
• Global TopoServer
• vtctld
• Creating a cell
• Keyspaces and Shards
• VTTablet and MySQL
• InitShardPrimary
• vtorc (experimental)
• vtgate
• Backups and Restores
• More…

Migration

User guides covering migration to Vitess

• Migrating data into Vitess
• MoveTables
• Materialize
• Cutover Steps and Troubleshooting

SQL Statement Analysis

User guides covering analyzing SQL statements

• Analyzing a SQL statement
• Analyzing SQL statements in bulk

Advanced Configuration

User guides covering advanced configuration concepts

• User Management and Authentication
• LDAP authentication
• Authorization
• Resharding
• Integration with Orchestrator
• Reparenting
• Region-based Sharding
• CreateLookupVindex
• Tracing
• Unmanaged Tablet
• More…

Operational

User guides covering operational aspects of Vitess

• Backup and Restore
• Upgrading Vitess

Legacy

User guides for features in older version of Vitess

• Horizontal Sharding
• Vertical Split

Making Schema Changes

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