X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=src%2Finclude%2Fcore%2Fstore.h;h=15f435fefdc6136a83fdb2e53a004a5cac82e8a9;hp=8a80852a7a5ba44d64659b1fc10713a67c7b3b18;hb=9345a64b2fa015c30d6b3fcba76211f8d0d7cfd6;hpb=1426e3fcf927d6321fd2cf8595394f817bb1a0e2 diff --git a/src/include/core/store.h b/src/include/core/store.h index 8a80852..15f435f 100644 --- a/src/include/core/store.h +++ b/src/include/core/store.h @@ -62,6 +62,7 @@ enum { SDB_FIELD_INTERVAL, /* type: datetime */ SDB_FIELD_BACKEND, /* type: array of strings */ SDB_FIELD_VALUE, /* attributes only; type: type of the value */ + SDB_FIELD_TIMESERIES, /* metrics only; type: boolean */ }; #define SDB_STORE_TYPE_TO_NAME(t) \ (((t) == SDB_HOST) ? "host" \ @@ -80,6 +81,7 @@ enum { : ((f) == SDB_FIELD_INTERVAL) ? "interval" \ : ((f) == SDB_FIELD_BACKEND) ? "backend" \ : ((f) == SDB_FIELD_VALUE) ? "value" \ + : ((f) == SDB_FIELD_TIMESERIES) ? "timeseries" \ : "unknown") #define SDB_FIELD_TYPE(f) \ @@ -89,6 +91,7 @@ enum { : ((f) == SDB_FIELD_INTERVAL) ? SDB_TYPE_DATETIME \ : ((f) == SDB_FIELD_BACKEND) ? (SDB_TYPE_ARRAY | SDB_TYPE_STRING) \ : ((f) == SDB_FIELD_VALUE) ? -1 /* unknown */ \ + : ((f) == SDB_FIELD_TIMESERIES) ? SDB_TYPE_BOOLEAN \ : -1) /* @@ -147,49 +150,100 @@ typedef struct sdb_store_json_formatter sdb_store_json_formatter_t; /* * A store writer describes the interface for plugins implementing a store. + * + * Any of the call-back functions shall return: + * - 0 on success + * - a positive value if the new entry is older than the currently stored + * entry (in this case, no update will happen) + * - a negative value on error */ typedef struct { + /* + * store_host: + * Add/update a host in the store. If the host, identified by its + * canonicalized name, already exists, it will be updated according to the + * specified name and timestamp. Else, a new entry will be created in the + * store. + */ int (*store_host)(const char *name, sdb_time_t last_update, sdb_object_t *user_data); + + /* + * store_service: + * Add/update a service in the store. If the service, identified by its + * name, already exists for the specified host, it will be updated + * according to the specified name and timestamp. If the referenced host + * does not exist, an error will be reported. Else, a new entry will be + * created in the store. + */ int (*store_service)(const char *hostname, const char *name, sdb_time_t last_update, sdb_object_t *user_data); + + /* + * store_metric: + * Add/update a metric in the store. If the metric, identified by its + * name, already exists for the specified host, it will be updated + * according to the specified attributes. If the referenced host does not + * exist, an error will be reported. Else, a new entry will be created in + * the store. + */ int (*store_metric)(const char *hostname, const char *name, sdb_metric_store_t *store, sdb_time_t last_update, sdb_object_t *user_data); + + /* + * store_attribute: + * Add/update a host's attribute in the store. If the attribute, + * identified by its key, already exists for the specified host, it will + * be updated to the specified values. If the referenced host does not + * exist, an error will be reported. Else, a new entry will be created in + * the store. + */ int (*store_attribute)(const char *hostname, const char *key, const sdb_data_t *value, sdb_time_t last_update, sdb_object_t *user_data); + + /* + * store_service_attr: + * Add/update a service's attribute in the store. If the attribute, + * identified by its key, already exists for the specified service, it + * will be updated to the specified value. If the references service (for + * the specified host) does not exist, an error will be reported. + */ 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); + + /* + * store_metric_attr: + * Add/update a metric's attribute in the store. If the attribute, + * identified by its key, already exists for the specified metric, it will + * be updated to the specified value. If the references metric (for the + * specified host) does not exist, an error will be reported. + */ 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. - */ -void -sdb_store_clear(void); - -/* - * sdb_store_host: - * Add/update a host in the store. If the host, identified by its - * canonicalized name, already exists, it will be updated according to the - * specified name and timestamp. 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. + * sdb_store_init: + * Initialize the store sub-system. This function has to be called before + * doing any other store operations. * * Returns: * - 0 on success - * - a positive value if the new entry is older than the currently stored - * entry (in this case, no update will happen) - * - a negative value on error + * - a negative value else */ int -sdb_store_host(const char *name, sdb_time_t last_update); +sdb_store_init(void); + +/* + * sdb_store_clear: + * Clear the entire store and remove all stored objects. + */ +void +sdb_store_clear(void); /* * sdb_store_has_host: @@ -205,102 +259,6 @@ sdb_store_has_host(const char *name); sdb_store_obj_t * sdb_store_get_host(const char *name); -/* - * sdb_store_attribute: - * Add/update a host's attribute in the store. If the attribute, identified by - * its key, already exists for the specified host, it will be updated to the - * specified values. 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 and managed by the store - * itself. - * - * Returns: - * - 0 on success - * - a positive value if the new entry is older than the currently stored - * entry (in this case, no update will happen) - * - a negative value on error - */ -int -sdb_store_attribute(const char *hostname, - const char *key, const sdb_data_t *value, - sdb_time_t last_update); - -/* - * sdb_store_service: - * Add/update a service in the store. If the service, identified by its name, - * already exists for the specified host, it will be updated according to the - * 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. - * - * Returns: - * - 0 on success - * - a positive value if the new entry is older than the currently stored - * entry (in this case, no update will happen) - * - a negative value on error - */ -int -sdb_store_service(const char *hostname, const char *name, - sdb_time_t last_update); - -/* - * sdb_store_service_attr: - * Add/update a service's attribute in the store. If the attribute, identified - * by its key, already exists for the specified service, it will be updated to - * the specified value. If the references service (for the specified host) - * does not exist, an error will be reported. Any memory required for storing - * the entry will be allocated and managed by the store itself. - * - * Returns: - * - 0 on success - * - a positive value if the new entry is older than the currently stored - * entry (in this case, no update will happen) - * - a negative value on error - */ -int -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_metric: - * Add/update a metric in the store. If the metric, identified by its name, - * already exists for the specified host, it will be updated according to the - * 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. - * - * If specified, the metric store describes where to access the metric's data. - * - * Returns: - * - 0 on success - * - a positive value if the new entry is older than the currently stored - * entry (in this case, no update will happen) - * - a negative value on error - */ -int -sdb_store_metric(const char *hostname, const char *name, - sdb_metric_store_t *store, sdb_time_t last_update); - -/* - * sdb_store_metric_attr: - * Add/update a metric's attribute in the store. If the attribute, identified - * by its key, already exists for the specified metric, it will be updated to - * the specified value. If the references metric (for the specified host) - * does not exist, an error will be reported. Any memory required for storing - * the entry will be allocated and managed by the store itself. - * - * Returns: - * - 0 on success - * - a positive value if the new entry is older than the currently stored - * entry (in this case, no update will happen) - * - a negative value on error - */ -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 @@ -335,8 +293,6 @@ sdb_store_get_child(sdb_store_obj_t *host, int type, const char *name); * the returned value. If 'res' is NULL, the function will return whether the * field exists. * - * Note: Retrieving the backend this way is not currently supported. - * * Returns: * - 0 on success * - a negative value else @@ -569,14 +525,6 @@ sdb_store_all_matcher(sdb_store_expr_t *iter, 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: @@ -659,51 +607,6 @@ sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj, typedef sdb_store_matcher_t *(*sdb_store_matcher_op_cb) (sdb_store_expr_t *, sdb_store_expr_t *); -/* - * sdb_store_parse_matcher_op: - * Parse a matcher operator and return a constructor for the respective - * matcher. - * - * Returns: - * - matcher operator constructor on success - * - NULL else - */ -sdb_store_matcher_op_cb -sdb_store_parse_matcher_op(const char *op); - -/* - * sdb_store_parse_object_type: - * Parse the type name of a stored object. - * - * Returns: - * - the object type on success - * - a negative value else - */ -int -sdb_store_parse_object_type(const char *name); - -/* - * 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. - * - * Returns: - * - the field id on success - * - a negative value else - */ -int -sdb_store_parse_field_name(const char *name); - /* * sdb_store_lookup_cb: * Lookup callback. It is called for each matching object when looking up data