store, frontend: Renamed sdb_store_lookup() to sdb_store_scan().

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

diff --git a/src/include/core/store.h b/src/include/core/store.h
index ecaf21d0bbd6b974483290a94dce38916dd285c4..4e8d468c4263f0e57cd2f26d301aedf0006102a7 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
@@ -32,7 +32,6 @@
 #include "core/object.h"
 #include "core/data.h"
 #include "core/time.h"
-#include "utils/llist.h"
 #include "utils/strbuf.h"
 
 #include <stdio.h>
@@ -56,12 +55,12 @@ enum {
 
 
 /*
- * sdb_store_base_t represents the super-class of any object stored in the
+ * 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.
  */
-struct sdb_store_base;
-typedef struct sdb_store_base sdb_store_base_t;
+struct sdb_store_obj;
+typedef struct sdb_store_obj sdb_store_obj_t;
 
 /*
  * sdb_store_clear:
@@ -98,7 +97,7 @@ sdb_store_host(const char *name, sdb_time_t last_update);
 _Bool
 sdb_store_has_host(const char *name);
 
-sdb_store_base_t *
+sdb_store_obj_t *
 sdb_store_get_host(const char *name);
 
 /*
@@ -123,7 +122,7 @@ sdb_store_attribute(const char *hostname,
 
 /*
  * sdb_store_service:
- * Add/update a store in the store. If the service, identified by its name,
+ * Add/update a service in the store. If the service, identified by its name,
  * already exists for the specified host, it will be updated according to the
  * specified 'service' object. If the referenced host does not exist, an error
  * will be reported. Else, a new entry will be created in the store. Any
@@ -141,6 +140,24 @@ int
 sdb_store_service(const char *hostname, const char *name,
                sdb_time_t last_update);
 
+/*
+ * sdb_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. Any memory required for storing
+ * the entry will be allocated and managed by the store itself.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a positive value if the new entry is older than the currently stored
+ *    entry (in this case, no update will happen)
+ *  - a negative value on error
+ */
+int
+sdb_store_service_attr(const char *hostname, const char *service,
+               const char *key, const sdb_data_t *value, sdb_time_t last_update);
+
 /*
  * Conditionals may be used to lookup hosts from the store based on a
  * conditional expression.
@@ -192,6 +209,13 @@ sdb_store_name_matcher(int type, const char *name, _Bool re);
 sdb_store_matcher_t *
 sdb_store_attr_matcher(const char *name, const char *value, _Bool re);
 
+/*
+ * sdb_store_isnull_matcher:
+ * Creates a matcher matching "missing" attributes.
+ */
+sdb_store_matcher_t *
+sdb_store_isnull_matcher(const char *attr_name);
+
 /*
  * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher,
  * sdb_store_ge_matcher, sdb_store_gt_matcher:
@@ -221,7 +245,7 @@ sdb_store_gt_matcher(sdb_store_cond_t *cond);
  */
 sdb_store_matcher_t *
 sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr,
-               const char *op, const char *value);
+               const char *op, const sdb_data_t *value);
 
 /*
  * sdb_store_dis_matcher:
@@ -253,7 +277,7 @@ sdb_store_inv_matcher(sdb_store_matcher_t *m);
  *  - 0 else
  */
 int
-sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_base_t *obj);
+sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj);
 
 /*
  * sdb_store_matcher_tostring:
@@ -268,19 +292,20 @@ sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen);
  * 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.
  */
-typedef int (*sdb_store_lookup_cb)(sdb_store_base_t *obj, void *user_data);
+typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj, void *user_data);
 
 /*
- * sdb_store_lookup:
+ * sdb_store_scan:
  * Look up objects in the store. The specified callback function is called for
- * each object in the store matching 'm'.
+ * each object in the store matching 'm'. The function performs a full scan of
+ * all hosts stored in the database.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_store_lookup(sdb_store_matcher_t *m, sdb_store_lookup_cb cb,
+sdb_store_scan(sdb_store_matcher_t *m, sdb_store_lookup_cb cb,
                void *user_data);
 
 /*
@@ -319,13 +344,13 @@ sdb_store_tojson(sdb_strbuf_t *buf, int flags);
  *  - a negative value on error
  */
 int
-sdb_store_host_tojson(sdb_store_base_t *host, sdb_strbuf_t *buf, int flags);
+sdb_store_host_tojson(sdb_store_obj_t *host, sdb_strbuf_t *buf, 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_base_t *obj, void *user_data);
+typedef int (*sdb_store_iter_cb)(sdb_store_obj_t *obj, void *user_data);
 
 /*
  * sdb_store_iterate: