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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb

Overview

Note:

When making an API call, you may pass QueryPlanningContext data as a hash:

{
  catalog_id: "CatalogIdString",
  database_name: "QueryPlanningContextDatabaseNameString", # required
  query_as_of_time: Time.now,
  query_parameters: {
    "String" => "String",
  },
  transaction_id: "TransactionIdString",
}

A structure containing information about the query plan.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

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:

  • (String)


3202
3203
3204
3205
3206
3207
3208
3209
3210
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 3202

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

#database_nameString

The database containing the table.

Returns:

  • (String)


3202
3203
3204
3205
3206
3207
3208
3209
3210
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 3202

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

#query_as_of_timeTime

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:

  • (Time)


3202
3203
3204
3205
3206
3207
3208
3209
3210
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 3202

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

#query_parametersHash<String,String>

A map consisting of key-value pairs.

Returns:

  • (Hash<String,String>)


3202
3203
3204
3205
3206
3207
3208
3209
3210
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 3202

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

#transaction_idString

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:

  • (String)


3202
3203
3204
3205
3206
3207
3208
3209
3210
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 3202

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