Skip to content

SubStatementData

Source code in docs_src/capo_redshift_data/types/sub_statement_data.py
class SubStatementData(TypedDict, closed=True):
    id: "capo_redshift_data.types.uuid.UUID"
    """<p>The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.</p>"""
    duration: "capo_redshift_data.types.long.Long"
    """<p>The amount of time in nanoseconds that the statement ran.</p>"""
    error: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The error message from the cluster if the SQL statement encountered an error while running.</p>"""
    status: NotRequired[
        "capo_redshift_data.types.statement_status_string.StatementStatusString"
    ]
    """<p>The status of the SQL statement. An example is the that the SQL statement finished. </p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time (UTC) the statement was created. </p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time (UTC) that the statement metadata was last updated.</p>"""
    query_string: NotRequired[
        "capo_redshift_data.types.statement_string.StatementString"
    ]
    """<p>The SQL statement text.</p>"""
    result_rows: "capo_redshift_data.types.long.Long"
    """<p>Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A <code>-1</code> indicates the value is null.</p>"""
    result_size: "capo_redshift_data.types.long.Long"
    """<p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>"""
    redshift_query_id: "capo_redshift_data.types.long.Long"
    """<p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>"""
    has_result_set: NotRequired["bool"]
    """<p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.</p>"""

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time (UTC) the statement was created.

duration instance-attribute

duration: Long

The amount of time in nanoseconds that the statement ran.

error instance-attribute

error: NotRequired[String]

The error message from the cluster if the SQL statement encountered an error while running.

has_result_set instance-attribute

has_result_set: NotRequired[bool]

A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.

id instance-attribute

id: UUID

The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.

query_string instance-attribute

query_string: NotRequired[StatementString]

The SQL statement text.

redshift_query_id instance-attribute

redshift_query_id: Long

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

result_rows instance-attribute

result_rows: Long

Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

result_size instance-attribute

result_size: Long

The size in bytes of the returned results. A -1 indicates the value is null.

status instance-attribute

status: NotRequired[StatementStatusString]

The status of the SQL statement. An example is the that the SQL statement finished.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The date and time (UTC) that the statement metadata was last updated.