GET_DDL

Scalar function that returns the full CREATE OR REPLACE SEMANTIC VIEW DDL text for a stored semantic view. The output is a syntactically valid DDL statement that can be executed to recreate the view.

Syntax

SELECT GET_DDL('<object_type>', '<name>')

Parameters

Parameter	Type	Description
<object_type>	VARCHAR	The object type. Only 'SEMANTIC_VIEW' is supported (case-insensitive).
<name>	VARCHAR	The name of the semantic view. Returns an error if the view does not exist.

Output

Returns a single VARCHAR value containing the full CREATE OR REPLACE SEMANTIC VIEW DDL statement. The DDL includes all clauses (TABLES, RELATIONSHIPS, FACTS, DIMENSIONS, METRICS, MATERIALIZATIONS) with all annotations (COMMENT, WITH SYNONYMS, PRIVATE, NON ADDITIVE BY, OVER). The MATERIALIZATIONS clause is included only when the view has materializations declared; it is omitted for views without materializations.

The rendered DDL re-parses to the same definition. In particular:

• A relationship declared against a UNIQUE key (rather than the primary key) renders its REFERENCES <target>(<columns>) column list, so re-parsing keeps the join wired to the unique key instead of silently falling back to the primary key.

• A view name that needs quoting (embedded whitespace or non-ASCII characters) is quoted in the rendered CREATE OR REPLACE SEMANTIC VIEW header. (Mixed-case names are never quoted for case: names fold to lowercase — see CREATE SEMANTIC VIEW.)

Examples

Retrieve DDL for a semantic view:

SELECT GET_DDL('SEMANTIC_VIEW', 'sales');

Sample output:

CREATE OR REPLACE SEMANTIC VIEW sales AS
TABLES (
    o AS orders PRIMARY KEY (id) COMMENT = 'Order transactions'
)
DIMENSIONS (
    o.region AS o.region COMMENT = 'Sales region'
)
METRICS (
    o.revenue AS SUM(o.amount) COMMENT = 'Total revenue'
)

Retrieve DDL for a view with materializations:

SELECT GET_DDL('SEMANTIC_VIEW', 'order_metrics');

Sample output:

CREATE OR REPLACE SEMANTIC VIEW order_metrics AS
TABLES (
    o AS orders PRIMARY KEY (id)
)
DIMENSIONS (
    o.region AS o.region
)
METRICS (
    o.revenue AS SUM(o.amount),
    o.order_count AS COUNT(*)
)
MATERIALIZATIONS (
    region_agg AS (
        TABLE daily_revenue_by_region,
        DIMENSIONS (region),
        METRICS (revenue, order_count)
    )
)

Relationship against a UNIQUE key:

When a relationship references a target’s UNIQUE key rather than its primary key, the rendered REFERENCES carries the explicit column list so the round-trip preserves the join:

CREATE OR REPLACE SEMANTIC VIEW sales AS
TABLES (
    o AS orders   PRIMARY KEY (id),
    c AS customers PRIMARY KEY (id) UNIQUE (email)
)
RELATIONSHIPS (
    order_customer AS o(customer_email) REFERENCES c(email)
)
DIMENSIONS (
    c.customer AS c.name
)
METRICS (
    o.revenue AS SUM(o.amount)
)

Round-trip verification:

The DDL output can be executed to recreate the view with identical semantics:

-- Save the DDL
CREATE TABLE ddl_backup AS
SELECT GET_DDL('SEMANTIC_VIEW', 'sales') AS ddl;

-- Drop and recreate
DROP SEMANTIC VIEW sales;

-- Execute the saved DDL (copy-paste the output)

Error: unsupported object type:

SELECT GET_DDL('TABLE', 'orders');

Error: GET_DDL: unsupported object type 'TABLE'. Only 'SEMANTIC_VIEW' is supported.

Error: view does not exist:

SELECT GET_DDL('SEMANTIC_VIEW', 'nonexistent');

Error: semantic view 'nonexistent' does not exist