Поиск таблиц
Описание
Ищет набор таблиц на основе свойств в метаданных таблицы, а также родительской базы данных. Можно искать по тексту или по условиям фильтрации.
Можно получить только те таблицы, к которым у вас есть доступ на основе политик безопасности, определенных в Lake Formation. Вам нужен как минимум доступ для чтения к таблице, чтобы она была возвращена. Если у вас нет доступа ко всем столбцам таблицы, эти столбцы не будут просматриваться при возвращении списка таблиц. Если у вас есть доступ к столбцам, но не к данным в столбцах, эти столбцы и связанные с ними метаданные будут включены в поиск.
См. также: Документацию API AWS
Синтаксис
search-tables
[--catalog-id <value>]
[--next-token <value>]
[--filters <value>]
[--search-text <value>]
[--sort-criteria <value>]
[--max-results <value>]
[--resource-share-type <value>]
[--include-status-details | --no-include-status-details]
[--cli-input-json | --cli-input-yaml]
[--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-id (строка)
--next-token (строка)
--filters (список)
Список пар ключ-значение и компаратора, используемых для фильтрации результатов поиска. Возвращает все сущности, соответствующие предикату.
Член Comparator структуры PropertyPredicate используется только для полей времени и может быть опущен для других типов полей. Кроме того, при сравнении строковых значений, таких как при Key=Name, используется алгоритм поиска с нечётким соответствием. Поле Key (например, значение поля Name) разделяется на токены определёнными знаками препинания, например, -, :, # и т. д. Затем каждый токен точно сравнивается с членом Value структуры PropertyPredicate. Например, если Key=Name и Value=link, возвращаются таблицы с именами customer-link и xx-link-yy, но не xxlinkyy.
(структура)
Определяет предикативное свойство.
Ключ -> (строка)
Значение -> (строка)
Компаратор -> (строка)
Сокращённый синтаксис:
Key=string,Value=string,Comparator=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string",
"Comparator": "EQUALS"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_EQUALS"|"LESS_THAN_EQUALS"
}
...
]
--search-text (строка)
Строка, используемая для поиска по тексту.
Указание значения в кавычках фильтрует по точному соответствию значению.
--sort-criteria (список)
Список критериев для сортировки результатов по имени поля в порядке возрастания или убывания.
(структура)
Указывает поле для сортировки и порядок сортировки.
ИмяПоля -> (строка)
Сортировка -> (строка)
Сокращённый синтаксис:
FieldName=string,Sort=string ...
Синтаксис JSON:
[
{
"FieldName": "string",
"Sort": "ASC"|"DESC"
}
...
]
--max-results (целое число)
--resource-share-type (строка)
Позволяет указать, что вы хотите искать таблицы, общие с вашей учётной записью. Допустимые значения: FOREIGN или ALL.
- Если установлено значение
FOREIGN, будет производиться поиск по таблицам, общих с вашей учётной записью. - Если установлено значение
ALL, будет производиться поиск по таблицам, общих с вашей учётной записью, а также по таблицам в вашей локальной учётной записи.
Возможные значения:
FOREIGNALLFEDERATED
--include-status-details | --no-include-status-details (булево)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.
--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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определённого профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--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.
Вывод
NextToken -> (строка)
TableList -> (список)
Список запрошенных Table объектов. Ответ SearchTables возвращает только таблицы, к которым у вас есть доступ.
(структура)
Представляет собой коллекцию связанных данных, организованных в столбцы и строки.
Name -> (строка)
DatabaseName -> (строка)
Description -> (строка)
Owner -> (строка)
CreateTime -> (метка времени)
UpdateTime -> (метка времени)
LastAccessTime -> (метка времени)
LastAnalyzedTime -> (метка времени)
Retention -> (целое число)
StorageDescriptor -> (структура)
Описание хранилища, содержащее информацию о физическом хранении этой таблицы.
Columns -> (список)
Список Columns в таблице.
(структура)
Столбец в Table.
Name -> (строка)
Column.Type -> (строка)
Column.Comment -> (строка)
Parameters -> (карта)
Эти пары ключ-значение определяют свойства, связанные со столбцом.
key -> (строка)
value -> (строка)
Location -> (строка)
AdditionalLocations -> (список)
Список расположений, указывающих на путь, где находится таблица Delta.
(строка)
InputFormat -> (строка)
SequenceFileInputFormat (двоичный), или TextInputFormat, или пользовательский формат.OutputFormat -> (строка)
SequenceFileOutputFormat (двоичный), или IgnoreKeyTextOutputFormat, или пользовательский формат.Compressed -> (булево)
True, если данные в таблице сжаты, или False, если нет.NumberOfBuckets -> (целое число)
SerdeInfo -> (структура)
Информация о сериализации/десериализации (SerDe).
Name -> (строка)
SerializationLibrary -> (строка)
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.Parameters -> (карта)
Эти пары ключ-значение определяют параметры инициализации для SerDe.
key -> (строка)
value -> (строка)
BucketColumns -> (список)
Список столбцов группировки редуктора, столбцов кластеризации и столбцов разбиения в таблице.
(строка)
SortColumns -> (список)
Список, определяющий порядок сортировки каждого разбиения в таблице.
(структура)
Определяет порядок сортировки отсортированного столбца.
Column -> (строка)
SortOrder -> (целое число)
== 1), или по убыванию (==0).Parameters -> (карта)
Пользовательские свойства в формате ключ-значение.
key -> (строка)
value -> (строка)
SkewedInfo -> (структура)
Информация о значениях, которые часто встречаются в столбце (смещенные значения).
SkewedColumnNames -> (список)
Список имён столбцов, содержащих смещенные значения.
(строка)
SkewedColumnValues -> (список)
Список значений, которые появляются достаточно часто, чтобы считаться смещенными.
(строка)
SkewedColumnValueLocationMaps -> (карта)
Сопоставление смещенных значений столбцам, которые их содержат.
key -> (строка)
value -> (строка)
StoredAsSubDirectories -> (булево)
True, если данные таблицы хранятся в подкаталогах, или False, если нет.SchemaReference -> (структура)
Объект, ссылающийся на схему, хранящуюся в Glue Schema Registry.
При создании таблицы вы можете передать пустой список столбцов для схемы и вместо этого использовать ссылку на схему.
SchemaId -> (структура)
Структура, содержащая поля идентификации схемы. Или это, или SchemaVersionId должны быть указаны.
SchemaArn -> (строка)
SchemaArn или SchemaName.SchemaName -> (строка)
SchemaArn или SchemaName.RegistryName -> (строка)
SchemaVersionId -> (строка)
SchemaId должны быть указаны.SchemaVersionNumber -> (длинное целое число)
PartitionKeys -> (список)
Список столбцов, по которым таблица разбита на разделы. В качестве ключей разделов поддерживаются только примитивные типы.
При создании таблицы, используемой Amazon Athena, и вы не указываете partitionKeys, вы должны по крайней мере задать значение partitionKeys как пустой список. Например:
"PartitionKeys": [](структура)
Столбец в Table.
Name -> (строка)
Column.Type -> (строка)
Column.Comment -> (строка)
Parameters -> (карта)
Эти пары ключ-значение определяют свойства, связанные со столбцом.
key -> (строка)
value -> (строка)
ViewOriginalText -> (строка)
VIRTUAL_VIEW, определенные конфигурации Athena закодированы в base64.ViewExpandedText -> (строка)
TableType -> (строка)
Тип этой таблицы. Glue создаёт таблицы типа EXTERNAL_TABLE. Другие сервисы, такие как Athena, могут создавать таблицы с дополнительными типами таблиц.
Типы таблиц, относящиеся к Glue:
Совместимый с Hive атрибут - указывает на таблицу, не управляемую Hive.
Используется Lake Formation. Glue Data Catalog понимает GOVERNED.
Parameters -> (карта)
Эти пары ключ-значение определяют свойства, связанные с таблицей.
key -> (строка)
value -> (строка)
CreatedBy -> (строка)
IsRegisteredWithLakeFormation -> (булево)
TargetTable -> (структура)
Структура TableIdentifier, описывающая целевую таблицу для связывания ресурсов.
CatalogId -> (строка)
DatabaseName -> (строка)
Name -> (строка)
Region -> (строка)
CatalogId -> (строка)
VersionId -> (строка)
FederatedTable -> (структура)
Структура FederatedTable, ссылающаяся на сущность за пределами Glue Data Catalog.
Identifier -> (строка)
DatabaseIdentifier -> (строка)
ConnectionName -> (строка)
ViewDefinition -> (структура)
Структура, содержащая всю информацию, определяющую представление, включая диалект(ы) для представления и запрос.
IsProtected -> (булево)
Definer -> (строка)
SubObjects -> (список)
Список Amazon Resource Names (ARN) таблиц.
(строка)
Representations -> (список)
Список представлений.
(структура)
Структура, содержащая диалект движка запросов и запрос, определяющий представление.
Dialect -> (строка)
DialectVersion -> (строка)
ViewOriginalText -> (строка)
SELECT запрос, предоставленный клиентом во время CREATE VIEW DDL. Этот SQL не используется во время запроса к представлению (используется ViewExpandedText). ViewOriginalText используется для случаев, таких как SHOW CREATE VIEW, где пользователи хотят увидеть исходную команду DDL, которая создала представление.ViewExpandedText -> (строка)
Расширенный SQL для представления. Этот SQL используется движками при обработке запроса к представлению. Движки могут выполнять операции во время создания представления для преобразования ViewOriginalText в ViewExpandedText. Например:
- Полные имена идентификаторов:
SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection -> (строка)
IsStale -> (булево)
IsMultiDialectView -> (булево)
Status -> (структура)
Структура, содержащая информацию о состоянии асинхронного изменения таблицы.
RequestedBy -> (строка)
UpdatedBy -> (строка)
RequestTime -> (метка времени)
UpdateTime -> (метка времени)
Action -> (строка)
CREATE или UPDATE.State -> (строка)
Error -> (структура)
Ошибка, которая будет отображаться только при состоянии «НЕ_УДАЛОСЬ». Это сообщение об ошибке на уровне родительского элемента; могут быть разные Error для каждого диалекта.
ErrorCode -> (строка)
ErrorMessage -> (строка)
Details -> (структура)
Объект StatusDetails с информацией о запрошенном изменении.
RequestedChange -> (структура)
Объект Table, представляющий запрошенные изменения.
Name -> (строка)
DatabaseName -> (строка)
Description -> (строка)
Owner -> (строка)
CreateTime -> (метка времени)
UpdateTime -> (метка времени)
LastAccessTime -> (метка времени)
LastAnalyzedTime -> (метка времени)
Retention -> (целое число)
StorageDescriptor -> (структура)
Описание хранения, содержащее информацию о физическом хранении этой таблицы.
Columns -> (список)
Список Columns в таблице.
(структура)
Столбец в Table.
Name -> (строка)
Column.Type -> (строка)
Column.Comment -> (строка)
Parameters -> (отображение)
Эти пары ключ-значение определяют свойства, связанные со столбцом.
key -> (строка)
value -> (строка)
Location -> (строка)
AdditionalLocations -> (список)
Список расположений, указывающих на путь, где расположена таблица Delta.
(строка)
InputFormat -> (строка)
SequenceFileInputFormat (бинарный), или TextInputFormat, или пользовательский формат.OutputFormat -> (строка)
SequenceFileOutputFormat (бинарный), или IgnoreKeyTextOutputFormat, или пользовательский формат.Compressed -> (булево)
True, если данные в таблице сжаты, или False, если нет.NumberOfBuckets -> (целое число)
SerdeInfo -> (структура)
Информация о сериализации/десериализации (SerDe).
Name -> (строка)
SerializationLibrary -> (строка)
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.Parameters -> (отображение)
Эти пары ключ-значение определяют параметры инициализации для SerDe.
key -> (строка)
value -> (строка)
BucketColumns -> (список)
Список столбцов для группировки редукторов, столбцов кластеризации и столбцов букетирования в таблице.
(строка)
SortColumns -> (список)
Список, определяющий порядок сортировки каждого букета в таблице.
(структура)
Определяет порядок сортировки отсортированного столбца.
Column -> (строка)
SortOrder -> (целое число)
== 1) или по убыванию (==0).Parameters -> (отображение)
Пользовательские свойства в формате ключ-значение.
key -> (строка)
value -> (строка)
SkewedInfo -> (структура)
Информация о значениях, часто встречающихся в столбце (смещенные значения).
SkewedColumnNames -> (список)
Список имён столбцов, содержащих смещенные значения.
(строка)
SkewedColumnValues -> (список)
Список значений, которые настолько часто встречаются, что считаются смещёнными.
(строка)
SkewedColumnValueLocationMaps -> (отображение)
Сопоставление смещенных значений столбцам, которые их содержат.
key -> (строка)
value -> (строка)
StoredAsSubDirectories -> (булево)
True, если данные таблицы хранятся в подкаталогах, или False, если нет.SchemaReference -> (структура)
Объект, ссылающийся на схему, хранящуюся в реестре схем Glue.
При создании таблицы вы можете передать пустой список столбцов для схемы и вместо этого использовать ссылку на схему.
SchemaId -> (структура)
Структура, содержащая поля идентификации схемы. Либо это, либо SchemaVersionId должно быть указано.
SchemaArn -> (строка)
SchemaArn, либо SchemaName.SchemaName -> (строка)
SchemaArn, либо SchemaName.RegistryName -> (строка)
SchemaVersionId -> (строка)
SchemaId должно быть указано.SchemaVersionNumber -> (длинное целое)
PartitionKeys -> (список)
Список столбцов, по которым таблица разбита на разделы. В качестве разделов поддерживаются только примитивные типы.
При создании таблицы, используемой Amazon Athena, и если вы не указываете никаких partitionKeys, вы должны как минимум установить значение partitionKeys в пустой список. Например:
"PartitionKeys": [](структура)
Столбец в Table.
Name -> (строка)
Column.Type -> (строка)
Column.Comment -> (строка)
Parameters -> (отображение)
Эти пары ключ-значение определяют свойства, связанные со столбцом.
key -> (строка)
value -> (строка)
ViewOriginalText -> (строка)
VIRTUAL_VIEW, определённые конфигурации Athena закодированы в base64.ViewExpandedText -> (строка)
TableType -> (строка)
Тип этой таблицы. Glue создаёт таблицы с типом EXTERNAL_TABLE. Другие сервисы, такие как Athena, могут создавать таблицы с дополнительными типами таблиц.
Типы таблиц, относящиеся к Glue:
Совместимый атрибут Hive - указывает на таблицу, не управляемую Hive.
Используется Lake Formation. Каталог данных Glue понимает GOVERNED.
Parameters -> (отображение)
Эти пары ключ-значение определяют свойства, связанные с таблицей.
key -> (строка)
value -> (строка)
CreatedBy -> (строка)
IsRegisteredWithLakeFormation -> (булево)
TargetTable -> (структура)
Структура TableIdentifier, описывающая целевую таблицу для связывания ресурсов.
CatalogId -> (строка)
DatabaseName -> (строка)
Name -> (строка)
Region -> (строка)
CatalogId -> (строка)
VersionId -> (строка)
FederatedTable -> (структура)
Структура FederatedTable, которая ссылается на сущность за пределами каталога данных Glue.
Identifier -> (строка)
DatabaseIdentifier -> (строка)
ConnectionName -> (строка)
ViewDefinition -> (структура)
Структура, содержащая всю информацию, определяющую представление, включая диалект(ы) для представления и запрос.
IsProtected -> (булево)
Definer -> (строка)
SubObjects -> (список)
Список Amazon Resource Names (ARN) таблиц.
(строка)
Representations -> (список)
Список представлений.
(структура)
Структура, содержащая диалект представления и запрос, определяющий представление.
Dialect -> (строка)
DialectVersion -> (строка)
ViewOriginalText -> (строка)
SELECT запрос, предоставленный клиентом во время CREATE VIEW DDL. Этот SQL не используется во время запроса к представлению (ViewExpandedText используется вместо этого). ViewOriginalText используется для случаев, таких как SHOW CREATE VIEW, где пользователи хотят увидеть исходную команду DDL, создавшую представление.ViewExpandedText -> (строка)
Расширенный SQL для представления. Этот SQL используется движками при обработке запроса к представлению. Движки могут выполнять операции при создании представления для преобразования ViewOriginalText в ViewExpandedText. Например:
- Полностью квалифицированные идентификаторы:
SELECT * from table1 -> SELECT * from db1.table1
ValidationConnection -> (строка)
IsStale -> (булево)
IsMultiDialectView -> (булево)
Status -> (структура)
Структура, содержащая информацию о состоянии асинхронного изменения таблицы.
RequestedBy -> (строка)
UpdatedBy -> (строка)
RequestTime -> (метка времени)
UpdateTime -> (метка времени)
Action -> (строка)
CREATE или UPDATE.State -> (строка)
Error -> (структура)
Ошибка, которая будет отображаться только при состоянии «НЕУДАЧНО». Это сообщение об ошибке родительского уровня, могут быть разные Error для каждого диалекта.
ErrorCode -> (строка)
ErrorMessage -> (строка)
Details -> (структура)
Объект StatusDetails с информацией о запрошенном изменении.
( … рекурсивно … )ViewValidations -> (список)
Список объектов ViewValidation, содержащих информацию для аналитического движка для проверки представления.
(структура)
Структура, содержащая информацию для аналитического движка для проверки представления перед сохранением метаданных представления. Используется в случае прямых UpdateTable или CreateTable вызовов API.
Dialect -> (строка)
DialectVersion -> (строка)
ViewValidationText -> (строка)
SELECT, определяющий представление, предоставленный клиентом.UpdateTime -> (метка времени)
State -> (строка)
Error -> (структура)
Ошибка, связанная с проверкой.
ErrorCode -> (строка)
ErrorMessage -> (строка)
ViewValidations -> (список)
Список объектов ViewValidation, содержащих информацию для аналитического движка для проверки представления.
(структура)
Структура, содержащая информацию для аналитического движка для проверки представления перед сохранением метаданных представления. Используется в случае прямых UpdateTable или CreateTable вызовов API.
Dialect -> (строка)
DialectVersion -> (строка)
ViewValidationText -> (строка)
SELECT, определяющий представление, предоставленный клиентом.UpdateTime -> (метка времени)
State -> (строка)
Error -> (структура)
Ошибка, связанная с проверкой.
ErrorCode -> (строка)
ErrorMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.