# jainfamilyinstitute/azure-connectors architecture

> Architecture diagram of the GitHub repository jainfamilyinstitute/azure-connectors, 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/jainfamilyinstitute/azure-connectors
- Repository: https://github.com/jainfamilyinstitute/azure-connectors

## Overview

##### Main Components

a) Core Components:
- Credential Management System
- Client Factory
- Service Connectors (SQL, Blob, DataLake, Tables)
- Configuration Management
- DataFrame I/O Handlers
- Validation Layer

b) External Components:
- Azure Services (SQL, Blob Storage, Data Lake, Tables)
- Azure Authentication (CLI and Default credentials)
- Client Applications (showing integration points)

##### Specific Design Elements

Use these visual elements:
- Rectangles: Core library components
- Hexagons: External authentication sources
- Double lines: API boundaries

##### Detailed Component Breakdown

a) Credential Management:
**credential/**
- credential.py
- settings.py
As central authentication hub

b) Service Connectors:
**azure_blob/**
**azure_datalake/**
**azure_sql/**
**azure_tables/**
As separate modules with their respective SDK clients

c) Configuration:
**config/**
- env_file.py
- settings_config.py
As a supporting layer feeding into all components

##### Authentication Flow
- Environment Variables → Credential Management → Azure Services

##### Client Creation Flow
- Client Factory → Service Connectors → Azure SDK Clients

##### Data Flow
- DataFrame I/O → Service Connectors → Azure Services

##### Important Notes

- Passwordless nature of authentication
- Both local (CLI) and deployed (default) authentication paths
- Environment variable configuration points
- Two main entry points mentioned in the README:
- AzureSqlConnection
- SDK Client shadow constructors

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client["Client Applications"]
        APP[Client Code]
    end

    subgraph Core["Azure Connectors Library"]
        subgraph Auth["Authentication Layer"]
            CM[Credential Management]:::auth
            CF[Client Factory]:::core
            click CM "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/credential/"
            click CF "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/client_factory/"
        end

        subgraph Connectors["Service Connectors"]
            SQL[Azure SQL Connector]:::connector
            BLOB[Azure Blob Connector]:::connector
            DL[Azure DataLake Connector]:::connector
            TBL[Azure Tables Connector]:::connector
            click SQL "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/azure_sql/"
            click BLOB "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/azure_blob/"
            click DL "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/azure_datalake/"
            click TBL "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/azure_tables/"
        end

        subgraph Support["Support Components"]
            DF[DataFrame I/O]:::support
            VAL[Validation Layer]:::support
            CONF[Configuration Management]:::config
            click DF "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/dataframe_io/"
            click VAL "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/validation/"
            click CONF "https://github.com/JainFamilyInstitute/azure-connectors/tree/main/src/azure_connectors/config/"
        end
    end

    subgraph Azure["Azure Services"]
        ASQL[(Azure SQL DB)]:::azure
        ABLOB[(Azure Blob Storage)]:::azure
        ADL[(Azure Data Lake)]:::azure
        ATBL[(Azure Tables)]:::azure
    end

    subgraph Auth_Sources["Authentication Sources"]
        CLI{Azure CLI}:::authsrc
        DEFAULT{Default Credentials}:::authsrc
    end

    %% Connections
    APP --> CM
    APP --> CF
    
    CLI --> CM
    DEFAULT --> CM
    
    CM --> CF
    CF --> SQL & BLOB & DL & TBL
    
    CONF -.-> CM
    CONF -.-> CF
    CONF -.-> SQL & BLOB & DL & TBL
    
    VAL --> SQL & BLOB & DL & TBL
    DF --> SQL & BLOB & DL & TBL
    
    SQL --> ASQL
    BLOB --> ABLOB
    DL --> ADL
    TBL --> ATBL

    %% Styles
    classDef azure fill:#0078D4,color:white
    classDef connector fill:#2ECC71,color:white
    classDef core fill:#3498DB,color:white
    classDef auth fill:#F1C40F,color:black
    classDef authsrc fill:#E67E22,color:white
    classDef config fill:#95A5A6,color:white
    classDef support fill:#9B59B6,color:white

    %% Legend
    subgraph Legend
        L1[Azure Services]:::azure
        L2[Connectors]:::connector
        L3[Core Components]:::core
        L4[Authentication]:::auth
        L5[Auth Sources]:::authsrc
        L6[Configuration]:::config
        L7[Support Tools]:::support
    end
```
