DATACMNS-145 - Added Docbook file to list all supported keywords.

This commit is contained in:
Oliver Gierke
2012-04-10 18:48:23 +02:00
parent 08b26665d8
commit 171de78200

View File

@@ -0,0 +1,200 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<appendix id="repository-query-keywords">
<title>Repository query keywords</title>
<section>
<title>Supported query keywords</title>
<para>The following table lists the keywords generally supported by the
Spring data repository query derivation mechanism. However consult the
store specific documentation for the exact list of supported keywords as
some of the ones listed here might not be supported in a particular
store.</para>
<table>
<title>Query keywords</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="4*" />
<thead>
<row>
<entry>Logical keyword</entry>
<entry>Keyword expressions</entry>
</row>
</thead>
<tbody>
<row>
<entry><code>AFTER</code></entry>
<entry><literal>After</literal>,
<literal>IsAfter</literal></entry>
</row>
<row>
<entry><code>BEFORE</code></entry>
<entry><literal>Before</literal>,
<literal>IsBefore</literal></entry>
</row>
<row>
<entry><code>CONTAINING</code></entry>
<entry><literal>Containing</literal>,
<literal>IsContaining</literal>,
<literal>Contains</literal></entry>
</row>
<row>
<entry><code>BETWEEN</code></entry>
<entry><literal>Between</literal>,
<literal>IsBetween</literal></entry>
</row>
<row>
<entry><code>ENDING_WITH</code></entry>
<entry><literal>EndingWith</literal>,
<literal>IsEndingWith</literal>,
<literal>EndsWith</literal></entry>
</row>
<row>
<entry><code>EXISTS</code></entry>
<entry><literal>Exists</literal></entry>
</row>
<row>
<entry><code>FALSE</code></entry>
<entry><literal>False</literal>,
<literal>IsFalse</literal></entry>
</row>
<row>
<entry><code>GREATER_THAN</code></entry>
<entry><literal>GreaterThan</literal>,
<literal>IsGreaterThan</literal></entry>
</row>
<row>
<entry><code>GREATER_THAN_EQUALS</code></entry>
<entry><literal>GreaterThanEqual</literal>,
<literal>IsGreaterThanEqual</literal></entry>
</row>
<row>
<entry><code>IN</code></entry>
<entry><literal>In</literal>, <literal>IsIn</literal></entry>
</row>
<row>
<entry><code>IS</code></entry>
<entry><literal>Is</literal>, <literal>Equals</literal>, (or no
keyword)</entry>
</row>
<row>
<entry><code>IS_NOT_NULL</code></entry>
<entry><literal>NotNull</literal>,
<literal>IsNotNull</literal></entry>
</row>
<row>
<entry><code>IS_NULL</code></entry>
<entry><literal>Null</literal>, <literal>IsNull</literal></entry>
</row>
<row>
<entry><code>LESS_THAN</code></entry>
<entry><literal>LessThan</literal>,
<literal>IsLessThan</literal></entry>
</row>
<row>
<entry><code>LESS_THAN_EQUAL</code></entry>
<entry><literal>LessThanEqual</literal>,
<literal>IsLessThanEqual</literal></entry>
</row>
<row>
<entry><code>LIKE</code></entry>
<entry><literal>Like</literal>, <literal>IsLike</literal></entry>
</row>
<row>
<entry><code>NEAR</code></entry>
<entry><literal>Near</literal>, <literal>IsNear</literal></entry>
</row>
<row>
<entry><code>NOT</code></entry>
<entry><literal>Not</literal>, <literal>IsNot</literal></entry>
</row>
<row>
<entry><code>NOT_IN</code></entry>
<entry><literal>NotIn</literal>,
<literal>IsNotIn</literal></entry>
</row>
<row>
<entry><code>NOT_LIKE</code></entry>
<entry><literal>NotLike</literal>,
<literal>IsNotLike</literal></entry>
</row>
<row>
<entry><code>REGEX</code></entry>
<entry><literal>Regex</literal>, <literal>MatchesRegex</literal>,
<literal>Matches</literal></entry>
</row>
<row>
<entry><code>STARTING_WITH</code></entry>
<entry><literal>StartingWith</literal>,
<literal>IsStartingWith</literal>,
<literal>StartsWith</literal></entry>
</row>
<row>
<entry><code>TRUE</code></entry>
<entry><literal>True</literal>, <literal>IsTrue</literal></entry>
</row>
<row>
<entry><code>WITHIN</code></entry>
<entry><literal>Within</literal>,
<literal>IsWithin</literal></entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</appendix>