Skip to content

ViewRepresentation

Source code in docs_src/capo_glue/types/view_representation.py
class ViewRepresentation(TypedDict, closed=True):
    dialect: NotRequired["capo_glue.types.view_dialect.ViewDialect"]
    """<p>The dialect of the query engine.</p>"""
    dialect_version: NotRequired[
        "capo_glue.types.view_dialect_version_string.ViewDialectVersionString"
    ]
    """<p>The version of the dialect of the query engine. For example, 3.0.0.</p>"""
    view_original_text: NotRequired["capo_glue.types.view_text_string.ViewTextString"]
    """<p>The <code>SELECT</code> query provided by the customer during <code>CREATE VIEW DDL</code>. This SQL is not used during a query on a view (<code>ViewExpandedText</code> is used instead). <code>ViewOriginalText</code> is used for cases like <code>SHOW CREATE VIEW</code> where users want to see the original DDL command that created the view.</p>"""
    view_expanded_text: NotRequired["capo_glue.types.view_text_string.ViewTextString"]
    """<p>The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform <code>ViewOriginalText</code> to <code>ViewExpandedText</code>. For example:</p> <ul> <li> <p>Fully qualified identifiers: <code>SELECT * from table1 -> SELECT * from db1.table1</code> </p> </li> </ul>"""
    validation_connection: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the connection to be used to validate the specific representation of the view.</p>"""
    is_stale: NotRequired["capo_glue.types.nullable_boolean.NullableBoolean"]
    """<p>Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.</p>"""

dialect instance-attribute

dialect: NotRequired[ViewDialect]

The dialect of the query engine.

dialect_version instance-attribute

dialect_version: NotRequired[ViewDialectVersionString]

The version of the dialect of the query engine. For example, 3.0.0.

is_stale instance-attribute

is_stale: NotRequired[NullableBoolean]

Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.

validation_connection instance-attribute

validation_connection: NotRequired[NameString]

The name of the connection to be used to validate the specific representation of the view.

view_expanded_text instance-attribute

view_expanded_text: NotRequired[ViewTextString]

The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:

  • Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1

view_original_text instance-attribute

view_original_text: NotRequired[ViewTextString]

The SELECT query provided by the customer during CREATE VIEW DDL. This SQL is not used during a query on a view (ViewExpandedText is used instead). ViewOriginalText is used for cases like SHOW CREATE VIEW where users want to see the original DDL command that created the view.