Основные команды для работы с БД Redis

Redis, известный своей высокой производительностью как система управления базами данных на основе ключ-значение, становится всё более популярным выбором для разработчиков, работающих с Django. Этот мощный инструмент может использоваться для самых разных целей: от кеширования до очередей задач и сессий. В этой статье мы рассмотрим, как Redis может быть интегрирован в Django, обсудим его преимущества и потенциальные сценарии использования.

Почему Redis и Django - отличное сочетание

Django, всемирно известный своим удобством и эффективностью как фреймворк для веб-разработки, часто используется в сочетании с традиционными реляционными базами данных, такими как PostgreSQL или MySQL. Однако в современных веб-приложениях требуется больше гибкости и производительности, особенно когда речь идет о масштабировании и управлении большими объемами данных в реальном времени. Именно здесь на сцену выходит Redis.

Redis предлагает уникальные возможности, такие как:

• Быстродействие: Redis хранит данные в памяти, что позволяет выполнять операции с невероятной скоростью.
• Гибкость данных: Ключ-значение, списки, множества, хеш-таблицы - Redis поддерживает множество типов данных.
• Масштабируемость: Redis легко масштабируется, что делает его отличным выбором для растущих приложений.
• Надежность: Возможности по репликации и персистентности данных обеспечивают высокий уровень надежности.

Что мы рассмотрим

В этой статье разберём основной синтаксис для работы с redis в django.

# docker-compose.yml

version: '3.9'

services:
  # ... иные контейнеры ...
  redis:
    image: redis:latest
    container_name: todo_redis
    restart: always
    command: >
      --requirepass ${REDIS_PASSWORD}
    expose:
      - 6379
    env_file:
      - ./.env
  # ... иные контейнеры ...

# .env 
REDIS_HOST=localhost 
REDIS_PORT=6379 
REDIS_PASSWORD=your_password

# settings.py 
 
REDIS_HOST = os.getenv('REDIS_HOST', 'localhost') 
REDIS_PORT = os.getenv('REDIS_PORT', '6379') 
REDIS_PASSWORD = os.getenv('REDIS_PASSWORD', 'abra_kadabra') 
REDIS_URL = f'redis://:{REDIS_PASSWORD}@{REDIS_HOST}:{REDIS_PORT}' 
 
redis_client = redis.StrictRedis( 
    host=REDIS_HOST, 
    port=REDIS_PORT, 
    db=0, 
    password=REDIS_PASSWORD 
)

В Redis можно сохранять данные в сериализованном виде с использованием различных форматов сериализации. Два самых популярных формата сериализации в Redis - это JSON и MessagePack. Важно заметить, что Redis поддерживает двоичные данные, поэтому вы можете хранить как текстовые данные (например, строки и числа), так и бинарные данные в виде сериализованных строк.

import json

data = {
    'name': 'John',
    'age': 30,
    'city': 'New York'
}

# Сериализуем данные в JSON и сохраняем в Redis
serialized_data = json.dumps(data)
redis_client.set('user:1', serialized_data)

# Получим данные из Redis и десериализуем их
stored_data = redis_client.get('user:1')
if stored_data:
    deserialized_data = json.loads(stored_data)
    print(deserialized_data)
else:
    print("Ключ 'user:1' не найден в Redis.")

# Результат:
# {'name': 'John', 'age': 30, 'city': 'New York'}

Для использования библиотеки MessagePack вам нужно установить библиотеку с помощью pip install msgpack-python.

import msgpack

# Создадим словарь Python
data = {
    'name': 'Alice',
    'age': 25,
    'city': 'London'
}

# Сериализуем данные в MessagePack и сохраняем в Redis
serialized_data = msgpack.packb(data)
redis_client.set('user:2', serialized_data)

# Получим данные из Redis и десериализуем их
stored_data = redis_client.get('user:2')
if stored_data:
    deserialized_data = msgpack.unpackb(stored_data)
    print(deserialized_data)
else:
    print("Ключ 'user:2' не найден в Redis.")

# Результат:
# {'name': 'Alice', 'age': 25, 'city': 'London'}

Обратите внимание, что при использовании MessagePack данные будут сохранены в более компактной форме, чем JSON, и это может быть полезно для экономии памяти и ускорения передачи данных.

• Описание: Эта группа методов предназначена для управления данными в Redis, включая операции чтения, записи и удаления значений.
• Сферы применения: Везде, где требуется быстрая и масштабируемая работа с данными, такие как кэширование, сессии, хранение временных данных и другие операции с данными.

