index b84fc72720d2fa5938b5121650d22ef0dc554683..6edbea4f173e89000f7869217b145a38ec3294be 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
#include "core/timeseries.h"
#include "utils/strbuf.h"
+#include <stdbool.h>
#include <stdio.h>
#ifdef __cplusplus
SDB_SERVICE,
SDB_METRIC,
SDB_ATTRIBUTE,
+
+ /*
+ * Queryable fields of a stored object.
+ */
+ SDB_FIELD_NAME = 1 << 8, /* type: string */
+ SDB_FIELD_LAST_UPDATE, /* type: datetime */
+ SDB_FIELD_AGE, /* type: datetime */
+ SDB_FIELD_INTERVAL, /* type: datetime */
+ SDB_FIELD_BACKEND, /* type: array of strings */
};
#define SDB_STORE_TYPE_TO_NAME(t) \
(((t) == SDB_HOST) ? "host" \
: ((t) == SDB_METRIC) ? "metric" \
: ((t) == SDB_ATTRIBUTE) ? "attribute" : "unknown")
+#define SDB_FIELD_TO_NAME(f) \
+ (((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")
+
+#define SDB_FIELD_TYPE(f) \
+ (((f) == SDB_FIELD_NAME) ? SDB_TYPE_STRING \
+ : ((f) == SDB_FIELD_LAST_UPDATE) ? SDB_TYPE_DATETIME \
+ : ((f) == SDB_FIELD_AGE) ? SDB_TYPE_DATETIME \
+ : ((f) == SDB_FIELD_INTERVAL) ? SDB_TYPE_DATETIME \
+ : ((f) == SDB_FIELD_BACKEND) ? (SDB_TYPE_ARRAY | SDB_TYPE_STRING) \
+ : -1)
+
/*
* sdb_store_obj_t represents the super-class of any object stored in the
* database. It inherits from sdb_object_t and may safely be cast to a generic
struct sdb_store_json_formatter;
typedef struct sdb_store_json_formatter sdb_store_json_formatter_t;
-/*
- * Queryable fields of a stored object.
- */
-enum {
- 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_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")
-
-#define SDB_FIELD_TYPE(f) \
- (((f) == SDB_FIELD_NAME) ? SDB_TYPE_STRING \
- : ((f) == SDB_FIELD_LAST_UPDATE) ? SDB_TYPE_DATETIME \
- : ((f) == SDB_FIELD_AGE) ? SDB_TYPE_DATETIME \
- : ((f) == SDB_FIELD_INTERVAL) ? SDB_TYPE_DATETIME \
- : ((f) == SDB_FIELD_BACKEND) ? (SDB_TYPE_ARRAY | SDB_TYPE_STRING) \
- : -1)
-
/*
* sdb_store_clear:
* Clear the entire store and remove all stored objects.
* sdb_store_get_host increments the ref count of the host object. The caller
* needs to deref it when no longer using it.
*/
-_Bool
+bool
sdb_store_has_host(const char *name);
sdb_store_obj_t *
sdb_store_service_attr(const char *hostname, const char *service,
const char *key, const sdb_data_t *value, sdb_time_t last_update);
-/*
- * sdb_store_get_child:
- * Retrieve a host's child object of the specified type and name. The
- * reference count of the child object will be incremented before returning
- * it. The caller is responsible for releasing the object once it's no longer
- * used.
- *
- * Returns:
- * - the child object on success
- * - NULL else
- */
-sdb_store_obj_t *
-sdb_store_get_child(sdb_store_obj_t *host, int type, const char *name);
-
/*
* A metric store describes how to access a metric's data.
*/
sdb_store_fetch_timeseries(const char *hostname, const char *metric,
sdb_timeseries_opts_t *opts, sdb_strbuf_t *buf);
+/*
+ * sdb_store_get_child:
+ * Retrieve a host's child object of the specified type and name. The
+ * reference count of the child object will be incremented before returning
+ * it. The caller is responsible for releasing the object once it's no longer
+ * used.
+ *
+ * Returns:
+ * - the child object on success
+ * - NULL else
+ */
+sdb_store_obj_t *
+sdb_store_get_child(sdb_store_obj_t *host, int type, const char *name);
+
/*
* sdb_store_get_field:
* Get the value of a stored object's queryable field. The caller is
sdb_store_expr_t *
sdb_store_expr_create(int op, sdb_store_expr_t *left, sdb_store_expr_t *right);
+/*
+ * sdb_store_expr_typed:
+ * Creates an expression which evaluates in the context of an object's sibling
+ * as specified by the given type.
+ *
+ * Returns:
+ * - an expression object on success
+ * - NULL else
+ */
+sdb_store_expr_t *
+sdb_store_expr_typed(int typ, sdb_store_expr_t *expr);
+
/*
* sdb_store_expr_fieldvalue:
* Creates an expression which evaluates to the value of the specified
sdb_data_t *res, sdb_store_matcher_t *filter);
/*
- * sdb_store_isnull_matcher:
- * Creates a matcher matching NULL values.
+ * sdb_store_dis_matcher:
+ * Creates a matcher matching the disjunction (logical OR) of two matchers.
*/
sdb_store_matcher_t *
-sdb_store_isnull_matcher(sdb_store_expr_t *expr);
+sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
/*
- * sdb_store_isnnull_matcher:
- * Creates a matcher matching non-NULL values.
+ * sdb_store_con_matcher:
+ * Creates a matcher matching the conjunction (logical AND) of two matchers.
*/
sdb_store_matcher_t *
-sdb_store_isnnull_matcher(sdb_store_expr_t *expr);
+sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
+
+/*
+ * sdb_store_inv_matcher::
+ * Creates a matcher matching the inverse (logical NOT) of a matcher.
+ */
+sdb_store_matcher_t *
+sdb_store_inv_matcher(sdb_store_matcher_t *m);
/*
* sdb_store_any_matcher:
sdb_store_matcher_t *
sdb_store_all_matcher(int type, sdb_store_matcher_t *m);
+/*
+ * sdb_store_in_matcher:
+ * Creates a matcher which matches if the right value evaluates to an array
+ * value and the left value is included in that array. See sdb_data_inarray
+ * for more details.
+ */
+sdb_store_matcher_t *
+sdb_store_in_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:
sdb_store_matcher_t *
sdb_store_gt_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
-/*
- * sdb_store_in_matcher:
- * Creates a matcher which matches if the right value evaluates to an array
- * value and the left value is included in that array. See sdb_data_inarray
- * for more details.
- */
-sdb_store_matcher_t *
-sdb_store_in_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
-
/*
* sdb_store_regex_matcher:
* Creates a matcher which matches the string value the left expression
sdb_store_matcher_t *
sdb_store_nregex_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
+/*
+ * sdb_store_isnull_matcher:
+ * Creates a matcher matching NULL values.
+ */
+sdb_store_matcher_t *
+sdb_store_isnull_matcher(sdb_store_expr_t *expr);
+
+/*
+ * sdb_store_isnnull_matcher:
+ * Creates a matcher matching non-NULL values.
+ */
+sdb_store_matcher_t *
+sdb_store_isnnull_matcher(sdb_store_expr_t *expr);
+
+/*
+ * sdb_store_matcher_matches:
+ * Check whether the specified matcher matches the specified store object. If
+ * specified, the filter will be used to preselect objects for further
+ * evaluation. It is applied to any object that's used during the evaluation
+ * of the matcher. Only those objects matching the filter will be considered.
+ *
+ * Note that the filter is applied to all object types (hosts, service,
+ * metric, attribute). Thus, any object-specific matchers are mostly unsuited
+ * for this purpose and, if used, may result in unexpected behavior.
+ *
+ * Returns:
+ * - 1 if the object matches
+ * - 0 else
+ */
+int
+sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj,
+ sdb_store_matcher_t *filter);
+
/*
* sdb_store_matcher_op_cb:
* Callback constructing a matcher operator.
int
sdb_store_parse_field_name(const char *name);
-/*
- * sdb_store_dis_matcher:
- * Creates a matcher matching the disjunction (logical OR) of two matchers.
- */
-sdb_store_matcher_t *
-sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
-
-/*
- * sdb_store_con_matcher:
- * Creates a matcher matching the conjunction (logical AND) of two matchers.
- */
-sdb_store_matcher_t *
-sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
-
-/*
- * sdb_store_con_matcher::
- * Creates a matcher matching the inverse (logical NOT) of a matcher.
- */
-sdb_store_matcher_t *
-sdb_store_inv_matcher(sdb_store_matcher_t *m);
-
-/*
- * sdb_store_matcher_matches:
- * Check whether the specified matcher matches the specified store object. If
- * specified, the filter will be used to preselect objects for further
- * evaluation. It is applied to any object that's used during the evaluation
- * of the matcher. Only those objects matching the filter will be considered.
- *
- * Note that the filter is applied to all object types (hosts, service,
- * metric, attribute). Thus, any object-specific matchers are mostly unsuited
- * for this purpose and, if used, may result in unexpected behavior.
- *
- * Returns:
- * - 1 if the object matches
- * - 0 else
- */
-int
-sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj,
- sdb_store_matcher_t *filter);
-
/*
* sdb_store_lookup_cb:
* Lookup callback. It is called for each matching object when looking up data