Code

store: Added field type VALUE for attribute values.
[sysdb.git] / src / include / core / store.h
index a8208bf7d9a0a849e16c6316616af092e4b1e9b5..94a571345852481b89479fd6664f2fc484c103b9 100644 (file)
@@ -60,6 +60,7 @@ enum {
        SDB_FIELD_AGE,           /* type: datetime */
        SDB_FIELD_INTERVAL,      /* type: datetime */
        SDB_FIELD_BACKEND,       /* type: array of strings */
+       SDB_FIELD_VALUE,         /* attributes only;  type: type of the value */
 };
 #define SDB_STORE_TYPE_TO_NAME(t) \
        (((t) == SDB_HOST) ? "host" \
@@ -76,7 +77,9 @@ enum {
                : ((f) == SDB_FIELD_LAST_UPDATE) ? "last-update" \
                : ((f) == SDB_FIELD_AGE) ? "age" \
                : ((f) == SDB_FIELD_INTERVAL) ? "interval" \
-               : ((f) == SDB_FIELD_BACKEND) ? "backend" : "unknown")
+               : ((f) == SDB_FIELD_BACKEND) ? "backend" \
+               : ((f) == SDB_FIELD_VALUE) ? "value" \
+               : "unknown")
 
 #define SDB_FIELD_TYPE(f) \
        (((f) == SDB_FIELD_NAME) ? SDB_TYPE_STRING \
@@ -84,6 +87,7 @@ enum {
                : ((f) == SDB_FIELD_AGE) ? SDB_TYPE_DATETIME \
                : ((f) == SDB_FIELD_INTERVAL) ? SDB_TYPE_DATETIME \
                : ((f) == SDB_FIELD_BACKEND) ? (SDB_TYPE_ARRAY | SDB_TYPE_STRING) \
+               : ((f) == SDB_FIELD_VALUE) ? -1 /* unknown */ \
                : -1)
 
 /*
@@ -94,6 +98,14 @@ enum {
 struct sdb_store_obj;
 typedef struct sdb_store_obj sdb_store_obj_t;
 
+/*
+ * A metric store describes how to access a metric's data.
+ */
+typedef struct {
+       const char *type;
+       const char *id;
+} sdb_metric_store_t;
+
 /*
  * Expressions represent arithmetic expressions based on stored objects and
  * their various attributes.
@@ -105,6 +117,13 @@ struct sdb_store_expr;
 typedef struct sdb_store_expr sdb_store_expr_t;
 #define SDB_STORE_EXPR(obj) ((sdb_store_expr_t *)(obj))
 
+/*
+ * An expression iterator iterates over the values of an iterable expression
+ * (see sdb_store_expr_iterable).
+ */
+struct sdb_store_expr_iter;
+typedef struct sdb_store_expr_iter sdb_store_expr_iter_t;
+
 /*
  * Store matchers may be used to lookup hosts from the store based on their
  * various attributes. Service and attribute matchers are applied to a host's
@@ -125,6 +144,28 @@ typedef struct sdb_store_matcher sdb_store_matcher_t;
 struct sdb_store_json_formatter;
 typedef struct sdb_store_json_formatter sdb_store_json_formatter_t;
 
+/*
+ * A store writer describes the interface for plugins implementing a store.
+ */
+typedef struct {
+       int (*store_host)(const char *name, sdb_time_t last_update,
+                       sdb_object_t *user_data);
+       int (*store_service)(const char *hostname, const char *name,
+                       sdb_time_t last_update, sdb_object_t *user_data);
+       int (*store_metric)(const char *hostname, const char *name,
+                       sdb_metric_store_t *store, sdb_time_t last_update,
+                       sdb_object_t *user_data);
+       int (*store_attribute)(const char *hostname,
+                       const char *key, const sdb_data_t *value, sdb_time_t last_update,
+                       sdb_object_t *user_data);
+       int (*store_service_attr)(const char *hostname, const char *service,
+                       const char *key, const sdb_data_t *value, sdb_time_t last_update,
+                       sdb_object_t *user_data);
+       int (*store_metric_attr)(const char *hostname, const char *metric,
+                       const char *key, const sdb_data_t *value, sdb_time_t last_update,
+                       sdb_object_t *user_data);
+} sdb_store_writer_t;
+
 /*
  * sdb_store_clear:
  * Clear the entire store and remove all stored objects.
@@ -220,14 +261,6 @@ 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,
@@ -403,6 +436,34 @@ int
 sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
                sdb_data_t *res, sdb_store_matcher_t *filter);
 
+/*
+ * sdb_store_expr_iterable:
+ * Check whether an expression, evaluated in the specified context (HOST,
+ * SERVICE, METRIC) is iterable, that is, if it may evaluate to multiple
+ * values.
+ */
+bool
+sdb_store_expr_iterable(sdb_store_expr_t *expr, int context);
+
+/*
+ * sdb_store_expr_iter:
+ * Iterate over the elements of an iterable expression. sdb_store_expr_iter
+ * returns NULL if the expression is not iterable (for the specified object).
+ * See also sdb_store_expr_iterable.
+ *
+ * sdb_store_expr_iter_get_next returns NULL if there is no next element.
+ */
+sdb_store_expr_iter_t *
+sdb_store_expr_iter(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
+               sdb_store_matcher_t *filter);
+void
+sdb_store_expr_iter_destroy(sdb_store_expr_iter_t *iter);
+
+bool
+sdb_store_expr_iter_has_next(sdb_store_expr_iter_t *iter);
+sdb_data_t
+sdb_store_expr_iter_get_next(sdb_store_expr_iter_t *iter);
+
 /*
  * sdb_store_dis_matcher:
  * Creates a matcher matching the disjunction (logical OR) of two matchers.
@@ -426,19 +487,21 @@ sdb_store_inv_matcher(sdb_store_matcher_t *m);
 
 /*
  * sdb_store_any_matcher:
- * Creates a matcher iterating over objects of the specified type. It matches
- * if *any* of those objects match 'm'.
+ * Creates a matcher iterating over values of the first expression (which has
+ * to be iterable). It matches if *any* of those elements match 'm'. 'm' has
+ * to be an ary operation with the left operand unset.
  */
 sdb_store_matcher_t *
-sdb_store_any_matcher(int type, sdb_store_matcher_t *m);
+sdb_store_any_matcher(sdb_store_expr_t *iter, sdb_store_matcher_t *m);
 
 /*
  * sdb_store_all_matcher:
- * Creates a matcher iterating over objects of the specified type. It matches
- * if *all* of those objects match 'm'.
+ * Creates a matcher iterating over values of the first expression (which has
+ * to be iterable). It matches if *all* of those elements match 'm'. 'm' has
+ * to be an ary operation with the left operand unset.
  */
 sdb_store_matcher_t *
-sdb_store_all_matcher(int type, sdb_store_matcher_t *m);
+sdb_store_all_matcher(sdb_store_expr_t *iter, sdb_store_matcher_t *m);
 
 /*
  * sdb_store_in_matcher:
@@ -449,6 +512,14 @@ sdb_store_all_matcher(int type, sdb_store_matcher_t *m);
 sdb_store_matcher_t *
 sdb_store_in_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
 
+/*
+ * sdb_store_nin_matcher:
+ * Like sdb_store_in_matcher but matches if the left value is not included in
+ * the right value.
+ */
+sdb_store_matcher_t *
+sdb_store_nin_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
+
 /*
  * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher,
  * sdb_store_ge_matcher, sdb_store_gt_matcher: