# yangziwen/quick-dao architecture

> Architecture diagram of the GitHub repository yangziwen/quick-dao, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yangziwen/quick-dao
- Repository: https://github.com/yangziwen/quick-dao

## Overview

QuickDAO is a Java DAO abstraction library: callers define entity repositories, build criteria or queries, and use a shared CRUD API implemented by Spring JDBC, MyBatis, sql2o, or Elasticsearch adapters. The SQL adapters generate and execute database operations; the Elasticsearch adapter translates the shared query model to search and aggregation requests. The README documents paging and type-safe query construction as well as CRUD. Some adapter behavior is represented from README and index references because its source was not excerpted.

Main entry points: [`quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java`](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java) (Spring JDBC adapter), [`quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java`](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java) (Typed query builder), [`quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseRepository.java`](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseRepository.java) (Repository contracts), [`quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Query.java`](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Query.java) (Query builder)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Shared DAO API"]
  node_repo_api["Repository contracts"]
  node_readonly_api["Read and paging API"]
  node_entity_meta["Entity mapping<br/>[EntityMeta.java]"]
end

subgraph group_query["Query DSL"]
  node_query_dsl["Query builder<br/>[Query.java]"]
  node_typed_query["Typed query builder<br/>[TypedQuery.java]"]
  node_criteria["Criteria builder<br/>[Criteria.java]"]
  node_typed_criteria["Typed criteria<br/>[TypedCriteria.java]"]
end

subgraph group_sql["SQL Adapters"]
  node_sql_generator["SQL generation<br/>[SqlGenerator.java]"]
  node_jdbc_adapter["Spring JDBC adapter"]
  node_mybatis_adapter["MyBatis adapter"]
  node_sql2o_adapter["sql2o adapter"]
end

subgraph group_search["Search Adapter"]
  node_es_adapter["Elasticsearch adapter"]
  node_es_write["ES CRUD extension"]
end

node_caller(("Repository caller"))
node_sql_db[("SQL database")]
node_elasticsearch[("Elasticsearch")]

node_caller -->|"uses CRUD"| node_repo_api
node_caller -->|"builds query"| node_typed_query
node_repo_api -->|"extends reads"| node_readonly_api
node_readonly_api -->|"accepts queries"| node_query_dsl
node_typed_query -->|"specializes"| node_query_dsl
node_typed_query -->|"builds conditions"| node_typed_criteria
node_typed_criteria -->|"extends conditions"| node_criteria
node_jdbc_adapter -->|"generates SQL"| node_sql_generator
node_mybatis_adapter -->|"uses SQL generation"| node_sql_generator
node_sql2o_adapter -->|"uses SQL generation"| node_sql_generator
node_jdbc_adapter -->|"executes statements"| node_sql_db
node_jdbc_adapter -.->|"maps entities"| node_entity_meta
node_mybatis_adapter -.->|"accesses database"| node_sql_db
node_sql2o_adapter -.->|"accesses database"| node_sql_db
node_es_adapter -->|"translates queries"| node_query_dsl
node_es_adapter -->|"sends searches"| node_elasticsearch
node_es_write -->|"implements CRUD"| node_repo_api
node_es_write -.->|"performs writes"| node_elasticsearch

