How yangziwen/quick-dao works
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: BaseSpringJdbcRepository.java Spring JDBC adapter · TypedQuery.java Typed query builder · BaseRepository.java Repository contracts · Query.java Query builder
Components 16
Shared DAO API
- Repository contracts
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseRepository.java - Read and paging API
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseReadOnlyRepository.java - Entity mapping
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/EntityMeta.java
Query DSL
- Query builder
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Query.java - Typed query builder
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java - Criteria builder
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/Criteria.java - Typed criteria
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedCriteria.java
SQL Adapters
- SQL generation
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/SqlGenerator.java - Spring JDBC adapter
quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java - MyBatis adapter
quick-dao-mybatis/src/main/java/io/github/yangziwen/quickdao/mybatis/BaseMybatisRepository.java - sql2o adapter
quick-dao-sql2o/src/main/java/io/github/yangziwen/quickdao/sql2o/BaseSql2oRepository.java
Search Adapter
- Elasticsearch adapter
quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseReadOnlyElasticSearchRepository.java - ES CRUD extension
quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseElasticSearchRepository.java
Other components
- Repository caller
- SQL database
- Elasticsearch
Connections 18
- Repository caller → Repository contracts: uses CRUD
README.md - Repository caller → Typed query builder: builds query
README.md - Repository contracts → Read and paging API: extends reads
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseRepository.java - Read and paging API → Query builder: accepts queries
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/BaseReadOnlyRepository.java - Typed query builder → Query builder: specializes
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java - Typed query builder → Typed criteria: builds conditions
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedQuery.java - Typed criteria → Criteria builder: extends conditions
quick-dao-core/src/main/java/io/github/yangziwen/quickdao/core/TypedCriteria.java - Spring JDBC adapter → SQL generation: generates SQL
quick-dao-spring-jdbc/src/main/java/io/github/yangziwen/quickdao/springjdbc/BaseSpringJdbcRepository.java - MyBatis adapter → SQL generation: uses SQL generation
quick-dao-mybatis/src/main/java/io/github/yangziwen/quickdao/mybatis/BaseMybatisRepository.java - sql2o adapter → SQL generation: uses SQL generation
quick-dao-sql2o/src/main/java/io/github/yangziwen/quickdao/sql2o/BaseSql2oRepository.java - Spring JDBC adapter → SQL database: executes statements
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
quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseReadOnlyElasticSearchRepository.java - Elasticsearch adapter → Elasticsearch: sends searches
quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseReadOnlyElasticSearchRepository.java - ES CRUD extension → Repository contracts: implements CRUD
quick-dao-elasticsearch/src/main/java/io/github/yangziwen/quickdao/elasticsearch/BaseElasticSearchRepository.java - ES CRUD extension → Elasticsearch: performs writes