Configuration

Project Configuration

Properties

  • project_name (string, required)
  • default_columns (object, required)
    • LOADTS (object)
      • name (string)
      • data_type (string)
    • HASHDIFF (object)
      • name (string)
      • data_type (string)
    • RECORDSOURCE (object)
      • name (string)
      • data_type (string)
    • RECORDSOURCESTATUS (object)
      • name (string)
      • data_type (string)
    • HASHKEY (object)
      • name_format (string)
      • data_type (string)
    • LINKHASHKEY (object)
      • name_format (string)
      • data_type (string)
    • ISCURRENT (object)
      • name (string)
      • data_type (string)
    • ISDELETED (object)
      • name (string)
      • data_type (string)
    • SYSTEMTIMEFROM (object)
      • name (string)
      • data_type (string)
    • SYSTEMTIMETO (object)
      • name (string)
      • data_type (string)
  • default_table_columns (object, required)
    • HUB (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • SAT (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • CURRENTSATELLITE (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • CURRENTLINK (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • LINK (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • LINK_SAT (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • REF (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • RECORDSOURCETRACKINGSAT (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • RECORDSOURCETRACKINGLINKSAT (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • PIT (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • CURRENTPIT (array): Length must be at least 1.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • DIM (array): Length must be at least 0.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • FACT (array): Length must be at least 0.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • ODS (array): Length must be at least 0.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
    • ODS_HISTORY (array): Length must be at least 0.
      • Items (object)
        • column_type (string, required): Must be one of: "HASHDIFF", "HASHKEY", "LINKHASHKEY", "ISCURRENT", "ISDELETED", "LOADTS", "RECORDSOURCE", "RECORDSOURCESTATUS", "EXTRACTTS", "SYSTEMTIMEFROM", or "SYSTEMTIMETO".
        • mandatory (boolean, required)
        • primary_key (boolean, required)
  • hashkey_separator (string, required)
  • table_type_suffix (object, required)
    • HUB (string)
    • SAT (string)
    • CURRENTSATELLITE (string)
    • CURRENTLINKSATELLITE (string)
    • CURRENTLINK (string)
    • LINK (string)
    • LINK_SAT (string)
    • REF (string)
    • RECORDSOURCETRACKINGSAT (string)
    • RECORDSOURCETRACKINGLINKSAT (string)
    • PIT (string)
    • CURRENTPIT (string)
    • DIM (string)
    • FACT (string)
    • ODS (string)
    • ODS_HISTORY (string)
  • datamodel_location (string, required)
  • custom_sql_script_directory (string)
  • features (array)
    • Items (object)
      • name (string): Must be one of: "dewi.compiler.custom_sql_parsing", "dewi.configuration.yaml_c_loader", or "dewi.generator.generate_data_profiling".
      • enabled (boolean): Default: true.
      • params (object)

Staging table

Properties

  • type (string, required): Must be one of: "STG".
  • name (string)
  • description (string)
  • entity (string, required): Default: "$name".
  • schema (string): Default: "stg".
  • namespace (array)
    • Items (string)
  • layer (string): Default: "STAGING".
  • columns (array, required): Length must be at least 1.
    • Items (object): Cannot contain additional properties.
      • name (string, required)
      • description (string)
      • examples (array)
        • Items (string)
      • data_type (string)
      • mandatory (boolean)
      • primary_key (boolean): Default: false.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

Hub table

This configuration defines a hub table

Properties

  • type (string, required): Must be one of: "HUB".
  • layer (string): Must be one of: "DATAVAULT" or "BUSINESSVAULT". Default: "DATAVAULT".
  • name (string)
  • schema (string, required): Default: "dv".
  • namespace (array)
    • Items (string)
  • entity (string, required)
  • track_source_deletions (boolean): Default: true.
  • business_keys (array, required): Length must be at least 1.
    • Items (object): Configures the business keys for the entity. Cannot contain additional properties.
      • name (string)
      • data_type (string)
      • description (string)
      • examples (array)
        • Items (string)
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

Satellite table

Properties

  • type (string, required): Must be one of: "SAT".
  • description (string)
  • schema (string)
  • namespace (array)
    • Items (string)
  • entity (string, required)
  • name (string)
  • hub (object)
    • schema (string, required)
    • table (string)
    • entity (string)
  • additional_columns (array): Length must be at least 1.
    • Items (object): Cannot contain additional properties.
      • name (string, required)
      • data_type (string)
      • hashdiff_include (boolean): Default: true.
      • mandatory (boolean)
      • description (string)
      • examples (array)
        • Items (string)
  • current_view (object): . Cannot contain additional properties.
    • storage (string): Must be one of: "virtual" or "physical". Default: "virtual".
    • query (object): Configures a custom query location for a flow.
      • type (string): Must be one of: "sql" or "template". Default: "sql".
      • path (string)
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

Properties

  • type (string, required): Must be one of: "LINK".
  • description (string)
  • layer (string): Must be one of: "DATAVAULT" or "BUSINESSVAULT". Default: "DATAVAULT".
  • name (string)
  • schema (string): Default: "dv".
  • namespace (array)
    • Items (string)
  • entity (string, required)
  • hubs (array, required): Length must be at least 2.
    • Items (object): Cannot contain additional properties.
      • schema (string)
      • name (string)
      • entity (string)
      • driving_key (boolean): If true, the hub is the driving key.
      • column_name (string)
  • dependent_children (array)
    • Items (object): Cannot contain additional properties.
      • name (string, required)
      • data_type (string)
      • description (string)
      • examples (array)
        • Items (string)
  • track_source_deletions (boolean): Default: true.
  • current_view (object): . Cannot contain additional properties.
    • storage (string): Must be one of: "virtual" or "physical". Default: "virtual".
    • query (object): Configures a custom query location for a flow.
      • type (string): Must be one of: "sql" or "template". Default: "sql".
      • path (string)
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

Dimension table

Properties

  • type (string, required): Must be one of: "DIM".
  • description (string)
  • name (string)
  • entity (string, required): Default: "$name".
  • schema (string): Default: "dm".
  • namespace (array)
    • Items (string)
  • layer (string): Default: "DATAMART".
  • storage (string): Default: "virtual".
  • columns (array, required): Length must be at least 1.
    • Items (object): Cannot contain additional properties.
      • name (string, required)
      • description (string)
      • examples (array)
        • Items (string)
      • data_type (string)
      • mandatory (boolean)
      • primary_key (boolean): Default: false.
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

Fact table

Properties

  • type (string, required): Must be one of: "FACT".
  • description (string)
  • name (string)
  • entity (string, required): Default: "$name".
  • schema (string): Default: "dm".
  • namespace (array)
    • Items (string)
  • layer (string): Default: "DATAMART".
  • storage (string): Default: "virtual".
  • dimensions (array): Length must be at least 0.
    • Items (object): Cannot contain additional properties.
      • name (string)
      • entity (string)
      • schema (string)
      • column_name (string)
  • columns (array, required): Length must be at least 1.
    • Items (object): Cannot contain additional properties.
      • name (string, required)
      • description (string)
      • examples (array)
        • Items (string)
      • data_type (string)
      • mandatory (boolean)
      • primary_key (boolean): Default: false.
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

Configuration of a link_sat

Properties

  • type (string, required): Must be one of: "LINK_SAT".
  • description (string)
  • schema (string)
  • namespace (array)
    • Items (string)
  • entity (string, required)
  • name (string)
  • link (object)
    • schema (string, required)
    • table (string)
    • entity (string)
  • additional_columns (array): Length must be at least 1.
    • Items (object): Cannot contain additional properties.
      • name (string, required)
      • data_type (string)
      • hashdiff_include (boolean): Default: true.
      • mandatory (boolean)
      • description (string)
      • examples (array)
        • Items (string)
  • current_view (object): . Cannot contain additional properties.
    • storage (string): Must be one of: "virtual" or "physical". Default: "virtual".
    • query (object): Configures a custom query location for a flow.
      • type (string): Must be one of: "sql" or "template". Default: "sql".
      • path (string)
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

Custom table

This configuration defines a custom table

Properties

  • type (string, required): Must be one of: "CUST".
  • description (string)
  • layer (string): Default: "CUSTOM".
  • namespace (array)
    • Items (string)
  • name (string)
  • schema (string, required): Default: "dbo".
  • entity (string, required)
  • storage (string): Default: "physical".
  • columns (array): Length must be at least 1.
    • Items (object): Cannot contain additional properties.
      • name (string, required)
      • parent (object): Cannot contain additional properties.
        • schema (string, required)
        • table (string, required)
        • column (string, required)
        • extensions (object): Can contain additional properties.
      • data_type (string)
      • column_type (string)
      • mandatory (boolean)
      • primary_key (boolean)
      • description (string)
      • examples (array)
        • Items (string)
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

ODS table

This configuration defines a ODS table

Properties

  • type (string, required): Must be one of: "ODS".
  • description (string)
  • layer (string): Default: "STAGING".
  • name (string)
  • schema (string)
  • namespace (array)
    • Items (string)
  • entity (string, required)
  • track_history (boolean)
  • columns (array, required): Length must be at least 1.
    • Items (object): Cannot contain additional properties.
      • name (string, required)
      • description (string)
      • examples (array)
        • Items (string)
      • data_type (string)
      • mandatory (boolean)
      • primary_key (boolean): Default: false.
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.

PIT (Point-In-Time) table

Configuration of a Point-In-Time tracking table for hubs or links

Properties

  • type (string, required): Must be one of: "PIT".
  • description (string)
  • schema (string)
  • namespace (array)
    • Items (string)
  • entity (string, required)
  • name (string)
  • hub (object)
    • schema (string, required)
    • table (string)
    • entity (string)
  • link (object)
    • schema (string, required)
    • table (string)
    • entity (string)
  • satellites (array): Length must be at least 0.
    • Items (object)
      • schema (string, required)
      • table (string)
      • entity (string)
  • current_only (boolean): Default: false.
  • flows (object)
    • .* (object): Cannot contain additional properties.
      • name (string)
      • procedure_type (string): Default: "INSERT".
      • load_types (object)
        • full (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • incremental (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • deletes (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • partial (object)
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • delta_key (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
        • key_load (object): Configures a load type.
          • query (object): Configures a custom query location for a flow.
            • type (string): Must be one of: "sql" or "template". Default: "sql".
            • path (string)
          • procedure_type (string)
          • enabled (boolean)
          • extensions (object): Defines the extension values. Can contain additional properties.
            • Additional properties (object): Can contain additional properties.
      • query (object): Configures a custom query location for a flow.
        • type (string): Must be one of: "sql" or "template". Default: "sql".
        • path (string)
      • upstream (array)
        • Items (object)
          • schema (string)
          • table (string)
          • column_mapping (object): Can contain additional properties.
            • Additional properties (string): Key is the column name in the current table, the value is the name of column in the staging table.
  • extensions (object): Defines the extension values. Can contain additional properties.
    • Additional properties (object): Can contain additional properties.