Skip to content

QueryPlanningContext

Used by
Source code in docs_src/capo_lakeformation/types/query_planning_context.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class QueryPlanningContext(TypedDict, closed=True):
    catalog_id: NotRequired[
        "capo_lakeformation.types.catalog_id_string.CatalogIdString"
    ]
    """<p>The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.</p>"""
    database_name: "capo_lakeformation.types.query_planning_context_database_name_string.QueryPlanningContextDatabaseNameString"
    """<p>The database containing the table.</p>"""
    query_as_of_time: NotRequired["capo_lakeformation.types.timestamp.Timestamp"]
    """<p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p>"""
    query_parameters: NotRequired[
        "capo_lakeformation.types.query_parameter_map.QueryParameterMap"
    ]
    """<p>A map consisting of key-value pairs.</p>"""
    transaction_id: NotRequired[
        "capo_lakeformation.types.transaction_id_string.TransactionIdString"
    ]
    """<p>The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with <code>QueryAsOfTime</code>.</p>"""

catalog_id instance-attribute 

catalog_id: NotRequired[CatalogIdString]

The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.

database_name instance-attribute 

database_name: QueryPlanningContextDatabaseNameString

The database containing the table.

query_as_of_time instance-attribute 

query_as_of_time: NotRequired[Timestamp]

The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

query_parameters instance-attribute 

query_parameters: NotRequired[QueryParameterMap]

A map consisting of key-value pairs.

transaction_id instance-attribute 

transaction_id: NotRequired[TransactionIdString]

The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.