Перейти к основному содержимому

Redis основные функции (Redis_ОсновныеФункции)

Методы модуля​

ПолучитьСоединение​

Создает и возвращает новое соединение с сервером Redis. При необходимости производит аутентификацию

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

Возвращает

Неопределено - Объект TCP клиента при успешном начале транзакции или Неопределено в случае ошибки

ЗакрытьСоединение​

Завершает работу соединения с сервером Redis

Параметры метода

  • Соединение
    • Произвольный - Объект TCP клиента

ПроверкаДоступности​

Проверяет доступность сервера Redis по переданным параметрам или по существующему соединению

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

Возвращает

Булево - Истина если удалось установить соединение с сервером Redis, ложь - от сервера не был получен корректный ответ

УстановитьЗначение​

Устанавливает новое или изменяет существующее значение на сервере Redis с заданным ключом При совпадении ключей, данные с типом "Строка" перетирают массивы и хэш-таблицы (структуры и соответствия). Но при попытке записать хэш-таблицу поверх строки будет вызвано исключение. Это задокументированное поведение Redis.

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ с которым будет схранено значение на сервере

  • Данные

    • Строка - Строковые данные для помещения в Redis

    • Массив - Массив строк

    • Структура - Где:

      • Ключ - Строка - Имя поля хэш-таблицы
      • Значение - Строка - Значение поля хэш-таблицы

    • Соответствие - Где:

      • Ключ - Строка - Имя поля хэш-таблицы
      • Значение - Строка - Значение поля хэш-таблицы

Возвращает

Булево - Истина если помещение данных произведено успешно, ложь - значение не было сохранено

ПолучитьЗначение​

Возвращает значение с сервера Redis по ключу Если читается хэш-таблица, то имена полей будут проверены на возможность использования в структуре и при корректных значениях будет возвращена Структура. В противном случае - Соответствие. Для принудительного чтения значения в Соответствие можно использовать функцию ПолучитьХэшТаблицу

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение с сервера

Возвращает

Строка - Значение полученное из сервера Redis.

ПроверитьСуществованиеКлюча​

Проверяет существование на сервере Redis записи с опреденным ключом

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

  • Ключ

    • Строка - Ключ по которому будет осуществляться проверка наличия записи

Возвращает

Булево - Истина если запись с таким ключом существкет, ложь - запись отсутствует

НайтиКлючиПоШаблону​

Находит все ключи на сервере Redis по заданному шаблону

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • ШаблонКлюча

    • Строка - Шаблон по которому будет осуществляться поиск ключей. Пример шаблона "user:*"

  • Асинхронно

    • Булево - Флаг используемой команды. Истина - SCAN, Ложь - KEYS

Возвращает

Массив - найденные ключи удовлетворяющие переданному шаблону

УдалитьЗначение​

Удаляет значение с сервера Redis по ключу

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

  • Ключ

    • Строка - Ключ по которому будет осуществляться удаление значения

  • Асинхронно

    • Булево - Флаг используемой команды. Истина - UNLINK, Ложь - DEL

Возвращает

Булево - Истина если удаление произведено успешно, ложь - значение с таким ключом не найдено

ТипДанных​

Возвращает тип данных на сервере Redis по ключу

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение с сервера

Возвращает

Структура - Данные о результате проверки типа данных для ключа на сервере "string", "list", "hash", "json", "none"

  • ТипДанных - Строка - Тип данных на сервере Redis по данному ключу. Возможные значения:
  • Соединение - Произвольный - Объект TCP клиента

ОчиститьВсе​

Удаляет все ключи из всех баз данных Redis

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

  • Асинхронно

    • Булево - К команде добавляется флаг ASYNC

Возвращает

Булево - Истина если команда выполнена успешно, ложь - ключи не были удалены

ПолучитьВремяЖизни​

Возвращает оставшееся время жизни (ttl) значения на сервере Redis

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ для которого будет получено оставшееся время жизни значения на сервере

Возвращает

Число - Оставшееся время жизни значения на сервере Redis в секундах. 0 - время жизни для

УстановитьВремяЖизни​

Устанавливает время жизни (ttl) значения на сервере Redis

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ для которого будет установлено время жизни значения в секундах

  • ВремяЖизни

    • Число - Время жизни значения на сервере Redis в секундах

Возвращает

Булево - Истина если обновление времени жизни значения произведено успешно, ложь - время жизни не было обновлено

УстановитьСтроку​

Устанавливает новое или изменят существующее значение строкового типа на сервере Redis

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ с которым будет схранено значение на сервере

  • Данные

    • Строка - Строковые данные для помещения в Redis

  • ВремяЖизни

    • Число - Время жизни значения на сервере Redis в секундах

Возвращает

Булево - Истина если помещение данных произведено успешно, ложь - значение не было сохранено

ПолучитьСтроку​

Получает строковое значение с сервера Redis по ключу

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение с сервера ЗакрыватьСоединение - Булево -

  • ЗакрыватьСоединение -

Возвращает

Строка - Значение полученное из сервера Redis

ДобавитьЭлементыВМассив​

Добавляет элементы в массив на сервере Redis. В случае если массива с таким ключом не существует, то создаёт новое значение

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение с сервера

  • Данные

    • Массив - Данные для помещения в Redis

  • МестоДобавления

    • Строка - Признак, добавляются элементы "ВНачало" массива или "ВКонец"

Возвращает

Булево - Истина если помещение данных произведено успешно, ложь - значение не было сохранено

ПолучитьМассив​

Возвращает массив строк с сервера Redis по ключу

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение с сервера ЗакрыватьСоединение - Булево -

  • ЗакрыватьСоединение -

Возвращает

Массив - Значение полученное из сервера Redis

КоличествоСтрокМассива​

