execute-query

Описание

Выполнить запрос openCypher.

При вызове этой операции в кластере Neptune Analytics пользователь IAM или роль, выполняющая запрос, должна иметь прикреплённую политику, разрешающую одну из следующих действий IAM в этом кластере, в зависимости от запроса:

neptune-graph:ReadDataViaQuery
neptune-graph:WriteDataViaQuery
neptune-graph:DeleteDataViaQuery

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

execute-query использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команды, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  execute-query
--graph-identifier <value>
--query-string <value>
--language <value>
[--parameters <value>]
[--plan-cache <value>]
[--explain-mode <value>]
[--query-timeout-milliseconds <value>]
<outfile>
[--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]

Параметры

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

Уникальный идентификатор графа Neptune Analytics.

--query-string (строка)

Строка запроса, который нужно выполнить.

--language (строка)

Язык запроса. В настоящее время поддерживается только openCypher.

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

OPEN_CYPHER

--parameters (массив)

Параметры данных, которые запрос может использовать в формате JSON. Например: {“name”: “john”, “age”: 20}. (необязательно)

ключ -> (строка)

значение -> (документ)

Синтаксис JSON:

{"string": {...}
  ...}

--plan-cache (строка)

Кэширование плана запроса — это функция, которая сохраняет план запроса и повторно использует его при последующих выполнениях того же запроса. Это уменьшает задержку запроса и работает как для READ, так и для UPDATE запросов. Кэш плана — это кэш LRU с TTL 5 минут и емкостью 1000.

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

ENABLED
DISABLED
AUTO

--explain-mode (строка)

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

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

STATIC
DETAILS

--query-timeout-milliseconds (целое число)

Указывает время ожидания запроса в миллисекундах. (необязательно)

outfile (строка) Имя файла, куда будет сохранёно содержимое

Глобальные параметры

--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 для вывода.

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

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

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

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

Вывод

payload -> (потоковый блок)

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