Spec-Zone.ru › AWS CLI v2

[ aws . redshift-data ]

get-statement-result-v2

Описание

Извлекает временно кэшированные результаты SQL-запроса в формате CSV. Операция ExecuteStatement или BatchExecuteStatement, которая выполнила SQL-запрос, должна была указать ResultFormat как CSV. Возвращается маркер для перехода к результатам запроса.

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

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

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

Синтаксис

  get-statement-result-v2
--id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

--id (строка)

Идентификатор SQL-запроса, результаты которого необходимо извлечь. Это универсальный уникальный идентификатор (UUID), сгенерированный Amazon Redshift Data API. Суффикс указывает номер SQL-запроса. Например, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 имеет суффикс :2, указывающий на второй SQL-запрос в пакетном запросе. Этот идентификатор возвращается операциями BatchExecuteStatment, ExecuteStatment и ListStatements.

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

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

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

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя 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 (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 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 (булево)

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

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

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

Вывод

ColumnMetadata -> (список)

Свойства (метаданные) столбца.

(структура)

Свойства (метаданные) столбца.

columnDefault -> (строка)

Значение по умолчанию столбца.

isCaseSensitive -> (булево)

Значение, указывающее, является ли столбец регистрозависимым.

isCurrency -> (булево)

Значение, указывающее, содержит ли столбец значения валюты.

isSigned -> (булево)

Значение, указывающее, является ли целочисленный столбец со знаком.

label -> (строка)

Метка столбца.

length -> (целое число)

Длина столбца.

name -> (строка)

Имя столбца.

nullable -> (целое число)

Значение, указывающее, является ли столбец допускающим NULL.

precision -> (целое число)

Значение точности столбца с десятичными числами.

scale -> (целое число)

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

schemaName -> (строка)

Имя схемы, содержащей таблицу, которая включает столбец.

tableName -> (строка)

Имя таблицы, которая включает столбец.

typeName -> (строка)

Специфичный для базы данных тип данных столбца.

NextToken -> (строка)

Значение, указывающее начальную точку для следующего набора записей ответа в последующем запросе. Если значение возвращается в ответе, вы можете извлечь следующий набор записей, предоставив это возвращенное значение NextToken в следующем параметре NextToken и повторив команду. Если поле NextToken пустое, все записи ответа были извлечены для запроса.

Records -> (список)

Результаты SQL-запроса в формате CSV.

(структура со значенями)

Результаты SQL-запроса.

Примечание

Это структура со значенями. Может быть установлено только одно из следующих верхнеуровневых ключей: CSVRecords.

CSVRecords -> (строка)

Результаты SQL-запроса в формате CSV.

ResultFormat -> (строка)

Формат данных результата SQL-запроса.

TotalNumRows -> (длинное число)

Общее количество строк в наборе результатов, возвращаемых запросом. Это число можно использовать для оценки количества вызовов операции GetStatementResultV2, необходимых для постраничного вывода результатов.

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

Spec-Zone.ru

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