paws.analytics (version 0.1.0)

glue_get_partitions: Retrieves information about the partitions in a table

Description

Retrieves information about the partitions in a table.

Usage

glue_get_partitions(CatalogId, DatabaseName, TableName, Expression,
  NextToken, Segment, MaxResults)

Arguments

CatalogId

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

DatabaseName

[required] The name of the catalog database where the partitions reside.

TableName

[required] The name of the partitions' table.

Expression

An expression filtering 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 if the values of the two operands are equal or not; if yes, then the condition becomes true.

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

(a = b) is not true.

\< \>

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

Example: (a \< \> b) is true.

\>

: Checks if 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 if 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 if 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 if 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 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:

NextToken

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

Segment

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

MaxResults

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

Request syntax

svc$get_partitions(
  CatalogId = "string",
  DatabaseName = "string",
  TableName = "string",
  Expression = "string",
  NextToken = "string",
  Segment = list(
    SegmentNumber = 123,
    TotalSegments = 123
  ),
  MaxResults = 123
)