| Overview |  |
Copyright © (C) 2016, Project-FiFo UG
This module defines the dqe_idx behaviour.
Required callback functions: init/0, lookup/1, lookup/2, lookup_tags/1, collections/0, metrics/1, namespaces/2, tags/3, values/4, expand/2, add/4, add/5, update/5, delete/4, delete/5.
bucket() = binary()
collection() = binary()
glob_metric() = [binary() | '*']
group_by_field() = binary()
key() = binary()
lqry() = {in, collection(), [metric()]} | {in, collection(), [metric()], where()}
metric() = binary()
namespace() = binary()
tag() = {tag, Namespace::namespace(), TagName::tag_name()}
tag_name() = binary()
tag_value() = binary()
tags() = [{Namespace::namespace(), TagName::tag_name(), Value::tag_value()}]
where() = {'=', tag(), tag_value()} | {'and', where(), where()} | {'or', where(), where()}
| add/4 | Links a collection/metric to a bucket and key. |
| add/5 | Adds one or more metrics tag pairs to a metric. |
| collections/0 | Lists all collections. |
| delete/4 | Deletes a Collection/Metric pair and all it's tags. |
| delete/5 | Deletes one or more tag pairs from a Metric. |
| expand/2 | Expands a glob into all matching metrics for a given bucket. |
| init/0 | Initializes the Dalmatiner Query Engine indexer, this will hand down to whatever indexing backend is used. |
| lookup/1 | Takes a lookup query and reutrns a list of all metric/bucket paris that metch the lookup criteria. |
| lookup/2 | Takes a lookup query and reutrns a list of all metric/bucket paris that metch the lookup criteria with the values for the provided group by fields (tags). |
| lookup_tags/1 | Find all possible namespace, tag, value pairs for a query. |
| metrics/1 | Lists all metrics in a collections. |
| namespaces/2 | Lists all namespaces for a metrics. |
| tags/3 | Lists all tags for a namespaces metrics. |
| update/5 | Updates values of a metric, this behaves equivalent to add/5 if the metric was not yet known to the index store, if however it was known it MUST add new tags and MUST update existing tags. |
| values/4 | Lists all the possible values for a tag. |
add(Collection::collection(), Metric::metric(), Bucket::bucket(), Key::key()) -> {ok, MetricIdx::term()} | ok | {error, Error::term()}
Links a collection/metric to a bucket and key. Returns whatever identifyer the colleciton/metric has if any. This MAY either return {ok, ID} or optinally ok, if ok is returned it MUST only be done if the metric was already present in the index store. Returning {ok, ID} is ALWAYS acceptable. A consumer of this API MAY assume that if ok is returned the related tags are already in the store as well.
add(Collection::collection(), Metric::metric(), Bucket::bucket(), Key::key(), Tags::[{namespace(), tag_name(), tag_value()}]) -> {ok, MetricIdx::term()} | ok | {error, Error::term()}
Adds one or more metrics tag pairs to a metric. This function MUST not change existing tags, or add tags to an existing metric IF add/4 returned ok. It MAY add additional tags if add/4 returned {ok, ID} despite the metric being present.
collections() -> {ok, [collection()]} | {error, Error::term()}
Lists all collections.
delete(Collection::collection(), Metric::metric(), Bucket::bucket(), Key::key()) -> ok | {error, Error::term()}
Deletes a Collection/Metric pair and all it's tags.
delete(Collection::collection(), Metric::metric(), Bucket::bucket(), Key::key(), Tags::[{namespace(), tag_name()}]) -> ok | {error, Error::term()}
Deletes one or more tag pairs from a Metric. This funciton can call delete/6 multiple times or use a more optimized method. This MUST only be used with metric2.0 like metadata tags that do not change metric identity!
expand(B::bucket(), Gs::[glob_metric()]) -> {ok, {bucket(), [metric()]}} | {error, Error::term()}
Expands a glob into all matching metrics for a given bucket. WARNING: This might go away!
init() -> ok | {error, Error::term()}
Initializes the Dalmatiner Query Engine indexer, this will hand down to whatever indexing backend is used.
Takes a lookup query and reutrns a list of all metric/bucket paris that metch the lookup criteria.
lookup(Query::lqry(), GroupBy::[group_by_field()]) -> {ok, [{bucket(), key(), [group_by_field()]}]} | {error, Error::term()}
Takes a lookup query and reutrns a list of all metric/bucket paris that metch the lookup criteria with the values for the provided group by fields (tags).
Find all possible namespace, tag, value pairs for a query.
metrics(Collection::collection()) -> {ok, [metric()]} | {error, Error::term()}
Lists all metrics in a collections.
namespaces(Collection::collection(), Metric::metric()) -> {ok, [namespace()]} | {error, Error::term()}
Lists all namespaces for a metrics.
tags(Collection::collection(), Metric::metric(), Namesplace::namespace()) -> {ok, [tag_name()]} | {error, Error::term()}
Lists all tags for a namespaces metrics.
update(Collection::collection(), Metric::metric(), Bucket::bucket(), Key::key(), Tags::[{namespace(), tag_name(), tag_value()}]) -> {ok, MetricIdx::term()} | ok | {error, Error::term()}
Updates values of a metric, this behaves equivalent to add/5 if the metric was not yet known to the index store, if however it was known it MUST add new tags and MUST update existing tags. This is meant to be used with metadata tags as described in the metrics2.0 specification.
values(Collection::collection(), Metric::metric(), Namesplace::namespace(), Tag::tag_name()) -> {ok, [tag_value()]} | {error, Error::term()}
Lists all the possible values for a tag
Generated by EDoc, May 24 2016, 11:36:52.