X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=src%2Finclude%2Fcore%2Fstore.h;h=0cee91362998d55c4f329c031572d5096e68400c;hp=28b257e056b10f6912b793c95ee592afba6ed59d;hb=9a96acd759c31211aa512e174339a9c178c4eb83;hpb=502bbcd0731ca35b4f3d93653a818f5246f81e0b diff --git a/src/include/core/store.h b/src/include/core/store.h index 28b257e..0cee913 100644 --- a/src/include/core/store.h +++ b/src/include/core/store.h @@ -103,21 +103,79 @@ typedef struct sdb_store sdb_store_t; #define SDB_STORE(obj) ((sdb_store_t *)(obj)) /* - * 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 - * object to access its name. + * sdb_store_obj_t represents the super-class of any stored object. It + * inherits from sdb_object_t and may safely be cast to a generic object to + * access its name. */ struct sdb_store_obj; typedef struct sdb_store_obj sdb_store_obj_t; /* - * A metric store describes how to access a metric's data. + * sdb_store_host_t represents the meta-data of a stored host object. + */ +typedef struct { + const char *name; + + sdb_time_t last_update; + sdb_time_t interval; + const char * const *backends; + size_t backends_num; +} sdb_store_host_t; + +/* + * sdb_store_service_t represents the meta-data of a stored service object. + */ +typedef struct { + const char *hostname; + const char *name; + + sdb_time_t last_update; + sdb_time_t interval; + const char * const *backends; + size_t backends_num; +} sdb_store_service_t; + +/* + * sdb_metric_store_t specifies how to access a metric's data. */ typedef struct { const char *type; const char *id; } sdb_metric_store_t; +/* + * sdb_store_metric_t represents the meta-data of a stored metric object. + */ +typedef struct { + const char *hostname; + const char *name; + struct { + const char *type; + const char *id; + } store; + + sdb_time_t last_update; + sdb_time_t interval; + const char * const *backends; + size_t backends_num; +} sdb_store_metric_t; + +/* + * sdb_store_attribute_t represents a stored attribute. + */ +typedef struct { + const char *hostname; /* optional */ + int parent_type; + const char *parent; + const char *key; + sdb_data_t value; + + sdb_time_t last_update; + sdb_time_t interval; + const char * const *backends; + size_t backends_num; +} sdb_store_attribute_t; + /* * Expressions represent arithmetic expressions based on stored objects and * their various attributes. @@ -130,8 +188,7 @@ 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). + * An expression iterator iterates over the values of an iterable expression. */ struct sdb_store_expr_iter; typedef struct sdb_store_expr_iter sdb_store_expr_iter_t; @@ -176,8 +233,7 @@ typedef struct { * 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); + int (*store_host)(sdb_store_host_t *host, sdb_object_t *user_data); /* * store_service: @@ -187,8 +243,7 @@ typedef struct { * 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); + int (*store_service)(sdb_store_service_t *service, sdb_object_t *user_data); /* * store_metric: @@ -198,9 +253,7 @@ typedef struct { * 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); + int (*store_metric)(sdb_store_metric_t *metric, sdb_object_t *user_data); /* * store_attribute: @@ -210,31 +263,7 @@ typedef struct { * 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); + int (*store_attribute)(sdb_store_attribute_t *attr, sdb_object_t *user_data); } sdb_store_writer_t; /* @@ -259,15 +288,12 @@ typedef struct { * execute_query: * Execute a previously prepared query. The callback may expect that only * queries prepared by its respective prepare callback will be passed to - * this function. - * - * TODO: Instead of letting the executor write directly to a string buffer - * (which cannot easily be merged with other results), let it hand - * all objects to a store-writer. + * this function. The query result will be passed back via the specified + * store writer. */ int (*execute_query)(sdb_object_t *q, - sdb_strbuf_t *buf, sdb_strbuf_t *errbuf, - sdb_object_t *user_data); + sdb_store_writer_t *w, sdb_object_t *wd, + sdb_strbuf_t *errbuf, sdb_object_t *user_data); } sdb_store_reader_t; /* @@ -433,7 +459,7 @@ sdb_store_query_prepare_matcher(sdb_ast_node_t *ast); */ int sdb_store_query_execute(sdb_store_t *store, sdb_store_query_t *m, - sdb_strbuf_t *buf, sdb_strbuf_t *errbuf); + sdb_store_writer_t *w, sdb_object_t *wd, sdb_strbuf_t *errbuf); /* * sdb_store_expr_create: @@ -512,20 +538,10 @@ 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. */ @@ -683,9 +699,9 @@ typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj, * sdb_store_scan: * Look up objects of the specified type in the specified store. The specified * callback function is called for each object in the store matching 'm'. The - * function performs a full scan of all objects stored in the database. If - * specified, the filter will be used to preselect objects for further - * evaluation. See the description of 'sdb_store_matcher_matches' for details. + * function performs a full scan of all stored objects. If specified, the + * filter will be used to preselect objects for further evaluation. See the + * description of 'sdb_store_matcher_matches' for details. * * Returns: * - 0 on success @@ -712,13 +728,12 @@ sdb_store_json_formatter_t * sdb_store_json_formatter(sdb_strbuf_t *buf, int type, int flags); /* - * sdb_store_json_emit: + * sdb_store_emit: * Serialize a single object to JSON adding it to the string buffer associated * with the formatter object. The serialized object will not include * attributes or any child objects. Instead, call the function again for each * of those objects. All attributes have to be emitted before any other - * children types. Use sdb_store_json_emit_full() to emit a full (filtered) - * object. + * children types. Use sdb_store_emit_full() to emit a full (filtered) object. * * Note that the output might not be valid JSON before calling * sdb_store_json_finish(). @@ -728,10 +743,10 @@ sdb_store_json_formatter(sdb_strbuf_t *buf, int type, int flags); * - a negative value else */ int -sdb_store_json_emit(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj); +sdb_store_emit(sdb_store_obj_t *obj, sdb_store_writer_t *w, sdb_object_t *wd); /* - * sdb_store_json_emit_full: + * sdb_store_emit_full: * Serialize a single object including it's attributes and all children to * JSON, adding it to the string buffer associated with the formatter object. * The filter, if specified, is applied to each attribute and child object. @@ -745,8 +760,8 @@ sdb_store_json_emit(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj); * - a negative value else */ int -sdb_store_json_emit_full(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj, - sdb_store_matcher_t *filter); +sdb_store_emit_full(sdb_store_obj_t *obj, sdb_store_matcher_t *filter, + sdb_store_writer_t *w, sdb_object_t *wd); /* * sdb_store_json_finish: @@ -756,6 +771,13 @@ sdb_store_json_emit_full(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj, int sdb_store_json_finish(sdb_store_json_formatter_t *f); +/* + * sdb_store_json_writer: + * A store writer implementation that generates JSON output. It expects a + * store JSON formatter as its user-data argument. + */ +extern sdb_store_writer_t sdb_store_json_writer; + #ifdef __cplusplus } /* extern "C" */ #endif