# isaacadams/bq-rs architecture

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

- Interactive diagram: https://gitdiagram.com/isaacadams/bq-rs
- Repository: https://github.com/isaacadams/bq-rs

## Overview

##### Main Components

a) Client Layer:
- Command Line Interface (CLI)
- Query Processing
- Authentication Handler

b) Core Components:
- BigQuery API Integration
- Service Account Authentication
- Query Execution Engine

c) External Services:
- Google Cloud BigQuery
- Google Cloud Authentication

**[User/Terminal] → [CLI Layer] → [Core Services] → [External Services]**

##### Component Relationships

**[CLI (src/cli.rs)] → [API Handler (src/api.rs)] → [Query Processor (src/query.rs)]**
- ↘ [Authenticator (gauthenticator crate)] → [Google Cloud Auth]

##### Specific Implementation Details

a) The modular crate structure:
- Main application crate (bq-rs)
- Authentication crate (gauthenticator)

b) Key files and their roles:
- src/main.rs (Entry point)
- src/api.rs (API integration)
- src/query.rs (Query handling)
- gauthenticator crate components

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef cli fill:#3498db,stroke:#2980b9,color:white
    classDef auth fill:#2ecc71,stroke:#27ae60,color:white
    classDef query fill:#e67e22,stroke:#d35400,color:white
    classDef external fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef core fill:#9b59b6,stroke:#8e44ad,color:white

    %% User Input
    User([User/Terminal])

    %% CLI Layer
    subgraph CLI
        MainEntry["Main Entry Point"]
        CLInterface["CLI Interface"]
        User --> MainEntry --> CLInterface
    end

    %% Core Components
    subgraph Core
        QueryProc["Query Processing"]
        APIInteg["BigQuery API Integration"]
        CLInterface --> QueryProc
        CLInterface --> APIInteg
    end

    %% Authentication Components
    subgraph Authentication
        AuthLib["Service Account Auth Library"]
        CredHandler["Credentials Handler"]
        TokenGen["Token Generation"]
        AuthSign["Authentication Signing"]
        ProfMgmt["Profile Management"]
        
        AuthLib --> CredHandler
        CredHandler --> TokenGen
        TokenGen --> AuthSign
        AuthLib --> ProfMgmt
    end

    %% External Services
    subgraph External
        GCloudAuth["Google Cloud Auth"]
        BigQuery["BigQuery Service"]
    end

    %% Connections
    CLInterface --> AuthLib
    AuthLib --> GCloudAuth
    APIInteg --> BigQuery
    QueryProc --> APIInteg

    %% Output
    APIInteg --> CSVOutput["CSV Output"]

    %% Click Events
    click MainEntry "https://github.com/isaacadams/bq-rs/blob/main/src/main.rs"
    click CLInterface "https://github.com/isaacadams/bq-rs/blob/main/src/cli.rs"
    click QueryProc "https://github.com/isaacadams/bq-rs/blob/main/src/query.rs"
    click APIInteg "https://github.com/isaacadams/bq-rs/blob/main/src/api.rs"
    click AuthLib "https://github.com/isaacadams/bq-rs/blob/main/crates/gauthenticator/src/lib.rs"
    click CredHandler "https://github.com/isaacadams/bq-rs/blob/main/crates/gauthenticator/src/credentials.rs"
    click TokenGen "https://github.com/isaacadams/bq-rs/blob/main/crates/gauthenticator/src/token.rs"
    click AuthSign "https://github.com/isaacadams/bq-rs/blob/main/crates/gauthenticator/src/sign.rs"
    click ProfMgmt "https://github.com/isaacadams/bq-rs/blob/main/crates/gauthenticator/src/profile.rs"

    %% Style Applications
    class CLInterface,MainEntry cli
    class AuthLib,CredHandler,TokenGen,AuthSign,ProfMgmt auth
    class QueryProc,APIInteg query
    class GCloudAuth,BigQuery external
    class CSVOutput core

    %% Legend
    subgraph Legend
        CLI_L["CLI Components"]:::cli
        Auth_L["Authentication Components"]:::auth
        Query_L["Query Components"]:::query
        External_L["External Services"]:::external
        Output_L["Output Components"]:::core
    end
```
