# softwaresale/sddms architecture

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

- Interactive diagram: https://gitdiagram.com/softwaresale/sddms
- Repository: https://github.com/softwaresale/sddms

## Overview

##### Main Components

a) Core Services:
- SDDMS Central Service (Coordinator)
- SDDMS Site Services (Replicated Database Nodes)
- SDDMS Client Interface
- Service Communication Layer (gRPC, based on proto files)

b) Key Subsystems:
- Concurrency Control System (Two-Phase Locking)
- Deadlock Detection System
- Transaction Management
- History Logging/Verification
- Query Generation/Processing

##### Component Relationships

- Lock request flows
- Transaction coordination flows
- Data replication paths

##### Specific Component Details

Central Coordinator (sddms-central):
- Lock Table Management
- Deadlock Detection
- Transaction Set Management
- Connection Pool

Site Nodes (sddms-site):
- Local Database Instance
- Transaction History Logger
- Client Connection Handler
- Central Client Interface

Client (sddms-client):
- Query Processing
- Transaction State Management
- Site Communication

##### Technical Details

- gRPC service definitions (from proto files)
- Lock modes (from lock_mode.proto)
- Transaction states
- Error handling paths

##### The deadlock detection system

Keep the abstraction level high enough to show the overall architecture but detailed enough to illustrate the key mechanisms of transaction management, replication, and concurrency control.

Remember to include annotations explaining critical paths like:
- Transaction initialization
- Lock acquisition sequence
- Deadlock detection process
- Replication updates
- Transaction commit/abort paths

This will create a comprehensive visualization of the SDDMS architecture while maintaining clarity about its distributed nature and key features.

## Diagram (Mermaid)

```mermaid
%%{init: {
  'theme': 'base',
  'themeVariables': {
    'primaryColor': '#2b2b2b',
    'primaryTextColor': '#fff',
    'primaryBorderColor': '#7C0000',
    'lineColor': '#F8B229',
    'secondaryColor': '#006100',
    'tertiaryColor': '#fff'
  }
}}%%

flowchart TB
    classDef client fill:#4a90e2,stroke:#2b2b2b,color:white
    classDef coordinator fill:#50c878,stroke:#2b2b2b,color:white
    classDef site fill:#ffa500,stroke:#2b2b2b,color:white
    classDef communication fill:#808080,stroke:#2b2b2b,color:white
    classDef monitoring fill:#9370db,stroke:#2b2b2b,color:white
    classDef storage fill:#cd853f,stroke:#2b2b2b,color:white

    subgraph ClientLayer["Client Layer"]
        CI[Client Interface]:::client
        QP[Query Processing]:::client
        TSM[Transaction State Management]:::client
        QG[Query Generation]:::client
    end

    subgraph CommunicationLayer["Communication Layer"]
        GRPC[gRPC Services]:::communication
        PD[Protocol Definitions]:::communication
    end

    subgraph CoordinatorLayer["Coordinator Layer"]
        CS[Central Coordinator Service]:::coordinator
        LMS[Lock Management System]:::coordinator
        DDS[Deadlock Detection System]:::coordinator
        TM[Transaction Management]:::coordinator
        CPM[Connection Pool Management]:::coordinator
    end

    subgraph SiteLayer["Site Layer"]
        SS[Site Service]:::site
        SC[Site Communication]:::site
        CCH[Client Connection Handler]:::site
        HL[History Logger]:::site
        TH[Transaction History]:::site
        DB[(Replicated Database)]:::storage
    end

    subgraph MonitoringLayer["Monitoring Layer"]
        THV[Transaction History Verification]:::monitoring
    end

    CI --> GRPC
    QP --> CI
    TSM --> CI
    QG --> CI

    GRPC --> CS
    GRPC --> SS

    CS --> LMS
    CS --> DDS
    CS --> TM
    CS --> CPM

    SS --> SC
    SS --> CCH
    SS --> HL
    SS --> TH
    SS --> DB

    HL --> THV
    TH --> THV

    click CS "https://github.com/softwaresale/sddms/blob/main/sddms-central/src/central_service.rs"
    click SS "https://github.com/softwaresale/sddms/blob/main/sddms-site/src/site_server.rs"
    click CI "https://github.com/softwaresale/sddms/blob/main/sddms-client/src/main.rs"
    click GRPC "https://github.com/softwaresale/sddms/tree/main/sddms-services/proto/"
    click LMS "https://github.com/softwaresale/sddms/tree/main/sddms-central/src/lock_table/"
    click DDS "https://github.com/softwaresale/sddms/blob/main/sddms-central/src/lock_table/deadlock_graph.rs"
    click TM "https://github.com/softwaresale/sddms/blob/main/sddms-central/src/live_transaction_set.rs"
    click HL "https://github.com/softwaresale/sddms/blob/main/sddms-site/src/history_logger.rs"
    click THV "https://github.com/softwaresale/sddms/tree/main/history-verifier/src/verify/"
    click QP "https://github.com/softwaresale/sddms/blob/main/sddms-client/src/query_results.rs"
    click CPM "https://github.com/softwaresale/sddms/blob/main/sddms-central/src/connection_pool.rs"
    click TSM "https://github.com/softwaresale/sddms/blob/main/sddms-client/src/transaction_state.rs"
    click SC "https://github.com/softwaresale/sddms/blob/main/sddms-site/src/central_client.rs"
    click PD "https://github.com/softwaresale/sddms/blob/main/sddms-services/proto/concurrency_controller.proto"
    click QG "https://github.com/softwaresale/sddms/tree/main/sql-trans-gen/src/query_gen/"
    click CCH "https://github.com/softwaresale/sddms/blob/main/sddms-site/src/client_connection.rs"
    click TH "https://github.com/softwaresale/sddms/blob/main/sddms-site/src/transaction_history.rs"

    %% Legend
    subgraph Legend
        CL[Client Components]:::client
        COL[Coordinator Components]:::coordinator
        SL[Site Components]:::site
        COML[Communication Components]:::communication
        ML[Monitoring Components]:::monitoring
        STL[Storage Components]:::storage
    end
```