SET: Устанавливает значение для ключа.

redis_client.set("my_key", "Hello, Redis!")

GET: Получает значение, связанное с указанным ключом.

value = redis_client.get("my_key") 
print(value.decode('utf-8')) # Декодируем байты в строку

DEL: Удаляет указанный ключ и связанное с ним значение.

redis_client.delete("my_key")

INCR: Увеличивает значение ключа на 1, при условии, что значение ключа является целым числом. Если ключ не существует, он будет создан, и его значение будет установлено в 1.

redis_client.incr("my_counter")

DECR: Уменьшает значение ключа на 1.

redis_client.decr("my_counter")

APPEND: Добавляет строку к уже существующему значению ключа, который представляет собой строку. Если ключ не существует, то он будет создан, и к нему будет добавлена указанная строка.

redis_client.append("my_key", " World!")

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

length = redis_client.strlen("my_key")

MSET: Устанавливает несколько ключей и их значений одновременно.

data = {"key1": "value1", "key2": "value2", "key3": "value3"} 
redis_client.mset(data)

MGET: Получает значения для нескольких ключей одновременно.

keys = ["key1", "key2", "key3"] 
values = redis_client.mget(keys)

SETEX: Устанавливает значение для ключа и устанавливает время жизни (в секундах) для этого ключа.

redis_client.setex("my_key_with_ttl", 60, "This key will expire in 60 seconds.")

PSETEX: Устанавливает значение для ключа и устанавливает время жизни (в миллисекундах) для этого ключа.

redis_client.psetex("my_key_with_ttl", 60000, "This key will expire in 60 seconds (in milliseconds).")

SETNX: Устанавливает значение для ключа, только если ключ не существует.

redis_client.setnx("new_key", "This will be set only if 'new_key' doesn't exist.")

GETSET: Устанавливает новое значение для ключа и возвращает старое значение.

old_value = redis_client.getset("my_key", "New Value")

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

redis_client.incrby("my_counter", 10) # Увеличить на 10

DECRBY: Уменьшает значение ключа на указанную величину.

redis_client.decrby("my_counter", 5) # Уменьшить на 5

INCRBYFLOAT: Увеличивает значение ключа на указанную вещественную величину.

redis_client.incrbyfloat("my_float_counter", 3.5) # Увеличить на 3.5

• Описание: Эти методы предоставляют удобный способ управления структурированными данными в виде хэшей, где каждый хэш имеет поля и значения.
• Лучшие сферы применения: Хранение и управление данными с множеством ассоциированных полей, например, хранение информации о пользователях, продуктах или настройках.

HSET: Устанавливает поле и значение в хэше. Если поле уже существует, оно перезаписывается.

redis_client.hset("my_hash", "field1", "value1")

HGET: Получает значение поля из хэша.

value = redis_client.hget("my_hash", "field1")

HMSET: Устанавливает несколько полей и их значений в хэше.

data = {"field1": "value1", "field2": "value2", "field3": "value3"} 
redis_client.hmset("my_hash", data)

HMGET: Получает значения для нескольких полей из хэша.

fields = ["field1", "field2", "field3"] 
values = redis_client.hmget("my_hash", fields)

HGETALL: Получает все поля и их значения из хэша.

all_data = redis_client.hgetall("my_hash")

HDEL: Удаляет одно или несколько полей из хэша.

redis_client.hdel("my_hash", "field1", "field2")

HEXISTS:Проверяет наличие поля в хэше.

exists = redis_client.hexists("my_hash", "field1")

HINCRBY: Увеличивает целочисленное значение поля в хэше на указанное значение.

redis_client.hincrby("my_hash", "field1", 5) # Увеличить на 5

HINCRBYFLOAT: Увеличивает вещественное значение поля в хэше на указанное значение.

redis_client.hincrbyfloat("my_hash", "float_field", 3.5) # Увеличить на 3.5

HKEYS: Получает список всех полей в хэше.

fields = redis_client.hkeys("my_hash")

HVALS: Получает список всех значений в хэше.

values = redis_client.hvals("my_hash")

HLEN: Получает количество полей в хэше.

length = redis_client.hlen("my_hash")

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

LPUSH: Добавляет одно или несколько значений в начало списка.

redis_client.lpush("my_list", "value1")

RPUSH: Добавляет одно или несколько значений в конец списка.

redis_client.rpush("my_list", "value2")

LPOP: Удаляет и возвращает первый элемент из списка.

value = redis_client.lpop("my_list")

