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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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,
  exclude_column_schema: false,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_id ⇒ String

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) 


8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
 
# File 'lib/aws-sdk-glue/types.rb', line 8234

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

#database_name ⇒ String

The name of the catalog database where the partitions reside.

Returns:

  • (String) 


8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
 
# File 'lib/aws-sdk-glue/types.rb', line 8234

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

#exclude_column_schema ⇒ Boolean

Returns:

  • (Boolean) 


8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
 
# File 'lib/aws-sdk-glue/types.rb', line 8234

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results,
  :exclude_column_schema)
  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.

&lt; &gt;

: Checks whether the values of two operands are equal; if the values

are not equal, then the condition becomes true.

Example: (a &lt; &gt; b) is true.

&gt;

: 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 &gt; b) is not true.

&lt;

: 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 &lt; b) is true.

&gt;=

: 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 &gt;= b) is not true.

&lt;=

: 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 &lt;= 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*:

[1]: jsqlparser.sourceforge.net/home.php

Returns:

  • (String) 


8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
 
# File 'lib/aws-sdk-glue/types.rb', line 8234

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

#max_results ⇒ Integer

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

Returns:

  • (Integer) 


8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
 
# File 'lib/aws-sdk-glue/types.rb', line 8234

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

#next_token ⇒ String

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

Returns:

  • (String) 


8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
 
# File 'lib/aws-sdk-glue/types.rb', line 8234

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

#segment ⇒ Types::Segment

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

Returns:



8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
 
# File 'lib/aws-sdk-glue/types.rb', line 8234

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

#table_name ⇒ String

The name of the partitions’ table.

Returns:

  • (String) 


8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
 
# File 'lib/aws-sdk-glue/types.rb', line 8234

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