Code

store: Let sdb_store_scan() pass on filters to callback functions.
[sysdb.git] / src / include / core / store.h
index cef3d063cf0f41f18aad997eedf92971d7cf93ac..2720db472f30abd4c853b7c1c805979749407f25 100644 (file)
@@ -106,6 +106,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,24 +366,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);
 
-/*
- * 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.
@@ -391,33 +381,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_any_matcher(int type, sdb_store_matcher_t *m);
+
+/*
+ * 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_child_matcher(int type, sdb_store_matcher_t *m);
+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:
- * 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.
+ * 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:
@@ -466,6 +464,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.
@@ -488,18 +497,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 (<obj_type> <op> <expression>).
- *
- * Returns:
- *  - a matcher object on success
- *  - NULL else
- */
-sdb_store_matcher_t *
-sdb_store_matcher_parse_cmp(const char *obj_type,
-               const char *op, sdb_store_expr_t *expr);
-
 /*
  * sdb_store_dis_matcher:
  * Creates a matcher matching the disjunction (logical OR) of two matchers.
@@ -543,24 +540,26 @@ sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj,
 /*
  * 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);
 
 /*
@@ -613,24 +612,6 @@ int
 sdb_store_host_tojson(sdb_store_obj_t *host, sdb_strbuf_t *buf,
                sdb_store_matcher_t *filter, int flags);
 
-/*
- * 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.
- *
- * Returns:
- *  - 0 on success
- *  - a negative value else
- */
-int
-sdb_store_iterate(sdb_store_iter_cb cb, void *user_data);
-
 #ifdef __cplusplus
 } /* extern "C" */
 #endif