RPOP: Удаляет и возвращает последний элемент из списка.

value = redis_client.rpop("my_list")

LLEN: Возвращает количество элементов в списке.

length = redis_client.llen("my_list")

LRANGE: Возвращает элементы списка в указанном диапазоне.

elements = redis_client.lrange("my_list", 0, -1) # Получить все элементы списка

LINDEX: Получает элемент списка по индексу.

element = redis_client.lindex("my_list", 2) # Получить элемент по индексу 2

LSET: Устанавливает значение элемента списка по индексу.

redis_client.lset("my_list", 1, "new_value") # Установить новое значение для элемента с индексом 1

LREM: Удаляет элементы списка, соответствующие заданному значению.

redis_client.lrem("my_list", 2, "value_to_remove") # Удалить 2 вхождения "value_to_remove"

LTRIM: Обрезает список до указанного диапазона элементов.

redis_client.ltrim("my_list", 0, 2) # Оставить только элементы с индексами 0, 1, 2

• Описание: Методы этой группы позволяют управлять данными в виде множеств, где элементы могут быть добавлены, удалены и проверены наличие.
• Лучшие сферы применения: Уникальные списки, проверка наличия элементов, реализация сценариев "один раз".

SADD: Добавляет одно или несколько значений в множество.

redis_client.sadd("my_set", "value1")

SREM: Удаляет одно или несколько значений из множества.

redis_client.srem("my_set", "value2")

SMEMBERS: Получает все элементы множества.

members = redis_client.smembers("my_set")

SISMEMBER: Проверяет наличие элемента в множестве.

is_member = redis_client.sismember("my_set", "value1")

SCARD: Возвращает количество элементов в множестве.

count = redis_client.scard("my_set")

SINTER: Возвращает пересечение нескольких множеств.

intersect = redis_client.sinter("set1", "set2")

SUNION: Возвращает объединение нескольких множеств.

union = redis_client.sunion("set1", "set2")

SDIFF: Возвращает разницу между двумя множествами.

difference = redis_client.sdiff("set1", "set2")

SRANDMEMBER: Получает случайный элемент из множества, не удаляя его.

random_member = redis_client.srandmember("my_set")

SPOP: Удаляет и возвращает один случайный элемент из множества.

popped_member = redis_client.spop("my_set")

• Описание: Эти методы позволяют работать с упорядоченными множествами, где элементы имеют ассоциированные баллы.
• Лучшие сферы применения: Рейтинги, сортированные списки, задачи с приоритетами, хранение данных с учетом порядка.

ZADD: Добавляет один или несколько элементов в упорядоченное множество и назначения им определенного балла. Упорядоченное множество хранит элементы в порядке возрастания (или убывания) баллов и обеспечивает быстрый доступ к элементам по их баллам.

redis_client.zadd("my_sorted_set", {"member1": 10, "member2": 20})

ZREM: Удаляет один или несколько элементов из упорядоченного множества.

redis_client.zrem("my_sorted_set", "member1")

ZRANGE: Получает элементы из упорядоченного множества в заданном диапазоне по их позиции.

elements = redis_client.zrange("my_sorted_set", 0, -1)

ZREVRANGE: Получает элементы из упорядоченного множества в обратном порядке в заданном диапазоне по их позиции.

elements = redis_client.zrevrange("my_sorted_set", 0, -1)

ZRANGEBYSCORE: Получает элементы из упорядоченного множества в заданном диапазоне по их баллам.

elements = redis_client.zrangebyscore("my_sorted_set", min=10, max=20)

ZREMRANGEBYRANK: Удаляет элементы из упорядоченного множества в заданном диапазоне по их позиции.

redis_client.zremrangebyrank("my_sorted_set", 0, 2) # Удалить первые 3 элемента

ZREMRANGEBYSCORE: Удаляет элементы из упорядоченного множества в заданном диапазоне по их баллам.

redis_client.zremrangebyscore("my_sorted_set", min=10, max=20) # Удалить элементы с баллами от 10 до 20

ZCARD: Возвращает количество элементов в упорядоченном множестве.

count = redis_client.zcard("my_sorted_set")

ZSCORE: Получает балл элемента в упорядоченном множестве.

score = redis_client.zscore("my_sorted_set", "member1")

ZCOUNT: Возвращает количество элементов в упорядоченном множестве в заданном диапазоне по баллам.

count = redis_client.zcount("my_sorted_set", min=10, max=20)

ZINCRBY: Увеличивает балл элемента в упорядоченном множестве на указанное значение.

