/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Glue::GetPartitions

NAME

Paws::Glue::GetPartitions - Arguments for method GetPartitions on Paws::Glue

DESCRIPTION

This class represents the parameters used for calling the method GetPartitions on the AWS Glue service. Use the attributes of this class as arguments to method GetPartitions.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetPartitions.

SYNOPSIS

my $glue = Paws->service('Glue');
my $GetPartitionsResponse = $glue->GetPartitions(
  DatabaseName        => 'MyNameString',
  TableName           => 'MyNameString',
  CatalogId           => 'MyCatalogIdString',    # OPTIONAL
  ExcludeColumnSchema => 1,                      # OPTIONAL
  Expression          => 'MyPredicateString',    # OPTIONAL
  MaxResults          => 1,                      # OPTIONAL
  NextToken           => 'MyToken',              # OPTIONAL
  Segment             => {
    SegmentNumber => 1,
    TotalSegments => 1,                          # min: 1, max: 10

  },    # OPTIONAL
);

# Results:
my $NextToken  = $GetPartitionsResponse->NextToken;
my $Partitions = $GetPartitionsResponse->Partitions;

# Returns a L<Paws::Glue::GetPartitionsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/glue/GetPartitions

ATTRIBUTES

CatalogId => Str

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.

REQUIRED DatabaseName => Str

The name of the catalog database where the partitions reside.

ExcludeColumnSchema => Bool

Expression => Str

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 (http://jsqlparser.sourceforge.net/home.php) 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:

MaxResults => Int

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

NextToken => Str

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

Segment => Paws::Glue::Segment

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

REQUIRED TableName => Str

The name of the partitions' table.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetPartitions in Paws::Glue

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues