# dromara/easy-query architecture

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

- Interactive diagram: https://gitdiagram.com/dromara/easy-query
- Repository: https://github.com/dromara/easy-query
- Video tour (about a minute): https://gitdiagram.com/dromara/easy-query/video

## Overview

EasyQuery is a Java ORM and fluent SQL-query framework. Its principal workflow lets an application build an entity query, apply relational and aggregation operations, execute it against a database, and receive mapped results. The README also documents implicit relationship queries, pagination, sharding, dialect support, caching, search, and framework integrations, represented as additional capabilities. The excerpts show query APIs and expression-building utilities, but do not expose the full execution wiring; uncertain runtime connections are therefore shown as unverified.

Main entry points: [`sql-core/src/main/java/com/easy/query/core/basic/api/select/ClientQueryable.java`](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/basic/api/select/ClientQueryable.java) (Fluent Queries), [`sql-core/src/main/java/com/easy/query/core/basic/api/select/abstraction/AbstractClientQueryable.java`](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/basic/api/select/abstraction/AbstractClientQueryable.java) (Query Execution), [`sql-core/src/main/java/com/easy/query/core/context/QueryRuntimeContext.java`](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/context/QueryRuntimeContext.java) (Runtime Context), [`sql-core/src/main/java/com/easy/query/core/api/client/DefaultEasyQueryClient.java`](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/api/client/DefaultEasyQueryClient.java) (Client Factory)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Query API"]
  node_query["Fluent Queries"]
  node_queryimpl["Query Execution"]
  node_client["Client Factory"]
  node_crud["Entity Mutations"]
  node_codefirst["Code First"]
end

subgraph group_engine["SQL Engine"]
  node_metadata["Entity Metadata"]
  node_expression["SQL Expressions"]
  node_predicates["Predicate Segments"]
  node_include["Relationship Includes"]
end

subgraph group_runtime["Execution Runtime"]
  node_runtimecontext["Runtime Context"]
  node_jdbc["JDBC Execution"]
  node_dialects["Database Dialects"]
end

subgraph group_capabilities["Product Capabilities"]
  node_pagination["Pagination And Sharding"]
  node_proxy["Entity Proxies"]
  node_cache["Query Cache"]
  node_search["Search Extension"]
  node_spring["Spring Integration"]
  node_solon["Solon Integration"]
end

node_application(("Application"))
node_database[("SQL Database")]

node_application -->|"builds queries"| node_query
node_query -.->|"configures"| node_queryimpl
node_queryimpl -.->|"builds SQL"| node_expression
node_queryimpl -.->|"executes query"| node_database
node_queryimpl -->|"returns results"| node_application
node_client -->|"creates queries"| node_query
node_client -->|"creates mutations"| node_crud
node_client -->|"exposes schema"| node_codefirst
node_query -->|"supports relations"| node_include
node_query -->|"supports paging"| node_pagination
node_expression -->|"uses conditions"| node_predicates
node_runtimecontext -->|"provides metadata"| node_metadata
node_runtimecontext -->|"provides executor"| node_jdbc
node_jdbc -.->|"sends SQL"| node_database
node_expression -.->|"renders dialect SQL"| node_dialects
node_application -.->|"may query through"| node_proxy
node_query -.->|"optional caching"| node_cache
node_query -.->|"optional search"| node_search
node_spring -.->|"configures runtime"| node_runtimecontext
node_solon -.->|"configures runtime"| node_runtimecontext

