store: Added quaryable field ‘name’.

[sysdb.git] / src / include / core / store.h

diff --git a/src/include/core/store.h b/src/include/core/store.h
index 8eaeecdc3f554998e2a63fee3b15bbce50a6125b..90416a2cc0699cc3df67d50ac516a1d415a9f058 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
@@ -32,6 +32,7 @@
 #include "core/object.h"
 #include "core/data.h"
 #include "core/time.h"
+#include "core/timeseries.h"
 #include "utils/strbuf.h"
 
 #include <stdio.h>
@@ -67,14 +68,16 @@ typedef struct sdb_store_obj sdb_store_obj_t;
  * Queryable fields of a stored object.
  */
 enum {
-       SDB_FIELD_LAST_UPDATE = 1, /* datetime */
-       SDB_FIELD_AGE,             /* datetime */
-       SDB_FIELD_INTERVAL,        /* datetime */
-       SDB_FIELD_BACKEND,         /* string */
+       SDB_FIELD_NAME = 1,    /* string */
+       SDB_FIELD_LAST_UPDATE, /* datetime */
+       SDB_FIELD_AGE,         /* datetime */
+       SDB_FIELD_INTERVAL,    /* datetime */
+       SDB_FIELD_BACKEND,     /* string */
 };
 
 #define SDB_FIELD_TO_NAME(f) \
-       (((f) == SDB_FIELD_LAST_UPDATE) ? "last-update" \
+       (((f) == SDB_FIELD_NAME) ? "name" \
+               : ((f) == SDB_FIELD_LAST_UPDATE) ? "last-update" \
                : ((f) == SDB_FIELD_AGE) ? "age" \
                : ((f) == SDB_FIELD_INTERVAL) ? "interval" \
                : ((f) == SDB_FIELD_BACKEND) ? "backend" : "unknown")
@@ -144,8 +147,7 @@ sdb_store_attribute(const char *hostname,
  * specified 'service' object. If the referenced host does not exist, an error
  * will be reported. Else, a new entry will be created in the store. Any
  * memory required for storing the entry will be allocated an managed by the
- * store itself. The specified service-object will not be referenced or
- * further accessed.
+ * store itself.
  *
  * Returns:
  *  - 0 on success
@@ -175,6 +177,14 @@ int
 sdb_store_service_attr(const char *hostname, const char *service,
                const char *key, const sdb_data_t *value, sdb_time_t last_update);
 
+/*
+ * A metric store describes how to access a metric's data.
+ */
+typedef struct {
+       const char *type;
+       const char *id;
+} sdb_metric_store_t;
+
 /*
  * sdb_store_metric:
  * Add/update a metric in the store. If the metric, identified by its name,
@@ -182,8 +192,9 @@ sdb_store_service_attr(const char *hostname, const char *service,
  * specified 'metric' object. If the referenced host does not exist, an error
  * will be reported. Else, a new entry will be created in the store. Any
  * memory required for storing the entry will be allocated an managed by the
- * store itself. The specified metric-object will not be referenced or
- * further accessed.
+ * store itself.
+ *
+ * If specified, the metric store describes where to access the metric's data.
  *
  * Returns:
  *  - 0 on success
@@ -193,7 +204,7 @@ sdb_store_service_attr(const char *hostname, const char *service,
  */
 int
 sdb_store_metric(const char *hostname, const char *name,
-               sdb_time_t last_update);
+               sdb_metric_store_t *store, sdb_time_t last_update);
 
 /*
  * sdb_store_metric_attr:
@@ -213,6 +224,19 @@ int
 sdb_store_metric_attr(const char *hostname, const char *metric,
                const char *key, const sdb_data_t *value, sdb_time_t last_update);
 
+/*
+ * sdb_store_fetch_timeseries:
+ * Fetch the time-series described by the specified host's metric and
+ * serialize it as JSON into the provided string buffer.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_store_fetch_timeseries(const char *hostname, const char *metric,
+               sdb_timeseries_opts_t *opts, sdb_strbuf_t *buf);
+
 /*
  * sdb_store_get_field:
  * Get the value of a stored object's queryable field. The caller is
@@ -375,6 +399,17 @@ sdb_store_ge_matcher(sdb_store_cond_t *cond);
 sdb_store_matcher_t *
 sdb_store_gt_matcher(sdb_store_cond_t *cond);
 
+/*
+ * sdb_store_parse_object_type_plural:
+ * Parse the type name (plural) of a stored object.
+ *
+ * Returns:
+ *  - the object type on success
+ *  - a negative value else
+ */
+int
+sdb_store_parse_object_type_plural(const char *name);
+
 /*
  * sdb_store_parse_field_name:
  * Parse the name of a stored object's queryable field.
@@ -485,8 +520,9 @@ sdb_store_scan(sdb_store_matcher_t *m, sdb_store_matcher_t *filter,
 /*
  * Flags for serialization functions.
  *
- * By default, the full object will be included in the serialized output. When
- * specifying any of the flags, the respective information will be left out.
+ * By default, the full host object will be included in the serialized output.
+ * When specifying any of the flags, the respective information will be left
+ * out. The SKIP_EMPTY flags may be used to skip host objects entirely.
  */
 enum {
        SDB_SKIP_ATTRIBUTES         = 1 << 0,
@@ -494,7 +530,11 @@ enum {
        SDB_SKIP_METRICS            = 1 << 2,
        SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 3,
 
-       SDB_SKIP_ALL                = 0xffff,
+       SDB_SKIP_ALL                = (1 << 8) - 1,
+
+       /* skip hosts if they do not reference any services/metrics */
+       SDB_SKIP_EMPTY_SERVICES     = 1 << 8,
+       SDB_SKIP_EMPTY_METRICS      = 1 << 9,
 };
 
 /*