Skip to content

aws.athena.list_table_metadata

Example SQL Queries

SELECT * FROM
aws.athena.list_table_metadata
WHERE
"catalog_name" = 'VALUE'
AND "database_name" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
catalog_name Required Input Column

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

VARCHAR
database_name Required Input Column

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

VARCHAR
expression Input Column

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

VARCHAR
work_group Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
columns

A list of the columns in the table.

STRUCT(
"name" VARCHAR,
"type" VARCHAR,
"comment" VARCHAR
)[]
Show child fields
columns[]
Show child fields
columns[].comment

Optional information about the column.

columns[].name

The name of the column.

columns[].type

The data type of the column.

create_time

The time that the table was created.

TIMESTAMP_S
last_access_time

The last time the table was accessed.

TIMESTAMP_S
name

The name of the table.

VARCHAR
parameters

A set of custom key/value pairs for table properties.

MAP(VARCHAR, VARCHAR)
partition_keys

A list of the partition keys in the table.

STRUCT(
"name" VARCHAR,
"type" VARCHAR,
"comment" VARCHAR
)[]
Show child fields
partition_keys[]
Show child fields
partition_keys[].comment

Optional information about the column.

partition_keys[].name

The name of the column.

partition_keys[].type

The data type of the column.

table_type

The type of table. In Athena, only EXTERNAL_TABLE is supported.

VARCHAR