Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LakeFormation.Types.QueryPlanningContext

Description

Documentation

data QueryPlanningContext Source #

A structure containing information about the query plan.

See: newQueryPlanningContext smart constructor.

Constructors

QueryPlanningContext'

Fields

catalogId :: Maybe Text
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.
queryAsOfTime :: Maybe POSIX
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 :: Maybe (HashMap Text Text)
A map consisting of key-value pairs.
transactionId :: Maybe Text
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.
databaseName :: Text
The database containing the table.

Instances

Instances details

ToJSON QueryPlanningContext Source #
Instance details Defined in Amazonka.LakeFormation.Types.QueryPlanningContext Methods toJSON :: QueryPlanningContext -> Value # toEncoding :: QueryPlanningContext -> Encoding # toJSONList :: [QueryPlanningContext] -> Value # toEncodingList :: [QueryPlanningContext] -> Encoding #
Generic QueryPlanningContext Source #
Instance details Defined in Amazonka.LakeFormation.Types.QueryPlanningContext Associated Types type Rep QueryPlanningContext :: Type -> Type # Methods from :: QueryPlanningContext -> Rep QueryPlanningContext x # to :: Rep QueryPlanningContext x -> QueryPlanningContext #
Read QueryPlanningContext Source #
Instance details Defined in Amazonka.LakeFormation.Types.QueryPlanningContext Methods readsPrec :: Int -> ReadS QueryPlanningContext # readList :: ReadS [QueryPlanningContext] # readPrec :: ReadPrec QueryPlanningContext # readListPrec :: ReadPrec [QueryPlanningContext] #
Show QueryPlanningContext Source #
Instance details Defined in Amazonka.LakeFormation.Types.QueryPlanningContext Methods showsPrec :: Int -> QueryPlanningContext -> ShowS # show :: QueryPlanningContext -> String # showList :: [QueryPlanningContext] -> ShowS #
NFData QueryPlanningContext Source #
Instance details Defined in Amazonka.LakeFormation.Types.QueryPlanningContext Methods rnf :: QueryPlanningContext -> () #
Eq QueryPlanningContext Source #
Instance details Defined in Amazonka.LakeFormation.Types.QueryPlanningContext Methods (==) :: QueryPlanningContext -> QueryPlanningContext -> Bool # (/=) :: QueryPlanningContext -> QueryPlanningContext -> Bool #
Hashable QueryPlanningContext Source #
Instance details Defined in Amazonka.LakeFormation.Types.QueryPlanningContext Methods hashWithSalt :: Int -> QueryPlanningContext -> Int # hash :: QueryPlanningContext -> Int #
type Rep QueryPlanningContext Source #
Instance details Defined in Amazonka.LakeFormation.Types.QueryPlanningContext type Rep QueryPlanningContext = D1 ('MetaData "QueryPlanningContext" "Amazonka.LakeFormation.Types.QueryPlanningContext" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "QueryPlanningContext'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "queryAsOfTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "queryParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "transactionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newQueryPlanningContext Source #

Arguments

:: Text	`$sel:databaseName:QueryPlanningContext'`
-> QueryPlanningContext

Create a value of QueryPlanningContext with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:catalogId:QueryPlanningContext', queryPlanningContext_catalogId - 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.

$sel:queryAsOfTime:QueryPlanningContext', queryPlanningContext_queryAsOfTime - 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.

$sel:queryParameters:QueryPlanningContext', queryPlanningContext_queryParameters - A map consisting of key-value pairs.

$sel:transactionId:QueryPlanningContext', queryPlanningContext_transactionId - 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.

$sel:databaseName:QueryPlanningContext', queryPlanningContext_databaseName - The database containing the table.

queryPlanningContext_catalogId :: Lens' QueryPlanningContext (Maybe Text) Source #

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.

queryPlanningContext_queryAsOfTime :: Lens' QueryPlanningContext (Maybe UTCTime) Source #

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.

queryPlanningContext_queryParameters :: Lens' QueryPlanningContext (Maybe (HashMap Text Text)) Source #

A map consisting of key-value pairs.

queryPlanningContext_transactionId :: Lens' QueryPlanningContext (Maybe Text) Source #

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.

queryPlanningContext_databaseName :: Lens' QueryPlanningContext Text Source #

The database containing the table.