# chrisflow20/dbsch-rebuild-03 architecture

> Architecture diagram of the GitHub repository chrisflow20/dbsch-rebuild-03, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/chrisflow20/dbsch-rebuild-03
- Repository: https://github.com/chrisflow20/dbsch-rebuild-03

## Overview

##### Project Type and Purpose
- This is a monolithic Java desktop application (com.wisecoders.dbs) that provides both a CLI and a rich JavaFX UI for exploring, designing, synchronizing, scripting, generating data for, and reverse‐engineering database schemas.

##### High-Level Architecture Layers
- UI Layer
- CLI Module: `com.wisecoders.dbs.dbs.cli` – uses a Console, Completers and Command classes (Command Pattern).
- Application / Controller Layer
- Controllers and Tasks: e.g. `FxBrowseManager`, `FxBrowseLoaderTask`, `FxGeneratorTask`, `FxLoaderTask`, `FxSyncTask`, `FxImportStructureTask`, `FxGetRenewedLicenseTask`…
- Scripting Controllers: wrapper classes for Groovy, Python, JavaScript (JSR-223) under `cli/command/groovy`, `cli/command/python`, `scripting/actions`.
- Domain Model Layer
- Schema Model: `com.wisecoders.dbs.schema.*` – tables, columns, relations, generators, layouts, projects, scripts.
- Data Model: `com.wisecoders.dbs.data.model.*` – results, execution plans, groovy bindings, loader metadata.
- Config Model: `com.wisecoders.dbs.config.model.*`, `com.wisecoders.dbs.config.system.*`.
- Service / Engine Layer
- DBMS Connectivity & Drivers: `com.wisecoders.dbs.dbms.connect.model`, `dbms.driver.model`, `dbms.plugins.*` (Plugin Pattern for each RDBMS/NoSQL).
- Loader Engine: `com.wisecoders.dbs.loader.engine.*` for CSV/Excel/JSON/XML.
- Generator Engine: `com.wisecoders.dbs.generator.engine.*` – data generators for sequences, JSON, RegEx, foreign keys, etc.
- Query Engine: `com.wisecoders.dbs.query.model.engine.*`.
- Synchronization Engine: `com.wisecoders.dbs.dbms.sync.engine.*` – diff and operation generators.
- Reverse-Engineering Engine: `com.wisecoders.dbs.dbms.reverseEngineer.*`.
- Persistence / Store Layer
- Project Store: XML-based storage under `com.wisecoders.dbs.project.store` + `schema.store`, `convert.store`, `governance.store`, `generator.store`.
- Browse Store: `BrowseMongoStore`, `BrowseSQLStore`.
- Driver & Connector Store: `com.wisecoders.dbs.dbms.driver.store`, `dbms.schema.store`, cli console properties files.
- Preferences & Encryption: `com.wisecoders.dbs.project.store.Pref`, `Encrypter`, `CipherUtil`.

##### External Interactions
- JDBC / MongoDB / NoSQL through `dbms.plugins.*` and envoy model.
- File system (open/save projects, load scripts, CSV/Excel loader).
- JSR-223 Scripting VMs: Groovy, Jython (Python), Nashorn (JavaScript).
- HTTP for license checks and updates (`com.wisecoders.dbs.sys.fx.CheckForUpdatesTask`, `com.wisecoders.dbs.dbms.reverseEngineer.tasks.FxGetRenewedLicenseTask`).
- Git via `dialogs/git` and JSch.
- Email (newsletter send/read) and SSH tunnels under CLI.

##### Architectural Patterns and Principles
- MVC / MVP for JavaFX UI (separate FXML-like Pane classes, Controllers, Domain).
- Command Pattern in CLI (`Command` interface, command registry).
- Plugin Pattern for database drivers.
- Factory and Builder for loader/generator engines.
- Background Tasks for long-running operations in FX (`Fx*Task` extends `Task`).

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "UI Layer"
        CLI["CLI Module"]:::ui
        FX["JavaFX UI"]:::ui
    end

    subgraph "Application / Controller Layer"
        Controllers["Controllers & Tasks"]:::controllers
        ScriptingCtrl["Scripting Controllers"]:::controllers
    end

    subgraph "Domain Model Layer"
        Schema["Schema Model"]:::domain
        Data["Data Model"]:::domain
        DiagramModel["Diagram Model"]:::domain
        Config["Config Model"]:::domain
    end

    subgraph "Service / Engine Layer"
        Connect["DBMS Connectivity & Drivers"]:::service
        Loader["Loader Engine"]:::service
        Generator["Generator Engine"]:::service
        Query["Query Engine"]:::service
        Sync["Sync Engine"]:::service
        RevEng["Reverse‐Engineering Engine"]:::service
        ScriptEng["Scripting Engine"]:::service
    end

    subgraph "Persistence / Store Layer"
        ProjStore["Project Store"]:::persistence
        SchStore["Schema Store"]:::persistence
        BrStore["Browse Store"]:::persistence
        DrConStore["Driver & Connector Store"]:::persistence
        Pref["Preferences & Encryption"]:::persistence
    end

    subgraph "External Systems"
        DBs["DBs (JDBC/Mongo/NoSQL)"]:::external
        FS["File System"]:::external
        HTTP["HTTP License/Updates"]:::external
        GitSys["Git"]:::external
    end

    CLI --> Controllers
    FX --> Controllers
    Controllers --> Schema
    Controllers --> Data
    Controllers --> DiagramModel
    Controllers --> Config
    Controllers --> Connect
    Controllers --> Loader
    Controllers --> Generator
    Controllers --> Query
    Controllers --> Sync
    Controllers --> RevEng
    Controllers --> ScriptEng
    Connect --> BrStore
    Connect --> SchStore
    Connect --> DrConStore
    Connect --> DBs
    Loader --> FS
    Generator --> FS
    Query --> DBs
    Sync --> DBs
    RevEng --> DBs
    RevEng --> HTTP
    ScriptEng --> Controllers
    ProjStore --> Config
    ProjStore --> Schema
    ProjStore -.-> Pref
    BrStore --> Schema
    DrConStore --> Connect
    Pref --> ProjStore
    GitSys --> Controllers
    FS --> ProjStore

    click CLI "https://github.com/chrisflow20/dbsch-rebuild-03/blob/master/com/wisecoders/dbs/DbSchemaCLI.java"
    click CLI "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/cli"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/browse/fx"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/connect/fx"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/diagram/fx"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/loader/fx"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/generator/fx"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/query/fx"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/project/fx"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/sys/fx"
    click FX "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dialogs"
    click Controllers "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/browse/store"
    click Controllers "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/generator/engine/tasks"
    click Controllers "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/loader/tasks"
    click Controllers "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/reverseEngineer/fx"
    click Controllers "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/reverseEngineer/tasks"
    click Controllers "https://github.com/chrisflow20/dbsch-rebuild-03/blob/master/com/wisecoders/dbs/sys/fx/CheckForUpdatesTask.java"
    click ScriptingCtrl "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/cli/command/groovy"
    click ScriptingCtrl "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/cli/command/python"
    click ScriptingCtrl "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/scripting/actions"
    click Schema "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/schema"
    click Data "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/data/model"
    click DiagramModel "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/diagram/model"
    click Config "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/config/model"
    click Config "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/config/system"
    click Connect "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/connect/model"
    click Connect "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/driver/model"
    click Connect "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/plugins"
    click Connect "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/driver/store"
    click DrConStore "https://github.com/chrisflow20/dbsch-rebuild-03/blob/master/com/wisecoders/dbs/schema/store/ConnectorStore.java"
    click Loader "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/loader/engine"
    click Generator "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/generator/engine"
    click Query "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/query/model/engine"
    click Sync "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/sync/engine"
    click RevEng "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/reverseEngineer/model"
    click RevEng "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/reverseEngineer/tasks"
    click ScriptEng "https://github.com/chrisflow20/dbsch-rebuild-03/blob/master/com/wisecoders/dbs/scripting/ScriptEngine.java"
    click ProjStore "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/project/store"
    click SchStore "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/schema/store"
    click BrStore "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/browse/store"
    click DrConStore "https://github.com/chrisflow20/dbsch-rebuild-03/tree/master/com/wisecoders/dbs/dbms/driver/store"
    click Pref "https://github.com/chrisflow20/dbsch-rebuild-03/blob/master/com/wisecoders/dbs/project/store/Pref.java"
    click Pref "https://github.com/chrisflow20/dbsch-rebuild-03/blob/master/com/wisecoders/dbs/project/store/Encrypter.java"
    click Pref "https://github.com/chrisflow20/dbsch-rebuild-03/blob/master/com/wisecoders/dbs/project/store/CipherUtil.java"

    classDef ui fill:#D6EAF8,stroke:#5499C7
    classDef controllers fill:#D5F5E3,stroke:#27AE60
    classDef domain fill:#FCF3CF,stroke:#F1C40F
    classDef service fill:#FDEBD0,stroke:#D35400
    classDef persistence fill:#E5E8E8,stroke:#ABB2B9
    classDef external fill:#FADBD8,stroke:#CB4335
```
