summaryrefslogtreecommitdiff
path: root/doc/querylanguage.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2021-12-07 09:23:00 +0000
committerPaul Buetow <paul@buetow.org>2021-12-07 09:23:00 +0000
commit1fa1f0329442c555635460221c809fecdaa977a7 (patch)
tree65a8060a974f570ef4b1180fc6373d63e2ab5d57 /doc/querylanguage.md
parent6031ce78df6cda9c8b924b231554bb4e0c077358 (diff)
initial logformats and querylanguage documentation
Diffstat (limited to 'doc/querylanguage.md')
-rw-r--r--doc/querylanguage.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/querylanguage.md b/doc/querylanguage.md
new file mode 100644
index 0000000..9f38f5e
--- /dev/null
+++ b/doc/querylanguage.md
@@ -0,0 +1,18 @@
+DTail Query Language
+====================
+
+The query language allows you to run mapreduce queries on log files. This page intends to be a reference to the language.
+
+## Prerequisites
+
+For this to work, DTail needs to understand your log format. DTail already understands its own log format. You can have a look at all examples of the [examples](./examples.md) page using `-query` (these would be all examples of the `dmap` command, and some examples using the `dtail` command).
+
+DTail also ships with a generic log format, which only allows you to run very basic queries. Check out the [log formats](./logformats.md) documentation for this.
+
+To implement your own log format, please also check out the [log formats](./logformats.md) documentation.
+
+## The complete language
+
+```
+TODO: Add EBNF
+```