click node_repo_api "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseRepository.java"
click node_readonly_api "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseReadOnlyRepository.java"
click node_entity_meta "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/EntityMeta.java"
click node_query_dsl "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Query.java"
click node_typed_query "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java"
click node_criteria "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Criteria.java"
click node_typed_criteria "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedCriteria.java"
click node_sql_generator "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/SqlGenerator.java"
click node_jdbc_adapter "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java"
click node_mybatis_adapter "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-mybatis/src/main/java/io/github/yangziwen/quickdao/mybatis/BaseMybatisRepository.java"
click node_sql2o_adapter "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-sql2o/src/main/java/io/github/yangziwen/quickdao/sql2o/BaseSql2oRepository.java"
click node_es_adapter "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseReadOnlyElasticSearchRepository.java"
click node_es_write "https://github.com/yangziwen/quick-dao/blob/master/quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseElasticSearchRepository.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_repo_api,node_readonly_api,node_entity_meta toneBlue
class node_query_dsl,node_typed_query,node_criteria,node_typed_criteria,node_sql_db,node_elasticsearch toneAmber
class node_sql_generator,node_jdbc_adapter,node_mybatis_adapter,node_sql2o_adapter toneMint
class node_es_adapter,node_es_write toneRose
class node_caller toneIndigo
```

## Components

### Shared DAO API

- [Repository contracts](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseRepository.java): `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseRepository.java`
- [Read and paging API](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseReadOnlyRepository.java): `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseReadOnlyRepository.java`
- [Entity mapping](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/EntityMeta.java): `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/EntityMeta.java`

### Query DSL

- [Query builder](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Query.java): `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Query.java`
- [Typed query builder](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java): `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java`
- [Criteria builder](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Criteria.java): `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Criteria.java`
- [Typed criteria](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedCriteria.java): `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedCriteria.java`

### SQL Adapters

- [SQL generation](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/SqlGenerator.java): `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/SqlGenerator.java`
- [Spring JDBC adapter](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java): `quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java`
- [MyBatis adapter](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-mybatis/src/main/java/io/github/yangziwen/quickdao/mybatis/BaseMybatisRepository.java): `quick-dao-mybatis/src/main/java/io/github/yangziwen/quickdao/mybatis/BaseMybatisRepository.java`
- [sql2o adapter](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-sql2o/src/main/java/io/github/yangziwen/quickdao/sql2o/BaseSql2oRepository.java): `quick-dao-sql2o/src/main/java/io/github/yangziwen/quickdao/sql2o/BaseSql2oRepository.java`

### Search Adapter

- [Elasticsearch adapter](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseReadOnlyElasticSearchRepository.java): `quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseReadOnlyElasticSearchRepository.java`
- [ES CRUD extension](https://github.com/yangziwen/quick-dao/blob/master/quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseElasticSearchRepository.java): `quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseElasticSearchRepository.java`

### Other components

- **Repository caller**
- **SQL database**
- **Elasticsearch**

## Connections

- Repository caller → Repository contracts: uses CRUD (evidence: `README.md`)
- Repository caller → Typed query builder: builds query (evidence: `README.md`)
- Repository contracts → Read and paging API: extends reads (evidence: `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseRepository.java`)
- Read and paging API → Query builder: accepts queries (evidence: `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseReadOnlyRepository.java`)
- Typed query builder → Query builder: specializes (evidence: `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java`)
- Typed query builder → Typed criteria: builds conditions (evidence: `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java`)
- Typed criteria → Criteria builder: extends conditions (evidence: `quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedCriteria.java`)
- Spring JDBC adapter → SQL generation: generates SQL (evidence: `quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java`)
- MyBatis adapter → SQL generation: uses SQL generation (evidence: `quick-dao-mybatis/src/main/java/io/github/yangziwen/quickdao/mybatis/BaseMybatisRepository.java`)
- sql2o adapter → SQL generation: uses SQL generation (evidence: `quick-dao-sql2o/src/main/java/io/github/yangziwen/quickdao/sql2o/BaseSql2oRepository.java`)
- Spring JDBC adapter → SQL database: executes statements (evidence: `quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java`)
- Spring JDBC adapter → Entity mapping: maps entities
- MyBatis adapter → SQL database: accesses database
- sql2o adapter → SQL database: accesses database
- Elasticsearch adapter → Query builder: translates queries (evidence: `quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseReadOnlyElasticSearchRepository.java`)
- Elasticsearch adapter → Elasticsearch: sends searches (evidence: `quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseReadOnlyElasticSearchRepository.java`)
- ES CRUD extension → Repository contracts: implements CRUD (evidence: `quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseElasticSearchRepository.java`)
- ES CRUD extension → Elasticsearch: performs writes
