execute-gremlin-explain-query

Описание

Выполняет запрос Gremlin Explain.

Amazon Neptune добавил функцию Gremlin под названием explain, которая предоставляет инструмент самообслуживания для понимания подхода к выполнению запроса движком Neptune. Вы вызываете ее, добавив параметр explain к HTTP-запросу, который отправляет запрос Gremlin.

Функция explain предоставляет информацию о логической структуре планов выполнения запросов. Вы можете использовать эту информацию, чтобы определить потенциальные узкие места в оценке и выполнении и настроить свой запрос, как описано в разделе Настройка запросов Gremlin. Вы также можете использовать подсказки запроса для улучшения планов выполнения запросов.

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

• neptune-db:ReadDataViaQuery
• neptune-db:WriteDataViaQuery
• neptune-db:DeleteDataViaQuery

Обратите внимание, что ключ условия IAM neptune-db:QueryLanguage:Gremlin может использоваться в документе политики для ограничения использования запросов Gremlin (см. Ключи условий, доступные в политиках доступа к данным Neptune IAM).

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

Синтаксис

  execute-gremlin-explain-query
--gremlin-query <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]

Параметры

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

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

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

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

вывод -> (blob)