Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

list-table-metadata

Описание

Выводит метаданные для таблиц в указанной базе данных каталога данных.

См. также: Документацию API AWS

list-table-metadata — это операция с постраничной передачей данных. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей, аргумент --query должен извлечь данные из результатов следующих выражений запросов: TableMetadataList

Синтаксис

  list-table-metadata
--catalog-name <value>
--database-name <value>
[--expression <value>]
[--work-group <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--catalog-name (строка)

Имя каталога данных, для которого должны быть возвращены метаданные таблиц.

--database-name (строка)

Имя базы данных, для которой должны быть возвращены метаданные таблиц.

--expression (строка)

Фильтр в формате регулярного выражения для сопоставления имён таблиц. Если выражение не указано, выводятся метаданные для всех таблиц.

--work-group (строка)

Имя рабочей группы, для которой извлекаются метаданные. Требуется, если используется Glue Data Catalog с включённой IAM Identity Center.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения из JSON-строки. Невозможно передавать произвольные двоичные данные, используя JSON-значение в качестве строки, так как строка будет взята буквально. Не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер, указывающий, с какой точки начать постраничную передачу. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе «Постраничная передача» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для вызова в AWS-сервисе. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе «Постраничная передача» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения постраничной передачи укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная передача» в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или с значением input, выводит пример JSON-ввода, который может использоваться в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выводит пример YAML-ввода, который может использоваться с --cli-input-yaml. Если указано значение output, оно проверяет входные данные команды и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включает отладку.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение по умолчанию по проверке сертификатов SSL.

--no-paginate (логическое значение)

Отключает автоматическую постраничную передачу. Если автоматическая постраничная передача отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-потоковый

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определённого профиля из файла параметров.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии данного инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Данные учетных данных не будут загружены, если указан этот аргумент.

--ca-bundle (строка)

Файл сертификата CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь ограничения по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь ограничения по времени. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, который будет использоваться для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод пейджера для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос входных параметров CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для вывода метаданных таблиц в заданной базе данных каталога данных

Следующий list-table-metadata пример возвращает метаинформацию максимум для двух таблиц в базе данных geography каталога данных AwsDataCatalog.

aws athena list-table-metadata \
    --catalog-name AwsDataCatalog \
    --database-name geography \
    --max-items 2

Вывод:

{
    "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://amzn-s3-demo-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://amzn-s3-demo-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=="
}

Дополнительную информацию см. в разделе «Отображение метаданных всех таблиц в базе данных: list-table-metadata» в Руководстве пользователя Amazon Athena.

Вывод

TableMetadataList -> (список)

Список метаданных таблиц.

(структура)

Содержит метаданные таблицы.

Name -> (строка)

Имя таблицы.

CreateTime -> (отметка времени)

Время создания таблицы.

LastAccessTime -> (отметка времени)

Последний раз, когда к таблице был доступ.

TableType -> (строка)

Тип таблицы. В Athena поддерживается только EXTERNAL_TABLE.

Columns -> (список)

Список столбцов в таблице.

(структура)

Содержит метаданные столбца в таблице.

Name -> (строка)

Имя столбца.

Type -> (строка)

Тип данных столбца.

Comment -> (строка)

Дополнительная информация о столбце.

PartitionKeys -> (список)

Список столбцов-разделителей в таблице.

(структура)

Содержит метаданные столбца в таблице.

Name -> (строка)

Имя столбца.

Type -> (строка)

Тип данных столбца.

Comment -> (строка)

Дополнительная информация о столбце.

Parameters -> (карта)

Набор настраиваемых пар ключ/значение для свойств таблицы.

key -> (строка)

value -> (строка)

NextToken -> (строка)

Маркер, сгенерированный сервисом Athena, который указывает, где продолжить постраничную передачу, если предыдущий запрос был обрезан. Для получения следующего набора страниц передайте значение NextToken из объекта ответа предыдущей страницы.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API