select

Описание

select ищет в таблице или индексе.

Под капотом эта операция будет использовать query, если задано --key-condition, или scan в противном случае.

Для этой операции поддерживается только yaml вывод.

Синтаксис

  select
<table-name>
[--index-name <value>]
[--projection <value> [<value>...]]
[--filter <value> [<value>...]]
[--key-condition <value> [<value>...]]
[--attributes <value>]
[--consistent-read | --no-consistent-read]
[--return-consumed-capacity | --no-return-consumed-capacity]
[--starting-token <value>]
[--max-items <value>]
[--page-size <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]

Параметры

table_name (строка)

Имя вашей таблицы DynamoDB.

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

Имя вторичного индекса для сканирования. Этот индекс может быть любым локальным или глобальным вторичным индексом.

--projection (строка)

Строка, определяющая один или несколько атрибутов для извлечения из указанной таблицы или индекса. Эти атрибуты могут включать скаляры, наборы или элементы JSON-документа. Атрибуты в выражении должны быть разделены запятыми. Если какие-либо из запрошенных атрибутов не найдены, они не появятся в результате.

Для получения дополнительной информации см. Доступ к атрибутам элементов в Руководстве разработчика Amazon DynamoDB .

Для синтаксиса, специфичного для командной строки, см. aws help ddb-expressions

--filter (строка)

Строка, содержащая условия, которые DynamoDB применяет после операции, но перед возвратом данных. Элементы, не удовлетворяющие критериям --filter, не возвращаются.

Примечание

Фильтр --filter применяется после того, как элементы уже были прочитаны; процесс фильтрации не потребляет дополнительные единицы пропускной способности чтения.

Для получения дополнительной информации см. Выражения фильтрации в Руководстве разработчика Amazon DynamoDB .

Для синтаксиса, специфичного для командной строки, см. aws help ddb-expressions

--key-condition (строка)

Условие, определяющее значение(я) ключа для извлечения элементов. Должен выполнять проверку на равенство для одного значения первичного ключа.

Условие может дополнительно выполнить несколько проверок сравнения для одного значения сортировочного ключа. Это позволяет select извлечь один элемент с заданным значением первичного ключа и значения сортировочного ключа или несколько элементов, имеющих одинаковое значение первичного ключа, но разные значения сортировочного ключа.

Проверка первичного ключа на равенство должна быть указана в следующем формате:

partitionKeyName = :partitionkeyval

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

Допустимые сравнения для условия сортировочного ключа:

sortKeyName = :sortkeyval - true, если значение сортировочного ключа равно :sortkeyval .
sortKeyName < :sortkeyval - true, если значение сортировочного ключа меньше :sortkeyval .
sortKeyName <= :sortkeyval - true, если значение сортировочного ключа меньше или равно :sortkeyval .
sortKeyName > :sortkeyval - true, если значение сортировочного ключа больше :sortkeyval .
sortKeyName >= :sortkeyval - true, если значение сортировочного ключа больше или равно :sortkeyval .
sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true, если значение сортировочного ключа больше или равно :sortkeyval1 и меньше или равно :sortkeyval2 .
begins_with(sortKeyName, :sortkeyval) - true, если значение сортировочного ключа начинается с определенного операнда. (Вы не можете использовать эту функцию с сортировочным ключом типа Number.) Обратите внимание, что имя функции begins_with чувствительно к регистру.

Для синтаксиса, специфичного для командной строки, см. aws help ddb-expressions

--attributes (строка)

Атрибуты, которые должны быть возвращены в результате. Вы можете извлечь все атрибуты элемента, определенные атрибуты элемента, количество соответствующих элементов или, в случае индекса, некоторые или все атрибуты, спроецированные в индекс.

ALL - Возвращает все атрибуты элемента из указанной таблицы или индекса. Если вы выполняете запрос к локальному вторичному индексу, то для каждого соответствующего элемента в индексе DynamoDB извлекает весь элемент из родительской таблицы. Если индекс настроен на проецирование всех атрибутов элемента, все данные можно получить из локального вторичного индекса, и извлечение не требуется.
ALL_PROJECTED - Разрешено только при запросе к индексу. Возвращает все атрибуты, которые были спроецированы в индекс. Если индекс настроен на проецирование всех атрибутов, это значение возврата эквивалентно указанию ALL.
COUNT - Возвращает количество соответствующих элементов, а не сами соответствующие элементы.

--consistent-read | --no-consistent-read (логическое)

Определяет модель согласованности чтения: если установлено --consistent-read, операция использует сильную согласованность чтения; в противном случае операция использует согласованность чтения по умолчанию. Сильная согласованность чтения не поддерживается для глобальных вторичных индексов. Если вы запрашиваете глобальный вторичный индекс с --consistent-read, вы получите ValidationException.

--return-consumed-capacity | --no-return-consumed-capacity (логическое)

Будет включать агрегированное значение ConsumedCapacity для операции. Если --index-name также указано, то ConsumedCapacity для каждой таблицы и вторичного индекса, к которым был осуществлен доступ, будет возвращено.

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

Маркер для указания начала пагинации. Это NextToken из ранее усеченного ответа.

Примеры использования см. в Руководстве пользователя AWS Command Line Interface в разделе Пагинация.

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

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

Примеры использования см. в Руководстве пользователя AWS Command Line Interface в разделе Пагинация.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в Руководстве пользователя AWS Command Line Interface в разделе Пагинация.

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

--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 (логическое)

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы с Руководствами по AWS CLI.

Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для сканирования всей таблицы

В этом примере сканируется вся таблица MusicCollection, а затем результаты сужаются до песен исполнителя «No One You Know». Для каждого элемента возвращаются только название альбома и название песни.

Команда:

aws ddb select MusicCollection --projection 'SongTitle, AlbumTitle' \
    --filter 'Artist = "No One You Know"'

Вывод:

Count: 2
Items:
- SongTitle: "Call Me Today"
  AlbumTitle: "Somewhat Famous"
- SongTitle: "Scared of My Shadow"
  AlbumTitle: "Blue Sky Blues"
ScannedCount: 3

Для запроса по конкретным первичным ключам

В этом примере запрашиваются элементы в таблице MusicCollection. Таблица имеет первичный ключ с хэшем и диапазоном (Artist и SongTitle), но этот запрос указывает только значение ключа хэша. Он возвращает названия песен исполнителя «No One You Know».

Команда:

aws ddb select MusicCollection --projection SongTitle \
    --key-condition 'Artist = "No One You Know"'

Вывод:

Count: 2
Items:
- SongTitle: "Call Me Today"
- SongTitle: "Scared of My Shadow"
ScannedCount: 2