X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=src%2Finclude%2Fcore%2Fstore.h;h=c52299e806314a951df6fbb670e7b098f7e371cd;hp=3722a7262d6aa773d4f3210e12217e7505d449f1;hb=bbd1b997cf153d54878efebc182bd88f1c64d45c;hpb=b072d9b2786422fcb8f068dd5076bd108a6228e9 diff --git a/src/include/core/store.h b/src/include/core/store.h index 3722a72..c52299e 100644 --- a/src/include/core/store.h +++ b/src/include/core/store.h @@ -33,6 +33,7 @@ #include "core/data.h" #include "core/time.h" #include "core/timeseries.h" +#include "parser/ast.h" #include "utils/strbuf.h" #include @@ -60,6 +61,8 @@ 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 */ + SDB_FIELD_TIMESERIES, /* metrics only; type: boolean */ }; #define SDB_STORE_TYPE_TO_NAME(t) \ (((t) == SDB_HOST) ? "host" \ @@ -76,7 +79,10 @@ 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" \ + : ((f) == SDB_FIELD_TIMESERIES) ? "timeseries" \ + : "unknown") #define SDB_FIELD_TYPE(f) \ (((f) == SDB_FIELD_NAME) ? SDB_TYPE_STRING \ @@ -84,6 +90,8 @@ 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 */ \ + : ((f) == SDB_FIELD_TIMESERIES) ? SDB_TYPE_BOOLEAN \ : -1) /* @@ -330,8 +338,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 @@ -355,6 +361,62 @@ int sdb_store_get_attr(sdb_store_obj_t *obj, const char *name, sdb_data_t *res, sdb_store_matcher_t *filter); +/* + * Querying a store: + * + * - Query interface: A query is a formal description of an interaction with + * the store. It can be used, both, for read and write access. The query is + * described by its abstract syntax tree (AST). The parser package provides + * means to parse a string (SysQL) representation of the query into an AST. + * + * - Matcher / expression interface: This low-level interface provides direct + * control over how to access the store. It is used by the query + * implementation internally and can only be used for read access. + */ + +/* + * sdb_store_query_t: + * A parsed query readily prepared for execution. + */ +struct sdb_store_query; +typedef struct sdb_store_query sdb_store_query_t; + +/* + * sdb_store_query_prepare: + * Prepare the query described by 'ast' for execution in a store. + * + * Returns: + * - a store query on success + * - NULL else + */ +sdb_store_query_t * +sdb_store_query_prepare(sdb_ast_node_t *ast); + +/* + * sdb_store_query_prepare_matcher: + * Prepare the logical expression described by 'ast' for execution as a store + * matcher. + * + * Returns: + * - a matcher on success + * - NULL else + */ +sdb_store_matcher_t * +sdb_store_query_prepare_matcher(sdb_ast_node_t *ast); + +/* + * sdb_store_query_execute: + * Execute a previously prepared query. The query result will be written to + * 'buf' and any errors to 'errbuf'. + * + * Returns: + * - the result type (to be used by the server reply) + * - a negative value on error + */ +int +sdb_store_query_execute(sdb_store_query_t *m, + sdb_strbuf_t *buf, sdb_strbuf_t *errbuf); + /* * sdb_store_expr_create: * Creates an arithmetic expression implementing the specified operator on the @@ -508,14 +570,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: @@ -564,11 +618,13 @@ 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_istrue_matcher, sdb_store_isfalse_matcher: + * Creates a matcher matching boolean values. */ sdb_store_matcher_t * -sdb_store_isnnull_matcher(sdb_store_expr_t *expr); +sdb_store_istrue_matcher(sdb_store_expr_t *expr); +sdb_store_matcher_t * +sdb_store_isfalse_matcher(sdb_store_expr_t *expr); /* * sdb_store_matcher_matches: @@ -596,51 +652,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