Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface QueryPlanningContext

A structure containing information about the query plan.


  • QueryPlanningContext


CatalogId?: string

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.

DatabaseName: undefined | string

The database containing the table.

QueryAsOfTime?: Date

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.

QueryParameters?: Record<string, string>

A map consisting of key-value pairs.

TransactionId?: string

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.