Spec-Zone.ru › AWS CLI v2

[ aws . glue ]

get-databases

Описание

Возвращает все базы данных, определенные в заданном каталоге данных.

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

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

Синтаксис

  get-databases
[--catalog-id <value>]
[--resource-share-type <value>]
[--attributes-to-get <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-id (строка)

Идентификатор каталога данных, из которого необходимо получить Databases. Если не указан, по умолчанию используется идентификатор учетной записи Amazon Web Services.

--resource-share-type (строка)

Позволяет указать, что необходимо перечислить базы данных, доступные для вашей учетной записи. Допустимые значения — FEDERATED, FOREIGN или ALL.

  • Если установлено значение FEDERATED, будут перечислены федеративные базы данных (ссылающиеся на внешнее сущность), доступные вашей учетной записи.
  • Если установлено значение FOREIGN, будут перечислены базы данных, доступные вашей учетной записи.
  • Если установлено значение ALL, будут перечислены базы данных, доступные вашей учетной записи, а также базы данных в вашей локальной учетной записи.

Возможные значения:

  • FOREIGN
  • ALL
  • FEDERATED

--attributes-to-get (список)

Указывает поля базы данных, возвращаемые вызовом GetDatabases. Этот параметр не допускает пустого списка. Запрос должен включать NAME.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  NAME

--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
  • text
  • таблица
  • 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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Чтобы перечислить определения некоторых или всех баз данных в каталоге данных AWS Glue

Следующий get-databases пример возвращает информацию о базах данных в каталоге данных.

aws glue get-databases

Вывод:

{
    "DatabaseList": [
        {
            "Name": "default",
            "Description": "Default Hive database",
            "LocationUri": "file:/spark-warehouse",
            "CreateTime": 1602084052.0,
            "CreateTableDefaultPermissions": [
                {
                    "Principal": {
                        "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS"
                    },
                    "Permissions": [
                        "ALL"
                    ]
                }
            ],
            "CatalogId": "111122223333"
        },
        {
            "Name": "flights-db",
            "CreateTime": 1587072847.0,
            "CreateTableDefaultPermissions": [
                {
                    "Principal": {
                        "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS"
                    },
                    "Permissions": [
                        "ALL"
                    ]
                }
            ],
            "CatalogId": "111122223333"
        },
        {
            "Name": "legislators",
            "CreateTime": 1601415625.0,
            "CreateTableDefaultPermissions": [
                {
                    "Principal": {
                        "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS"
                    },
                    "Permissions": [
                        "ALL"
                    ]
                }
            ],
            "CatalogId": "111122223333"
        },
        {
            "Name": "tempdb",
            "CreateTime": 1601498566.0,
            "CreateTableDefaultPermissions": [
                {
                    "Principal": {
                        "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS"
                    },
                    "Permissions": [
                        "ALL"
                    ]
                }
            ],
            "CatalogId": "111122223333"
        }
    ]
}

Дополнительную информацию см. в разделе Определение базы данных в вашем каталоге данных в Руководстве разработчика AWS Glue.

Вывод

DatabaseList -> (список)

Список объектов Database из указанного каталога.

(структура)

Объект Database представляет собой логическую группировку таблиц, которые могут находиться в хранилище Hive или в RDBMS.

Name -> (строка)

Имя базы данных. Для совместимости с Hive это значение преобразуется в нижний регистр при хранении.

Description -> (строка)

Описание базы данных.

LocationUri -> (строка)

Расположение базы данных (например, путь HDFS).

Parameters -> (карта)

Эти пары «ключ-значение» определяют параметры и свойства базы данных.

key -> (строка)

value -> (строка)

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

Время создания метаданных базы данных в каталоге.

CreateTableDefaultPermissions -> (список)

Создает набор разрешений по умолчанию для таблицы для принципов. Используется Lake Formation. Не используется в обычных операциях Glue.

(структура)

Разрешения, предоставленные принципу.

Principal -> (структура)

Принцип, которому предоставлены разрешения.

DataLakePrincipalIdentifier -> (строка)

Идентификатор принципа Lake Formation.

Permissions -> (список)

Разрешения, предоставленные принципу.

(строка)

TargetDatabase -> (структура)

Структура DatabaseIdentifier, описывающая целевую базу данных для привязки ресурсов.

CatalogId -> (строка)

Идентификатор каталога данных, в котором расположена база данных.

DatabaseName -> (строка)

Имя базы данных каталога.

Region -> (строка)

Регион целевой базы данных.

CatalogId -> (строка)

Идентификатор каталога данных, в котором расположена база данных.

FederatedDatabase -> (структура)

Структура FederatedDatabase, которая ссылается на сущность за пределами каталога данных Glue.

Identifier -> (строка)

Уникальный идентификатор федеративной базы данных.

ConnectionName -> (строка)

Имя подключения к внешнему хранилищу метаданных.

NextToken -> (строка)

Токен продолжения для постраничной обработки возвращаемого списка токенов, возвращается, если текущий фрагмент списка не является последним.

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

Spec-Zone.ru

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