CodeCow/querydsl
1
0
Fork 0
mirror of https://github.com/querydsl/querydsl.git synced 2026-06-16 21:01:10 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated documentation

Browse Source
This commit is contained in:
Timo Westkämper 2008-08-15 09:00:26 +00:00
parent 5c684f3917
commit 85bc31b119
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
querydsl-root/src/site/xdoc/index.xml Normal file
View File

@ -0,0 +1,46 @@
<document>
<properties>
<author email="timo@mysema.com">Timo Westkämper</author>
<title>querydsl</title>
</properties>
<body>
<section name="Intro">
<p>
querydsl is a framework which enables the construction of statically typed SQL-like queries.
Instead of writing queries as inline strings or externalizing them into XML files they can be constructed via a
<a href="http://www.martinfowler.com/bliki/FluentInterface.html">fluent</a> API.
</p>
<p>
The benefits of using a fluent API in comparison to simple strings are
<ul>
<li>code completion in IDE</li>
<li>almost none syntactically invalid queries allowed</li>
<li>domain types and properties can be referenced safely</li>
<li>adopts better to refactoring changes in domain types</li>
</ul>
</p>
</section>
<section name="Modules">
<p>
querydsl is based on various modules with different purposes. The modules are
<ul>
<li><a href="../querydsl-core">querydsl-core</a> with the basic constructs used in various query language specific versions of the API</li>
<li><a href="../querydsl-annotations">querydsl-annotations</a> with Java annotations for domain and DTO types</li>
<li><a href="../querydsl-apt">querydsl-apt</a> for code generation via <a href="http://java.sun.com/j2se/1.5.0/docs/guide/apt/GettingStarted.html">APT</a></li>
<li><a href="../querydsl-hql">querydsl-hql</a> as a fluent API for <a href="http://www.hibernate.org/hib_docs/reference/en/html/queryhql.html">Hibernate HQL</a></li>
<li><a href="../querydsl-sql">querydsl-sql</a> as a fluent API for SQL</li>
</ul>
</p>
</section>
<section name="Getting started">
<p>
Read the Getting started guides of <a href="../querydsl-hql/getting-started.html">querydsl-hql</a>
if HQL is your target language or <a href="../querydsl-sql/getting-started.html">querydsl-sql</a> for SQL.
</p>
</section>
</body>
</document>