Skip to main content
Controls the display name of the joined view in the UI when using the join. For example, you might want fields from user_facts to appear as if they belong to the buyers table. In reality, the fields come from user_facts, which is aliased in the model and generated in SQL as buyer_facts. This can be used jointly with join_to_view_as or used as a way to label a view within a topic.

Syntax

Properties

string
The display name for the joined view in the UI.

Behavior

When a view is joined in a topic, Omni picks its display label using the following hierarchy, in order of precedence:
  1. join_to_view_as_label set on the topic’s own copy of the relationship
  2. label set on the view in the topic’s views parameter
  3. join_to_view_as_label set on the model-level relationship
  4. The label set in the view’s file (model level)
If a topic re-declares a relationship without setting join_to_view_as_label, the relationship inherits the model-level label after merging. That inherited label doesn’t count as set in the topic, so a topic view label still overrides it. This precedence only changes the label shown in the field picker. It doesn’t affect the generated SQL.

Examples

Label the buyer_facts view as Buyers in the UI