click node_query "https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/basic/api/select/ClientQueryable.java"
click node_queryimpl "https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/basic/api/select/abstraction/AbstractClientQueryable.java"
click node_client "https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/api/client/DefaultEasyQueryClient.java"
click node_crud "https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/basic/api"
click node_codefirst "https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/basic/api/database"
click node_metadata "https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/metadata"
click node_expression "https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/util/EasySQLExpressionUtil.java"
click node_predicates "https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/expression/segment/condition/PredicateSegment.java"
click node_include "https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/expression/sql/include/DefaultIncludeParserEngine.java"
click node_runtimecontext "https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/context/QueryRuntimeContext.java"
click node_jdbc "https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/basic/api/jdbc"
click node_dialects "https://github.com/dromara/easy-query/tree/main/sql-db-support"
click node_pagination "https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/api/pagination"
click node_proxy "https://github.com/dromara/easy-query/blob/main/sql-platform/sql-api-proxy/src/main/java/com/easy/query/api/proxy/entity/EntityQueryProxyManager.java"
click node_cache "https://github.com/dromara/easy-query/tree/main/sql-extension/sql-cache/src/main/java/com/easy/query/cache/core/impl"
click node_search "https://github.com/dromara/easy-query/tree/main/sql-extension/sql-search/src/main/java/com/easy/query/search"
click node_spring "https://github.com/dromara/easy-query/tree/main/sql-extension/sql-springboot-starter/src/main/java/com/easy/query/sql/starter"
click node_solon "https://github.com/dromara/easy-query/tree/main/sql-extension/sql-solon-plugin/src/main/java/com/easy/query/solon/integration"

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_query,node_queryimpl,node_client,node_crud,node_codefirst toneBlue
class node_metadata,node_expression,node_predicates,node_include,node_database toneAmber
class node_runtimecontext,node_jdbc,node_dialects toneMint
class node_pagination,node_proxy,node_cache,node_search,node_spring,node_solon toneRose
class node_application toneIndigo
```

## Components

### Query API

- [Fluent Queries](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/basic/api/select/ClientQueryable.java): `sql-core/src/main/java/com/easy/query/core/basic/api/select/ClientQueryable.java`
- [Query Execution](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/basic/api/select/abstraction/AbstractClientQueryable.java): `sql-core/src/main/java/com/easy/query/core/basic/api/select/abstraction/AbstractClientQueryable.java`
- [Client Factory](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/api/client/DefaultEasyQueryClient.java): `sql-core/src/main/java/com/easy/query/core/api/client/DefaultEasyQueryClient.java`
- [Entity Mutations](https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/basic/api): `sql-core/src/main/java/com/easy/query/core/basic/api`
- [Code First](https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/basic/api/database): `sql-core/src/main/java/com/easy/query/core/basic/api/database`

### SQL Engine

- [Entity Metadata](https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/metadata): `sql-core/src/main/java/com/easy/query/core/metadata`
- [SQL Expressions](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/util/EasySQLExpressionUtil.java): `sql-core/src/main/java/com/easy/query/core/util/EasySQLExpressionUtil.java`
- [Predicate Segments](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/expression/segment/condition/PredicateSegment.java): `sql-core/src/main/java/com/easy/query/core/expression/segment/condition/PredicateSegment.java`
- [Relationship Includes](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/expression/sql/include/DefaultIncludeParserEngine.java): `sql-core/src/main/java/com/easy/query/core/expression/sql/include/DefaultIncludeParserEngine.java`

### Execution Runtime

- [Runtime Context](https://github.com/dromara/easy-query/blob/main/sql-core/src/main/java/com/easy/query/core/context/QueryRuntimeContext.java): `sql-core/src/main/java/com/easy/query/core/context/QueryRuntimeContext.java`
- [JDBC Execution](https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/basic/api/jdbc): `sql-core/src/main/java/com/easy/query/core/basic/api/jdbc`
- [Database Dialects](https://github.com/dromara/easy-query/tree/main/sql-db-support): `sql-db-support`

### Product Capabilities

- [Pagination And Sharding](https://github.com/dromara/easy-query/tree/main/sql-core/src/main/java/com/easy/query/core/api/pagination): `sql-core/src/main/java/com/easy/query/core/api/pagination`
- [Entity Proxies](https://github.com/dromara/easy-query/blob/main/sql-platform/sql-api-proxy/src/main/java/com/easy/query/api/proxy/entity/EntityQueryProxyManager.java): `sql-platform/sql-api-proxy/src/main/java/com/easy/query/api/proxy/entity/EntityQueryProxyManager.java`
- [Query Cache](https://github.com/dromara/easy-query/tree/main/sql-extension/sql-cache/src/main/java/com/easy/query/cache/core/impl): `sql-extension/sql-cache/src/main/java/com/easy/query/cache/core/impl`
- [Search Extension](https://github.com/dromara/easy-query/tree/main/sql-extension/sql-search/src/main/java/com/easy/query/search): `sql-extension/sql-search/src/main/java/com/easy/query/search`
- [Spring Integration](https://github.com/dromara/easy-query/tree/main/sql-extension/sql-springboot-starter/src/main/java/com/easy/query/sql/starter): `sql-extension/sql-springboot-starter/src/main/java/com/easy/query/sql/starter`
- [Solon Integration](https://github.com/dromara/easy-query/tree/main/sql-extension/sql-solon-plugin/src/main/java/com/easy/query/solon/integration): `sql-extension/sql-solon-plugin/src/main/java/com/easy/query/solon/integration`

### Other components

- **Application**
- **SQL Database**

## Connections

- Application → Fluent Queries: builds queries (evidence: `README.md`)
- Fluent Queries → Query Execution: configures (evidence: `sql-core/src/main/java/com/easy/query/core/basic/api/select/abstraction/AbstractClientQueryable.java`)
- Query Execution → SQL Expressions: builds SQL
- Query Execution → SQL Database: executes query
- Query Execution → Application: returns results (evidence: `README.md`)
- Client Factory → Fluent Queries: creates queries (evidence: `sql-core/src/main/java/com/easy/query/core/api/client/DefaultEasyQueryClient.java`)
- Client Factory → Entity Mutations: creates mutations (evidence: `sql-core/src/main/java/com/easy/query/core/api/client/DefaultEasyQueryClient.java`)
- Client Factory → Code First: exposes schema (evidence: `sql-core/src/main/java/com/easy/query/core/api/client/DefaultEasyQueryClient.java`)
- Fluent Queries → Relationship Includes: supports relations (evidence: `README.md`)
- Fluent Queries → Pagination And Sharding: supports paging (evidence: `README.md`)
- SQL Expressions → Predicate Segments: uses conditions (evidence: `sql-core/src/main/java/com/easy/query/core/util/EasySQLExpressionUtil.java`)
- Runtime Context → Entity Metadata: provides metadata (evidence: `sql-core/src/main/java/com/easy/query/core/context/QueryRuntimeContext.java`)
- Runtime Context → JDBC Execution: provides executor (evidence: `sql-core/src/main/java/com/easy/query/core/context/QueryRuntimeContext.java`)
- JDBC Execution → SQL Database: sends SQL
- SQL Expressions → Database Dialects: renders dialect SQL (evidence: `sql-db-support/sql-mssql/src/main/java/com/easy/query/mssql/expression/MsSQLQuerySQLExpression.java`)
- Application → Entity Proxies: may query through
- Fluent Queries → Query Cache: optional caching
- Fluent Queries → Search Extension: optional search
- Spring Integration → Runtime Context: configures runtime
- Solon Integration → Runtime Context: configures runtime