redis_client.zincrby("my_sorted_set", 5, "member1") # Увеличить балл элемента "member1" на 5

• Описание: Эти методы предназначены для работы с данными в виде битовых строк, где каждый бит может быть установлен, извлечен и подвергнут логическим операциям.
• Сферы применения: Оптимизированное хранение флагов, битовые операции, фильтры.

SETBIT: Устанавливает бит в заданной позиции в битовой строке.

redis_client.setbit("my_bitmap", 2, 1) # Установить бит №2 в 1

GETBIT: Получает значение бита в заданной позиции в битовой строке.

bit_value = redis_client.getbit("my_bitmap", 2) # Получить значение бита №2

BITCOUNT: Возвращает количество установленных битов (значений 1) в битовой строке.

count = redis_client.bitcount("my_bitmap")

BITOP: Выполняет логические операции (AND, OR, XOR, NOT) над одной или несколькими битовыми строками и сохраняет результат в новой битовой строке.

redis_client.bitop("AND", "result_bitmap", "bitmap1", "bitmap2") # Выполнить логическое AND над двумя битовыми строками и сохранить результат в "result_bitmap"

• Описание: Эти методы позволяют управлять ключами в Redis, включая поиск ключей, проверку наличия, установку и проверку времени жизни, переименование и другие операции над ключами.
• Сферы применения: Управление ключами доступа, управление временем жизни, обслуживание и очистка данных.

KEYS: Возвращает все ключи, соответствующие заданному шаблону.

keys = redis_client.keys("my_pattern*")

EXISTS: Проверяет наличие ключа.

exists = redis_client.exists("my_key")

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

key_type = redis_client.type("my_key")

EXPIRE: Устанавливает время жизни ключа в секундах.

redis_client.expire("my_key", 60) # Установить время жизни ключа в 60 секунд

TTL: Возвращает оставшееся время жизни ключа в секундах.

time_to_live = redis_client.ttl("my_key")

PERSIST: Удаляет время жизни ключа, делая его перманентным.

redis_client.persist("my_key") # Сделать ключ "my_key" перманентным

RENAME: Переименовывает ключ.

redis_client.rename("old_key", "new_key")

RENAMENX: Переименовывает ключ, только если новое имя не занято другим ключом.

redis_client.renamenx("old_key", "new_key")

• Описание: Методы для работы с транзакциями позволяют выполнять несколько команд атомарно, обеспечивая целостность данных.
• Сферы применения: Операции, которые должны быть выполнены атомарно, такие как обновление нескольких ключей с учетом их текущего состояния.

MULTI: Начинает многокомандную транзакцию. Все последующие команды считаются частью транзакции и выполняются атомарно.

redis_client.multi()

EXEC: Завершает многокомандную транзакцию и выполняет все команды внутри транзакции.

result = redis_client.exec()

DISCARD: Отменяет текущую многокомандную транзакцию.

redis_client.discard()

WATCH: Мониторит изменения ключей. Если один из мониторинговых ключей изменяется другим клиентом, транзакция не выполняется.

redis_client.watch("key1", "key2")

UNWATCH: Прекращает мониторинг изменений ключей, начатый с помощью WATCH.

redis_client.unwatch()

• Описание: Эти методы позволяют создавать систему подписки и публикации сообщений в Redis, где клиенты могут подписываться на каналы и отправлять сообщения, которые будут доставлены всем подписчикам этого канала.
• Сферы применения: Реализация системы уведомлений, чатов, обновления в режиме реального времени.

SUBSCRIBE: Подписывает клиента на один или несколько каналов и начинает ожидание сообщений.

subscriber = redis_client.pubsub() 
subscriber.subscribe("channel1", "channel2")

UNSUBSCRIBE: Отписывает клиента от одного или нескольких каналов.

subscriber.unsubscribe("channel1", "channel2")

PUBLISH: Публикует сообщение в указанный канал. Все подписанные клиенты, ожидающие сообщения в этом канале, получат сообщение.

redis_client.publish("channel1", "Hello, subscribers!")

• Описание: Методы для управления конфигурацией Redis позволяют получать информацию о текущей конфигурации сервера и устанавливать значения определенных параметров.

CONFIG GET: Получает значения конфигурационных параметров Redis.

config = redis_client.config_get("parameter_name")

CONFIG SET: Устанавливает значения конфигурационных параметров Redis.

redis_client.config_set("parameter_name", "new_value")

INFO: Возвращает информацию о сервере и его текущей конфигурации.

info = redis_client.info()