Struct GetPartitionsInput 

#[non_exhaustive]
pub struct GetPartitionsInput {
    pub catalog_id: Option<String>,
    pub database_name: Option<String>,
    pub table_name: Option<String>,
    pub expression: Option<String>,
    pub next_token: Option<String>,
    pub segment: Option<Segment>,
    pub max_results: Option<i32>,
    pub exclude_column_schema: Option<bool>,
    pub transaction_id: Option<String>,
    pub query_as_of_time: Option<DateTime>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

catalog_id: Option<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.

database_name: Option<String>

The name of the catalog database where the partitions reside.

table_name: Option<String>

The name of the partitions' table.

expression: Option<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:

next_token: Option<String>

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

segment: Option<Segment>

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

max_results: Option<i32>

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

exclude_column_schema: Option<bool>

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.

transaction_id: Option<String>

The transaction ID at which to read the partition contents.

query_as_of_time: Option<DateTime>

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.

Implementations

impl GetPartitionsInput

pub fn catalog_id(&self) -> Option<&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.

pub fn database_name(&self) -> Option<&str>

The name of the catalog database where the partitions reside.

pub fn table_name(&self) -> Option<&str>

The name of the partitions' table.

pub fn expression(&self) -> Option<&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 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:

pub fn next_token(&self) -> Option<&str>

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

pub fn segment(&self) -> Option<&Segment>

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

pub fn max_results(&self) -> Option<i32>

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

pub fn exclude_column_schema(&self) -> Option<bool>

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.

pub fn transaction_id(&self) -> Option<&str>

The transaction ID at which to read the partition contents.

pub fn query_as_of_time(&self) -> Option<&DateTime>

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.

impl GetPartitionsInput

pub fn builder() -> GetPartitionsInputBuilder

Creates a new builder-style object to manufacture GetPartitionsInput.

Trait Implementations

impl Clone for GetPartitionsInput

fn clone(&self) -> GetPartitionsInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetPartitionsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetPartitionsInput

fn eq(&self, other: &GetPartitionsInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetPartitionsInput