从逻辑模型到物理数据的映射。

逻辑模型元数据

映射和联接(Mappings and Joins)

可以指定共享映射并在模型级别上进行联接。这些映射和联接被模型中的所有多维数据集继承。

mappigns多维数据集的字典与模型的全局映射字典合并。多维数据集的值将覆盖模型的值。

该joins可视为命名模板。它们应包含 name将由多维数据集引用的属性。

可见性：联接和映射对于单个模型而言是本地的。它们不在工作空间内共享。

"joins": [
    {
        "name": "date",
        "detail": "dim_date.date_id",
        "method": "match"
    }
]

"joins": [
    {
        "name": "date",
        "master": "fact_contract.contract_start_date_id",
    },
    {
        "name": "date",
        "master": "fact_sales.contract_sign_date_id",
    }
]

文件表示

该模型可以表示为JSON文件或带有JSON文件的目录。单文件模型规范只是具有模型属性的字典。模型目录捆绑软件应具有以下内容：

• model.json –模型的主元数据–与单文件模型相同
• dim_*.json –维元数据文件–单维字典
• cube_*.json –多维数据集元数据–单个多维数据集字典

中的维度和多维数据集列表model.json与单独文件中的维度和多维数据集合并。避免重复定义。

示例目录捆绑模型：

model.cubesmodel /
    model.json
    dim_date.json
    dim_organization.json
    dim_category.json
    cube_contracts.json
    cube_events.json

模型提供者和外部模型

如果模型是从外部来源（例如API或数据库）提供的，则应该在中指定提供者的名称provider。

提供者接收模型的元数据和模型的数据存储（如果提供者愿意）。然后，提供程序将生成所有多维数据集和维度。

由外部来源（Mixpanel）提供的模型示例：

{ 
    “ name” ： “ Events” ，
    “ provider” ： “ mixpanel” 
}

维度可见性(Dimension Visibility)

默认情况下，静态（文件）模型的所有维度在工作空间中共享。这意味着这些维度可以在不同模型的多维数据集中自由重用。

可以定义仅包含维度而没有多维数据集的主模型。然后为每个多维数据集类别，数据集市或任何其他类别定义一个模型。这些模型可以共享主模型维度。

要仅公开模型中的某些维度，请在public_dimensionsmodel属性中指定维度名称列表。工作区中的其他多维数据集只能共享列表中的维度。

该key会由一些后端，如SQL是必需的，以便能够生成详细的事实或获得一个事实。请参阅后端的文档以获取更多信息。

度量和汇总

度量是事实的数字属性。例如，它们可能表示为表格列。度量汇总到度量汇总中。该措施描述为：

• name –度量标识符（必填）
• label –显示的人类可读名称（本地化）
• info –其他自定义信息（未指定）
• aggregates–为此措施提供的汇总功能列表。此属性用于自动生成默认聚合。强烈建议显式列出聚合，并避免使用此属性。
• window_size–窗口功能（例如移动平均值）在窗口中的元素数量。如果未提供且功能需要，则假定为1（一个元素）。

例子：

“ measures” ： [ 
    { 
        “ name” ： “ amount” ，
        “ label” ： “ Sales Amount” 
    }，
    { 
        “ name” ： “ vat” ，
        “ label” ： “ VAT” 
    } 
]

度量聚合是通过对事实聚合度量而计算出的值。它的属性是：

• name–集合标识符，例如：amount_sum，price_avg， total，record_count
• label –显示的人类可读标签（本地化）
• measure–测量聚合的来源（如果存在或已知）。可能是空的。
• function-应用于度量的聚合函数的名称（如果已知）。例如：sum，min，max。
• window_size–窗口功能（例如移动平均值）在窗口中的元素数量。如果未提供且功能需要，则假定为1（一个元素）。
• info –其他自定义信息（未指定）

例子：

“ aggregates” ： [ 
    {{ 
        name“ ： ” amount_sum“ ，
        ” label“ ： ”总销售额“ ，
        ” measure“ ： ” amount“ ，
        ” function“ ： ” sum“ 
    }，
    { 
        ” name“ ： ” vat_sum“ ，
        “ label” ： “总增值税” ，
        “ measure” ： “ vat” ，
        “ function” ： “ sum” 
    }，
    { 
        “ name” ： “item_count” ，
        “ label” ： “ Item Count” ，
        “ function” ： “计数” 
    } 
]

注意最后一个合计item_count–它计算一个单元格中事实的数量。无需采取任何措施作为汇总的来源。

如果未指定聚合，则多维数据集将根据度量生成默认聚合。对于措施：

“ measures” ： [ 
    { 
        “ name” ： “ amount” ，
        “ aggregates” ： [ “ sum” ， “ min” ， “ max” ] 
    } 
]

创建了以下聚合：

“ aggregates”  =  [ 
    {{ 
        “ name” ： “ amount_sum” ，
        “ measure” ： “ amount” ，
        “ function” ： “ sum” 
    }，
    { 
        “ name” ： “ amount_min” ，
        “ measure” ： “ amount” ，
        “ function “ ： ” min“ 
    }，
    { 
        ” name“ ： ” amount_max“ ，
        ” measure“ ： ” amount“ ，
        ” function“ ： ” max“
    } 
]

如果多维数据集中已经明确指定了一个聚合列表，则两个列表将合并在一起。

在以前的多维数据集版本中，有无处不在的度量聚合称为record_count。默认情况下不再提供它，而必须在模型中明确定义。名称可以是任何选择，它不再是内置聚合。为了保持原始行为，应添加以下汇总：

“ aggregates” ： [ 
    { 
        “name” ： “ record_count” ，
        “ function” ： “ count” 
    } 
]

自定义维度链接

可以指定如何将维度链接到多维数据集。该 dimensions列表除维名称外，还可能包含一个规范，说明如何在多维数据集的上下文中使用维。该规范可能包含：

• hierarchies(等级/层级)–与多维数据集相关的层次结构列表。例如，日期维度可能被定义为具有日粒度，但是某些多维数据集可能仅处于月份级别（level）。要仅指定相关的层次结构，请使用hierarchies元数据属性：
• exclude_hierarchies–克隆原始维度时要排除的层次结构。hierarchies如果想保留大多数层次结构并仅删除其中的几个层次结构，请使用此方法代替hierarchies。
• default_hierarchy_name –多维数据集上下文中维的默认层次结构名称
• cardinality–关于多维数据集的维数基数。例如，一个多维数据集可能包含housands产品类型，另一个可能只有少数，但它们都共享相同的产品维度
  • ps:维度的基数(Cardinality)指的是该维度在数据中出现的不同值的个数;例如一个国家是一个维度,如果有200个不同的值,那么此维度的基数是200
• alias–如何在多维数据集中调用维度。例如，您可能有两个日期维度，并使用别名将它们命名为start_date和 end_date

例子：

{ 
    “ name” ： “ churn” ，

    “ dimensions” ： [ 
        { “ name” ： “ date” ， “ hierarchies” ： [ “ ym” ， “ yqm” ]}，
        “ customer” ，
        { “ name” ： “ date” ， “ alias” ： “ contract_date” } 
    ]，

    ... 
}

上面的多维数据集将具有三个维度：date，customer和 contract_date。该日期维度将只有两个层级与最低粒度月，在客户维度将被指定为-是和contract_date维度将是相同的原始日期 维度。

维度描述-属性。

维度模板

如果要创建更多具有相同或相似结构的维度，例如多个日期或不同类型的组织关系，则可以创建模板维度，然后将其用作其他维度的基础：

“ dimensions”  =  [ 
    { 
        “ name” ： “ date” ，
        “ levels” ： [...] 
    }，
    { 
        “ name” ： “ creation_date” ，
        “ template” ： “ date” 
    }，
    { 
        “ name” ： “ closing_date “ ，
        ” template“ ： ” date“ 
    } 
]

模板维度中的所有属性都将复制到新维度。可以在新维度中重新定义属性。在这种情况下，旧值将被丢弃。您可以更改级别，层次结构或默认层次结构。无法从模板添加或删除级别，如果所有新级别与原始模板维度不同，则必须再次指定所有新级别。但是，您可能只想重新定义层次结构以忽略不必要的级别。

level

维度层次结构级别(Dimension hierarchy levels)描述为：

标有*为必填项。

如果未指定任何属性，则仅假设一个属性具有与级别相同的名称。

如果未指定键，则采用第一个属性。

如果未指定label_attribute，则如果level具有多个属性，则假定第二个属性，否则使用第一个属性。

日期维度的月份级别示例：

{ 
    “ month” ，
    “ label” ： “ Mesiac” ，
    “ key” ： “ month” ，
    “ label_attribute” ： “ month_name” ，
    “ attributes” ： [ “ month” ， “ month_name” ， “ month_sname” ] 
}，

供应商维度的供应商级别示例（supplier level of supplier dimension）：

{ 
    “ name” ： “供应商” ，
    “ label” ： “Dodávateľ” ，
    “ key” ： “ ico” ，
    “ label_attribute” ： “ name” ，
    “ attributes” ： [ “ ico” ， “ name” ， “ address” ， “ date_start” ， “ date_end” ，
                    “ legal_form”  ] 
}

Hierarchy

层次结构(Hierarchies)描述为：

仅要求名称。

例子：

“ hierarchies” ： [ 
    { 
        “ name” ： “ default” ，
        “ levels” ： [ “ year” ， “ month” ] 
    }，
    { 
        “ name” ： “ ymd” ，
        “ levels” ： [ “ year” ， “ month” ， “ day” ] 
    }，
    { 
        “ name” ： “ yqmd” ，
        “ levels” ： [ “ year” ， “ quarter” ， “ month”， “ day” ] 
    } 
]

属性（Attributes）

维度级别属性可以指定为丰富的元数据，也可以仅指定为字符串。如果仅指定字符串，则所有属性元数据将具有默认值，label将等于属性名称。

可选顺序用于聚合浏览和报告。如果指定，则所有查询都将具有按此字段按指定方向排序的结果。级别层次结构用于对有序属性进行排序。每个维度级别只能指定一个有序属性，否则该行为是不可预测的。此自然（或默认）顺序可以稍后在报表中通过显式指定其他排序方向或属性来覆盖。显式顺序优先于自然顺序。

例如，您可能希望指定默认情况下所有日期都应排序：

“ attributes”  =  [ 
    { “ name”  =  “ year” ， “ order” ： “ asc” } 
]

语言环境是语言环境名称的列表。假设我们具有CPV维度（通用的采购词汇-欧盟采购主题层次结构），并且我们以斯洛伐克语，英语和匈牙利语进行报告。因此，属性将指定为：

“ attributes”  =  [ 
    { 
        “ name”  =  “ group_code” 
    }，
    { 
        “ name”  =  “ group_name” ，
        “ order” ： “ asc” ，
        “ locales”  =  [ “ sk” ， “ en” ， “ hu” ] 
    } 
]

组名称已本地化，但组代码未本地化。您还可以看到结果将始终按组名的字母顺序升序排序。

在报表中，您没有为每个本地化的属性指定区域设置，而是为整个报表或浏览会话指定了区域设置。所有语言的报表查询均保持不变。

Roles

某些维度和级别可能具有特殊但众所周知的角色。一个角色的例子是时间。将来可能会有更多公认的角色，例如地理。

关联角色的前端可能会提供不同的用户界面元素，例如用于选择日期/时间维度值的日期和时间选择器。为了使日期选择器正常工作，前端必须知道，哪个维表示日期，哪个维级别表示日历单位，例如年，月或日。

必须明确说明维度的作用。不需要前端假定名为date的维度实际上是完整日期的维度。

如果可以识别级别名称以匹配特定角色，则不必明确提及级别角色。例如，在具有角色时间级别名称为year的维度中，将自动具有角色year。

当级别名称使用不同的语言或出于任何原因与英语日历单位名称不匹配时，必须指定级别角色。

当前只有一个公认的维度角色：time。与级别名称的默认分配认可级别角色是：year， quarter，month，day，hour，minute，second，week， weeknum，dow，isoyear，isoweek，isoweekday。

具有角色级别的关键值week应具有格式 YYYY-MM-DD。