X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Finclude%2Fcore%2Fstore.h;h=9bb75948d76e76c759568dda46860b67f179ade7;hb=f20bc8d5ec8abe86914eeedc741ca00109fb6ece;hp=2e1e558a87fbc11a2c983261b83235b8448c0129;hpb=e4925baf923191b68f211354f57e743b7500d0c8;p=sysdb.git diff --git a/src/include/core/store.h b/src/include/core/store.h index 2e1e558..9bb7594 100644 --- a/src/include/core/store.h +++ b/src/include/core/store.h @@ -88,6 +88,13 @@ struct sdb_store_matcher; typedef struct sdb_store_matcher sdb_store_matcher_t; #define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj)) +/* + * A JSON formatter converts stored objects into the JSON format. + * See http://www.ietf.org/rfc/rfc4627.txt + */ +struct sdb_store_json_formatter; +typedef struct sdb_store_json_formatter sdb_store_json_formatter_t; + /* * Queryable fields of a stored object. */ @@ -106,6 +113,14 @@ enum { : ((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. @@ -358,53 +373,6 @@ int sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj, sdb_data_t *res, sdb_store_matcher_t *filter); -/* - * Conditionals may be used to lookup hosts from the store based on a - * conditional expression. - * - * A conditional object inherits from sdb_object_t and, thus, may safely be - * cast to a generic object. - */ -struct sdb_store_cond; -typedef struct sdb_store_cond sdb_store_cond_t; -#define SDB_STORE_COND(obj) ((sdb_store_cond_t *)(obj)) - -/* - * sdb_store_attr_cond: - * Creates a conditional based on attribute values. The value of stored - * attributes is compared against the value the expression evaluates to. See - * sdb_data_cmp for details about the comparison. - */ -sdb_store_cond_t * -sdb_store_attr_cond(const char *name, sdb_store_expr_t *expr); - -/* - * sdb_store_obj_cond: - * Creates a conditional based on queryable object fields. The respective - * field of *any* object type is compared against the value the expression - * evaluates to. - */ -sdb_store_cond_t * -sdb_store_obj_cond(int field, sdb_store_expr_t *expr); - -/* - * sdb_store_name_matcher: - * Creates a matcher matching by the specified object type's name. If 're' is - * true, the specified name is treated as a POSIX extended regular expression. - * Else, the exact name has to match (case-insensitive). - */ -sdb_store_matcher_t * -sdb_store_name_matcher(int type, const char *name, _Bool re); - -/* - * sdb_store_attr_matcher: - * Creates a matcher matching attributes based on their value. If 're' is - * true, the specified name is treated as a POSIX extended regular expression. - * Else, the exact name has to match (case-insensitive). - */ -sdb_store_matcher_t * -sdb_store_attr_matcher(const char *name, const char *value, _Bool re); - /* * sdb_store_isnull_matcher: * Creates a matcher matching NULL values. @@ -420,44 +388,41 @@ sdb_store_matcher_t * sdb_store_isnnull_matcher(sdb_store_expr_t *expr); /* - * sdb_store_child_matcher: - * Creates a matcher matching an object's children of the specified type. It - * matches if *any* of those children match 'm'. + * sdb_store_any_matcher: + * Creates a matcher iterating over objects of the specified type. It matches + * if *any* of those objects match 'm'. */ sdb_store_matcher_t * -sdb_store_child_matcher(int type, sdb_store_matcher_t *m); +sdb_store_any_matcher(int type, sdb_store_matcher_t *m); /* - * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher, - * sdb_store_ge_matcher, sdb_store_gt_matcher: - * Creates a matcher based on a conditional. The matcher matches objects for - * which the conditional evaluates the object to compare less than, less or - * equal, equal, greater or equal, or greater than the conditional's value - * repsectively. + * sdb_store_all_matcher: + * Creates a matcher iterating over objects of the specified type. It matches + * if *all* of those objects match 'm'. */ sdb_store_matcher_t * -sdb_store_lt_matcher(sdb_store_cond_t *cond); -sdb_store_matcher_t * -sdb_store_le_matcher(sdb_store_cond_t *cond); -sdb_store_matcher_t * -sdb_store_eq_matcher(sdb_store_cond_t *cond); -sdb_store_matcher_t * -sdb_store_ge_matcher(sdb_store_cond_t *cond); -sdb_store_matcher_t * -sdb_store_gt_matcher(sdb_store_cond_t *cond); +sdb_store_all_matcher(int type, sdb_store_matcher_t *m); +/* + * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher, + * sdb_store_ge_matcher, sdb_store_gt_matcher: + * Create conditional matchers comparing the values of two expressions. The + * matcher matches if the left expression compres less than, less or equal + * than, equal to, not equal to, greater or equal than, or greater than the + * right expression. + */ sdb_store_matcher_t * -sdb_store_cmp_lt(sdb_store_expr_t *left, sdb_store_expr_t *right); +sdb_store_lt_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right); sdb_store_matcher_t * -sdb_store_cmp_le(sdb_store_expr_t *left, sdb_store_expr_t *right); +sdb_store_le_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right); sdb_store_matcher_t * -sdb_store_cmp_eq(sdb_store_expr_t *left, sdb_store_expr_t *right); +sdb_store_eq_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right); sdb_store_matcher_t * -sdb_store_cmp_ne(sdb_store_expr_t *left, sdb_store_expr_t *right); +sdb_store_ne_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right); sdb_store_matcher_t * -sdb_store_cmp_ge(sdb_store_expr_t *left, sdb_store_expr_t *right); +sdb_store_ge_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right); sdb_store_matcher_t * -sdb_store_cmp_gt(sdb_store_expr_t *left, sdb_store_expr_t *right); +sdb_store_gt_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right); /* * sdb_store_in_matcher: @@ -506,6 +471,17 @@ typedef sdb_store_matcher_t *(*sdb_store_matcher_op_cb) 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. @@ -528,31 +504,6 @@ sdb_store_parse_object_type_plural(const char *name); int sdb_store_parse_field_name(const char *name); -/* - * sdb_store_matcher_parse_cmp: - * Parse a simple compare expression (. ). - * - * Returns: - * - a matcher object on success - * - NULL else - */ -sdb_store_matcher_t * -sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr, - const char *op, sdb_store_expr_t *expr); - -/* - * sdb_store_matcher_parse_field_cmp: - * Parse a simple compare expression for queryable object fields ( - * ). - * - * Returns: - * - a matcher object on success - * - NULL else - */ -sdb_store_matcher_t * -sdb_store_matcher_parse_field_cmp(const char *name, const char *op, - sdb_store_expr_t *expr); - /* * sdb_store_dis_matcher: * Creates a matcher matching the disjunction (logical OR) of two matchers. @@ -593,104 +544,90 @@ int sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj, sdb_store_matcher_t *filter); -/* - * sdb_store_matcher_tostring: - * Format a matcher object as string. This is meant for logging or debugging - * purposes. - */ -char * -sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen); - /* * sdb_store_lookup_cb: * Lookup callback. It is called for each matching object when looking up data - * in the store. The lookup aborts if the callback returns non-zero. + * in the store passing on the lookup filter and the specified user-data. The + * lookup aborts early if the callback returns non-zero. */ -typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj, void *user_data); +typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj, + sdb_store_matcher_t *filter, void *user_data); /* * sdb_store_scan: - * Look up objects in the store. The specified callback function is called for - * each object in the store matching 'm'. The function performs a full scan of - * all hosts 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. + * Look up objects of the specified type in the 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. * * Returns: * - 0 on success * - a negative value else */ int -sdb_store_scan(sdb_store_matcher_t *m, sdb_store_matcher_t *filter, +sdb_store_scan(int type, sdb_store_matcher_t *m, sdb_store_matcher_t *filter, sdb_store_lookup_cb cb, void *user_data); /* - * Flags for serialization functions. - * - * 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. + * Flags for JSON formatting. */ enum { - SDB_SKIP_ATTRIBUTES = 1 << 0, - SDB_SKIP_SERVICES = 1 << 1, - SDB_SKIP_METRICS = 1 << 2, - SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 3, - - 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, + SDB_WANT_ARRAY = 1 << 0, }; /* - * sdb_store_tojson: - * Serialize the entire store to JSON and append the result to the specified - * buffer. If specified, only objects matching the filter will be included in - * the result (see sdb_store_host_tojson for details). - * - * Returns: - * - 0 on success - * - a negative value on error + * sdb_store_json_formatter: + * Create a JSON formatter for the specified object types writing to the + * specified buffer. */ -int -sdb_store_tojson(sdb_strbuf_t *buf, sdb_store_matcher_t *filter, int flags); +sdb_store_json_formatter_t * +sdb_store_json_formatter(sdb_strbuf_t *buf, int type, int flags); /* - * sdb_store_host_tojson: - * Serialize a host object to JSON and append the result to the specified - * buffer. If specified, only objects matching the filter will be included in - * the result. The filter is applied to each object individually and, thus, - * should not be of any object-type specific kind. The filter is never applied - * to the specified host object; the caller is responsible for this and for - * correctly handling skipped hosts. + * sdb_store_json_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. + * + * Note that the output might not be valid JSON before calling + * sdb_store_json_finish(). * * Returns: * - 0 on success - * - a negative value on error + * - a negative value else */ int -sdb_store_host_tojson(sdb_store_obj_t *host, sdb_strbuf_t *buf, - sdb_store_matcher_t *filter, int flags); +sdb_store_json_emit(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj); /* - * sdb_store_iter_cb: - * Store iterator callback. Iteration stops if the callback returns non-zero. - */ -typedef int (*sdb_store_iter_cb)(sdb_store_obj_t *obj, void *user_data); - -/* - * sdb_store_iterate: - * Iterate the entire store, calling the specified callback for each object. - * The user_data pointer is passed on to each call of the callback. + * sdb_store_json_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. + * Only matching objects will be included in the output. + * + * Note that the output might not be valid JSON before calling + * sdb_store_json_finish(). * * Returns: * - 0 on success * - a negative value else */ int -sdb_store_iterate(sdb_store_iter_cb cb, void *user_data); +sdb_store_json_emit_full(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj, + sdb_store_matcher_t *filter); + +/* + * sdb_store_json_finish: + * Finish the JSON output. This function has to be called once after emiting + * all objects. + */ +int +sdb_store_json_finish(sdb_store_json_formatter_t *f); #ifdef __cplusplus } /* extern "C" */