# efectn/go-orm-benchmarks architecture

> Architecture diagram of the GitHub repository efectn/go-orm-benchmarks, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/efectn/go-orm-benchmarks
- Repository: https://github.com/efectn/go-orm-benchmarks

## Overview

- → Benchmark Runner to ORM Adapters: Test execution
- → ORM Adapters to Database: Query execution
- → Database to ORM Adapters: Results
- → Helper Utilities to other components: Support functions
- → Code Generation to ORM Adapters: Generated models

##### Detailed Elements

- A "Benchmarks" section showing:
- Raw SQL operations
- CRUD operations
- Complex queries
- Batch operations

- A "Results Collection" component showing:
- Metrics gathering
- Results formatting
- GitHub Actions integration

##### Notes Section

Callouts for:
- No-cache mode operation
- Database configuration requirements
- Supported ORM versions
- Benchmark methodology

##### The integration with external tools and services

This will provide a clear understanding of how the benchmark suite operates and how different components interact during benchmark execution.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph BenchmarkRunner
        BR[Benchmark Runner]:::core
        CI[CI/CD Integration]:::cicd
        RC[Results Collection]:::results
    end

    subgraph ORMAdapters
        direction TB
        GORM["GORM Adapter"]:::orm
        BUN["BUN Adapter"]:::orm
        SQLX["SQLX Adapter"]:::orm
        RAW["Raw SQL Adapter"]:::orm
        PGX["PGX Adapter"]:::orm
        ENT["Ent Adapter"]:::orm
        SQLC["SQLC Adapter"]:::orm
    end

    subgraph CodeGen
        direction TB
        ENTG["Ent Generated Code"]:::generated
        SQLCG["SQLC Generated Code"]:::generated
        REFORMG["Reform Generated Code"]:::generated
        SQLBOILERG["SQLBoiler Generated Code"]:::generated
        JETG["Jet Generated Code"]:::generated
    end

    subgraph Helpers
        direction TB
        CONST["Constants"]:::helper
        ERR["Error Handling"]:::helper
        MISC["Misc Utilities"]:::helper
        SQL["SQL Utilities"]:::helper
        SUITE["Test Suite"]:::helper
    end

    subgraph Database
        PG[("PostgreSQL DB")]:::db
        POOL["Connection Pool"]:::db
    end

    subgraph Models
        MS["Schema & Models"]:::model
    end

    BR --> ORMAdapters
    BR --> RC
    CI --> BR
    ORMAdapters --> PG
    PG --> ORMAdapters
    POOL --> PG
    CodeGen --> ORMAdapters
    Helpers --> BR
    Helpers --> ORMAdapters
    MS --> ORMAdapters
    MS --> CodeGen

    %% Click Events
    click BR "https://github.com/efectn/go-orm-benchmarks/blob/master/main.go"
    click CI "https://github.com/efectn/go-orm-benchmarks/blob/master/.github/workflows/build.yaml"
    click RC "https://github.com/efectn/go-orm-benchmarks/blob/master/.github/data/results.md.proto"
    click GORM "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/gorm.go"
    click BUN "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/bun.go"
    click SQLX "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/sqlx.go"
    click RAW "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/raw.go"
    click PGX "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/pgx.go"
    click ENT "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/ent.go"
    click SQLC "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/sqlc.go"
    click ENTG "https://github.com/efectn/go-orm-benchmarks/tree/master/bench/ent"
    click SQLCG "https://github.com/efectn/go-orm-benchmarks/tree/master/bench/sqlc"
    click REFORMG "https://github.com/efectn/go-orm-benchmarks/tree/master/bench/reform"
    click SQLBOILERG "https://github.com/efectn/go-orm-benchmarks/tree/master/bench/sqlboiler"
    click JETG "https://github.com/efectn/go-orm-benchmarks/tree/master/bench/jet"
    click CONST "https://github.com/efectn/go-orm-benchmarks/blob/master/helper/constants.go"
    click ERR "https://github.com/efectn/go-orm-benchmarks/blob/master/helper/error.go"
    click MISC "https://github.com/efectn/go-orm-benchmarks/blob/master/helper/misc.go"
    click SQL "https://github.com/efectn/go-orm-benchmarks/blob/master/helper/sql.go"
    click SUITE "https://github.com/efectn/go-orm-benchmarks/blob/master/helper/suite.go"
    click POOL "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/pgx_pool.go"
    click MS "https://github.com/efectn/go-orm-benchmarks/blob/master/bench/models.go"

    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef orm fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef generated fill:#e67e22,stroke:#d35400,color:white
    classDef helper fill:#f1c40f,stroke:#f39c12,color:black
    classDef db fill:#2ecc71,stroke:#27ae60,color:white
    classDef model fill:#9b59b6,stroke:#8e44ad,color:white
    classDef cicd fill:#34495e,stroke:#2c3e50,color:white
    classDef results fill:#e74c3c,stroke:#c0392b,color:white
```
