Skip to content

Commit 29851cb

Browse files
Add a bit more in query help (#5292)
1 parent 0739aac commit 29851cb

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/KurrentDB/Components/Query/QueryHelpDialog.razor

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,20 @@ Query one or more available sources like streams, categories, or everything.
3838
3939
**Consider adding `limit` to the query to constrain the scan surface.**
4040
41+
##### Available predicates
42+
43+
You can use top-level predicates as well as JSON predicates on payload and metadata.
44+
45+
Top-level predicates are available on:
46+
* `log_position`: commit position (bigint)
47+
* `stream`: stream name (varchar)
48+
* `event_number`: event number in a stream (int)
49+
* `created_at`: record append time (timestamp, for example `1992-09-20 11:30:00.123`)
50+
51+
JSON predicates are available on:
52+
* `data`: event payload
53+
* `metadata`: custom event metadata
54+
4155
##### Example query
4256
4357
The query will find all events from a category `Telemetry` where the `Version` property is set, and then count the number of

0 commit comments

Comments
 (0)