Get Unfiltered Partitions Metadata

glue_get_unfiltered_partitions_metadata

R Documentation

Retrieves partition metadata from the Data Catalog that contains unfiltered metadata

Description

Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.

For IAM authorization, the public IAM action associated with this API is glue:GetPartitions.

Usage

glue_get_unfiltered_partitions_metadata(Region, CatalogId, DatabaseName,
  TableName, Expression, AuditContext, SupportedPermissionTypes,
  NextToken, Segment, MaxResults, QuerySessionContext)

Arguments

Region

Specified only if the base tables belong to a different Amazon Web Services Region.

CatalogId

[required] The ID of the Data Catalog where the partitions in question reside. If none is provided, 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 table that contains the partition.

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 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.

AuditContext

A structure containing Lake Formation audit context information.

SupportedPermissionTypes

[required] A list of supported permission types.

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.

QuerySessionContext

A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

Value

A list with the following syntax:

list(
  UnfilteredPartitions = list(
    list(
      Partition = list(
        Values = list(
          "string"
        ),
        DatabaseName = "string",
        TableName = "string",
        CreationTime = as.POSIXct(
          "2015-01-01"
        ),
        LastAccessTime = as.POSIXct(
          "2015-01-01"
        ),
        StorageDescriptor = list(
          Columns = list(
            list(
              Name = "string",
              Type = "string",
              Comment = "string",
              Parameters = list(
                "string"
              )
            )
          ),
          Location = "string",
          AdditionalLocations = list(
            "string"
          ),
          InputFormat = "string",
          OutputFormat = "string",
          Compressed = TRUE|FALSE,
          NumberOfBuckets = 123,
          SerdeInfo = list(
            Name = "string",
            SerializationLibrary = "string",
            Parameters = list(
              "string"
            )
          ),
          BucketColumns = list(
            "string"
          ),
          SortColumns = list(
            list(
              Column = "string",
              SortOrder = 123
            )
          ),
          Parameters = list(
            "string"
          ),
          SkewedInfo = list(
            SkewedColumnNames = list(
              "string"
            ),
            SkewedColumnValues = list(
              "string"
            ),
            SkewedColumnValueLocationMaps = list(
              "string"
            )
          ),
          StoredAsSubDirectories = TRUE|FALSE,
          SchemaReference = list(
            SchemaId = list(
              SchemaArn = "string",
              SchemaName = "string",
              RegistryName = "string"
            ),
            SchemaVersionId = "string",
            SchemaVersionNumber = 123
          )
        ),
        Parameters = list(
          "string"
        ),
        LastAnalyzedTime = as.POSIXct(
          "2015-01-01"
        ),
        CatalogId = "string"
      ),
      AuthorizedColumns = list(
        "string"
      ),
      IsRegisteredWithLakeFormation = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_unfiltered_partitions_metadata(
  Region = "string",
  CatalogId = "string",
  DatabaseName = "string",
  TableName = "string",
  Expression = "string",
  AuditContext = list(
    AdditionalAuditContext = "string",
    RequestedColumns = list(
      "string"
    ),
    AllColumnsRequested = TRUE|FALSE
  ),
  SupportedPermissionTypes = list(
    "COLUMN_PERMISSION"|"CELL_FILTER_PERMISSION"|"NESTED_PERMISSION"|"NESTED_CELL_PERMISSION"
  ),
  NextToken = "string",
  Segment = list(
    SegmentNumber = 123,
    TotalSegments = 123
  ),
  MaxResults = 123,
  QuerySessionContext = list(
    QueryId = "string",
    QueryStartTime = as.POSIXct(
      "2015-01-01"
    ),
    ClusterId = "string",
    QueryAuthorizationId = "string",
    AdditionalContext = list(
      "string"
    )
  )
)