store: Fixed JSON serialization when skipping hosts due to filters.

[sysdb.git] / src / include / core / store.h

diff --git a/src/include/core/store.h b/src/include/core/store.h
index 578fb51e7087e72b634cb60f4b44cc32738a5b9d..308523a4476a1b861ad134e43815d7372088b036 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
@@ -53,7 +53,6 @@ enum {
                : ((t) == SDB_SERVICE) ? "service" \
                : ((t) == SDB_ATTRIBUTE) ? "attribute" : "unknown")
 
-
 /*
  * 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
@@ -62,6 +61,22 @@ enum {
 struct sdb_store_obj;
 typedef struct sdb_store_obj sdb_store_obj_t;
 
+/*
+ * Queryable fields of a stored object.
+ */
+enum {
+       SDB_FIELD_LAST_UPDATE = 1, /* datetime */
+       SDB_FIELD_AGE,             /* datetime */
+       SDB_FIELD_INTERVAL,        /* datetime */
+       SDB_FIELD_BACKEND,         /* string */
+};
+
+#define SDB_FIELD_TO_NAME(f) \
+       (((f) == SDB_FIELD_LAST_UPDATE) ? "last-update" \
+               : ((f) == SDB_FIELD_AGE) ? "age" \
+               : ((f) == SDB_FIELD_INTERVAL) ? "interval" \
+               : ((f) == SDB_FIELD_BACKEND) ? "backend" : "unknown")
+
 /*
  * sdb_store_clear:
  * Clear the entire store and remove all stored objects.
@@ -224,6 +239,15 @@ typedef struct sdb_store_cond sdb_store_cond_t;
 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);
+
 /*
  * Store matchers may be used to lookup hosts from the store based on their
  * various attributes. Service and attribute matchers are applied to a host's
@@ -381,26 +405,32 @@ enum {
 /*
  * sdb_store_tojson:
  * Serialize the entire store to JSON and append the result to the specified
- * buffer.
+ * 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
  */
 int
-sdb_store_tojson(sdb_strbuf_t *buf, int flags);
+sdb_store_tojson(sdb_strbuf_t *buf, sdb_store_matcher_t *filter, int flags);
 
 /*
  * sdb_store_host_tojson:
  * Serialize a host object to JSON and append the result to the specified
- * buffer.
+ * 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.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value on error
  */
 int
-sdb_store_host_tojson(sdb_store_obj_t *host, sdb_strbuf_t *buf, int flags);
+sdb_store_host_tojson(sdb_store_obj_t *host, sdb_strbuf_t *buf,
+               sdb_store_matcher_t *filter, int flags);
 
 /*
  * sdb_store_iter_cb: