Class: Aws::Glue::Types::GetPartitionsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Glue::Types::GetPartitionsRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-glue/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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
#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.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) SENSITIVE = [] include Aws::Structure end |
#database_name ⇒ String
The name of the catalog database where the partitions reside.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) 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.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) 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*:
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of partitions to return in a single response.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
A continuation token, if this is not the first call to retrieve these partitions.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) 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`.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) SENSITIVE = [] include Aws::Structure end |
#segment ⇒ Types::Segment
The segment of the table’s partitions to scan in this request.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) SENSITIVE = [] include Aws::Structure end |
#table_name ⇒ String
The name of the partitions’ table.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) SENSITIVE = [] include Aws::Structure end |
#transaction_id ⇒ String
The transaction ID at which to read the partition contents.
13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 |
# File 'lib/aws-sdk-glue/types.rb', line 13190 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) SENSITIVE = [] include Aws::Structure end |