Skip to content

Commit b545caf

Browse files
[docs] Update README (darrachequesne#45)
1 parent 067d4e4 commit b545caf

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,19 +88,23 @@ It overrides jQuery data serialization to allow Spring MVC to correctly map inpu
8888
#### On the server-side
8989

9090
The repositories now expose the following methods:
91-
* `DataTablesOutput<T> findAll(DataTablesInput input);`
92-
* `DataTablesOutput<T> findAll(DataTablesInput input, Specification<T> additionalSpecification);`
93-
* `DataTablesOutput<T> findAll(DataTablesInput input, Specification<T> additionalSpecification, Specification<T> preFilteringSpecification);`
91+
* `DataTablesOutput<T> findAll(DataTablesInput i);`
92+
* `DataTablesOutput<R> findAll(DataTablesInput i, Converter<T, R> c);`
93+
* `DataTablesOutput<T> findAll(DataTablesInput i, Specification<T> a);`
94+
* `DataTablesOutput<T> findAll(DataTablesInput i, Specification<T> a, Specification<T> p);`
95+
* `DataTablesOutput<R> findAll(DataTablesInput i, Specification<T> a, Specification<T> p, Converter<T, R> c);`
9496

95-
Note: since version 2.0, QueryDSL is also supported:
97+
**Note**: since version 2.0, QueryDSL is also supported:
9698
* replace `DataTablesRepositoryFactoryBean` with `QDataTablesRepositoryFactoryBean`
9799
* replace `DataTablesRepository` with `QDataTablesRepository`
98100

99101
and your repositories will now expose:
100102

101-
* `DataTablesOutput<T> findAll(DataTablesInput input);`
102-
* `DataTablesOutput<T> findAll(DataTablesInput input, com.mysema.querydsl.Predicate additionalPredicate);`
103-
* `DataTablesOutput<T> findAll(DataTablesInput input, com.mysema.querydsl.Predicate additionalPredicate, com.mysema.querydsl.Predicate preFilteringPredicate);`
103+
* `DataTablesOutput<T> findAll(DataTablesInput i);`
104+
* `DataTablesOutput<R> findAll(DataTablesInput i, Converter<T, R> c);`
105+
* `DataTablesOutput<T> findAll(DataTablesInput i, com.mysema.querydsl.Predicate a);`
106+
* `DataTablesOutput<T> findAll(DataTablesInput i, com.mysema.querydsl.Predicate a, com.mysema.querydsl.Predicate p);`
107+
* `DataTablesOutput<R> findAll(DataTablesInput i, com.mysema.querydsl.Predicate a, com.mysema.querydsl.Predicate p, Converter<T, R> c);`
104108

105109
Your controllers should be able to handle the parameters sent by DataTables:
106110

@@ -207,5 +211,8 @@ Supported filters:
207211
* Strings (`WHERE <column> LIKE %<input>%`)
208212
* Booleans
209213
* Array of values (`WHERE <column> IN (<input>)` where input is something like 'PARAM1+PARAM2+PARAM4')
214+
* `NULL` values are also supported: 'PARAM1+PARAM3+NULL' becomes `WHERE (<column> IN ('PARAM1', 'PARAM3') OR <column> IS NULL)` (to actually search for 'NULL' string, please use `\NULL`)
210215
211216
Also supports paging and sorting.
217+
218+
**Note**: the `regex` flag is currently ignored because JPQL only supports `LIKE` expressions (with `%` and `_` tokens).

0 commit comments

Comments
 (0)