list-table-metadata¶
Description¶
Lists the metadata for the tables in the specified data catalog database.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-table-metadata is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: TableMetadataList
Synopsis¶
list-table-metadata
--catalog-name <value>
--database-name <value>
[--expression <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--catalog-name (string)
The name of the data catalog for which table metadata should be returned.
--database-name (string)
The name of the database for which table metadata should be returned.
--expression (string)
A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To list the metadata for tables in the specified database of a data catalog
The following list-table-metadata example returns metadata information for a maximum of two tables in the geography database of the AwsDataCatalog data catalog.
aws athena list-table-metadata \
--catalog-name AwsDataCatalog \
--database-name geography \
--max-items 2
Output:
{
"TableMetadataList": [
{
"Name": "country_codes",
"CreateTime": 1586553454.0,
"TableType": "EXTERNAL_TABLE",
"Columns": [
{
"Name": "country",
"Type": "string",
"Comment": "geo id"
},
{
"Name": "alpha-2 code",
"Type": "string",
"Comment": "geo id2"
},
{
"Name": "alpha-3 code",
"Type": "string",
"Comment": "state name"
},
{
"Name": "numeric code",
"Type": "bigint",
"Comment": ""
},
{
"Name": "latitude",
"Type": "bigint",
"Comment": "location (latitude)"
},
{
"Name": "longitude",
"Type": "bigint",
"Comment": "location (longitude)"
}
],
"Parameters": {
"areColumnsQuoted": "false",
"classification": "csv",
"columnsOrdered": "true",
"delimiter": ",",
"has_encrypted_data": "false",
"inputformat": "org.apache.hadoop.mapred.TextInputFormat",
"location": "s3://awsdoc-example-bucket/csv/countrycode",
"outputformat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
"serde.param.field.delim": ",",
"serde.serialization.lib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
"skip.header.line.count": "1",
"typeOfData": "file"
}
},
{
"Name": "county_populations",
"CreateTime": 1586553446.0,
"TableType": "EXTERNAL_TABLE",
"Columns": [
{
"Name": "id",
"Type": "string",
"Comment": "geo id"
},
{
"Name": "country",
"Name": "id2",
"Type": "string",
"Comment": "geo id2"
},
{
"Name": "county",
"Type": "string",
"Comment": "county name"
},
{
"Name": "state",
"Type": "string",
"Comment": "state name"
},
{
"Name": "population estimate 2018",
"Type": "string",
"Comment": ""
}
],
"Parameters": {
"areColumnsQuoted": "false",
"classification": "csv",
"columnsOrdered": "true",
"delimiter": ",",
"has_encrypted_data": "false",
"inputformat": "org.apache.hadoop.mapred.TextInputFormat",
"location": "s3://awsdoc-example-bucket/csv/CountyPopulation",
"outputformat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
"serde.param.field.delim": ",",
"serde.serialization.lib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
"skip.header.line.count": "1",
"typeOfData": "file"
}
}
],
"NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}
For more information, see Showing Metadata for All Tables in a Database: list-table-metadata in the Amazon Athena User Guide.
Output¶
TableMetadataList -> (list)
A list of table metadata.
(structure)
Contains metadata for a table.
Name -> (string)
The name of the table.
CreateTime -> (timestamp)
The time that the table was created.
LastAccessTime -> (timestamp)
The last time the table was accessed.
TableType -> (string)
The type of table. In Athena, only
EXTERNAL_TABLEis supported.Columns -> (list)
A list of the columns in the table.
(structure)
Contains metadata for a column in a table.
Name -> (string)
The name of the column.
Type -> (string)
The data type of the column.
Comment -> (string)
Optional information about the column.
PartitionKeys -> (list)
A list of the partition keys in the table.
(structure)
Contains metadata for a column in a table.
Name -> (string)
The name of the column.
Type -> (string)
The data type of the column.
Comment -> (string)
Optional information about the column.
Parameters -> (map)
A set of custom key/value pairs for table properties.
key -> (string)
value -> (string)
NextToken -> (string)
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.