Skip to content

GetStatementResultV2Response

Source code in docs_src/capo_redshift_data/types/get_statement_result_v2_response.py
class GetStatementResultV2Response(TypedDict, closed=True):
    records: "capo_redshift_data.types.formatted_sql_records.FormattedSqlRecords"
    """<p>The results of the SQL statement in CSV format.</p>"""
    column_metadata: NotRequired[
        "capo_redshift_data.types.column_metadata_list.ColumnMetadataList"
    ]
    """<p>The properties (metadata) of a column.</p>"""
    total_num_rows: "capo_redshift_data.types.long.Long"
    """<p>The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the <code>GetStatementResultV2</code> operation needed to page through the results. </p>"""
    result_format: NotRequired[
        "capo_redshift_data.types.result_format_string.ResultFormatString"
    ]
    """<p>The data format of the result of the SQL statement.</p>"""
    next_token: NotRequired["capo_redshift_data.types.string.String"]
    """<p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>"""

column_metadata instance-attribute

column_metadata: NotRequired[ColumnMetadataList]

The properties (metadata) of a column.

next_token instance-attribute

next_token: NotRequired[String]

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

records instance-attribute

The results of the SQL statement in CSV format.

result_format instance-attribute

result_format: NotRequired[ResultFormatString]

The data format of the result of the SQL statement.

total_num_rows instance-attribute

total_num_rows: Long

The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResultV2 operation needed to page through the results.