diff --git a/doc/sysdbql.7.txt b/doc/sysdbql.7.txt
index 7e5945e5066b56fcc51d3b663aee0b299f489ba6..88ce0974bf93eb6aca70d25ecd2071ce3c9d1493 100644 (file)
--- a/doc/sysdbql.7.txt
+++ b/doc/sysdbql.7.txt
NAME
----
-sysdbql - the SysDB query language
+sysdbql - the SysDB query language (SysQL)
SYNOPSIS
--------
FETCH host 'some.host.name';
- LOOKUP hosts MATCHING attribute.architecture = 'amd64'
- FILTER :age < 5 * :interval;
+ LOOKUP hosts MATCHING attribute[architecture] = 'amd64'
+ FILTER .age < 5 * .interval;
DESCRIPTION
-----------
include::sysdb-description.txt[]
-The SysDB query language is a human-readable format for describing a request
-to retrieve data from a SysDB daemon. It is very remotely similar to the
-Standard Query Language (SQL) supported by relational database management
+The SysDB query language (SysQL) is a human-readable format for describing a
+request to retrieve data from a SysDB daemon. It is very remotely similar to
+the Standard Query Language (SQL) supported by relational database management
systems (RDBMS) but specialized for SysDB's use-case.
QUERY COMMANDS
*attribute*::
The full name of a host attribute.
-*attribute.*'<name>'::
+*attribute[*'<name>'*]*::
The value of the named host attribute. If an attribute of the specified
- does not exist, each comparison is treated as if the value does not match.
- See the documentation for the *IS NULL* and *IS NOT NULL* operators for
- ways to check if an attribute exists.
+ name does not exist, each comparison is treated as if the value does not
+ match. See the documentation for the *IS NULL* and *IS NOT NULL* operators
+ for ways to check if an attribute exists.
'<value>' may either be a string (when matching by object names) or match the
type of the attribute's value (when matching attribute values). Attribute
The following fields (core properties) of stored objects may be queried:
-*:last_update*::
+*.last_update*::
The timestamp of the last update of the object. This value is based on
information provided by the queried backend if possible.
-*:age*::
+*.age*::
The amount of time since the last update of the object.
-*:interval*::
+*.interval*::
The interval with which the object gets updated. This value is determined
automatically based on a moving average determined from the update
timestamps of an object. It depends on the update timestamps as provided
by the backend (if available) and SysDB's query interval.
-*:backend*::
+*.backend*::
The name of the backend (plugin) providing the data.
The type of the *last_update*, *age*, and *interval* fields is date-time and
replies look like. The replies are pretty-printed to more easily follow them.
LIST hosts;
- {"hosts":[{
+ [{
"name": "host1.example.com",
"last_update": "2001-02-03 04:05:06 +0700",
"update_interval": "5m4s"
"name": "host2.example.com",
"last_update": "2001-02-03 04:05:06 +0700",
"update_interval": "5m4s"
- }]}
+ }]
FETCH host 'host1.example.com';
{
...
}]}
- LOOKUP hosts MATCHING attribute.architecture = 'amd64';
+ LOOKUP hosts MATCHING attribute[architecture] = 'amd64';
[{
"name": "host1.example.com",
"last_update": "2001-02-03 04:05:06 +0700",