plugin: Add a helper function to query timeseries information.

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

diff --git a/src/include/core/plugin.h b/src/include/core/plugin.h
index 6c4a2e16cfdf674c2884f560ac158ef7836733d3..6574330412417dee9de23b98715fc9ba4882eafe 100644 (file)
--- a/src/include/core/plugin.h
+++ b/src/include/core/plugin.h
@@ -123,9 +123,6 @@ typedef int (*sdb_plugin_shutdown_cb)(sdb_object_t *user_data);
 typedef int (*sdb_plugin_log_cb)(int prio, const char *msg,
                sdb_object_t *user_data);
 
-typedef sdb_timeseries_t *(*sdb_plugin_fetch_ts_cb)(const char *id,
-               sdb_timeseries_opts_t *opts, sdb_object_t *user_data);
-
 /*
  * sdb_plugin_register_config:
  * Register a "config" function. This will be used to pass on the
@@ -240,11 +237,12 @@ sdb_plugin_register_log(const char *name, sdb_plugin_log_cb callback,
                sdb_object_t *user_data);
 
 /*
- * sdb_plugin_register_ts_fetcher:
- * Register a "time-series fetcher" function to be called whenever retrieving
- * a time-series from a data-store. The callback will receive an identifier
- * describing where to retrieve the data from (e.g. a filename or some kind of
- * URL) and options which further describe the query.
+ * sdb_plugin_register_timeseries_fetcher:
+ * Register a "time-series fetcher" to be called whenever retrieving a
+ * time-series from a data-store or information about it. The fetch callback
+ * will receive an identifier describing where to retrieve the data from (e.g.
+ * a filename or some kind of URL) and options which further describe the
+ * query.
  *
  * The name is used literally (without prepending the plugin name) to look up
  * the appropriate fetcher callback.
@@ -256,8 +254,8 @@ sdb_plugin_register_log(const char *name, sdb_plugin_log_cb callback,
  *    use the object for other purposes, it should thus deref it.
  */
 int
-sdb_plugin_register_ts_fetcher(const char *name,
-               sdb_plugin_fetch_ts_cb callback, sdb_object_t *user_data);
+sdb_plugin_register_timeseries_fetcher(const char *name,
+               sdb_timeseries_fetcher_t *fetcher, sdb_object_t *user_data);
 
 /*
  * sdb_plugin_register_writer:
@@ -436,6 +434,20 @@ sdb_timeseries_t *
 sdb_plugin_fetch_timeseries(const char *type, const char *id,
                sdb_timeseries_opts_t *opts);
 
+/*
+ * sdb_plugin_describe_timeseries:
+ * Fetch information about the time-series identified by 'id' from a backend
+ * data-store of the specified 'type'. The type has to match an existing
+ * time-series fetcher callback's name. The identifier is passed through to
+ * the callback which then needs to make sense of it.
+ *
+ * Returns:
+ *  - a time-series information object on success
+ *  - NULL else
+ */
+sdb_timeseries_info_t *
+sdb_plugin_describe_timeseries(const char *type, const char *id);
+
 /*
  * sdb_plugin_query:
  * Query the store using the query specified by 'ast'. The result will be