# rbock/sqlpp23 architecture

> Architecture diagram of the GitHub repository rbock/sqlpp23, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rbock/sqlpp23
- Repository: https://github.com/rbock/sqlpp23

## Overview

##### Project Type & Purpose
- sqlpp23 is a C++‑23 header‑only library (an embedded DSL) that lets C++ code express type‑safe SQL.
- It is vendor‑neutral at its core and extensible via “connectors” for specific backends (MySQL, PostgreSQL, SQLite3, SQLCipher, MariaDB).
- It includes documentation (docs/), examples (examples/), tests (tests/), build scripts (CMake), and code‑generation tools (scripts/).

##### High‑Level Components
- Build & Packaging
– CMakeLists.txt + cmake/… → defines CMake targets: sqlpp23::core, sqlpp23::mysql, sqlpp23::postgresql, sqlpp23::sqlite3, sqlpp23::connector_api
– .gitignore, LICENSE, ChangeLog.md, etc.
- Core Library (include/sqlpp23/core)
– Expression AST, clause builders, static checks, type traits, SQL serialization
- Connector API (connector_api/)
– Abstract interfaces: connection, connection_pool, interpreter, prepared_statement, bind_result
- Connectors (include/sqlpp23/{mysql,postgresql,sqlite3,mariadb,sqlcipher})
– Concrete implementations of connector_api, dialect‑specific SQL serialization, handle lifecycles
- Examples (examples/…)
- Tests (tests/…)
- Documentation (docs/…)
- Scripts & Tools (scripts/ddl2cpp)

##### Relationships & Data Flow
- At build time, CMake compiles/tests the Core and each Connector into separate targets.
- User code (examples or downstream projects) → links against core + chosen connector(s).
- The Connector API sits between Core and concrete connectors:
Core → calls Connector API interfaces → implemented by each Connector → calls into native DB client library (MySQL client, libpq, sqlite3).
- Scripts/ddl2cpp is a standalone tool that reads SQL DDL and emits C++ code—an auxiliary component, not part of the runtime library.
- Docs and examples reference Core+Connectors but do not interact at runtime.

##### Architectural Patterns & Principles
- Layered architecture:
– Layer 1: Core DSL (database‑vendor‑neutral expressions & serialization)
– Layer 2: Connector API (abstract “port”)
– Layer 3: Connectors (adapter/“plugin” for each SQL dialect)
– Layer 4: Native DB client libraries
- Header‑only, template‑meta‑programming to achieve compile‑time safety.
- CMake modular targets to decouple connectors.
- Test‑driven: a vast hierarchy of unit tests per core and per connector.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build & Packaging Layer
    subgraph "Build & Packaging" 
        direction TB
        CMAKE["CMake (CMakeLists.txt, cmake/)"]:::build
        FILES["Config & Metadata (.gitignore, LICENSE, ChangeLog.md)"]:::build
    end

    %% Core Layer
    Core["Core Library\n(include/sqlpp23/core)"]:::lib
    
    %% Connector API Layer
    API["Connector API\n(connector_api)"]:::lib

    %% Connectors Layer
    subgraph "Connectors" 
        direction TB
        MySQL["MySQL Connector\n(include/sqlpp23/mysql)"]:::lib
        PostgreSQL["PostgreSQL Connector\n(include/sqlpp23/postgresql)"]:::lib
        SQLite3["SQLite3 Connector\n(include/sqlpp23/sqlite3)"]:::lib
        SQLCipher["SQLCipher Connector\n(via cmake/configs/Sqlpp23SQLCipherConfig.cmake)"]:::lib
        MariaDB["MariaDB Connector\n(via cmake/configs/Sqlpp23MariaDBConfig.cmake)"]:::lib
    end

    %% Native DB Clients
    MySQLClient["MySQL Client Lib"]:::external
    LibPQ["libpq (PostgreSQL Client)"]:::external
    SQLiteLib["sqlite3"]:::external

    %% Usage & Verification Layers
    Examples["Examples\n(examples/)"]:::example
    Tests["Tests\n(tests/)"]:::example
    Docs["Documentation\n(docs/)"]:::example

    %% Scripts & Tools
    Scripts["DDL->C++ Generator\n(scripts/ddl2cpp)"]:::build

    %% Build relationships
    CMAKE -->|builds| Core
    CMAKE -->|builds| API
    CMAKE -->|builds| MySQL
    CMAKE -->|builds| PostgreSQL
    CMAKE -->|builds| SQLite3
    CMAKE -->|builds| SQLCipher
    CMAKE -->|builds| MariaDB
    CMAKE -->|runs| Tests

    %% Core to API to Connectors to DB
    Core -->|"uses interfaces"| API
    API -->|"implemented by"| MySQL
    API -->|"implemented by"| PostgreSQL
    API -->|"implemented by"| SQLite3
    API -->|"implemented by"| SQLCipher
    API -->|"implemented by"| MariaDB

    MySQL -->|calls| MySQLClient
    PostgreSQL -->|calls| LibPQ
    SQLite3 -->|calls| SQLiteLib
    SQLCipher -->|calls| SQLiteLib
    MariaDB -->|calls| MySQLClient

    %% Usage arrows
    Examples -->|links| Core
    Examples -->|links| MySQL
    Examples -->|links| PostgreSQL
    Tests -->|verifies| Core
    Tests -->|verifies| MySQL
    Docs -->|references| Core
    Docs -->|references| Connectors

    %% Scripts standalone
    Scripts -.->|generates code| Core

    %% Click Events
    click CMAKE "https://github.com/rbock/sqlpp23/blob/main/CMakeLists.txt"
    click CMAKE "https://github.com/rbock/sqlpp23/tree/main/cmake/"
    click Core "https://github.com/rbock/sqlpp23/tree/main/include/sqlpp23/core"
    click API "https://github.com/rbock/sqlpp23/tree/main/connector_api"
    click MySQL "https://github.com/rbock/sqlpp23/tree/main/include/sqlpp23/mysql"
    click PostgreSQL "https://github.com/rbock/sqlpp23/tree/main/include/sqlpp23/postgresql"
    click SQLite3 "https://github.com/rbock/sqlpp23/tree/main/include/sqlpp23/sqlite3"
    click Scripts "https://github.com/rbock/sqlpp23/tree/main/scripts/ddl2cpp"
    click Examples "https://github.com/rbock/sqlpp23/tree/main/examples/"
    click Tests "https://github.com/rbock/sqlpp23/tree/main/tests/"
    click Docs "https://github.com/rbock/sqlpp23/tree/main/docs/"

    %% Styles
    classDef lib fill:#BBDEFB,stroke:#1976D2,color:#0D47A1;
    classDef build fill:#C8E6C9,stroke:#388E3C,color:#1B5E20;
    classDef example fill:#FFE0B2,stroke:#F57C00,color:#E65100;
    classDef external fill:#E0E0E0,stroke:#9E9E9E,color:#424242;
```
