Объект встроенный объект

Объект Redis

Клиентский объект базы данных Redis

Используется для создания и управления базой данных Redis, метод создания:

1 2
var db = require("db"); var test = new db.openRedis("redis-server");

Наследование

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>Redis|onsuberror|command();set();setNX();setXX();mset();msetNX();append();setRange();getRange();strlen();bitcount();get();mget();getset();decr();incr();setBit();getBit();exists();type();keys();del();expire();ttl();persist();rename();renameNX();sub();unsub();psub();unpsub();pub();getHash();getList();getSet();getSortedSet();dump();restore();close()] [object] <:- [Redis] Redis onsuberror command() set() setNX() setXX() mset() msetNX() append() setRange() getRange() strlen() bitcount() get() mget() getset() decr() incr() setBit() getBit() exists() type() keys() del() expire() ttl() persist() rename() renameNX() sub() unsub() psub() unpsub() pub() getHash() getList() getSet() getSortedSet() dump() restore() close() object toString() toJSON()

Атрибуты члена

onsuberror

Функция, запрос и функция обработки ошибок, обратный вызов, когда есть ошибка в подпрограмме или сеть прерывается, когда происходит обратный вызов, все подпрограммы этого объекта будут прерваны

1
Function Redis.onsuberror;

Функция члена

command

Базовый метод команд Redis

1 2
Value Redis.command(String cmd, ...args);

Параметры звонка:

  • cmd: String, укажите отправленную команду
  • args: ..., укажите параметры для отправки

Результат возврата:

  • Value, Вернуть результат, возвращенный сервером

set

Свяжите значение строкового значения с ключом, если ключ уже содержит другие значения, SET перезаписывает старое значение, независимо от типа

1 2 3
Redis.set(Buffer key, Buffer value, Long ttl = 0);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно связать
  • value: Buffer, Укажите данные, которые нужно связать
  • ttl: Long, установите время выживания для ключа в миллисекундах; если ttl равно 0, тогда не устанавливайте время выживания

setNX

Установите значение ключа равным значению тогда и только тогда, когда ключ не существует. Если данный ключ уже существует, SETNX ничего не делает.

1 2 3
Redis.setNX(Buffer key, Buffer value, Long ttl = 0);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно связать
  • value: Buffer, Укажите данные, которые нужно связать
  • ttl: Long, установите время выживания для ключа в миллисекундах; если ttl равно 0, тогда не устанавливайте время выживания

setXX

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

1 2 3
Redis.setXX(Buffer key, Buffer value, Long ttl = 0);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно связать
  • value: Buffer, Укажите данные, которые нужно связать
  • ttl: Long, установите время выживания для ключа в миллисекундах; если ttl равно 0, тогда не устанавливайте время выживания

mset

Задайте одновременно одну или несколько пар "ключ-значение". Если данный ключ уже существует, MSET перезапишет старое значение новым значением.

1
Redis.mset(Object kvs);

Параметры звонка:

  • kvs: Object, укажите объект типа ключ / значение, который нужно установить

Задайте одновременно одну или несколько пар "ключ-значение". Если данный ключ уже существует, MSET перезапишет старое значение новым значением.

1
Redis.mset(...kvs);

Параметры звонка:

  • kvs: ..., укажите список ключей / значений, который нужно установить

msetNX

Установите одну или несколько пар ключ-значение одновременно, если и только если все заданные ключи не существуют

1
Redis.msetNX(Object kvs);

Параметры звонка:

  • kvs: Object, укажите объект типа ключ / значение, который нужно установить

Установите одну или несколько пар ключ-значение одновременно, если и только если все заданные ключи не существуют

1
Redis.msetNX(...kvs);

Параметры звонка:

  • kvs: ..., укажите список ключей / значений, который нужно установить

append

Если ключ уже существует и является строкой, команда добавления добавляет значение в конец исходного значения ключа. Если ключ не существует, append просто устанавливает для данного ключа значение

1 2
Integer Redis.append(Buffer key, Buffer value);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно добавить
  • value: Buffer, Укажите данные для добавления

Результат возврата:

  • Integer, После добавления значения длина строки в ключе

setRange

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

1 2 3
Integer Redis.setRange(Buffer key, Integer offset, Buffer value);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно изменить
  • offset: Целое число, укажите измененное смещение байта
  • value: Buffer, Укажите данные для перезаписи

