Skip to main content
Proper documentation of tables and columns provides the foundational context required for formal semantic modeling. This initial step is essential for translating technical database structures into familiar business concepts and is critical for data governance, user understanding, and effective analytics. This guide will show you how to do it.

Document Tables

For each table in your data model, you can configure the following fields:
FieldDescriptionExample
Display NameA business-friendly alias that replaces technical or system-generated table names. You can assign unique display names to the same table across different domains. If left blank, the system defaults to the technical table name for SQL generation.The table named “contact” can be displayed as “B2B Contact Details” to clarify the type of contact data it represents.
DescriptionIn this field, you should provide a clear explanation of what the table represents, focusing on a concise, plain-English description of each row’s purpose and content.This table stores detailed records of business accounts that have monthly revenue exceeding $10,000. Each row represents a single account and includes fields such as account ID, account name, industry classification, account creation date, current status (active, inactive, suspended), monthly revenue amount, and primary contact information.
Always specify the granularity of each row in your table description. This helps analysts understand the level of detail in the data and prevents misinterpretation during analysis.
To Document tables, go to Domains > Select a Domain > Data Sources > Tables.
The table is listed with the Display name and Description highlighted

Document Columns

To document columns, click on the table’s name. A new page will open, displaying a list of all the columns in the table. You can configure the following fields:
FieldDescription
Display NameUser-friendly name shown in the interface replaces technical or system-generated table names. You can assign unique display names to the same table across different domains. If left blank, the system defaults to the technical table name for SQL generation.
DescriptionClear explanation of what the column represents in business terms.
Display FormatA dropdown menu used to specify how data is presented to users. You can choose from options such as Date, Fiscal Year, Currency, Percentage, or Time to ensure the AI renders results in the most readable format.
The column is listed with the Display name and the Descrption highlighted

Next Steps