system-table-change

Guide schema, migration, and golden file updates for CockroachDB system tables.

32.4k|4.1k|Updated Feb 6, 2014
One-click install
npx skills add https://github.com/cockroachdb/cockroach --skill system-table-change
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: system-table-change
Source: https://github.com/cockroachdb/cockroach/tree/main/.claude/skills/system-table-change
Command: npx skills add https://github.com/cockroachdb/cockroach --skill system-table-change

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive checklist to prevent errors and ensure all necessary files and artifacts are updated when modifying system tables in CockroachDB, thus avoiding confusing test failures.

Core Features & Use Cases

  • Systematic Checklist: Guides users through updating schema definitions, registering new tables, managing version gates, and handling migrations.
  • Golden File Regeneration: Details the process for regenerating critical golden files that represent serialized schema and test data.
  • Use Case: When a developer needs to add a new column to the users system table, this Skill ensures they update the schema string, descriptor literal, version gates, migration scripts, and all relevant golden test files in a coordinated manner.

Quick Start

Use the system-table-change skill to ensure all artifacts are updated when modifying system tables.

Frequently Asked Questions about system-table-change

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

FAQPage Schema
How do I change system table schema in CockroachDB?

To change system table schema in CockroachDB, you must update schema definitions, descriptor literals, version gates, migration scripts, and golden files in a coordinated manner to maintain consistency and avoid test failures.

Why do I get confusing test failures after a CockroachDB system table migration?

Confusing test failures after a CockroachDB system table migration usually happen when serialized schema representations and golden test files are not regenerated to match the new schema definitions and descriptor literals.

What do I need to update when adding a column to a CockroachDB system table?

When adding a column to a CockroachDB system table, you need to update the schema string, descriptor literal, version constants, migration scripts, and regenerate all relevant golden test artifacts.

When do I need to regenerate golden files for CockroachDB system tables?

You need to regenerate golden files for CockroachDB system tables whenever you modify schema definitions or descriptor literals, ensuring serialized schema and test data artifacts accurately reflect the latest distributed database system table changes.

Does CockroachDB system table change require version gate management?

Yes, CockroachDB system table changes require version gate management to ensure synchronized schema updates across the distributed database, preventing inconsistencies between new migrations and existing system table descriptors.

What is the best way to manage schema consistency for database migrations?

The best way to manage schema consistency for database migrations is to follow a systematic checklist that coordinates updates across schema definitions, version gates, migration scripts, and golden test files.