Incant.Dataset (Incant v0.1.1)

Copy Markdown View Source

Defines a code-first analytical dataset.

Datasets describe dimensions, metrics, default tables, and drilldowns for analytical data sources such as QuackDB, Postgres, or external APIs. They are metadata-first; data-source adapters own query execution.

Summary

Functions

columns(columns)
dimension(name, opts \\ [])
dimensions(list)
drilldown(dimension, opts \\ [])
filter(name, type \\ :auto, opts \\ [])
filters(list)
from(value)
group_by(dimensions)
heatmap(columns)
metric(name, aggregate \\ nil, opts \\ [])
metrics(list)
normalize_metric_definition(aggregate, opts)
query(dataset_or_module, opts \\ [])

Builds a normalized query request for a dataset.

run(dataset_or_module, opts \\ [])

Runs a dataset query through the configured data source.

sort(metric, direction \\ :asc)
table(opts \\ [], list)
title(value)

Functions

columns(columns)

(macro)

dimension(name, opts \\ [])

(macro)

dimensions(list)

(macro)

drilldown(dimension, opts \\ [])

(macro)

filter(name, type \\ :auto, opts \\ [])

(macro)

filters(list)

(macro)

from(value)

(macro)

group_by(dimensions)

(macro)

heatmap(columns)

(macro)

metric(name, aggregate \\ nil, opts \\ [])

(macro)

metrics(list)

(macro)

normalize_metric_definition(aggregate, opts)

query(dataset_or_module, opts \\ [])

Builds a normalized query request for a dataset.

run(dataset_or_module, opts \\ [])

Runs a dataset query through the configured data source.

sort(metric, direction \\ :asc)

(macro)

table(opts \\ [], list)

(macro)

title(value)

(macro)