Skip to content

Commit 036f718

Browse files
committed
DATACMNS-810 - Final tweaks to general Query by Example documentation.
Made the query-by-example.adoc a top level document. Clients including the documents have to tweak the indentation on the inclusion side then. Included query-by-example.adoc into index.adoc so that it can be double checked in test renderings easily.
1 parent ef7315a commit 036f718

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

src/main/asciidoc/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ include::preface.adoc[]
1919
:leveloffset: +1
2020
include::dependencies.adoc[]
2121
include::repositories.adoc[]
22+
include::query-by-example.adoc[]
2223
include::auditing.adoc[]
2324
:leveloffset: -1
2425

src/main/asciidoc/query-by-example.adoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
[[query.by.example]]
2-
== Query by Example
1+
[[query-by-example]]
2+
= Query by Example
33

4-
=== Introduction
4+
[[query-by-example.introduction]]
5+
== Introduction
56

67
This chapter will give you an introduction to Query by Example and explain how to use Examples.
78

89
Query by Example (QBE) is a user-friendly querying technique with a simple interface. It allows dynamic query creation and does not require to write queries containing field names. In fact, Query by Example does not require to write queries using store-specific query languages at all.
910

10-
=== Usage
11+
[[query-by-example.usage]]
12+
== Usage
1113

1214
The Query by Example API consists of three parts:
1315

@@ -48,7 +50,7 @@ public class Person {
4850
----
4951
====
5052

51-
This is a simple domain object. You can use it to create an `Example`. By default, fields having `null` values are ignored, and strings are matched using the store specific defaults. Examples can be built by either using the `of` factory method or by using <<query.by.example.matcher,`ExampleMatcher`>>. `Example` is immutable.
53+
This is a simple domain object. You can use it to create an `Example`. By default, fields having `null` values are ignored, and strings are matched using the store specific defaults. Examples can be built by either using the `of` factory method or by using <<query-by-example.matcher,`ExampleMatcher`>>. `Example` is immutable.
5254

5355
.Simple Example
5456
====
@@ -81,10 +83,10 @@ public interface QueryByExampleExecutor<T> {
8183
----
8284
====
8385

84-
You can read more about <<query.by.example.execution, Query by Example Execution>> below.
86+
You can read more about <<query-by-example.execution, Query by Example Execution>> below.
8587

86-
[[query.by.example.matcher]]
87-
=== Example matchers
88+
[[query-by-example.matchers]]
89+
== Example matchers
8890

8991
Examples are not limited to default settings. You can specify own defaults for string matching, null handling and property-specific settings using the `ExampleMatcher`.
9092

0 commit comments

Comments
 (0)