Dataset properties
label
:
label
:The value will be shown in the user interface. If the label is not set, the default label is the name
of the model.
label: Facebook Ads
hidden
:
hidden
:If the value is true, the model will not show up in the user interface.
hidden: false
category
:
category
:If you set the category field in your models, the system requires the end-user to select one of the categories before selecting the actual model. Otherwise, all the models under the same page will be listed in a single select box. It's a good practice to set the category field for accessibility if you have more than 20 models. If you have set the category in at least one of the models, the models that don't belong to a category will be grouped as Uncategorized in the user interface.
measures:
measures:
There are two ways to define a measure; under <model l seed | source>.columns.meta.measure
:
created_at:
meta:
rakam.measure:
aggregation: count_unique
column: user_id
or <model l seed | source>.meta.rakam.measures
for measures that will be written as SQL:
models:
- name: facebook_ads
meta:
rakam:
measures:
custom_measure:
aggregation: sum
sql: "{{TABLE}}.column1 * 2"
For more information, see Measure properties ]
dimensions:
dimensions:
There is two ways to define a dimension; under <model l seed | source>.columns.meta.dimension
:
created_at:
meta:
rakam.dimension:
type: timestamp
timeframes: [day, week, month, year] # only available for timestamp columns
or <model l seed | source>.meta.rakam.dimension
for measures that will be written as SQL:
models:
- name: facebook_ads
meta:
rakam:
dimensions:
custom_dimension:
sql: "{{TABLE}}.column1 * 2"
relations:
relations:
The relations in between the models can be defined under <model l seed | source>.meta.rakam.relations
as follows:
models:
- name: events
meta:
rakam:
relations:
user_attributes:
model: users
sql: ''
relationship: many_to_one
type: left_join
aggregates:
aggregates:
Aggregates should be defined under <model | seed | source>.meta.rakam.aggregates
. You can see the Aggregate properties ] or learn more about the concept on Aggregates ].
always_filters:
always_filters:
If you define always_filters
for a view
, the system pushes the relevant filter for all the queries that are executed in Rakam. It's not
It's only available in
.meta.rakam.always_filters`.
Updated over 3 years ago