execute-statement

Описание

Выполняет SQL-запрос, который может быть языком манипулирования данными (DML) или языком определения данных (DDL). Этот запрос должен быть единственным SQL-запросом. В зависимости от метода авторизации используйте одну из следующих комбинаций параметров запроса:

• Secrets Manager — при подключении к кластеру предоставьте secret-arn секрета, хранящегося в Secrets Manager, который содержит username и password. Указанный секрет содержит учетные данные для подключения к database, который вы указали. При подключении к кластеру вы также предоставляете имя базы данных. Если вы предоставляете идентификатор кластера (dbClusterIdentifier), он должен совпадать с идентификатором кластера, хранящимся в секрете. При подключении к серверной группе без выделенных ресурсов вы также указываете имя базы данных.
• Временные учетные данные — при подключении к хранилищу данных выберите один из следующих вариантов:
  • При подключении к серверной группе без выделенных ресурсов укажите имя рабочей группы и имя базы данных. Имя пользователя базы данных определяется по идентификатору IAM. Например, arn:iam::123456789012:user:foo имеет имя пользователя базы данных IAM:foo. Также требуется разрешение на вызов операции redshift-serverless:GetCredentials.
  • При подключении к кластеру как идентификатору IAM укажите идентификатор кластера и имя базы данных. Имя пользователя базы данных определяется по идентификатору IAM. Например, arn:iam::123456789012:user:foo имеет имя пользователя базы данных IAM:foo. Также требуется разрешение на вызов операции redshift:GetClusterCredentialsWithIAM.
  • При подключении к кластеру как пользователю базы данных укажите идентификатор кластера, имя базы данных и имя пользователя базы данных. Также требуется разрешение на вызов операции redshift:GetClusterCredentials.

Дополнительную информацию об API Amazon Redshift Data и примерах использования командной строки см. в руководстве Amazon Redshift Management Guide в разделе Использование API Amazon Redshift Data.

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

Синтаксис

  execute-statement
[--client-token <value>]
[--cluster-identifier <value>]
[--database <value>]
[--db-user <value>]
[--parameters <value>]
[--result-format <value>]
[--secret-arn <value>]
[--session-id <value>]
[--session-keep-alive-seconds <value>]
--sql <value>
[--statement-name <value>]
[--with-event | --no-with-event]
[--workgroup-name <value>]
[--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]

Параметры

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

--cluster-identifier (строка)

--database (строка)

--db-user (строка)

--parameters (список)

Сокращенный синтаксис:

name=string,value=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "value": "string"
  }
  ...
]

--result-format (строка)

--secret-arn (строка)

--session-id (строка)

--session-keep-alive-seconds (целое число)

--sql (строка)

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

--with-event | --no-with-event (булево)

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

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

Вывод

ClusterIdentifier -> (строка)

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

Database -> (строка)

DbGroups -> (список)

DbUser -> (строка)

Id -> (строка)

SecretArn -> (строка)

SessionId -> (строка)

WorkgroupName -> (строка)