Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clarityq.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Table Catalog is ClarityQ’s centralized metadata repository for your data warehouse. It automatically discovers, catalogs, and enriches your tables and columns with business context — giving ClarityQ the foundational understanding it needs to answer questions about your data.

​
What It Contains

​
Tables

For each table in your warehouse, the Table Catalog stores:
  • Fully qualified name — The complete path to the table in your warehouse (e.g., project.dataset.table_name), along with the table name as it appears in the database
  • Description — User-provided or AI-suggested description of what the table contains
  • Table type — A user-assigned classification that helps ClarityQ understand how to use the table: Events, Fact, Dimension, Lookup, Aggregate, or Raw Data
  • Statistics — Row count, size, creation date, and last modified timestamp
  • Mandatory filters — Optional SQL WHERE conditions that are automatically applied to every query against this table (see Mandatory Filters)

​
Columns

For each column, the Table Catalog captures:
  • Data type and whether it’s nullable or repeated
  • Distinct value count and up to 50 sample values for categorical columns
  • Description — User-provided or AI-suggested
  • Nested fields — Full support for STRUCT/RECORD types with hierarchical column display

​
Statuses

Every table and column has a status that reflects whether it’s ready to be synced to the Semantic Catalog:
  • Pending — Does not yet have an approved description
  • Approved — Has an approved description and is ready to be synced to the Semantic Catalog
Tables also have a processing state during discovery:
  • In Progress — Currently being discovered or updated
  • Completed — Discovery finished successfully
  • Error — Something went wrong during discovery (with a detailed error message)

​
How It Fits into the Context Layer

The Table Catalog is the first building block of the Context Layer. It feeds into the Semantic Catalog in two ways:
  1. Entity building — Create entities (core business objects) directly from your tables and columns
  2. Event syncing — Tables classified as “Events” can sync to the Semantic Catalog via the Event Catalog