Skip to content

Commit efbadfe

Browse files
committed
Add Docs on EQL
1 parent 8791851 commit efbadfe

5 files changed

Lines changed: 658 additions & 0 deletions

File tree

docs/query/background/overview.html

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,70 @@ <h1><a href="/docs/">Documentation</a><span class="sep">&nbsp;/&nbsp;</span><a h
8888

8989

9090
<div class="bs-docs-section">
91+
92+
<h2 id="query-methods-by-version">Query Methods by Version</h2>
93+
94+
<table class="table table-bordered">
95+
<thead>
96+
<tr>
97+
<th>Query Method</th>
98+
<th>Ebean 16.x</th>
99+
<th>Ebean 17.x</th>
100+
<th>Notes</th>
101+
</tr>
102+
</thead>
103+
<tbody>
104+
<tr>
105+
<td><strong>Query Beans</strong> (e.g., <code>new QCustomer()...</code>)</td>
106+
<td></td>
107+
<td>✓ Recommended</td>
108+
<td>Type-safe, compile-time checking, IDE auto-completion</td>
109+
</tr>
110+
<tr>
111+
<td><strong>Standard Query API</strong> (e.g., <code>DB.find(Class).where()...</code>)</td>
112+
<td></td>
113+
<td></td>
114+
<td>Fluent API with string property names</td>
115+
</tr>
116+
<tr>
117+
<td><strong>DB.createQuery(Class)</strong></td>
118+
<td></td>
119+
<td></td>
120+
<td>Creates Query object (equivalent to DB.find)</td>
121+
</tr>
122+
<tr>
123+
<td><strong>DB.createQuery(Class, eqlString)</strong></td>
124+
<td></td>
125+
<td>✗ Removed</td>
126+
<td>EQL (Ebean Query Language) support removed in 17.x</td>
127+
</tr>
128+
<tr>
129+
<td><strong>Named Queries</strong> (@NamedQuery with EQL)</td>
130+
<td></td>
131+
<td>Deprecated</td>
132+
<td>EQL syntax no longer actively developed in 17.x</td>
133+
</tr>
134+
<tr>
135+
<td><strong>Raw SQL / SqlQuery</strong> (e.g., <code>DB.sqlQuery("select...")</code>)</td>
136+
<td></td>
137+
<td></td>
138+
<td>For complex database-specific queries</td>
139+
</tr>
140+
<tr>
141+
<td><strong>Native SQL</strong> (e.g., <code>DB.findNative(Class, sql)</code>)</td>
142+
<td></td>
143+
<td></td>
144+
<td>For raw SQL queries with entity mapping</td>
145+
</tr>
146+
</tbody>
147+
</table>
148+
149+
<div class="alert alert-info">
150+
<strong>Migration note:</strong> If you are upgrading from Ebean 16.x to 17.x and using EQL queries,
151+
see the <a href="/docs/query/eql">EQL documentation</a> and <a href="/docs/upgrading">upgrading guide</a>
152+
for migration examples using Query Beans or standard Query API.
153+
</div>
154+
91155
<h2 id="notsqlreplacement">Not a SQL replacement</h2>
92156

93157
<div class="row mvm">

0 commit comments

Comments
 (0)