# njrslv/bustub architecture

> Architecture diagram of the GitHub repository njrslv/bustub, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/njrslv/bustub
- Repository: https://github.com/njrslv/bustub

## Overview

##### Main Components Identification
The system should be divided into these key layers:

a) Query Processing Layer:
- Binder (/src/binder)
- Planner (/src/planner)
- Optimizer (/src/optimizer)
- Execution (/src/execution)

b) Storage Layer:
- Buffer Management (/src/buffer)
- Storage Management (/src/storage)
- Index Structures (/src/storage/index)

c) Concurrency Control:
- Transaction Management (/src/concurrency)
- Lock Management (/src/concurrency)

d) Catalog Management:
- Schema Management (/src/catalog)
- Table Management (/src/catalog)

##### Component Relationships

**SQL Query → Binder → Planner → Optimizer → Execution Engine**
- ↓
- Storage Layer
- ↙     ↓    ↘
- Buffer   Index   Table
- ↓       ↓       ↓
- Disk Manager Layer

##### Specific Implementation Details

Key architectural elements:
- B+ Tree Implementation (/src/storage/index/b_plus_tree.cpp)
- Buffer Pool Manager (/src/buffer/buffer_pool_manager.cpp)
- Execution Engine Components (/src/execution/executors/*)
- Transaction Manager (/src/concurrency/transaction_manager.cpp)

##### Component Interactions

Critical paths:
**Query Execution Flow:**
**SQL Query → Parser → Binder → Planner → Optimizer → Executor**
- ↓
- Buffer Manager
- ↓
- Storage Engine

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Query Processing Layer"
        SQL[SQL Query]
        Binder[Binder]:::queryproc
        Planner[Planner]:::queryproc
        Optimizer[Optimizer]:::queryproc
        ExecEngine[Execution Engine]:::queryproc
    end

    subgraph "Storage Layer"
        BufferMgr[Buffer Manager]:::storage
        StorageMgr[Storage Manager]:::storage
        IndexStruct[Index Structures]:::storage
        BPTree[B+ Tree]:::storage
        TableHeap[Table Heap]:::storage
    end

    subgraph "Concurrency Control"
        TransMgr[Transaction Manager]:::concurrency
        LockMgr[Lock Manager]:::concurrency
    end

    subgraph "Catalog Management"
        SchemaMgr[Schema Manager]:::catalog
        TableMgr[Table Manager]:::catalog
    end

    subgraph "Disk Layer"
        DiskMgr[Disk Manager]:::disk
    end

    SQL --> Binder
    Binder --> Planner
    Planner --> Optimizer
    Optimizer --> ExecEngine
    ExecEngine --> BufferMgr
    ExecEngine --> IndexStruct
    ExecEngine --> TableHeap

    BufferMgr --> DiskMgr
    StorageMgr --> DiskMgr
    IndexStruct --> BPTree
    BPTree --> BufferMgr
    TableHeap --> BufferMgr

    ExecEngine <--> TransMgr
    TransMgr <--> LockMgr
    ExecEngine <--> SchemaMgr
    SchemaMgr <--> TableMgr

    %% Component Mappings
    click Binder "https://github.com/NJrslv/bustub/tree/master/src/binder/"
    click Planner "https://github.com/NJrslv/bustub/tree/master/src/planner/"
    click Optimizer "https://github.com/NJrslv/bustub/tree/master/src/optimizer/"
    click ExecEngine "https://github.com/NJrslv/bustub/tree/master/src/execution/"
    click BufferMgr "https://github.com/NJrslv/bustub/blob/master/src/buffer/buffer_pool_manager.cpp"
    click StorageMgr "https://github.com/NJrslv/bustub/tree/master/src/storage/"
    click IndexStruct "https://github.com/NJrslv/bustub/tree/master/src/storage/index/"
    click BPTree "https://github.com/NJrslv/bustub/blob/master/src/storage/index/b_plus_tree.cpp"
    click TransMgr "https://github.com/NJrslv/bustub/blob/master/src/concurrency/transaction_manager.cpp"
    click LockMgr "https://github.com/NJrslv/bustub/blob/master/src/concurrency/lock_manager.cpp"
    click SchemaMgr "https://github.com/NJrslv/bustub/blob/master/src/catalog/schema.cpp"
    click TableMgr "https://github.com/NJrslv/bustub/blob/master/src/catalog/table_generator.cpp"
    click TableHeap "https://github.com/NJrslv/bustub/blob/master/src/storage/table/table_heap.cpp"

    %% Styling
    classDef queryproc fill:#a8d1f0,stroke:#333,stroke-width:2px
    classDef storage fill:#90EE90,stroke:#333,stroke-width:2px
    classDef concurrency fill:#FFE5B4,stroke:#333,stroke-width:2px
    classDef catalog fill:#E6E6FA,stroke:#333,stroke-width:2px
    classDef disk fill:#D3D3D3,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        L1[Query Processing]:::queryproc
        L2[Storage]:::storage
        L3[Concurrency]:::concurrency
        L4[Catalog]:::catalog
        L5[Disk]:::disk
    end
```
