Class: Aws::LakeFormation::Types::QueryPlanningContext

Inherits:

Struct

• Object
• Struct
• Aws::LakeFormation::Types::QueryPlanningContext

Includes:

Structure

Defined in:

lib/aws-sdk-lakeformation/types.rb

Overview

A structure containing information about the query plan.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog_id ⇒ String

  The ID of the Data Catalog where the partition in question resides.

• #database_name ⇒ String

  The database containing the table.

• #query_as_of_time ⇒ Time

  The time as of when to read the table contents.

• #query_parameters ⇒ Hash<String,String>

  A map consisting of key-value pairs.

• #transaction_id ⇒ String

  The transaction ID at which to read the table contents.

Instance Attribute Details

#catalog_id ⇒ 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.

Returns:

# File 'lib/aws-sdk-lakeformation/types.rb', line 3085

class QueryPlanningContext < Struct.new(
  :catalog_id,
  :database_name,
  :query_as_of_time,
  :query_parameters,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

The database containing the table.

Returns:

# File 'lib/aws-sdk-lakeformation/types.rb', line 3085

class QueryPlanningContext < Struct.new(
  :catalog_id,
  :database_name,
  :query_as_of_time,
  :query_parameters,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#query_as_of_time ⇒ Time

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.

Returns:

# File 'lib/aws-sdk-lakeformation/types.rb', line 3085

class QueryPlanningContext < Struct.new(
  :catalog_id,
  :database_name,
  :query_as_of_time,
  :query_parameters,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#query_parameters ⇒ Hash<String,String>

A map consisting of key-value pairs.

Returns:

# File 'lib/aws-sdk-lakeformation/types.rb', line 3085

class QueryPlanningContext < Struct.new(
  :catalog_id,
  :database_name,
  :query_as_of_time,
  :query_parameters,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#transaction_id ⇒ 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.

Returns:

# File 'lib/aws-sdk-lakeformation/types.rb', line 3085

class QueryPlanningContext < Struct.new(
  :catalog_id,
  :database_name,
  :query_as_of_time,
  :query_parameters,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end