extract-schema

Extract database schemas into Starlake YAML configuration files.

209|30|Updated Sep 18, 2021

Search Tags:#automation #database #schema #migration #yaml #extract #starlake

Ready to run

npx skills add https://github.com/starlake-ai/starlake --skill extract-schema

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: extract-schema
Source: https://github.com/starlake-ai/starlake/tree/main/.agent/skills/extract-schema
Command: npx skills add https://github.com/starlake-ai/starlake --skill extract-schema

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Extract and generate YAML configurations from an existing database schema to bootstrap Starlake pipelines, saving manual configuration effort.

Core Features & Use Cases

Extracts database schemas and converts them into Starlake YAML configuration files.
Supports selective or full schema extraction for loading into a data catalog and deployment pipelines.
Use case: onboarding a new database, quickly generate YAML definitions for tables, columns, and constraints.

Quick Start

Run the extract-schema command against your database and output the YAML files to your target folder.

Frequently Asked Questions about extract-schema

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

FAQPage Schema

How do I extract a database schema into YAML configuration files?▼

Schema extraction converts an existing database structure into YAML definitions by reading table metadata and generating configuration files, saving manual configuration effort when onboarding new databases into Starlake pipelines.

Can I extract schemas for specific tables instead of an entire database?▼

Selective schema extraction is supported through the --tables CLI option, allowing you to target specific tables instead of an entire database, while --connectionRef and --config options manage the database connection details.

How do I control where the extracted YAML files are saved?▼

The --outputDir CLI option specifies the target folder where extracted YAML configuration files are written, ensuring the generated table and column definitions are organized in your desired directory structure.

What is the best way to automate schema migration for multiple databases?▼

Using the --parallelism CLI option allows concurrent schema extraction across multiple databases, generating YAML definitions for tables and constraints efficiently to streamline large-scale data onboarding workflows.

Do I need a specific database connection setup to extract schemas to YAML?▼

Schema extraction requires a valid database connection established through the --connectionRef option and a --config file, enabling the tool to read source metadata and generate accurate YAML definitions.