sysdb: Use a custom output format instead of pretty-printed JSON.

[sysdb.git] / doc / sysdbql.7.txt

diff --git a/doc/sysdbql.7.txt b/doc/sysdbql.7.txt
index 9a16e23a4593f58f7ca582728e4828b6d68205aa..587cd6cc72bee0fe71d2f046480bea47aa9f59de 100644 (file)
--- a/doc/sysdbql.7.txt
+++ b/doc/sysdbql.7.txt
@@ -129,6 +129,13 @@ Boolean expressions may use the following operators:
        expression evaluates to NULL if the queried object does not exist (e.g.,
        when accessing an attribute value).
 
        expression evaluates to NULL if the queried object does not exist (e.g.,
        when accessing an attribute value).
 

+'<expression>' *IS TRUE*::
+'<expression>' *IS NOT TRUE*::
+'<expression>' *IS FALSE*::
+'<expression>' *IS NOT FALSE*::
+       Check whether an expression evaluates to a boolean *true* or *false* value
+       (or not).
+

 '<expression>' *IN* '<expression>'::
 '<expression>' *NOT IN* '<expression>'::
        Checks whether the value of the first expression is included in the value
 '<expression>' *IN* '<expression>'::
 '<expression>' *NOT IN* '<expression>'::
        Checks whether the value of the first expression is included in the value


@@ -177,6 +184,17 @@ The following fields may be queried:
        an attribute value with some other value, the two values will be cast to
        strings before comparing them.
 
        an attribute value with some other value, the two values will be cast to
        strings before comparing them.
 

+*value*::
+       *(Attributes only)* The value of an attribute. Attributes may be accessed
+       by iterating the values of the parent object and this field provides
+       access to its value in that case. See *attribute[*'<name>'*]* above for
+       details about how to handle attribute values.
+
+*timeseries*::
+       *(Metrics only)* A boolean value indicating whether a backend data-store
+       for fetching time-series information is known to SysDB. See the section
+       "Metrics and Time-Series" in manpage:sysdb[7] for details.
+

 Field expressions may be applied to parent or child nodes. For example, a
 host's services are child objects and the host is the parent of the service
 objects. This is done using typed expressions:
 Field expressions may be applied to parent or child nodes. For example, a
 host's services are child objects and the host is the parent of the service
 objects. This is done using typed expressions:


@@ -245,7 +263,7 @@ storing the different data types:
        provided as well. If omitted, the current time on the server will be used
        instead.
 
        provided as well. If omitted, the current time on the server will be used
        instead.
 

-*STORE* metric '<hostname>'.'<name>' STORE '<type>' '<id>' [*LAST UPDATE* '<datetime>']::
+*STORE* metric '<hostname>'.'<name>' STORE '<type>' '<id>' ['<datetime>'] [*LAST UPDATE* '<datetime>']::

        Store a metric and provide information about the metric store associated
        with it. A metric store describes how to access a metric's data and can be
        used to retrieve time-series information associated with the metric. See
        Store a metric and provide information about the metric store associated
        with it. A metric store describes how to access a metric's data and can be
        used to retrieve time-series information associated with the metric. See