# scylladb/scylla-rust-driver architecture

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

- Interactive diagram: https://gitdiagram.com/scylladb/scylla-rust-driver
- Repository: https://github.com/scylladb/scylla-rust-driver

## Overview

##### Component Details

a) Session Management:
- SessionBuilder
- Session
- Connection Pool
- Authentication Handler

b) Query Execution:
- Query Preparation
- Statement Execution
- Batch Processing
- Result Processing

c) Advanced Features:
- Load Balancing Policies
- Retry Policies
- Speculative Execution
- Compression (LZ4/Snappy)
- TLS Support
- Metrics Collection

##### Data Flow Indicators

- Query flow from client → driver → database
- Response flow from database → driver → client
- Internal communication between components
- Connection pooling and management

##### Component Relationships

Clear connections between:
- Session → Connection Pool
- Connection Pool → Database Nodes
- Query Execution → Protocol Layer
- Load Balancing → Connection Selection

##### Technical Details

Annotations for:
- Async operations (Tokio runtime)
- CQL protocol version
- Supported compression algorithms
- Authentication methods
- TLS configuration options

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef client fill:#FFE5CC,stroke:#000
    classDef core fill:#B3D9FF,stroke:#000
    classDef protocol fill:#90EE90,stroke:#000
    classDef database fill:#FFB366,stroke:#000
    classDef security fill:#FFB3B3,stroke:#000

    %% Client Layer
    Client["Client Application"]:::client

    %% Core Driver Components
    subgraph CoreDriver["Driver Core Components"]
        Session["Session Management"]
        QueryExec["Query Execution"]
        ConnPool["Connection Pool"]
        LoadBal["Load Balancing"]
        Routing["Routing"]
        
        %% Session Components
        SessionBuilder["Session Builder"]
        CachingSession["Caching Session"]
        
        %% Query Components
        QueryPrep["Query Preparation"]
        BatchProc["Batch Processing"]
        PrepStmt["Prepared Statements"]
        
        %% Advanced Features
        RetryPol["Retry Policies"]
        SpecExec["Speculative Execution"]
        Metrics["Metrics Collection"]
        Auth["Authentication"]
        
        %% Cluster Management
        Cluster["Cluster Management"]
        Topology["Topology Management"]
    end

    %% Protocol Layer
    subgraph ProtocolLayer["Protocol Layer"]
        Frame["Frame Handling"]
        Serialization["Serialization"]
        Deserialization["Deserialization"]
    end

    %% Database Layer
    subgraph DatabaseLayer["Database Nodes"]
        DB1["ScyllaDB Node 1"]
        DB2["ScyllaDB Node 2"]
        DB3["ScyllaDB Node 3"]
    end

    %% Relationships
    Client --> Session
    Session --> SessionBuilder
    Session --> CachingSession
    Session --> ConnPool
    Session --> QueryExec
    
    QueryExec --> QueryPrep
    QueryExec --> BatchProc
    QueryExec --> PrepStmt
    
    ConnPool --> LoadBal
    LoadBal --> Routing
    
    QueryExec --> Frame
    Frame --> Serialization
    Frame --> Deserialization
    
    ConnPool --> DB1
    ConnPool --> DB2
    ConnPool --> DB3
    
    Session --> Auth
    Session --> RetryPol
    Session --> SpecExec
    Session --> Metrics
    
    Cluster --> Topology
    Topology --> LoadBal

    %% Click Events
    click Session "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/session.rs"
    click SessionBuilder "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/session_builder.rs"
    click CachingSession "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/caching_session.rs"
    click QueryExec "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/statement/query.rs"
    click PrepStmt "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/statement/prepared_statement.rs"
    click BatchProc "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/statement/batch.rs"
    click ConnPool "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/connection_pool.rs"
    click LoadBal "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/load_balancing/mod.rs"
    click Frame "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla-cql/src/frame/mod.rs"
    click Auth "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/authentication/mod.rs"
    click Routing "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/routing.rs"
    click RetryPol "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/retry_policy.rs"
    click SpecExec "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/speculative_execution.rs"
    click Metrics "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/metrics.rs"
    click Cluster "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/cluster.rs"
    click Topology "https://github.com/scylladb/scylla-rust-driver/blob/main/scylla/src/transport/topology.rs"
    click Serialization "https://github.com/scylladb/scylla-rust-driver/tree/main/scylla-cql/src/types/serialize"
    click Deserialization "https://github.com/scylladb/scylla-rust-driver/tree/main/scylla-cql/src/types/deserialize"

    %% Legend
    subgraph Legend
        L1["Client Layer"]:::client
        L2["Core Components"]:::core
        L3["Protocol Layer"]:::protocol
        L4["Database Layer"]:::database
        L5["Security Features"]:::security
    end
```
