Add first-class ThoughtSpot TML Model object support

sidemantic/loaders.py

@@ -184,6 +184,13 @@ def load_from_directory(layer: "SemanticLayer", directory: str | Path, *, strict
                 adapter = ThoughtSpotAdapter()
             elif _contains_yaml_key(yaml_data, "worksheet") and _contains_yaml_key(yaml_data, "worksheet_columns"):
                 adapter = ThoughtSpotAdapter()
+            elif (
+                _contains_yaml_key(yaml_data, "model")
+                and _contains_yaml_key(yaml_data, "model_tables")
+                and _contains_yaml_key(yaml_data, "columns")
+            ):
+                # ThoughtSpot TML Model object (export_schema_version v2)
+                adapter = ThoughtSpotAdapter()
             elif _yaml_has_top_level_key(yaml_data, "tables") and _contains_yaml_key(yaml_data, "base_table"):
                 # Snowflake Cortex Semantic Model format
                 adapter = SnowflakeAdapter()

tests/fixtures/thoughtspot/model_alias.model.tml

@@ -0,0 +1,32 @@
+guid: "model-alias"
+export_schema_version: "2"
+model:
+  name: orders_model
+  description: Model with id-based tables and an aliased role-playing join
+  model_tables:
+    - name: orders
+      id: orders_tbl
+      fqn: ANALYTICS.PUBLIC.orders
+      joins:
+        - with: ship_country
+          on: "[orders::ship_country_id] = [ship_country::id]"
+          type: LEFT_OUTER
+          cardinality: MANY_TO_ONE
+    - name: countries
+      id: countries_tbl
+      fqn: ANALYTICS.PUBLIC.countries
+      alias: ship_country
+  columns:
+    - name: order_id
+      column_id: orders::id
+      properties:
+        column_type: ATTRIBUTE
+    - name: ship_country_name
+      column_id: ship_country::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: amount
+      column_id: orders::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_base_alias.model.tml

@@ -0,0 +1,30 @@
+guid: "model-base-alias"
+export_schema_version: "2"
+model:
+  name: orders_model
+  description: Joined model whose base/source table carries an alias (orders AS o)
+  model_tables:
+    - name: orders
+      alias: o
+      fqn: ANALYTICS.PUBLIC.orders
+      joins:
+        - with: customers
+          on: "[o::customer_id] = [customers::id]"
+          type: LEFT_OUTER
+          cardinality: MANY_TO_ONE
+    - name: customers
+      fqn: ANALYTICS.PUBLIC.customers
+  columns:
+    - name: order_id
+      column_id: o::id
+      properties:
+        column_type: ATTRIBUTE
+    - name: customer_name
+      column_id: customers::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: amount
+      column_id: o::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_composite_key.model.tml

@@ -0,0 +1,29 @@
+guid: "model-composite-key"
+export_schema_version: "2"
+model:
+  name: sales_model
+  description: Joined model with a composite-key join predicate
+  model_tables:
+    - name: sales
+      fqn: ANALYTICS.PUBLIC.sales
+      joins:
+        - with: regions
+          on: "[sales::region_id] = [regions::id] AND [sales::country_code] = [regions::country_code]"
+          type: INNER
+          cardinality: MANY_TO_ONE
+    - name: regions
+      fqn: ANALYTICS.PUBLIC.regions
+  columns:
+    - name: order_id
+      column_id: sales::id
+      properties:
+        column_type: ATTRIBUTE
+    - name: region_name
+      column_id: regions::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: amount
+      column_id: sales::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_joined_id_key.model.tml

@@ -0,0 +1,29 @@
+guid: "model-joined-id-key"
+export_schema_version: "2"
+model:
+  name: orders_model
+  description: A joined-table id dimension precedes the base table key
+  model_tables:
+    - name: orders
+      fqn: ANALYTICS.PUBLIC.orders
+      joins:
+        - with: customers
+          on: "[orders::customer_id] = [customers::id]"
+          type: LEFT_OUTER
+          cardinality: MANY_TO_ONE
+    - name: customers
+      fqn: ANALYTICS.PUBLIC.customers
+  columns:
+    - name: id
+      column_id: customers::id
+      properties:
+        column_type: ATTRIBUTE
+    - name: order_key
+      column_id: orders::order_key
+      properties:
+        column_type: ATTRIBUTE
+    - name: amount
+      column_id: orders::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_name_collision.model.tml

@@ -0,0 +1,39 @@
+guid: "model-name-collision"
+export_schema_version: "2"
+model:
+  name: sales_model
+  description: A TML field name collides with a different physical column name
+  model_tables:
+    - name: sales
+      fqn: ANALYTICS.PUBLIC.sales
+      joins:
+        - with: customers
+          on: "[sales::customer_id] = [customers::id]"
+          type: LEFT_OUTER
+          cardinality: MANY_TO_ONE
+    - name: customers
+      fqn: ANALYTICS.PUBLIC.customers
+  formulas:
+    - name: total
+      expr: "[amount] + [gross_revenue]"
+      id: total_f
+  columns:
+    - name: customer_name
+      column_id: customers::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: gross_revenue
+      column_id: sales::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM
+    - name: amount
+      column_id: sales::cost
+      properties:
+        column_type: MEASURE
+        aggregation: SUM
+    - name: total
+      formula_id: total_f
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_nested_formula.model.tml

@@ -0,0 +1,47 @@
+guid: "model-nested-formula"
+export_schema_version: "2"
+model:
+  name: sales_model
+  description: Joined model whose formula references another formula
+  model_tables:
+    - name: sales
+      fqn: ANALYTICS.PUBLIC.sales
+      joins:
+        - with: customers
+          on: "[sales::customer_id] = [customers::id]"
+          type: LEFT_OUTER
+          cardinality: MANY_TO_ONE
+    - name: customers
+      fqn: ANALYTICS.PUBLIC.customers
+  formulas:
+    - name: net_revenue
+      expr: "[gross_revenue] - [discount]"
+      id: net_rev
+    - name: margin
+      expr: "[net_revenue] / [gross_revenue]"
+      id: margin_f
+  columns:
+    - name: customer_name
+      column_id: customers::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: gross_revenue
+      column_id: sales::gross_revenue
+      properties:
+        column_type: MEASURE
+        aggregation: SUM
+    - name: discount
+      column_id: sales::discount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM
+    - name: net_revenue
+      formula_id: net_rev
+      properties:
+        column_type: MEASURE
+        aggregation: SUM
+    - name: margin
+      formula_id: margin_f
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_non_id_key.model.tml

@@ -0,0 +1,29 @@
+guid: "model-non-id-key"
+export_schema_version: "2"
+model:
+  name: orders_model
+  description: Joined model whose base table key is not literally `id`
+  model_tables:
+    - name: orders
+      fqn: ANALYTICS.PUBLIC.orders
+      joins:
+        - with: customers
+          on: "[orders::customer_id] = [customers::id]"
+          type: LEFT_OUTER
+          cardinality: MANY_TO_ONE
+    - name: customers
+      fqn: ANALYTICS.PUBLIC.customers
+  columns:
+    - name: order_key
+      column_id: orders::order_key
+      properties:
+        column_type: ATTRIBUTE
+    - name: customer_name
+      column_id: customers::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: amount
+      column_id: orders::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_one_to_many.model.tml

@@ -0,0 +1,29 @@
+guid: "model-one-to-many"
+export_schema_version: "2"
+model:
+  name: customers_model
+  description: One-to-many parent-to-child join (FK lives on the related model)
+  model_tables:
+    - name: customers
+      fqn: ANALYTICS.PUBLIC.customers
+      joins:
+        - with: orders
+          on: "[customers::id] = [orders::customer_id]"
+          type: LEFT_OUTER
+          cardinality: ONE_TO_MANY
+    - name: orders
+      fqn: ANALYTICS.PUBLIC.orders
+  columns:
+    - name: customer_id
+      column_id: customers::id
+      properties:
+        column_type: ATTRIBUTE
+    - name: customer_name
+      column_id: customers::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: order_amount
+      column_id: orders::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_one_to_one.model.tml

@@ -0,0 +1,29 @@
+guid: "model-one-to-one"
+export_schema_version: "2"
+model:
+  name: sales_model
+  description: One-to-one join where the source side owns the foreign key
+  model_tables:
+    - name: sales
+      fqn: ANALYTICS.PUBLIC.sales
+      joins:
+        - with: regions
+          on: "[sales::region_id] = [regions::id]"
+          type: INNER
+          cardinality: ONE_TO_ONE
+    - name: regions
+      fqn: ANALYTICS.PUBLIC.regions
+  columns:
+    - name: order_id
+      column_id: sales::id
+      properties:
+        column_type: ATTRIBUTE
+    - name: region_name
+      column_id: regions::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: amount
+      column_id: sales::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_relationship_fk.model.tml

@@ -0,0 +1,29 @@
+guid: "model-relationship-fk"
+export_schema_version: "2"
+model:
+  name: sales_model
+  description: Joined model whose relationship foreign key is not also a column
+  model_tables:
+    - name: sales
+      fqn: ANALYTICS.PUBLIC.sales
+      joins:
+        - with: regions
+          on: "[sales::region_id] = [regions::id]"
+          type: LEFT_OUTER
+          cardinality: MANY_TO_ONE
+    - name: regions
+      fqn: ANALYTICS.PUBLIC.regions
+  columns:
+    - name: order_id
+      column_id: sales::id
+      properties:
+        column_type: ATTRIBUTE
+    - name: region_name
+      column_id: regions::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: amount
+      column_id: sales::amount
+      properties:
+        column_type: MEASURE
+        aggregation: SUM

tests/fixtures/thoughtspot/model_renamed_formula.model.tml

@@ -0,0 +1,39 @@
+guid: "model-renamed-formula"
+export_schema_version: "2"
+model:
+  name: sales_model
+  description: Formula references a TML column whose backing DB column name differs
+  model_tables:
+    - name: sales
+      fqn: ANALYTICS.PUBLIC.sales
+      joins:
+        - with: customers
+          on: "[sales::customer_id] = [customers::id]"
+          type: LEFT_OUTER
+          cardinality: MANY_TO_ONE
+    - name: customers
+      fqn: ANALYTICS.PUBLIC.customers
+  formulas:
+    - name: net_revenue
+      expr: "[gross_revenue] - [discount]"
+      id: net_rev
+  columns:
+    - name: customer_name
+      column_id: customers::name
+      properties:
+        column_type: ATTRIBUTE
+    - name: gross_revenue
+      column_id: sales::gross_amt
+      properties:
+        column_type: MEASURE
+        aggregation: SUM
+    - name: discount
+      column_id: sales::disc_amt
+      properties:
+        column_type: MEASURE
+        aggregation: SUM
+    - name: net_revenue
+      formula_id: net_rev
+      properties:
+        column_type: MEASURE
+        aggregation: SUM