plugin: Add a new type of timeseries-fetcher plugins.

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

diff --git a/src/include/core/plugin.h b/src/include/core/plugin.h
index 1155a957cd3f06fc186b16d4250662c25aaaa9dd..5a26c39fb78b10f503667b9060e4d20f01416746 100644 (file)
--- a/src/include/core/plugin.h
+++ b/src/include/core/plugin.h
@@ -240,11 +240,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.
@@ -258,6 +259,9 @@ sdb_plugin_register_log(const char *name, sdb_plugin_log_cb callback,
 int
 sdb_plugin_register_ts_fetcher(const char *name,
                sdb_plugin_fetch_ts_cb callback, sdb_object_t *user_data);
+int
+sdb_plugin_register_timeseries_fetcher(const char *name,
+               sdb_timeseries_fetcher_t *fetcher, sdb_object_t *user_data);
 
 /*
  * sdb_plugin_register_writer:
@@ -267,7 +271,7 @@ sdb_plugin_register_ts_fetcher(const char *name,
  *
  * Arguments:
  *  - user_data: If specified, this will be passed on to each call of the
- *    callback. The function will take ownership of the object, that is,
+ *    callbacks. The function will take ownership of the object, that is,
  *    increment the reference count by one. In case the caller does not longer
  *    use the object for other purposes, it should thus deref it.
  */
@@ -275,6 +279,22 @@ int
 sdb_plugin_register_writer(const char *name,
                sdb_store_writer_t *writer, sdb_object_t *user_data);
 
+/*
+ * sdb_plugin_register_reader:
+ * Register a "reader" implementation for querying the store. It is invalid to
+ * register an incomplete reader which does not implement all of the reader
+ * interface.
+ *
+ * Arguments:
+ *  - user_data: If specified, this will be passed on to each call of the
+ *    callbacks. The function will take ownership of the object, that is,
+ *    increment the reference count by one. In case the caller does not longer
+ *    use the object for other purposes, it should thus deref it.
+ */
+int
+sdb_plugin_register_reader(const char *name,
+               sdb_store_reader_t *reader, sdb_object_t *user_data);
+
 /*
  * sdb_plugin_unregister_all:
  * Unregister all registered plugins and destruct their user-data objects.
@@ -420,6 +440,19 @@ sdb_timeseries_t *
 sdb_plugin_fetch_timeseries(const char *type, const char *id,
                sdb_timeseries_opts_t *opts);
 
+/*
+ * sdb_plugin_query:
+ * Query the store using the query specified by 'ast'. The result will be
+ * written to 'buf' and any errors will be written to 'errbuf'.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_plugin_query(sdb_ast_node_t *ast,
+               sdb_store_writer_t *w, sdb_object_t *wd, sdb_strbuf_t *errbuf);
+
 /*
  * sdb_plugin_store_host, sdb_plugin_store_service, sdb_plugin_store_metric,
  * sdb_plugin_store_attribute, sdb_plugin_store_service_attribute,