paws.analytics (version 0.1.11)

glue_get_column_statistics_for_table: Retrieves table statistics of columns

Description

Retrieves table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is get_table.

Usage

glue_get_column_statistics_for_table(CatalogId, DatabaseName, TableName,
  ColumnNames)

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.

ColumnNames

[required] A list of the column names.

Value

A list with the following syntax:

list(
  ColumnStatisticsList = list(
    list(
      ColumnName = "string",
      ColumnType = "string",
      AnalyzedTime = as.POSIXct(
        "2015-01-01"
      ),
      StatisticsData = list(
        Type = "BOOLEAN"|"DATE"|"DECIMAL"|"DOUBLE"|"LONG"|"STRING"|"BINARY",
        BooleanColumnStatisticsData = list(
          NumberOfTrues = 123,
          NumberOfFalses = 123,
          NumberOfNulls = 123
        ),
        DateColumnStatisticsData = list(
          MinimumValue = as.POSIXct(
            "2015-01-01"
          ),
          MaximumValue = as.POSIXct(
            "2015-01-01"
          ),
          NumberOfNulls = 123,
          NumberOfDistinctValues = 123
        ),
        DecimalColumnStatisticsData = list(
          MinimumValue = list(
            UnscaledValue = raw,
            Scale = 123
          ),
          MaximumValue = list(
            UnscaledValue = raw,
            Scale = 123
          ),
          NumberOfNulls = 123,
          NumberOfDistinctValues = 123
        ),
        DoubleColumnStatisticsData = list(
          MinimumValue = 123.0,
          MaximumValue = 123.0,
          NumberOfNulls = 123,
          NumberOfDistinctValues = 123
        ),
        LongColumnStatisticsData = list(
          MinimumValue = 123,
          MaximumValue = 123,
          NumberOfNulls = 123,
          NumberOfDistinctValues = 123
        ),
        StringColumnStatisticsData = list(
          MaximumLength = 123,
          AverageLength = 123.0,
          NumberOfNulls = 123,
          NumberOfDistinctValues = 123
        ),
        BinaryColumnStatisticsData = list(
          MaximumLength = 123,
          AverageLength = 123.0,
          NumberOfNulls = 123
        )
      )
    )
  ),
  Errors = list(
    list(
      ColumnName = "string",
      Error = list(
        ErrorCode = "string",
        ErrorMessage = "string"
      )
    )
  )
)

Request syntax

svc$get_column_statistics_for_table(
  CatalogId = "string",
  DatabaseName = "string",
  TableName = "string",
  ColumnNames = list(
    "string"
  )
)