Skip to content

List Table Metadata

athena_list_table_metadata R Documentation

Lists the metadata for the tables in the specified data catalog database

Description

Lists the metadata for the tables in the specified data catalog database.

Usage

athena_list_table_metadata(CatalogName, DatabaseName, Expression,
  NextToken, MaxResults, WorkGroup)

Arguments

CatalogName

[required] The name of the data catalog for which table metadata should be returned.

DatabaseName

[required] The name of the database for which table metadata should be returned.

Expression

A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.

NextToken

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

MaxResults

Specifies the maximum number of results to return.

WorkGroup

The name of the workgroup for which the metadata is being fetched. Required if requesting an IAM Identity Center enabled Glue Data Catalog.

Value

A list with the following syntax: 

list(
  TableMetadataList = list(
    list(
      Name = "string",
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      LastAccessTime = as.POSIXct(
        "2015-01-01"
      ),
      TableType = "string",
      Columns = list(
        list(
          Name = "string",
          Type = "string",
          Comment = "string"
        )
      ),
      PartitionKeys = list(
        list(
          Name = "string",
          Type = "string",
          Comment = "string"
        )
      ),
      Parameters = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_table_metadata(
  CatalogName = "string",
  DatabaseName = "string",
  Expression = "string",
  NextToken = "string",
  MaxResults = 123,
  WorkGroup = "string"
)