Skip to content

Commit 6b54536

Browse files
authored
Clean README.md (#590)
[skip ci]
1 parent dd8cedf commit 6b54536

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Doma has various strengths:
2020
Examples
2121
---------------------
2222

23-
### type-safe Criteria API
23+
### Type-safe Criteria API
2424

2525
Written in Java 8:
2626

@@ -58,34 +58,35 @@ val list = entityql
5858
.fetch()
5959
```
6060

61-
### two-way SQL
61+
See [Criteria API](https://doma.readthedocs.io/en/latest/criteria-api/)
62+
for more information.
6263

63-
selectByExample.sql:
64+
### SQL templates
6465

65-
```sql
66-
select * from EMPLOYEE where
67-
/*%if e.employeeNo > 7800*/
68-
/*%if e.managerId != null*/
69-
salary >= /*e.salary*/9999
70-
/*%end*/
71-
/*%end*/
72-
```
73-
74-
Doma maps the above SQL template to the following DAO interface:
66+
Written in Java 15:
7567

7668
```java
7769
@Dao
7870
public interface EmployeeDao {
7971

72+
@Sql(
73+
"""
74+
select * from EMPLOYEE where
75+
/*%if salary != null*/
76+
SALARY >= /*salary*/9999
77+
/*%end*/
78+
""")
8079
@Select
81-
List<Employee> selectByExample(Employee e);
80+
List<Employee> selectBySalary(BigDecimal salary);
8281
}
8382
```
8483

85-
### Other Examples
84+
See [SQL templates](https://doma.readthedocs.io/en/latest/sql/)
85+
for more information.
86+
87+
### More Examples
8688

87-
Try following getting started example:
88-
- [Getting started](https://doma.readthedocs.io/en/latest/getting-started/)
89+
Try [Getting started](https://doma.readthedocs.io/en/latest/getting-started/).
8990

9091
For more complete examples,
9192
see [simple-examples](https://github.com/domaframework/simple-examples)
@@ -126,10 +127,10 @@ https://groups.google.com/g/doma-user
126127
Related projects
127128
---------------------
128129

129-
- [doma-spring-boot](https://github.com/domaframework/doma-spring-boot) : Supports integration with Spring Boot
130-
- [doma-quarkus](https://github.com/domaframework/doma-quarkus) : Supports integration with Quarkus
131-
- [doma-compile-plugin](https://github.com/domaframework/doma-compile-plugin) : Makes compilation easy
132-
- [doma-codegen-plugin](https://github.com/domaframework/doma-codegen-plugin) : Generates Java and SQL files
130+
- [doma-spring-boot](https://github.com/domaframework/doma-spring-boot) - Supports integration with Spring Boot
131+
- [doma-quarkus](https://github.com/domaframework/doma-quarkus) - Supports integration with Quarkus
132+
- [doma-compile-plugin](https://github.com/domaframework/doma-compile-plugin) - Makes compilation easy
133+
- [doma-codegen-plugin](https://github.com/domaframework/doma-codegen-plugin) - Generates Java and SQL files
133134

134135
Major versions
135136
---------------------

0 commit comments

Comments
 (0)