Code

Renamed CONNECTION_* constants to SDB_CONNECTION_*.
[sysdb.git] / src / include / frontend / connection.h
index 8189470d4347721dab0aebeeb526e0e32ec90e07..5dc2b1a8c5ce35105f7b57b972b3dd924bca3ab8 100644 (file)
@@ -126,14 +126,15 @@ sdb_connection_ping(sdb_conn_t *conn);
  * Parse the query text specified in 'query' of length 'len' and return a list
  * of parse trees (for each command) to be executed by sdb_fe_exec. The list
  * has to be freed by the caller. If 'len' is less than zero, parse the whole
- * (nul-terminated) string.
+ * (nul-terminated) string. If specified, errbuf will be used to record parse
+ * errors.
  *
  * Returns:
  *  - an sdb_llist_t object of sdb_conn_node_t on success
  *  - NULL in case of an error
  */
 sdb_llist_t *
-sdb_fe_parse(const char *query, int len);
+sdb_fe_parse(const char *query, int len, sdb_strbuf_t *errbuf);
 
 /*
  * sdb_fe_exec:
@@ -167,9 +168,9 @@ sdb_fe_session_start(sdb_conn_t *conn);
 
 /*
  * sdb_fe_query, sdb_fe_fetch, sdb_fe_list, sdb_fe_lookup:
- * Handle the CONNECTION_QUERY, CONNECTION_FETCH, CONNECTION_LIST, and
- * CONNECTION_LOOKUP commands respectively. It is expected that the current
- * command has been initialized already.
+ * Handle the SDB_CONNECTION_QUERY, SDB_CONNECTION_FETCH, SDB_CONNECTION_LIST,
+ * and SDB_CONNECTION_LOOKUP commands respectively. It is expected that the
+ * current command has been initialized already.
  *
  * Returns:
  *  - 0 on success
@@ -186,24 +187,24 @@ sdb_fe_lookup(sdb_conn_t *conn);
 
 /*
  * sdb_fe_exec_fetch:
- * Execute the 'FETCH' command. Send the named host, serialized as JSON, to
- * the client. If specified, only objects matching the filter will be
- * included. See sdb_store_tojson for details.
+ * Execute the 'FETCH' command. Send the named object of the specified type,
+ * serialized as JSON, to the client. If specified, only objects matching the
+ * filter will be included.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_fe_exec_fetch(sdb_conn_t *conn, const char *name,
-               sdb_store_matcher_t *filter);
+sdb_fe_exec_fetch(sdb_conn_t *conn, int type,
+               const char *hostname, const char *name, sdb_store_matcher_t *filter);
 
 /*
  * sdb_fe_exec_list:
  * Execute the 'LIST' command. Send a complete listing of the store,
  * serialized as JSON, to the client. The listing includes all hosts and the
  * specified object type. If specified, only objects matching the filter will
- * be included. See sdb_store_tojson for details.
+ * be included.
  *
  * Returns:
  *  - 0 on success
@@ -214,17 +215,17 @@ sdb_fe_exec_list(sdb_conn_t *conn, int type, sdb_store_matcher_t *filter);
 
 /*
  * sdb_fe_exec_lookup:
- * Execute the 'LOOKUP' command. Send a list of hosts matching 'm', serialized
- * as JSON, to the client. If specified, only objects matching the filter will
- * be included. See sdb_store_tojson for details.
+ * Execute the 'LOOKUP' command. Send a list of objects of the specified type
+ * matching 'm', serialized as JSON, to the client. If specified, only objects
+ * matching the filter will be included.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_fe_exec_lookup(sdb_conn_t *conn, sdb_store_matcher_t *m,
-               sdb_store_matcher_t *filter);
+sdb_fe_exec_lookup(sdb_conn_t *conn, int type,
+               sdb_store_matcher_t *m, sdb_store_matcher_t *filter);
 
 /*
  * sdb_fe_exec_timeseries: