ОбъектРедис

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

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

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

отношения наследства

свойства члена

onsuberror

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

1
Function Redis.onsuberror;

функция-член

command

Основной метод команды Redis

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

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

cmd: строка, указывает команду для отправки
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: Объект, указывает объект «ключ/значение», который будет установлен.

1Redis.mset(...kvs);

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

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

msetNX

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

1
Redis.msetNX(Object kvs);

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

kvs: Объект, указывает объект «ключ/значение», который будет установлен.

1Redis.msetNX(...kvs);

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

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

append

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

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

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

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

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

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

setRange

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

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

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

1Integer 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.

1Buffer Redis.get(Buffer key);

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

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

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

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

mget

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

1
NArray Redis.mget(Array keys);

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

keys: Массив, указывает массив ключей, который будет запрошен.

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

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

1NArray 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, после вычитания числа, значение ключа

incr

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

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

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

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

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

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: строка, укажите режим запроса

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

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

del

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

1
Integer Redis.del(Array keys);

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

keys: Массив, указывает массив ключей, который необходимо удалить.

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

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

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

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

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

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

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

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

expire

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

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

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

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

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

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

ttl

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

1Long 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
2Redis.sub(Buffer channel,
    Function func);

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

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

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

1
Redis.sub(Object map);

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

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

unsub

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

1Redis.unsub(Buffer channel);

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

channel:Buffer, укажите название канала, от подписки на который нужно отказаться

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

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

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

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

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

1
Redis.unsub(Array channels);

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

channels: Массив, указывает массив каналов, от подписки на который нужно отказаться.

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

1
Redis.unsub(Object map);

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

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

psub

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

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

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

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

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

1
Redis.psub(Object map);

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

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

unpsub

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

1
Redis.unpsub(String pattern);

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

pattern: Строка, укажите шаблон канала отписки.

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

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

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

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

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

1
Redis.unpsub(Array patterns);

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

patterns: Массив, указывает массив шаблонов опубликованных каналов.

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

1
Redis.unpsub(Object map);

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

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

pub

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

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

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

channel:Buffer, укажите канал публикации
message:Buffer, укажите сообщение, которое нужно опубликовать

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

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

getHash

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

1RedisHash Redis.getHash(Buffer key);

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

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

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

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

getList

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

1RedisList Redis.getList(Buffer key);

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

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

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

RedisList, возвращает объект List, содержащий указанный ключ

getSet

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

1RedisSet Redis.getSet(Buffer key);

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

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

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

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

getSortedSet

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

1RedisSortedSet Redis.getSortedSet(Buffer key);

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

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

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

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

dump

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

1Buffer 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

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

1Redis.close();

toString

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

1
String Redis.toString();

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

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

toJSON

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

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

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

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

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

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

Руководство по разработке

Базовый модуль

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

модуль сообщества

ОбъектРедис

отношения наследства

свойства члена

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

toString

toJSON