sql-db-architecture

A short, useful, and actionable description of your project.

1|Updated Nov 11, 2025
One-click install
npx skills add https://github.com/wcygan/sql-database --skill sql-db-architecture
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sql-db-architecture
Source: https://github.com/wcygan/sql-database/tree/main/.claude/skills/sql-db-architecture
Command: npx skills add https://github.com/wcygan/sql-database --skill sql-db-architecture

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Navigating a complex database codebase, understanding its intricate data flow, and grasping the interactions between various components can be daunting and time-consuming. This Skill acts as an expert guide, providing immediate insights into the sql-database architecture, enabling quick comprehension, efficient debugging, and informed feature planning.

Core Features & Use Cases

  • Crate Responsibility Map: Instantly identify which Rust crate handles specific database functionalities (e.g., parser, planner, storage, wal).
  • Query Execution Data Flow: Visualize the end-to-end journey of SQL queries, from parsing to execution and storage interactions.
  • Key Design Principles: Understand the core architectural decisions, such as WAL-first writes, tiny interfaces, and the Volcano execution model.
  • Use Case: When a user asks "How does index selection work in this database?", this Skill can immediately point to the planner/ crate, explain the rules, and reference relevant code sections, saving hours of manual code exploration.

Quick Start

Explain the data flow for a SELECT query in the sql-database, from SQL string to REPL output.

Frequently Asked Questions about sql-db-architecture

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

FAQPage Schema
How does SQL query execution flow through a database architecture?

Query execution flows through distinct stages: parsing converts the SQL string into an abstract syntax tree, the planner generates an execution strategy, and the executor runs the plan while interacting with storage and indexing layers. Understanding this data flow helps trace where queries are processed across crates.

How do I debug storage and indexing issues in a SQL database?

Map storage and indexing problems to their owning crates—typically the storage and planner crates—then trace how queries interact with indexes during execution. This Skill identifies key types, traits, and interfaces that control index selection and data retrieval.

What are the crate responsibilities in a relational database architecture?

A relational database separates concerns across crates: parser handles SQL syntax, planner manages query strategy, storage manages data persistence, and WAL handles write-ahead logging. Each crate has defined boundaries and interfaces that enable debugging and feature planning.

How do I navigate a complex database codebase efficiently?

Use a crate responsibility map to identify which modules handle specific functions, then follow data flow documentation to understand how components interact. This Skill provides code navigation strategies and key type references to reduce exploration time.

What core design principles govern SQL database architecture?

Key principles include WAL-first writes for durability, tiny interfaces to decouple crates, and the Volcano execution model for query processing. These patterns shape how data flows and inform decisions when planning cross-crate features.