Spec-Zone.ru › AWS CLI v2

[ aws . redshift-data ]

get-statement-result

Описание

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

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

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

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

Синтаксис

  get-statement-result
--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 User Guide.

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

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

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

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

Вывод

ColumnMetadata -> (список)

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

(структура)

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

columnDefault -> (строка)

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

isCaseSensitive -> (булево)

Указывает, является ли столбец регистрозависимым.

isCurrency -> (булево)

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

isSigned -> (булево)

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

label -> (строка)

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

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

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

name -> (строка)

Имя столбца.

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

Указывает, является ли столбец допустимым для NULL.

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

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

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

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

schemaName -> (строка)

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

tableName -> (строка)

Имя таблицы, которая содержит столбец.

typeName -> (строка)

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

NextToken -> (строка)

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

Records -> (список)

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

(список)

(структура с тегами)

Значение данных в столбце.

Примечание

Это структура с тегами. Только один из следующих ключей верхнего уровня может быть установлен: blobValue, booleanValue, doubleValue, isNull, longValue, stringValue.

blobValue -> (двоичные данные)

Значение типа данных BLOB.

booleanValue -> (булево)

Значение типа данных Boolean.

doubleValue -> (двойное)

Значение типа данных double.

isNull -> (булево)

Указывает, являются ли данные NULL.

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

Значение типа данных long.

stringValue -> (строка)

Значение типа данных string.

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

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

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

Spec-Zone.ru

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