Documentation Index
Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Overview
PlanetScale validates MySQL schema, Vitess VSchema, and routing rule changes before applying them to a production branch. These checks protect deploy requests and imports from changes that Vitess cannot apply safely or that would make data inaccessible after a merge. When a check fails, PlanetScale returns a schema lint error with an error code, a description, and context such as the keyspace, table, column, VSchema JSON path, or vindex name. Use the error-specific pages below with the exact error description shown in the dashboard or API response.Error reference
UNSPECIFIEDNO_UNIQUE_KEYFOREIGN_KEYS_DISALLOWEDINVALID_CHARSETUNSUPPORTED_FEATUREUNSUPPORTED_SHARDED_FEATUREINVALID_VSCHEMADUPLICATE_ENUM_VALUEUNSUPPORTED_PARTITIONING_FEATUREINVALID_TABLE_REFERENCED_IN_VIEWINVALID_COLUMN_REFERENCED_IN_VIEWBLOB_IN_UNIQUE_KEYPARTIAL_KEY_IN_UNIQUE_KEYFOREIGN_KEYS_CIRCULAR_DEPENDENCYFOREIGN_KEYS_NONEXISTENT_TABLEFOREIGN_KEYS_REFERENCED_VIEWFOREIGN_KEYS_UNRESOLVEDINVALID_ROUTING_RULES
General troubleshooting flow
- Read the error description first. It usually names the specific table, column, vindex, JSON path, or routing rule that failed validation.
- Fix the schema or VSchema on a development branch.
- If the fix depends on another object, such as a referenced table or a sequence table, deploy that dependency first.
- Create a new deploy request after the branch schema is valid.