store: Added sdb_store_fetch_timeseries().

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

diff --git a/src/include/core/store.h b/src/include/core/store.h
index 8eaeecdc3f554998e2a63fee3b15bbce50a6125b..7c94a974297d46cb4107df7ea8773e036343a8d8 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
@@ -32,6 +32,7 @@
 #include "core/object.h"
 #include "core/data.h"
 #include "core/time.h"
+#include "core/timeseries.h"
 #include "utils/strbuf.h"
 
 #include <stdio.h>
@@ -144,8 +145,7 @@ sdb_store_attribute(const char *hostname,
  * 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
  * memory required for storing the entry will be allocated an managed by the
- * store itself. The specified service-object will not be referenced or
- * further accessed.
+ * store itself.
  *
  * Returns:
  *  - 0 on success
@@ -175,6 +175,14 @@ int
 sdb_store_service_attr(const char *hostname, const char *service,
                const char *key, const sdb_data_t *value, sdb_time_t last_update);
 
+/*
+ * A metric store describes how to access a metric's data.
+ */
+typedef struct {
+       const char *type;
+       const char *id;
+} sdb_metric_store_t;
+
 /*
  * sdb_store_metric:
  * Add/update a metric in the store. If the metric, identified by its name,
@@ -182,8 +190,9 @@ sdb_store_service_attr(const char *hostname, const char *service,
  * specified 'metric' object. If the referenced host does not exist, an error
  * will be reported. Else, a new entry will be created in the store. Any
  * memory required for storing the entry will be allocated an managed by the
- * store itself. The specified metric-object will not be referenced or
- * further accessed.
+ * store itself.
+ *
+ * If specified, the metric store describes where to access the metric's data.
  *
  * Returns:
  *  - 0 on success
@@ -193,7 +202,7 @@ sdb_store_service_attr(const char *hostname, const char *service,
  */
 int
 sdb_store_metric(const char *hostname, const char *name,
-               sdb_time_t last_update);
+               sdb_metric_store_t *store, sdb_time_t last_update);
 
 /*
  * sdb_store_metric_attr:
@@ -213,6 +222,19 @@ int
 sdb_store_metric_attr(const char *hostname, const char *metric,
                const char *key, const sdb_data_t *value, sdb_time_t last_update);
 
+/*
+ * sdb_store_fetch_timeseries:
+ * Fetch the time-series described by the specified host's metric and
+ * serialize it as JSON into the provided string buffer.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_store_fetch_timeseries(const char *hostname, const char *metric,
+               sdb_timeseries_opts_t *opts, sdb_strbuf_t *buf);
+
 /*
  * sdb_store_get_field:
  * Get the value of a stored object's queryable field. The caller is