convex-schema-validator

Define and validate typed Convex database schemas with indexes and migrations using v helpers.

Updated Apr 7, 2026
One-click install
npx skills add https://github.com/Yahia89/ordering-food --skill convex-schema-validator-yahia89
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-schema-validator
Source: https://github.com/Yahia89/ordering-food/tree/main/.claude/skills/convex-schema-validator
Command: npx skills add https://github.com/Yahia89/ordering-food --skill convex-schema-validator-yahia89

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Defining and validating extensive Convex database schemas with proper typing, index configuration, optional fields, unions, and migration strategies.

Core Features & Use Cases

  • Define typed tables with convex/server helpers (e.g., v.string(), v.number(), v.id("table")) and relationships.
  • Configure single-field and compound indexes, including search indexes, to optimize common queries.
  • Plan migrations and backfills, enabling schema evolution with safe, versioned changes.

Quick Start

Define a Convex schema using defineSchema and defineTable to model entities, indexes, and migrations.

Frequently Asked Questions about convex-schema-validator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I define and validate Convex schemas with proper typing?

Define Convex schemas using defineSchema and defineTable to model entities with v type helpers like v.string() and v.id("table"). This enforces strict typing for database tables and relationships, ensuring schema validation.

How do I configure indexes in a Convex database schema?

Configure Convex indexes by defining single-field and compound indexes, including search indexes, within your schema definition. This optimizes common database queries and enforces correct index configurations.

What is the best way to plan migrations and backfills for Convex schema evolution?

Plan Convex migrations by applying versioned schema changes with built-in migration guidance. This enables safe schema evolution and backfills, allowing you to add fields and configure indexes while maintaining validation.

How do I handle optional fields and unions when defining Convex schemas?

Handle optional fields and unions in Convex schemas by applying strict schema definitions using v type helpers. This ensures proper validation of extensive database schemas with complex data types.

Can I use this approach to validate relationships between Convex tables?

Yes, you can validate relationships between Convex tables by defining typed tables with v.id("table") helpers. This enforces strict schema definitions for relational data and ensures referential integrity.

Why does my Convex schema validation fail when adding new fields?

Convex schema validation fails when adding fields if strict definitions are not updated with proper v type helpers. Plan migrations and backfills to enable safe schema evolution with versioned changes.