Результат возврата:

  • Integer, После изменения длина строки

getRange

Возвращает подстроку строкового значения в ключе. Диапазон перехвата строки определяется двумя смещениями начала и конца (включая начало и конец).

1 2 3
Buffer Redis.getRange(Buffer key, Integer start, Integer end);

Параметры звонка:

  • key: Buffer, Укажите ключ для запроса
  • start: Целое число, укажите смещение начального байта запроса
  • end: Целое число, укажите смещение в конце запроса в байтах.

Результат возврата:

  • Buffer, Перехватить подстроку

strlen

Возвращает длину строкового значения, хранящегося в ключе. Если ключ не является строковым значением, возвращается ошибка

1
Integer Redis.strlen(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ для расчета

Результат возврата:

  • Integer, Длина строкового значения. Когда ключ не существует, верните 0

bitcount

Подсчитайте количество битов, установленных в 1 в данной строке

1 2 3
Integer Redis.bitcount(Buffer key, Integer start = 0, Integer end = -1);

Параметры звонка:

  • key: Buffer, Укажите ключ для расчета
  • start: Целое число, укажите начальный байт для вычисления, можно использовать отрицательные значения, -1 означает последний байт, -2 означает предпоследний байт и т. Д.
  • end: Целое число, укажите конечный байт для вычисления, можно использовать отрицательные значения, -1 означает последний байт, -2 означает предпоследний байт и т. Д.

Результат возврата:

  • Integer, Количество битов, равное 1

get

Вернуть строковое значение, связанное с ключом, если ключ не существует, вернуть специальное значение Null

1
Buffer Redis.get(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно связать

Результат возврата:

  • Buffer, Если ключ не существует, вернуть Null, в противном случае вернуть значение ключа

mget

Возвращает все (одно или несколько) значений данного ключа. Если ключ не существует в данном ключе, то этот ключ возвращает специальное значение nil.

1
NArray Redis.mget(Array keys);

Параметры звонка:

  • keys: Array, укажите ключевой массив для запроса

Результат возврата:

  • NArray, Список, содержащий все значения данного ключа

Возвращает все (одно или несколько) значений данного ключа. Если ключ не существует в данном ключе, то этот ключ возвращает специальное значение nil.

1
NArray Redis.mget(...keys);

Параметры звонка:

  • keys: ..., укажите список ключей для запроса

Результат возврата:

  • NArray, Список, содержащий все значения данного ключа

getset

Установите значение данного ключа в значение и верните старое значение ключа (старое значение)

1 2
Buffer Redis.getset(Buffer key, Buffer value);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно запросить и изменить
  • value: Buffer, Укажите измененное значение

Результат возврата:

  • Buffer, Вернуть старое значение данного ключа

decr

Вычтите декремент из значения, хранящегося в ключе

1 2
Long Redis.decr(Buffer key, Long num = 1);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно изменить
  • num: Длинный, укажите значение для вычитания

Результат возврата:

  • Long, После вычитания num значение ключа

incr

Добавьте приращение к значению, хранящемуся в ключе

1 2
Long Redis.incr(Buffer key, Long num = 1);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно изменить
  • num: Long, укажите значение, которое нужно добавить

Результат возврата:

  • Long, После добавления числа значение ключа

setBit

Для строкового значения, хранящегося в ключе, установите или сбросьте бит в указанном смещении (бит)

1 2 3
Integer Redis.setBit(Buffer key, Integer offset, Integer value);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно изменить
  • offset: Целое число, укажите измененное битовое смещение
  • value: Целое число, укажите параметр, который нужно установить или очистить, это может быть 0 или 1

Результат возврата:

  • Integer, Укажите исходный сохраненный бит смещения

getBit

Получить бит по указанному смещению для строкового значения, хранящегося в ключе

1 2
Integer Redis.getBit(Buffer key, Integer offset);

Параметры звонка:

  • key: Buffer, Укажите ключ для запроса
  • offset: Целое число, укажите битовое смещение запроса

Результат возврата:

  • Integer, Строковое значение указывает бит при смещении (бит)

exists

Проверить, существует ли данный ключ

1
Boolean Redis.exists(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно связать

Результат возврата:

  • Boolean, Если ключ существует, верните True, в противном случае верните False

type

Возвращает тип значения, хранящегося в ключе

1
String Redis.type(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ для запроса

Результат возврата:

  • String, Возвращает тип значения, хранящегося в ключе, возможное значение - нет (ключ не существует) строка (строка) список (список) набор (коллекция) zset (упорядоченный набор) hash(Хеш-таблица)

keys

Найдите все ключи, соответствующие заданному шаблону

1
NArray Redis.keys(String pattern);

Параметры звонка:

  • pattern: String, укажите режим запроса

Результат возврата:

  • NArray, Список ключей, соответствующих заданному шаблону

del

Удалите один или несколько заданных ключей, несуществующие ключи будут проигнорированы

1
Integer Redis.del(Array keys);

Параметры звонка:

  • keys: Массив, укажите массив ключей, который нужно удалить

Результат возврата:

  • Integer, Количество удаленных ключей

Удалите один или несколько заданных ключей, несуществующие ключи будут проигнорированы

1
Integer Redis.del(...keys);

Параметры звонка:

  • keys: ..., укажите список ключей для удаления

Результат возврата:

  • Integer, Количество удаленных ключей

expire

Установите время жизни для данного ключа, когда срок действия ключа истечет, он будет автоматически удален

1 2
Boolean Redis.expire(Buffer key, Long ttl);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно установить
  • ttl: Long, установите время выживания ключа в миллисекундах

Результат возврата:

  • Boolean, Если ключ существует, верните True, в противном случае верните False

ttl

Вернуть оставшееся время выживания данного ключа

1
Long Redis.ttl(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ для запроса

Результат возврата:

  • Long, Возвращает оставшееся время жизни ключа в миллисекундах. Если ключ не существует, возвращается -2. Когда ключ существует, но оставшееся время жизни не установлено, возвращается -1.

persist

Удалить время жизни данного ключа и преобразовать этот ключ из «изменчивого» (с ключом времени жизни) в «постоянный» (ключ без срока действия и никогда не истекает)

1
Boolean Redis.persist(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно установить

Результат возврата:

  • Boolean, Если ключ существует, верните True, в противном случае верните False

rename

Переименуйте ключ в newkey. Если ключ и newkey совпадают или ключ не существует, будет возвращена ошибка.

1 2
Redis.rename(Buffer key, Buffer newkey);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно переименовать
  • newkey: Buffer, Укажите целевой ключ для переименования

renameNX

Если и только если newkey не существует, переименуйте ключ в newkey и верните ошибку, если ключ не существует

1 2
Boolean Redis.renameNX(Buffer key, Buffer newkey);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно переименовать
  • newkey: Buffer, Укажите целевой ключ для переименования

Результат возврата:

  • Boolean, Когда модификация прошла успешно, возвращает True, если новый ключ уже существует, возвращает False

sub

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

1 2
Redis.sub(Buffer channel, Function func);

Параметры звонка:

  • channel: Buffer, Укажите название подписанного канала
  • func: Функция, укажите функцию обратного вызова

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

1
Redis.sub(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления каналов, имя атрибута объекта будет именем канала, а значение атрибута будет функцией обратного вызова

unsub

Отменить подписку на все обратные вызовы данного канала

1
Redis.unsub(Buffer channel);

Параметры звонка:

  • channel: Buffer, Укажите название неподписанного канала

Отказаться от подписки на указанную функцию обратного вызова данного канала

1 2
Redis.unsub(Buffer channel, Function func);

Параметры звонка:

  • channel: Buffer, Укажите название неподписанного канала
  • func: Функция, укажите функцию обратного вызова для отписки

Отменить подписку на все обратные вызовы данного канала

1
Redis.unsub(Array channels);

Параметры звонка:

  • channels: Массив, укажите массив неподписанных каналов

Отказаться от подписки на указанную функцию обратного вызова для заданного набора каналов

1
Redis.unsub(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления каналов, имя атрибута объекта будет именем канала, а значение атрибута будет функцией обратного вызова

psub

Подпишитесь на информацию о группе каналов в соответствии с шаблоном. При появлении сообщения функция func вызывается автоматически. Func содержит три параметра, которые по очереди являются каналом, сообщением и шаблоном. Будет вызвана одна и та же функция того же шаблона. назад один раз.

1 2
Redis.psub(String pattern, Function func);

Параметры звонка:

  • pattern: String, укажите шаблон подписанного канала
  • func: Функция, укажите функцию обратного вызова

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

1
Redis.psub(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления каналов, имя атрибута объекта будет использоваться в качестве шаблона канала, а значение атрибута будет использоваться как функция обратного вызова

unpsub

Отменить подписку на все обратные вызовы каналов с заданным шаблоном

1
Redis.unpsub(String pattern);

Параметры звонка:

  • pattern: String, укажите шаблон канала для отказа от подписки

Указанная функция обратного вызова для отказа от подписки на канал данного шаблона

1 2
Redis.unpsub(String pattern, Function func);

Параметры звонка:

  • pattern: String, укажите шаблон канала для отказа от подписки
  • func: Функция, укажите функцию обратного вызова для отписки

Отменить подписку на все обратные вызовы набора каналов с заданным шаблоном

1
Redis.unpsub(Array patterns);

Параметры звонка:

  • patterns: Array, укажите массив шаблонов каналов для публикации

Указанная функция обратного вызова канала, отменяющего подписку на набор шаблонов

1
Redis.unpsub(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления каналов, имя атрибута объекта будет использоваться в качестве шаблона канала, а значение атрибута будет использоваться как функция обратного вызова

pub

Отправить информационное сообщение на указанный канал канала

1 2
Integer Redis.pub(Buffer channel, Buffer message);

Параметры звонка:

  • channel: Buffer, Укажите опубликованный канал
  • message: Buffer, Укажите сообщение для публикации

Результат возврата:

  • Integer, Количество клиентов, получивших это сообщение

getHash

Получить объект Hash указанного ключа. Этот объект является клиентом, который содержит указанный ключ. База данных может работать только при вызове ее метода.

1
RedisHash Redis.getHash(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно получить

Результат возврата:

  • RedisHash, Вернуть объект Hash, содержащий указанный ключ

getList

Получить объект List указанного ключа. Этот объект является клиентом, который содержит указанный ключ. База данных может работать только при вызове ее метода.

1
RedisList Redis.getList(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно получить

Результат возврата:

  • RedisList, Вернуть объект списка, содержащий указанный ключ

getSet

Получить объект Set указанного ключа. Этот объект является клиентом, который содержит указанный ключ. Базой данных можно управлять только путем вызова его метода.

1
RedisSet Redis.getSet(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно получить

Результат возврата:

  • RedisSet, Вернуть объект Set, содержащий указанный ключ

getSortedSet

Получить объект SortedSet указанного ключа. Этот объект является клиентом, который содержит указанный ключ. База данных может работать только при вызове ее метода.

1
RedisSortedSet Redis.getSortedSet(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ, который нужно получить

Результат возврата:

  • RedisSortedSet, Возвращает объект SortedSet, содержащий указанный ключ

dump

Сериализуйте данный ключ и верните сериализованное значение. Используйте команду восстановления, чтобы десериализовать это значение в ключ Redis.

1
Buffer Redis.dump(Buffer key);

Параметры звонка:

  • key: Buffer, Укажите ключ для сериализации

Результат возврата:

  • Buffer, Вернуть сериализованное значение, если ключ не существует, вернуть нуль

restore

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

1 2 3
Redis.restore(Buffer key, Buffer data, Long ttl = 0);

Параметры звонка:

  • key: Buffer, Укажите ключ для десериализации
  • data: Buffer, Укажите данные для десериализации
  • ttl: Long, установите время выживания для ключа в миллисекундах; если ttl равно 0, тогда не устанавливайте время выживания

close

Закройте текущее соединение с базой данных или транзакцию

1
Redis.close();

toString

Возвращает строковое представление объекта, обычно возвращает «[Native Object]», объект может быть повторно реализован в соответствии с его собственными характеристиками.

1
String Redis.toString();

Результат возврата:

  • String, Возвращает строковое представление объекта

toJSON

Возвращает представление объекта в формате JSON, обычно возвращает набор читаемых атрибутов, определенных объектом.

1
Value Redis.toJSON(String key = "");

Параметры звонка:

  • key: Строка, не используется

Результат возврата:

  • Value, Возвращает значение, содержащее сериализуемый JSON