# lequokhanh/text-to-sql-slm architecture

> Architecture diagram of the GitHub repository lequokhanh/text-to-sql-slm, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lequokhanh/text-to-sql-slm
- Repository: https://github.com/lequokhanh/text-to-sql-slm

## Overview

##### Project Type and Purpose
- This is a full-stack, microservices-based “text-to-SQL” platform (“text-to-sql-slm”). Users interact via a rich React UI, which calls a Java Spring Boot backend that orchestrates two downstream services:
- slm-embed: manages database connections, schema introspection and metadata.
- slm-engine: runs LLM-driven workflows to translate user text into SQL queries.
- Under the covers, the system also uses persistent storage (MySQL/PostgreSQL), a vector store (Weaviate), and external LLM endpoints for embeddings and completions.

##### File Structure Highlights
- Top-level services:
- slm-ui (frontend, Vite + React)
- slm-backend (Java/Spring Boot)
- slm-embed (Java/Spring Boot microservice for schema)
- slm-engine (Python FastAPI/Flask service with LLM workflows)
- DevOps config: Dockerfiles, docker-compose.yml (spinning up the four services plus MySQL, Postgres, Weaviate).
- sample_pg_docker: example Postgres DB for local development.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Tier
    subgraph "Client Tier"
        direction TB
        UI["User Browser / slm-ui"]:::frontend
        UI -->|"REST calls (Auth, Chat, DataSource)"| Backend
    end

    %% API Tier
    subgraph "API Tier"
        direction TB
        Backend["slm-backend (API Gateway)"]:::api
        Backend -->|"GET /schema"| Embed
        Backend -->|"POST /schema metadata"| Embed
        Backend -->|"POST /chat AskQuestionRequestDTO"| Engine
        Engine -->|"BotResponseDTO"| Backend
    end

    %% Microservice Tier
    subgraph "Microservice Tier"
        direction TB
        Embed["slm-embed (Schema Service)"]:::micro
        Engine["slm-engine (Engine Service)"]:::micro
        Embed -->|"CRUD metadata"| RelDB
        Backend -->|"store user/chat"| RelDB
        Engine <-->|"store/retrieve embeddings"| VectorDB
        Engine <-->|"embedding/completion API"| LLM
    end

    %% Data Tier
    subgraph "Data Tier"
        direction TB
        RelDB["Relational DBs\n(MySQL / PostgreSQL)"]:::db
        VectorDB["Weaviate (Vector Store)"]:::db
        LLM["External LLM APIs"]:::external
    end

    %% Click Events - Client
    click UI "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-ui/"
    %% Frontend Entry and template
    UI --> FE1["app.tsx"]:::frontend
    UI --> FE2["index.html"]:::frontend
    click FE1 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-ui/src/app.tsx"
    click FE2 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-ui/index.html"

    %% Click Events - Backend
    click Backend "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-backend/"
    BE1["SlmBackendApplication.java"]:::api
    BE2["controller/"]:::api
    BE3["service/"]:::api
    BE4["config/"]:::api
    BE5["application.yml"]:::api
    Backend --> BE1
    Backend --> BE2
    Backend --> BE3
    Backend --> BE4
    Backend --> BE5
    click BE1 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-backend/src/main/java/com/slm/slmbackend/SlmBackendApplication.java"
    click BE2 "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-backend/src/main/java/com/slm/slmbackend/controller/"
    click BE3 "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-backend/src/main/java/com/slm/slmbackend/service/"
    click BE4 "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-backend/src/main/java/com/slm/slmbackend/config/"
    click BE5 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-backend/src/main/resources/application.yml"

    %% Click Events - Embed
    click Embed "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-embed/"
    EM1["SlmEmbedApplication.java"]:::micro
    EM2["controller/"]:::micro
    EM3["service/"]:::micro
    Embed --> EM1
    Embed --> EM2
    Embed --> EM3
    click EM1 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-embed/src/main/java/com/slm/slmembed/SlmEmbedApplication.java"
    click EM2 "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-embed/src/main/java/com/slm/slmembed/controller/"
    click EM3 "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-embed/src/main/java/com/slm/slmembed/service/"

    %% Click Events - Engine
    click Engine "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-engine/"
    ES1["app.py"]:::micro
    ES2["routes & models"]:::micro
    ES3["workflows/"]:::micro
    ES4["app_config.py"]:::micro
    ES5["llm & utils"]:::micro
    Engine --> ES1
    Engine --> ES2
    Engine --> ES3
    Engine --> ES4
    Engine --> ES5
    click ES1 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-engine/src/app.py"
    click ES2 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-engine/src/api/routes.py"
    click ES2 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-engine/src/api/models.py"
    click ES3 "https://github.com/lequokhanh/text-to-sql-slm/tree/main/slm-engine/src/core/workflows/"
    click ES4 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-engine/src/config/app_config.py"
    click ES5 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-engine/src/core/llm.py"
    click ES5 "https://github.com/lequokhanh/text-to-sql-slm/blob/main/slm-engine/src/core/utils.py"

    %% Click Events - DevOps
    DO["docker-compose.yml"]:::db
    click DO "https://github.com/lequokhanh/text-to-sql-slm/blob/main/docker-compose.yml"
    DM["devops/mysql"]:::db
    click DM "https://github.com/lequokhanh/text-to-sql-slm/tree/main/devops/mysql/Dockerfile"
    click DM "https://github.com/lequokhanh/text-to-sql-slm/blob/main/devops/mysql/register-to-consul.sh"
    DP["sample_pg_docker"]:::db
    click DP "https://github.com/lequokhanh/text-to-sql-slm/tree/main/sample_pg_docker/Dockerfile"
    click DP "https://github.com/lequokhanh/text-to-sql-slm/blob/main/sample_pg_docker/init-db.sh"
    DW["Weaviate Images"]:::db
    click DW "https://github.com/lequokhanh/text-to-sql-slm/blob/main/devops/dockerfile.weaviate.reranker"
    click DW "https://github.com/lequokhanh/text-to-sql-slm/blob/main/devops/dockerfile.weaviate.transformer"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#004085,color:#004085;
    classDef api fill:#D4EDDA,stroke:#155724,color:#155724;
    classDef micro fill:#FFF3CD,stroke:#856404,color:#856404;
    classDef db fill:#E2E3E5,stroke:#6C757D,color:#6C757D;
    classDef external fill:#F8D7DA,stroke:#721C24,color:#721C24;
```
