Class: Aws::Glue::Types::GetPartitionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::GetPartitionsRequest

Defined in:

gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #audit_context ⇒ Types::AuditContext

  A structure containing the Lake Formation audit context.

• #catalog_id ⇒ String

  The ID of the Data Catalog where the partitions in question reside.

• #database_name ⇒ String

  The name of the catalog database where the partitions reside.

• #exclude_column_schema ⇒ Boolean

  When true, specifies not returning the partition column schema.

• #expression ⇒ String

  An expression that filters the partitions to be returned.

• #max_results ⇒ Integer

  The maximum number of partitions to return in a single response.

• #next_token ⇒ String

  A continuation token, if this is not the first call to retrieve these partitions.

• #query_as_of_time ⇒ Time

  The time as of when to read the partition contents.

• #segment ⇒ Types::Segment

  The segment of the table's partitions to scan in this request.

• #table_name ⇒ String

  The name of the partitions' table.

• #transaction_id ⇒ String

  The transaction ID at which to read the partition contents.

Instance Attribute Details

#audit_context ⇒ Types::AuditContext

A structure containing the Lake Formation audit context.

Returns:

• (Types::AuditContext)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#catalog_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

The name of the catalog database where the partitions reside.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_column_schema ⇒ Boolean

When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.

Returns:

• (Boolean)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#expression ⇒ String

An expression that filters the partitions to be returned.

The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.

Operators: The following are the operators that you can use in the Expression API call:

=

: Checks whether the values of the two operands are equal; if yes, then the condition becomes true.

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

(a = b) is not true.

< >

Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.

Example: (a < > b) is true.

>

Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.

Example: (a > b) is not true.

<

Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.

Example: (a < b) is true.

>=

: Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.

Example: (a >= b) is not true.

<=

: Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.

Example: (a <= b) is true.

AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

Logical operators.

Supported Partition Key Types: The following are the supported partition keys.

• string

• date

• timestamp

• int

• bigint

• long

• tinyint

• smallint

• decimal

If an type is encountered that is not valid, an exception is thrown.

The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING, to be compatible with the catalog partitions.

Sample API Call:

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of partitions to return in a single response.

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A continuation token, if this is not the first call to retrieve these partitions.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#query_as_of_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#segment ⇒ Types::Segment

The segment of the table's partitions to scan in this request.

Returns:

• (Types::Segment)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name of the partitions' table.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end

#transaction_id ⇒ String

The transaction ID at which to read the partition contents.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16198

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema,
  :transaction_id,
  :query_as_of_time,
  :audit_context)
  SENSITIVE = []
  include Aws::Structure
end