Возвращает количество строк в массиве БД Redis

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение с сервера

Возвращает

Число - количество элментов в массиве. Неопределено - когда ключ в БД Redis отсутствует

ПолучитьСтрокуМассива​

Возвращает значение строки массива в БД Redis по номеру строки

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение с сервера

  • НомерСтроки

    • Число - Номер получаемой строки

Возвращает

Строка - значение элемента массива. Неопределено - когда ключ в БД Redis отсутствует

УдалитьСтрокиМассива​

Удаляет строки массива с сервера Redis по найденным значениям

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента

  • Ключ

    • Строка - Ключ по которому будет запрашиваться массив с сервера

  • НаправлениеУдаления

    • Число - Управляет количеством удаляемых элементов и направлением операции. Если значение больше 0, то удаляет указанное количество первых найденных элементов. Если значение меньше 0, то удаляет указанное количество воследних найденных элементов. Если значение равно 0, то удаляет все найденные элементы

  • ЗначениеЭлемента

    • Строка - Значение для поиска строк которые будут удалены

Возвращает

Число - Количество строк которые были удалены

ДобавитьЭлементыВХэшТаблицу​

Параметры метода

  • ПараметрыСоединения -
  • Ключ -
  • Данные -

ПолучитьХэшТаблицу​

Возвращает хэш-таблицу с сервера Redis по ключу

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение с сервера

  • СохранятьВСтруктуру

    • Булево - Признак того, что данные необходимо по возможности сохранить в Структуру. Иначе функция вернёт Соответствие. ЗакрыватьСоединение - Булево -

  • ЗакрыватьСоединение -

Возвращает

Структура - Значение полученное из сервера Redis

КоличествоПолейХэшТаблицы​

Возвращает количество полей в хэш-таблице БД Redis

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ по которому будет запрашиваться количество полей с сервера

Возвращает

Число - количество полей в хэш-таблице

ПоляХэшТаблицы​

Возвращает массив наименований полей с сервера Redis по ключу

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ по которому будет запрашиваться поля с сервера

Возвращает

Массив - наименования полей хэш-таблицы

ЗначениеПоляХэшТаблицы​

Возвращает значение поля хэш-таблицы в БД Redis по наименованию поля

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ по которому будет запрашиваться значение поля с сервера

  • Поле

    • Строка - Наименование поля для получения значения

Возвращает

Строка - значение поля хэш-таблицы

УдалитьПоляХэшТаблицы​

Удаляет поля хэш-таблицы с сервера Redis по перечню полей

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ по которому будет произведено удаление полей с сервера

  • Поля

    • Массив - Массив наименований удаляемых полей

Возвращает

Число - количество полей которые были удалены

УстановитьJson​

Устанавливает JSON значение для ключа. Данные помещаются в корень JSON

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента

  • Ключ

    • Строка - Ключ по которому будет схранены данные на сервере

  • Данные

    • Строка - Данные для записи в БД Redis
      • Число -
      • ЗаписьJSON -

Возвращает

Булево - Истина если помещение данных произведено успешно, ложь - значение не было сохранено

УстановитьJsonДляПути​

Устанавливает JSON значение для ключа по конкретному пути JSON. Путь должен существовать

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента

  • Ключ

    • Строка - Ключ по которому будет схранены данные на сервере

  • Данные

    • Строка - Данные для записи в БД Redis
      • Число -
      • ЗаписьJSON -

  • Путь

    • Строка - Путь для установки данных. Элементы пути отделяются друг от друга точкой

Возвращает

Булево - Истина если помещение данных произведено успешно, ложь - значение не было сохранено

ПолучитьJson​

Возвращает JSON значение для ключа. Данные запрашиваются из корня JSON

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента

  • Ключ

    • Строка - Ключ по которому будет прочитаны данные на сервере

Возвращает

ЧтениеJSON -

ПолучитьJsonДляПути​

Возвращает JSON значение для ключа по конкретному пути JSON. Путь должен существовать

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента

  • Ключ

    • Строка - Ключ по которому будет прочитаны данные на сервере

  • Путь

    • Строка - Путь для получения данных. Элементы пути отделяются друг от друга точкой

НачатьТранзакциюRedis​

Начинает транзакцию и возвращает соединение с сервером Redis для добавления в транзакцию команд

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis

Возвращает

Строка - Объект TCP клиента при успешном начале транзакции или информацию об ошибке

ЗафиксироватьТранзакциюRedis​

Фиксирует транзакцию и закрывает соединение с сервером Redis

Параметры метода

Возвращает

Строка - Результат выполнения фиксации транзакции

ПолучитьЭлементыМножества​

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ -

ДобавитьЭлементыВУпорядоченноеМножество​

Добавляет элементы с указанными оценками в упорядоченное множество для заданного ключа

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения

  • Ключ

    • Строка - Ключ по которому будут схранены данные на сервере

  • Данные *

    Массив Из Структура: - проводится упорядочивание элементов множества

    • Оценка - Число - Целое положительное число по значению которого будет
    • Значение - Строка - Значение элемента множества

ПолучитьЭлементыУпорядоченногоМножества​

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения Ключ - Строка - Начало - Число - Конец - Число - СОценкой - Булево -

  • Ключ -

  • Начало -

  • Конец -

  • СОценкой -

УдалитьЭлементыИзУпорядоченногоМножества​

Параметры метода

  • ПараметрыСоединения *

    Структура - Параметры для подключения

    • Адрес - Строка - Адрес сервера Redis
    • Пароль - Строка - Пароль для подключения к серверу Redis
    • Произвольный - Объект TCP клиента когда команда вызывается для ранее установленного соединения Ключ - Строка - Данные - Массив Из Строка -

  • Ключ -

  • Данные -