spanner-to-tidb-migration

Official

End-to-end Spanner to TiDB migration.

Authorpingcap-inc
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Migrate Cloud Spanner databases to TiDB, providing an end-to-end, phase-driven workflow that guides users from readiness assessment through schema conversion, data loading, and validation.

Core Features & Use Cases

  • End-to-end Spanner to TiDB migration workflow covering connect, scan, assess, score, convert, load, and validate.
  • Interactive, command-driven guidance that responds to user outputs and moves to the next phase.
  • Compatibility assessment with blockers and warnings, plus a formal readiness score and conversion artifacts.
  • DDL conversion rules including interleave flattening to foreign keys, commit-timestamp handling, TTL mapping, and view/function translation; supports multiple TiDB Cloud tiers.
  • Data loading orchestration via Dataflow/GCS and TiDB import/load paths; supports Starter/Essential/Dedicated tiers and CDC-based cutover guidance.
  • Validation and cutover planning, including delta checks and optional change stream configuration.

Quick Start

Follow Phase 1 to connect, then progress through Phase 2, Phase 3, Phase 4, Phase 5, Phase 6, and Phase 7 in sequence.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: spanner-to-tidb-migration
Download link: https://github.com/pingcap-inc/TiShift/archive/main.zip#spanner-to-tidb-migration

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.