Packages

dqe_idx

0.1.0
0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.0 0.2.1 0.2.0 0.1.21 0.1.20 0.1.19 0.1.18 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Dalmatiner QE indexing

HexDocs

Current section

Files

Jump to
Readme
30 Versions
0 Dependencies
Dependants
Files
Activity
dqe_idx src dqe_idx.erl
Raw

src/dqe_idx.erl 

-module(dqe_idx).



%% API exports

-export([lookup/1, add/5, delete/5]).



-type where() :: {binary(), binary()} |

                 {'and', where(), where()} |

                 {'or', where(), where()}.



-type qry() :: dql:bm() |

               {binary(), [binary()], where()}.



-callback lookup(qry()) ->

    {ok, {binary(), binary()}}.



-callback add(Bucket::binary(),

              Metric::[binary()],

              LookupMetric::binary(),

              TagKey::binary(),

              TagValue::binary()) ->

    {ok, {MetricIdx::non_neg_integer(), TagIdx::non_neg_integer()}}|

    {error, Error::term()}.



-callback delete(Bucket::binary(),

                 Metric::[binary()],

                 LookupMetric::binary(),

                 TagKey::binary(),

                 TagValue::binary()) ->

    ok |

    {error, Error::term()}.



%%====================================================================

%% API functions

%%====================================================================



-spec lookup(qry()) ->

                    {ok, [{binary(), binary()}]} |

                    {error, Error::term()}.

lookup(Query) ->

    Mod = idx_module(),

    Mod:lookup(Query).





-spec add(Bucket::binary(),

              Metric::[binary()],

              LookupMetric::binary(),

              TagKey::binary(),

              TagValue::binary()) ->

    {ok, {MetricIdx::non_neg_integer(), TagIdx::non_neg_integer()}}|

    {error, Error::term()}.



add(Bucket, Metric, LookupMetric, TagKey, TagValue) ->

    Mod = idx_module(),

    Mod:add(Bucket, Metric, LookupMetric, TagKey, TagValue).



-spec delete(Bucket::binary(),

                 Metric::[binary()],

                 LookupMetric::binary(),

                 TagKey::binary(),

                 TagValue::binary()) ->

    ok |

    {error, Error::term()}.



delete(Bucket, Metric, LookupMetric, TagKey, TagValue) ->

    Mod = idx_module(),

    Mod:delete(Bucket, Metric, LookupMetric, TagKey, TagValue).



%%====================================================================

%% Internal functions

%%====================================================================

idx_module() ->

    application:get_env(dqe, lookup_module, dqe_idx_ddb).