get-table-metadata¶

Description¶

Returns table metadata for the specified catalog, database, and table.

Synopsis¶

  get-table-metadata
--catalog-name <value>
--database-name <value>
--table-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--catalog-name (string)

The name of the data catalog that contains the database and table metadata to return.

--database-name (string)

The name of the database that contains the table metadata to return.

--table-name (string)

The name of the table for which metadata is returned.

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To return metadata information about a table

The following get-table-metadata example returns metadata information about the counties table, including including column names and their datatypes, from the sampledb database of the AwsDataCatalog data catalog.

aws athena get-table-metadata \
    --catalog-name AwsDataCatalog \
    --database-name sampledb \
    --table-name counties

Output:

{
    "TableMetadata": {
        "Name": "counties",
        "CreateTime": 1593559968.0,
        "LastAccessTime": 0.0,
        "TableType": "EXTERNAL_TABLE",
        "Columns": [
            {
                "Name": "name",
                "Type": "string",
                "Comment": "from deserializer"
            },
            {
                "Name": "boundaryshape",
                "Type": "binary",
                "Comment": "from deserializer"
            },
            {
                "Name": "motto",
                "Type": "string",
                "Comment": "from deserializer"
            },
            {
                "Name": "population",
                "Type": "int",
                "Comment": "from deserializer"
            }
        ],
        "PartitionKeys": [],
        "Parameters": {
            "EXTERNAL": "TRUE",
            "inputformat": "com.esri.json.hadoop.EnclosedJsonInputFormat",
            "location": "s3://awsdoc-example-bucket/json",
            "outputformat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
            "serde.param.serialization.format": "1",
            "serde.serialization.lib": "com.esri.hadoop.hive.serde.JsonSerde",
            "transient_lastDdlTime": "1593559968"
        }
    }
}

For more information, see Showing Table Details: get-table-metadata in the Amazon Athena User Guide.

Output¶

TableMetadata -> (structure)

An object that contains table metadata.

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_TABLE is 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)

Table of Contents

Feedback

User Guide