class Aws::Glue::Types::GetPartitionsRequest
@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, }
@!attribute [rw] catalog_id
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. @return [String]
@!attribute [rw] database_name
The name of the catalog database where the partitions reside. @return [String]
@!attribute [rw] table_name
The name of the partitions' table. @return [String]
@!attribute [rw] expression
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][1] 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*\: [1]: http://jsqlparser.sourceforge.net/home.php @return [String]
@!attribute [rw] next_token
A continuation token, if this is not the first call to retrieve these partitions. @return [String]
@!attribute [rw] segment
The segment of the table's partitions to scan in this request. @return [Types::Segment]
@!attribute [rw] max_results
The maximum number of partitions to return in a single response. @return [Integer]
@!attribute [rw] exclude_column_schema
@return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetPartitionsRequest AWS API Documentation
Constants
- SENSITIVE