You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

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

{
  catalog_id: "CatalogIdString",
  database_name: "NameString", # required
  table_name: "NameString", # required
  expression: "PredicateString",
  next_token: "Token",
  segment: {
    segment_number: 1, # required
    total_segments: 1, # required
  },
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

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

Returns:

  • (String)


6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6091

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#database_nameString

The name of the catalog database where the partitions reside.

Returns:

  • (String)


6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6091

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#expressionString

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 invalid type is encountered, 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)


6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6091

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6091

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6091

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#segmentTypes::Segment

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

Returns:



6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6091

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#table_nameString

The name of the partitions' table.

Returns:

  • (String)


6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 6091

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end