Document toolboxDocument toolbox

Configuring SQL schema

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)


When a semantic model is used as an SQL table, you can specify what attribute and measure names are visible to business users. Do this by setting up metadata (formerly referred to as schema) of the levels.

To view and configure the SQL schema, perform the following steps.

  1. From the Toolbox, click Semantic Models.

  2. Click the semantic model from the list of names or type it into the search box to find it.

  3. In the Design tab, click the Actions menu  (...) next to the Properties pane and choose SQL Metadata.

  4. Scroll to find a measure or dimension or use the search box to type the first few letters and find it. Click a name to select it.
    The field properties for the selected item display.

  5. Click the checkboxes to include or exclude fields from the metadata.
    Only the selected fields will be available. By default, all data is available.

  6. Use the Select to Filter Metadata Fields list to filter the list of choices.

    1. Select a dimension or measure from the list or type it into the Search box.

    2. Click the X next to the selected name to clear it from the dialog box.

  7. Click Apply to create the metadata.

The hidden entity in SQL metadata

If a level or attribute (entity) is hidden in the semantic model and included in the SQL metadata then:

  • If a semantic model is connected using SQL, then entities hidden in the semantic model are considered as visible as the checkbox is not cleared in the SQL metadata, and SQL protocol does not support the hidden attribute.

  • If the semantic model is connected using a TDS file, then the entities hidden in the semantic model will not be shown in Tableau. Tableau provides an option to reveal those entities on the visualization screen.
    To exclude any entity from a TDS file, you should clear the checkbox for it from the SQL metadata.

When exporting semantic model metadata, if the entity is hidden in the semantic model design, then all the levels and attributes are a part of the TDS file, with the hidden attribute wherever applicable. Tableau keeps these entities hidden until you unhide them from the Tableau screen. To exclude the entity from a TDS file, clear the checkbox for the entity from SQL metadata.

Copyright Kyvos, Inc. All rights reserved.