Skip to content

Commit b8dd2ee

Browse files
committed
docs: add dynamic sql example to @select
Signed-off-by: DevDengChao <[email protected]>
1 parent 6e84c85 commit b8dd2ee

File tree

2 files changed

+30
-7
lines changed

2 files changed

+30
-7
lines changed

pom.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,10 @@
106106
<name>Tomáš Neuberg</name>
107107
<email>[email protected]</email>
108108
</contributor>
109+
<contributor>
110+
<name>DevDengChao</name>
111+
<email>[email protected]</email>
112+
</contributor>
109113
</contributors>
110114

111115
<scm>

src/main/java/org/apache/ibatis/annotations/Select.java

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,34 @@
2626
* The annotation that specify an SQL for retrieving record(s).
2727
* <p>
2828
* <b>How to use:</b>
29-
*
30-
* <pre>
31-
* public interface UserMapper {
32-
* &#064;Select("SELECT id, name FROM users WHERE id = #{id}")
33-
* User selectById(int id);
34-
* }
35-
* </pre>
29+
* <br/>
30+
* <ul>
31+
* <li>
32+
* Simple:
33+
* <pre>
34+
* public interface UserMapper {
35+
* &#064;Select("SELECT id, name FROM users WHERE id = #{id}")
36+
* User selectById(int id);
37+
* }
38+
* </pre>
39+
* </li>
40+
* <li>
41+
* Dynamic SQL:
42+
* <pre>
43+
* public interface UserMapper {
44+
* &#064;Select({"&lt;script>",
45+
* "select * from users",
46+
* "where name = #{name}",
47+
* "&lt;if test="age != null"> age = #{age} &lt;/if>",
48+
* "&lt;/script>"})
49+
* User select(@NotNull String name, @Nullable Intger age);
50+
* }
51+
* </pre>
52+
* </li>
53+
* </ul>
3654
*
3755
* @author Clinton Begin
56+
* @see <a href="https://mybatis.org/mybatis-3/dynamic-sql.html">How to use Dynamic SQL</a>
3857
*/
3958
@Documented
4059
@Retention(RetentionPolicy.RUNTIME)

0 commit comments

Comments
 (0)