28b257e056b10f6912b793c95ee592afba6ed59d
1 /*
2 * SysDB - src/include/core/store.h
3 * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #ifndef SDB_CORE_STORE_H
29 #define SDB_CORE_STORE_H 1
31 #include "sysdb.h"
32 #include "core/object.h"
33 #include "core/data.h"
34 #include "core/time.h"
35 #include "core/timeseries.h"
36 #include "parser/ast.h"
37 #include "utils/strbuf.h"
39 #include <stdbool.h>
40 #include <stdio.h>
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
46 /*
47 * Store object types.
48 */
49 enum {
50 SDB_HOST = 1,
51 SDB_SERVICE,
52 SDB_METRIC,
54 SDB_ATTRIBUTE = 1 << 4,
56 /*
57 * Queryable fields of a stored object.
58 */
59 SDB_FIELD_NAME = 1 << 8, /* type: string */
60 SDB_FIELD_LAST_UPDATE, /* type: datetime */
61 SDB_FIELD_AGE, /* type: datetime */
62 SDB_FIELD_INTERVAL, /* type: datetime */
63 SDB_FIELD_BACKEND, /* type: array of strings */
64 SDB_FIELD_VALUE, /* attributes only; type: type of the value */
65 SDB_FIELD_TIMESERIES, /* metrics only; type: boolean */
66 };
67 #define SDB_STORE_TYPE_TO_NAME(t) \
68 (((t) == SDB_HOST) ? "host" \
69 : ((t) == SDB_SERVICE) ? "service" \
70 : ((t) == SDB_METRIC) ? "metric" \
71 : ((t) == SDB_ATTRIBUTE) ? "attribute" \
72 : ((t) == (SDB_ATTRIBUTE | SDB_HOST)) ? "host attribute" \
73 : ((t) == (SDB_ATTRIBUTE | SDB_SERVICE)) ? "service attribute" \
74 : ((t) == (SDB_ATTRIBUTE | SDB_METRIC)) ? "metric attribute" \
75 : "unknown")
77 #define SDB_FIELD_TO_NAME(f) \
78 (((f) == SDB_FIELD_NAME) ? "name" \
79 : ((f) == SDB_FIELD_LAST_UPDATE) ? "last-update" \
80 : ((f) == SDB_FIELD_AGE) ? "age" \
81 : ((f) == SDB_FIELD_INTERVAL) ? "interval" \
82 : ((f) == SDB_FIELD_BACKEND) ? "backend" \
83 : ((f) == SDB_FIELD_VALUE) ? "value" \
84 : ((f) == SDB_FIELD_TIMESERIES) ? "timeseries" \
85 : "unknown")
87 #define SDB_FIELD_TYPE(f) \
88 (((f) == SDB_FIELD_NAME) ? SDB_TYPE_STRING \
89 : ((f) == SDB_FIELD_LAST_UPDATE) ? SDB_TYPE_DATETIME \
90 : ((f) == SDB_FIELD_AGE) ? SDB_TYPE_DATETIME \
91 : ((f) == SDB_FIELD_INTERVAL) ? SDB_TYPE_DATETIME \
92 : ((f) == SDB_FIELD_BACKEND) ? (SDB_TYPE_ARRAY | SDB_TYPE_STRING) \
93 : ((f) == SDB_FIELD_VALUE) ? -1 /* unknown */ \
94 : ((f) == SDB_FIELD_TIMESERIES) ? SDB_TYPE_BOOLEAN \
95 : -1)
97 /*
98 * sdb_store_t represents an in-memory store. It inherits from sdb_object_t
99 * and may safely be case to a generic object.
100 */
101 struct sdb_store;
102 typedef struct sdb_store sdb_store_t;
103 #define SDB_STORE(obj) ((sdb_store_t *)(obj))
105 /*
106 * sdb_store_obj_t represents the super-class of any object stored in the
107 * database. It inherits from sdb_object_t and may safely be cast to a generic
108 * object to access its name.
109 */
110 struct sdb_store_obj;
111 typedef struct sdb_store_obj sdb_store_obj_t;
113 /*
114 * A metric store describes how to access a metric's data.
115 */
116 typedef struct {
117 const char *type;
118 const char *id;
119 } sdb_metric_store_t;
121 /*
122 * Expressions represent arithmetic expressions based on stored objects and
123 * their various attributes.
124 *
125 * An expression object inherits from sdb_object_t and, thus, may safely be
126 * cast to a generic object.
127 */
128 struct sdb_store_expr;
129 typedef struct sdb_store_expr sdb_store_expr_t;
130 #define SDB_STORE_EXPR(obj) ((sdb_store_expr_t *)(obj))
132 /*
133 * An expression iterator iterates over the values of an iterable expression
134 * (see sdb_store_expr_iterable).
135 */
136 struct sdb_store_expr_iter;
137 typedef struct sdb_store_expr_iter sdb_store_expr_iter_t;
139 /*
140 * Store matchers may be used to lookup hosts from the store based on their
141 * various attributes. Service and attribute matchers are applied to a host's
142 * services and attributes and evaluate to true if *any* service or attribute
143 * matches.
144 *
145 * A store matcher object inherits from sdb_object_t and, thus, may safely be
146 * cast to a generic object.
147 */
148 struct sdb_store_matcher;
149 typedef struct sdb_store_matcher sdb_store_matcher_t;
150 #define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj))
152 /*
153 * A JSON formatter converts stored objects into the JSON format.
154 * See http://www.ietf.org/rfc/rfc4627.txt
155 *
156 * A JSON formatter object inherits from sdb_object_t and, thus, may safely be
157 * cast to a generic object.
158 */
159 struct sdb_store_json_formatter;
160 typedef struct sdb_store_json_formatter sdb_store_json_formatter_t;
162 /*
163 * A store writer describes the interface for plugins implementing a store.
164 *
165 * Any of the call-back functions shall return:
166 * - 0 on success
167 * - a positive value if the new entry is older than the currently stored
168 * entry (in this case, no update will happen)
169 * - a negative value on error
170 */
171 typedef struct {
172 /*
173 * store_host:
174 * Add/update a host in the store. If the host, identified by its
175 * canonicalized name, already exists, it will be updated according to the
176 * specified name and timestamp. Else, a new entry will be created in the
177 * store.
178 */
179 int (*store_host)(const char *name, sdb_time_t last_update,
180 sdb_object_t *user_data);
182 /*
183 * store_service:
184 * Add/update a service in the store. If the service, identified by its
185 * name, already exists for the specified host, it will be updated
186 * according to the specified name and timestamp. If the referenced host
187 * does not exist, an error will be reported. Else, a new entry will be
188 * created in the store.
189 */
190 int (*store_service)(const char *hostname, const char *name,
191 sdb_time_t last_update, sdb_object_t *user_data);
193 /*
194 * store_metric:
195 * Add/update a metric in the store. If the metric, identified by its
196 * name, already exists for the specified host, it will be updated
197 * according to the specified attributes. If the referenced host does not
198 * exist, an error will be reported. Else, a new entry will be created in
199 * the store.
200 */
201 int (*store_metric)(const char *hostname, const char *name,
202 sdb_metric_store_t *store, sdb_time_t last_update,
203 sdb_object_t *user_data);
205 /*
206 * store_attribute:
207 * Add/update a host's attribute in the store. If the attribute,
208 * identified by its key, already exists for the specified host, it will
209 * be updated to the specified values. If the referenced host does not
210 * exist, an error will be reported. Else, a new entry will be created in
211 * the store.
212 */
213 int (*store_attribute)(const char *hostname,
214 const char *key, const sdb_data_t *value, sdb_time_t last_update,
215 sdb_object_t *user_data);
217 /*
218 * store_service_attr:
219 * Add/update a service's attribute in the store. If the attribute,
220 * identified by its key, already exists for the specified service, it
221 * will be updated to the specified value. If the references service (for
222 * the specified host) does not exist, an error will be reported.
223 */
224 int (*store_service_attr)(const char *hostname, const char *service,
225 const char *key, const sdb_data_t *value, sdb_time_t last_update,
226 sdb_object_t *user_data);
228 /*
229 * store_metric_attr:
230 * Add/update a metric's attribute in the store. If the attribute,
231 * identified by its key, already exists for the specified metric, it will
232 * be updated to the specified value. If the references metric (for the
233 * specified host) does not exist, an error will be reported.
234 */
235 int (*store_metric_attr)(const char *hostname, const char *metric,
236 const char *key, const sdb_data_t *value, sdb_time_t last_update,
237 sdb_object_t *user_data);
238 } sdb_store_writer_t;
240 /*
241 * sdb_store_writer:
242 * A store writer implementation that provides an in-memory object store. It
243 * expects a store object as its user-data argument.
244 */
245 extern sdb_store_writer_t sdb_store_writer;
247 /*
248 * A store reader describes the interface to query a store implementation.
249 */
250 typedef struct {
251 /*
252 * prepare_query:
253 * Prepare the query described by 'ast' for execution.
254 */
255 sdb_object_t *(*prepare_query)(sdb_ast_node_t *ast,
256 sdb_strbuf_t *errbuf, sdb_object_t *user_data);
258 /*
259 * execute_query:
260 * Execute a previously prepared query. The callback may expect that only
261 * queries prepared by its respective prepare callback will be passed to
262 * this function.
263 *
264 * TODO: Instead of letting the executor write directly to a string buffer
265 * (which cannot easily be merged with other results), let it hand
266 * all objects to a store-writer.
267 */
268 int (*execute_query)(sdb_object_t *q,
269 sdb_strbuf_t *buf, sdb_strbuf_t *errbuf,
270 sdb_object_t *user_data);
271 } sdb_store_reader_t;
273 /*
274 * sdb_store_reader:
275 * A store reader implementation that uses an in-memory object store. It
276 * expects a store object as its user-data argument.
277 */
278 extern sdb_store_reader_t sdb_store_reader;
280 /*
281 * sdb_store_create:
282 * Allocate a new in-memory store.
283 */
284 sdb_store_t *
285 sdb_store_create(void);
287 /*
288 * sdb_store_host, sdb_store_service, sdb_store_metric, sdb_store_attribute,
289 * sdb_store_metric_attr:
290 * Store an object in the specified store. The hostname is expected to be
291 * canonical.
292 */
293 int
294 sdb_store_host(sdb_store_t *store, const char *name, sdb_time_t last_update);
295 int
296 sdb_store_service(sdb_store_t *store, const char *hostname, const char *name,
297 sdb_time_t last_update);
298 int
299 sdb_store_metric(sdb_store_t *store, const char *hostname, const char *name,
300 sdb_metric_store_t *metric_store, sdb_time_t last_update);
301 int
302 sdb_store_attribute(sdb_store_t *store, const char *hostname,
303 const char *key, const sdb_data_t *value, sdb_time_t last_update);
304 int
305 sdb_store_service_attr(sdb_store_t *store, const char *hostname,
306 const char *service, const char *key, const sdb_data_t *value,
307 sdb_time_t last_update);
308 int
309 sdb_store_metric_attr(sdb_store_t *store, const char *hostname,
310 const char *metric, const char *key, const sdb_data_t *value,
311 sdb_time_t last_update);
313 /*
314 * sdb_store_get_host:
315 * Query the specified store for a host by its (canonicalized) name.
316 *
317 * The function increments the ref count of the host object. The caller needs
318 * to deref it when no longer using it.
319 */
320 sdb_store_obj_t *
321 sdb_store_get_host(sdb_store_t *store, const char *name);
323 /*
324 * sdb_store_fetch_timeseries:
325 * Fetch the time-series described by the specified host's metric and
326 * serialize it as JSON into the provided string buffer. The host data is
327 * retrieved from the specified store.
328 *
329 * Returns:
330 * - 0 on success
331 * - a negative value else
332 */
333 int
334 sdb_store_fetch_timeseries(sdb_store_t *store,
335 const char *hostname, const char *metric,
336 sdb_timeseries_opts_t *opts, sdb_strbuf_t *buf);
338 /*
339 * sdb_store_get_child:
340 * Retrieve a host's child object of the specified type and name. The
341 * reference count of the child object will be incremented before returning
342 * it. The caller is responsible for releasing the object once it's no longer
343 * used.
344 *
345 * Returns:
346 * - the child object on success
347 * - NULL else
348 */
349 sdb_store_obj_t *
350 sdb_store_get_child(sdb_store_obj_t *host, int type, const char *name);
352 /*
353 * sdb_store_get_field:
354 * Get the value of a stored object's queryable field. The caller is
355 * responsible for freeing any dynamically allocated memory possibly stored in
356 * the returned value. If 'res' is NULL, the function will return whether the
357 * field exists.
358 *
359 * Returns:
360 * - 0 on success
361 * - a negative value else
362 */
363 int
364 sdb_store_get_field(sdb_store_obj_t *obj, int field, sdb_data_t *res);
366 /*
367 * sdb_store_get_attr:
368 * Get the value of a stored object's attribute. The caller is responsible for
369 * freeing any dynamically allocated memory possibly stored in the returned
370 * value. If 'res' is NULL, the function will return whether the attribute
371 * exists. If specified, only attributes matching the filter will be
372 * considered.
373 *
374 * Returns:
375 * - 0 if the attribute exists
376 * - a negative value else
377 */
378 int
379 sdb_store_get_attr(sdb_store_obj_t *obj, const char *name, sdb_data_t *res,
380 sdb_store_matcher_t *filter);
382 /*
383 * Querying a store:
384 *
385 * - Query interface: A query is a formal description of an interaction with
386 * the store. It can be used, both, for read and write access. The query is
387 * described by its abstract syntax tree (AST). The parser package provides
388 * means to parse a string (SysQL) representation of the query into an AST.
389 *
390 * - Matcher / expression interface: This low-level interface provides direct
391 * control over how to access the store. It is used by the query
392 * implementation internally and can only be used for read access.
393 */
395 /*
396 * sdb_store_query_t:
397 * A parsed query readily prepared for execution.
398 */
399 struct sdb_store_query;
400 typedef struct sdb_store_query sdb_store_query_t;
402 /*
403 * sdb_store_query_prepare:
404 * Prepare the query described by 'ast' for execution in a store.
405 *
406 * Returns:
407 * - a store query on success
408 * - NULL else
409 */
410 sdb_store_query_t *
411 sdb_store_query_prepare(sdb_ast_node_t *ast);
413 /*
414 * sdb_store_query_prepare_matcher:
415 * Prepare the logical expression described by 'ast' for execution as a store
416 * matcher.
417 *
418 * Returns:
419 * - a matcher on success
420 * - NULL else
421 */
422 sdb_store_matcher_t *
423 sdb_store_query_prepare_matcher(sdb_ast_node_t *ast);
425 /*
426 * sdb_store_query_execute:
427 * Execute a previously prepared query in the specified store. The query
428 * result will be written to 'buf' and any errors to 'errbuf'.
429 *
430 * Returns:
431 * - the result type (to be used by the server reply)
432 * - a negative value on error
433 */
434 int
435 sdb_store_query_execute(sdb_store_t *store, sdb_store_query_t *m,
436 sdb_strbuf_t *buf, sdb_strbuf_t *errbuf);
438 /*
439 * sdb_store_expr_create:
440 * Creates an arithmetic expression implementing the specified operator on the
441 * specified left and right operand.
442 *
443 * Returns:
444 * - an expression object on success
445 * - NULL else
446 */
447 sdb_store_expr_t *
448 sdb_store_expr_create(int op, sdb_store_expr_t *left, sdb_store_expr_t *right);
450 /*
451 * sdb_store_expr_typed:
452 * Creates an expression which evaluates in the context of an object's sibling
453 * as specified by the given type.
454 *
455 * Returns:
456 * - an expression object on success
457 * - NULL else
458 */
459 sdb_store_expr_t *
460 sdb_store_expr_typed(int typ, sdb_store_expr_t *expr);
462 /*
463 * sdb_store_expr_fieldvalue:
464 * Creates an expression which evaluates to the value of the specified
465 * queryable field of a stored object.
466 *
467 * Returns:
468 * - an expression object on success
469 * - NULL else
470 */
471 sdb_store_expr_t *
472 sdb_store_expr_fieldvalue(int field);
474 /*
475 * sdb_store_expr_attrvalue:
476 * Creates an expression which evaluates to the value of the specified
477 * attribute of a stored object. Evaluates to a NULL value if the attribute
478 * does not exist.
479 *
480 * Returns:
481 * - an expression object on success
482 * - NULL else
483 */
484 sdb_store_expr_t *
485 sdb_store_expr_attrvalue(const char *name);
487 /*
488 * sdb_store_expr_constvalue:
489 * Creates an expression which evaluates to the specified constant value.
490 *
491 * Returns:
492 * - an expression object on success
493 * - NULL else
494 */
495 sdb_store_expr_t *
496 sdb_store_expr_constvalue(const sdb_data_t *value);
498 /*
499 * sdb_store_expr_eval:
500 * Evaluate an expression for the specified stored object and stores the
501 * result in 'res'. The result's value will be allocated dynamically if
502 * necessary and, thus, should be free'd by the caller (e.g. using
503 * sdb_data_free_datum). The object may be NULL, in which case the expression
504 * needs to evaluate to a constant value. If specified, only objects matching
505 * the filter will be used during the evaluation.
506 *
507 * Returns:
508 * - 0 on success
509 * - a negative value else
510 */
511 int
512 sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
513 sdb_data_t *res, sdb_store_matcher_t *filter);
515 /*
516 * sdb_store_expr_iterable:
517 * Check whether an expression, evaluated in the specified context (HOST,
518 * SERVICE, METRIC) is iterable, that is, if it may evaluate to multiple
519 * values.
520 */
521 bool
522 sdb_store_expr_iterable(sdb_store_expr_t *expr, int context);
524 /*
525 * sdb_store_expr_iter:
526 * Iterate over the elements of an iterable expression. sdb_store_expr_iter
527 * returns NULL if the expression is not iterable (for the specified object).
528 * See also sdb_store_expr_iterable.
529 *
530 * sdb_store_expr_iter_get_next returns NULL if there is no next element.
531 */
532 sdb_store_expr_iter_t *
533 sdb_store_expr_iter(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
534 sdb_store_matcher_t *filter);
535 void
536 sdb_store_expr_iter_destroy(sdb_store_expr_iter_t *iter);
538 bool
539 sdb_store_expr_iter_has_next(sdb_store_expr_iter_t *iter);
540 sdb_data_t
541 sdb_store_expr_iter_get_next(sdb_store_expr_iter_t *iter);
543 /*
544 * sdb_store_dis_matcher:
545 * Creates a matcher matching the disjunction (logical OR) of two matchers.
546 */
547 sdb_store_matcher_t *
548 sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
550 /*
551 * sdb_store_con_matcher:
552 * Creates a matcher matching the conjunction (logical AND) of two matchers.
553 */
554 sdb_store_matcher_t *
555 sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
557 /*
558 * sdb_store_inv_matcher::
559 * Creates a matcher matching the inverse (logical NOT) of a matcher.
560 */
561 sdb_store_matcher_t *
562 sdb_store_inv_matcher(sdb_store_matcher_t *m);
564 /*
565 * sdb_store_any_matcher:
566 * Creates a matcher iterating over values of the first expression (which has
567 * to be iterable). It matches if *any* of those elements match 'm'. 'm' has
568 * to be an ary operation with the left operand unset.
569 */
570 sdb_store_matcher_t *
571 sdb_store_any_matcher(sdb_store_expr_t *iter, sdb_store_matcher_t *m);
573 /*
574 * sdb_store_all_matcher:
575 * Creates a matcher iterating over values of the first expression (which has
576 * to be iterable). It matches if *all* of those elements match 'm'. 'm' has
577 * to be an ary operation with the left operand unset.
578 */
579 sdb_store_matcher_t *
580 sdb_store_all_matcher(sdb_store_expr_t *iter, sdb_store_matcher_t *m);
582 /*
583 * sdb_store_in_matcher:
584 * Creates a matcher which matches if the right value evaluates to an array
585 * value and the left value is included in that array. See sdb_data_inarray
586 * for more details.
587 */
588 sdb_store_matcher_t *
589 sdb_store_in_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
591 /*
592 * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher,
593 * sdb_store_ge_matcher, sdb_store_gt_matcher:
594 * Create conditional matchers comparing the values of two expressions. The
595 * matcher matches if the left expression compres less than, less or equal
596 * than, equal to, not equal to, greater or equal than, or greater than the
597 * right expression.
598 */
599 sdb_store_matcher_t *
600 sdb_store_lt_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
601 sdb_store_matcher_t *
602 sdb_store_le_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
603 sdb_store_matcher_t *
604 sdb_store_eq_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
605 sdb_store_matcher_t *
606 sdb_store_ne_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
607 sdb_store_matcher_t *
608 sdb_store_ge_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
609 sdb_store_matcher_t *
610 sdb_store_gt_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
612 /*
613 * sdb_store_regex_matcher:
614 * Creates a matcher which matches the string value the left expression
615 * evaluates to against the regular expression the right expression evaluates
616 * to. The right expression may either be a constant value regular expression
617 * or string or a dynamic value evaluating to a string. In the latter case,
618 * the string is compiled to a regex every time the matcher is executed.
619 */
620 sdb_store_matcher_t *
621 sdb_store_regex_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
623 /*
624 * sdb_store_nregex_matcher:
625 * Creates a regex matcher just like sdb_store_regex_matcher except that it
626 * matches in case the regular expression does not match.
627 */
628 sdb_store_matcher_t *
629 sdb_store_nregex_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
631 /*
632 * sdb_store_isnull_matcher:
633 * Creates a matcher matching NULL values.
634 */
635 sdb_store_matcher_t *
636 sdb_store_isnull_matcher(sdb_store_expr_t *expr);
638 /*
639 * sdb_store_istrue_matcher, sdb_store_isfalse_matcher:
640 * Creates a matcher matching boolean values.
641 */
642 sdb_store_matcher_t *
643 sdb_store_istrue_matcher(sdb_store_expr_t *expr);
644 sdb_store_matcher_t *
645 sdb_store_isfalse_matcher(sdb_store_expr_t *expr);
647 /*
648 * sdb_store_matcher_matches:
649 * Check whether the specified matcher matches the specified store object. If
650 * specified, the filter will be used to preselect objects for further
651 * evaluation. It is applied to any object that's used during the evaluation
652 * of the matcher. Only those objects matching the filter will be considered.
653 *
654 * Note that the filter is applied to all object types (hosts, service,
655 * metric, attribute). Thus, any object-specific matchers are mostly unsuited
656 * for this purpose and, if used, may result in unexpected behavior.
657 *
658 * Returns:
659 * - 1 if the object matches
660 * - 0 else
661 */
662 int
663 sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj,
664 sdb_store_matcher_t *filter);
666 /*
667 * sdb_store_matcher_op_cb:
668 * Callback constructing a matcher operator.
669 */
670 typedef sdb_store_matcher_t *(*sdb_store_matcher_op_cb)
671 (sdb_store_expr_t *, sdb_store_expr_t *);
673 /*
674 * sdb_store_lookup_cb:
675 * Lookup callback. It is called for each matching object when looking up data
676 * in the store passing on the lookup filter and the specified user-data. The
677 * lookup aborts early if the callback returns non-zero.
678 */
679 typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj,
680 sdb_store_matcher_t *filter, void *user_data);
682 /*
683 * sdb_store_scan:
684 * Look up objects of the specified type in the specified store. The specified
685 * callback function is called for each object in the store matching 'm'. The
686 * function performs a full scan of all objects stored in the database. If
687 * specified, the filter will be used to preselect objects for further
688 * evaluation. See the description of 'sdb_store_matcher_matches' for details.
689 *
690 * Returns:
691 * - 0 on success
692 * - a negative value else
693 */
694 int
695 sdb_store_scan(sdb_store_t *store, int type,
696 sdb_store_matcher_t *m, sdb_store_matcher_t *filter,
697 sdb_store_lookup_cb cb, void *user_data);
699 /*
700 * Flags for JSON formatting.
701 */
702 enum {
703 SDB_WANT_ARRAY = 1 << 0,
704 };
706 /*
707 * sdb_store_json_formatter:
708 * Create a JSON formatter for the specified object types writing to the
709 * specified buffer.
710 */
711 sdb_store_json_formatter_t *
712 sdb_store_json_formatter(sdb_strbuf_t *buf, int type, int flags);
714 /*
715 * sdb_store_json_emit:
716 * Serialize a single object to JSON adding it to the string buffer associated
717 * with the formatter object. The serialized object will not include
718 * attributes or any child objects. Instead, call the function again for each
719 * of those objects. All attributes have to be emitted before any other
720 * children types. Use sdb_store_json_emit_full() to emit a full (filtered)
721 * object.
722 *
723 * Note that the output might not be valid JSON before calling
724 * sdb_store_json_finish().
725 *
726 * Returns:
727 * - 0 on success
728 * - a negative value else
729 */
730 int
731 sdb_store_json_emit(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj);
733 /*
734 * sdb_store_json_emit_full:
735 * Serialize a single object including it's attributes and all children to
736 * JSON, adding it to the string buffer associated with the formatter object.
737 * The filter, if specified, is applied to each attribute and child object.
738 * Only matching objects will be included in the output.
739 *
740 * Note that the output might not be valid JSON before calling
741 * sdb_store_json_finish().
742 *
743 * Returns:
744 * - 0 on success
745 * - a negative value else
746 */
747 int
748 sdb_store_json_emit_full(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj,
749 sdb_store_matcher_t *filter);
751 /*
752 * sdb_store_json_finish:
753 * Finish the JSON output. This function has to be called once after emiting
754 * all objects.
755 */
756 int
757 sdb_store_json_finish(sdb_store_json_formatter_t *f);
759 #ifdef __cplusplus
760 } /* extern "C" */
761 #endif
763 #endif /* ! SDB_CORE_STORE_H */
765 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */