 |
VOOZH | about |
|
VOOZH | about |
This document covers Redis operations through the Redis facade, including connection management, command execution, data structure operations, pipelines, transactions, and pub/sub functionality. The Redis facade provides direct access to Redis protocol commands for low-level data operations.
For cache-specific operations using Redis as a backend, see Cache Management. For queue operations that may use Redis as a driver, see Queue Operations.
The Redis facade provides a static interface to the Redis client, resolving to Hypervel\Redis\Redis through the service container. The facade supports all native Redis commands and connection pooling.
Sources: src/Facades/Redis.php1-282
The Redis facade supports multiple named connections defined in the configuration. The default connection is used when no connection name is specified.
| Method | Description |
|---|---|
Redis::connection(string $name) | Get a named connection |
Redis::release() | Release connection back to pool |
Redis::reconnect() | Reconnect if disconnected |
Redis::close() | Close connection |
Redis::check() | Check connection health |
Redis::isConnected() | Verify connection status |
Sources: src/Facades/Redis.php10-26
The Redis facade provides methods for string data type operations, including basic get/set, atomic operations, and bitwise operations.
| Operation | Method | Description |
|---|---|---|
| Get | Redis::get(string $key) | Retrieve value |
| Set | Redis::set(string $key, mixed $value, ...) | Set value with optional expiry |
| Set if not exists | Redis::setnx(string $key, string $value) | Atomic set operation |
| Multiple get | Redis::mget(array $keys) | Get multiple values |
| Multiple set | Redis::mset(array $key_values) | Set multiple key-value pairs |
| Increment | Redis::incr(string $key, int $by) | Atomic increment |
| Decrement | Redis::decr(string $key, int $by) | Atomic decrement |
| Append | Redis::append(string $key, mixed $value) | Append to value |
Sources: src/Facades/Redis.php29-162
Hash operations allow storing field-value pairs under a single key.
| Operation | Method | Description |
|---|---|---|
| Set field | Redis::hSet(string $key, mixed ...$fields) | Set one or more fields |
| Get field | Redis::hGet(string $key, string $field) | Get field value |
| Get all | Redis::hGetAll(string $key) | Get all field-value pairs |
| Multiple get | Redis::hmget(string $key, mixed ...$fields) | Get multiple fields |
| Multiple set | Redis::hmset(string $key, mixed ...$dictionary) | Set multiple fields |
| Delete | Redis::hDel(string $key, string $field, ...) | Delete fields |
| Exists | Redis::hExists(string $key, string $field) | Check field existence |
| Increment | Redis::hIncrBy(string $key, string $field, int $value) | Increment field |
Sources: src/Facades/Redis.php33-137
List operations provide queue and stack functionality with ordered element access.
| Operation | Method | Description |
|---|---|---|
| Left push | Redis::lPush(string $key, mixed ...$elements) | Push to head |
| Right push | Redis::rPush(string $key, mixed ...$elements) | Push to tail |
| Left pop | Redis::lPop(string $key, int $count) | Pop from head |
| Right pop | Redis::rPop(string $key, int $count) | Pop from tail |
| Blocking pop | Redis::blpop(mixed ...$arguments) | Block until element available |
| Range | Redis::lrange(string $key, int $start, int $end) | Get range of elements |
| Length | Redis::lLen(string $key) | Get list length |
| Trim | Redis::ltrim(string $key, int $start, int $end) | Trim to range |
Sources: src/Facades/Redis.php36-158
Set operations manage unordered unique collections with support for union, intersection, and difference.
| Operation | Method | Description |
|---|---|---|
| Add | Redis::sAdd(string $key, mixed $value, ...) | Add members |
| Remove | Redis::srem(string $key, mixed $value, ...) | Remove members |
| Members | Redis::sMembers(string $key) | Get all members |
| Is member | Redis::sismember(string $key, mixed $value) | Check membership |
| Union | Redis::sUnion(string $key, string ...$other_keys) | Union of sets |
| Intersection | Redis::sInter(array|string $key, ...) | Intersection of sets |
| Difference | Redis::sDiff(string $key, string ...$other_keys) | Difference of sets |
| Pop | Redis::sPop(string $key, int $count) | Remove and return random member |
Sources: src/Facades/Redis.php39-216
Sorted sets maintain elements with scores for ordered retrieval and range queries.
| Operation | Method | Description |
|---|---|---|
| Add | Redis::zAdd(string $key, array|float $score, ...) | Add with score |
| Range | Redis::zRange(string $key, int $start, int $end, ...) | Get range by rank |
| Range by score | Redis::zrangebyscore(string $key, $min, $max, ...) | Get range by score |
| Reverse range | Redis::zRevRange(string $key, int $start, int $end, ...) | Reverse range |
| Score | Redis::zScore(string $key, mixed $member) | Get member score |
| Rank | Redis::zRank(string $key, mixed $member) | Get member rank |
| Remove | Redis::zRem(mixed $key, mixed $member, ...) | Remove members |
| Count | Redis::zCount(string $key, $start, $end) | Count members in score range |
Sources: src/Facades/Redis.php40-266
Pipelines batch multiple commands into a single network round-trip, reducing latency for bulk operations.
Pipeline Method:
Redis::pipeline(callable|null $callback = null)
Returns an array of results corresponding to each command in the pipeline, or a \Redis instance for chaining if no callback provided.
Sources: src/Facades/Redis.php27
Transactions execute commands atomically using Redis MULTI/EXEC protocol.
Transaction Method:
Redis::transaction(callable|null $callback = null)
Returns an array of command results, or a \Redis|\RedisCluster instance if no callback provided.
Sources: src/Facades/Redis.php28
Execute Lua scripts for atomic server-side operations.
| Method | Description |
|---|---|
Redis::eval(string $script, int $numberOfKeys, ...) | Execute Lua script |
Redis::evalsha(string $sha1, int $numkeys, ...) | Execute cached script by SHA1 |
Redis::eval_ro(string $script, array $args, int $num_keys) | Read-only script execution |
Redis::evalsha_ro(string $sha1, array $args, int $num_keys) | Read-only cached script |
Redis::script(string $command, ...) | Script management commands |
Sources: src/Facades/Redis.php45-204
Redis provides publish/subscribe messaging for real-time event distribution.
| Operation | Method | Description |
|---|---|---|
| Publish | Redis::publish(string $channel, string $message) | Publish message to channel |
| Subscribe | Redis::subscribe(array|string $channels, \Closure $callback) | Subscribe to channels |
| Pattern subscribe | Redis::psubscribe(array|string $patterns, \Closure $callback) | Subscribe with patterns |
| Unsubscribe | Redis::unsubscribe(array $channels) | Unsubscribe from channels |
| Pattern unsubscribe | Redis::punsubscribe(array $patterns) | Unsubscribe from patterns |
| Pub/sub info | Redis::pubsub(string $command, mixed $arg) | Introspection commands |
Sources: src/Facades/Redis.php174-220
| Operation | Method | Description |
|---|---|---|
| Delete | Redis::del(array|string $key, ...) | Delete keys |
| Unlink | Redis::unlink(array|string $key, ...) | Async delete |
| Exists | Redis::exists(mixed $key, ...) | Check existence |
| Expire | Redis::expire(string $key, int $timeout, string|null $mode) | Set expiration |
| Expire at | Redis::expireAt(string $key, int $timestamp, ...) | Set expiration timestamp |
| TTL | Redis::ttl(string $key) | Get time to live |
| Persist | Redis::persist(string $key) | Remove expiration |
| Type | Redis::type(string $key) | Get key type |
| Rename | Redis::rename(string $old, string $new) | Rename key |
Sources: src/Facades/Redis.php77-225
Iterate through keys without blocking using cursor-based iteration.
| Method | Description |
|---|---|
Redis::scan(mixed $cursor, array ...$arguments) | Scan keys |
Redis::sscan(string $key, mixed $cursor, ...) | Scan set members |
Redis::hscan(string $key, mixed $cursor, ...) | Scan hash fields |
Redis::zscan(string $key, mixed $cursor, ...) | Scan sorted set members |
Sources: src/Facades/Redis.php14-17
The facade provides direct access to Redis commands through magic methods. Each command is mapped to its corresponding method.
Sources: src/Facades/Redis.php275-281
The Redis connection supports automatic transformation of responses.
| Method | Description |
|---|---|
Redis::shouldTransform(bool $should) | Enable/disable response transformation |
Redis::getShouldTransform() | Get transformation setting |
Sources: src/Facades/Redis.php12-13
Redis supports multiple logical databases within a single server instance.
| Method | Description |
|---|---|
Redis::select(int $db) | Select database by index |
Redis::setDatabase(int|null $database) | Set database for connection |
Redis::getDBNum() | Get current database number |
Redis::swapdb(int $src, int $dst) | Swap two databases |
Sources: src/Facades/Redis.php22-221
Redis provides geospatial indexing for location-based queries.
| Operation | Method | Description |
|---|---|---|
| Add | Redis::geoadd(string $key, float $lng, float $lat, string $member, ...) | Add location |
| Distance | Redis::geodist(string $key, string $src, string $dst, string|null $unit) | Calculate distance |
| Radius | Redis::georadius(string $key, float $lng, float $lat, float $radius, string $unit, ...) | Query by radius |
| Search | Redis::geosearch(string $key, array|string $position, ...) | Geospatial search |
Sources: src/Facades/Redis.php95-104
Redis streams provide an append-only log data structure for event streaming.
| Operation | Method | Description |
|---|---|---|
| Add | Redis::xadd(string $key, string $id, array $values, ...) | Add entry |
| Range | Redis::xrange(string $key, string $start, string $end, int $count) | Read range |
| Read | Redis::xread(array $streams, int $count, int $block) | Read from streams |
| Group create | Redis::xgroup('CREATE', string $key, string $group, ...) | Create consumer group |
| Group read | Redis::xreadgroup(string $group, string $consumer, array $streams, ...) | Read as consumer |
| Acknowledge | Redis::xack(string $key, string $group, array $ids) | Acknowledge messages |
Sources: src/Facades/Redis.php230-243
| Method | Description |
|---|---|
Redis::info(string ...$sections) | Get server information |
Redis::dbSize() | Get database key count |
Redis::time() | Get server time |
Redis::ping(string|null $message) | Ping server |
Redis::slowlog(string $operation, int $length) | Query slow log |
Sources: src/Facades/Redis.php73-222
| Method | Description |
|---|---|
Redis::save() | Synchronous save |
Redis::bgSave() | Background save |
Redis::bgrewriteaof() | Background AOF rewrite |
Redis::lastSave() | Get last save timestamp |
Sources: src/Facades/Redis.php52-202
| Method | Description |
|---|---|
Redis::getHost() | Get configured host |
Redis::getPort() | Get configured port |
Redis::getTimeout() | Get connection timeout |
Redis::getReadTimeout() | Get read timeout |
Redis::getPersistentID() | Get persistent connection ID |
Sources: src/Facades/Redis.php110-120
| Method | Description |
|---|---|
Redis::setOption(int $option, mixed $value) | Set Redis option |
Redis::getOption(int $option) | Get Redis option |
Redis::getMode() | Get connection mode |
Sources: src/Facades/Redis.php112-208
| Method | Description |
|---|---|
Redis::connect(...) | Establish connection |
Redis::pconnect(...) | Persistent connection |
Redis::reconnect() | Reconnect after disconnect |
Redis::close() | Close connection |
Redis::release() | Release to pool |
Redis::isConnected() | Check connection status |
Sources: src/Facades/Redis.php11-165
The Redis facade exposes over 270 methods corresponding to Redis protocol commands. The complete method signature list is documented as PHPDoc annotations on the facade class, enabling IDE autocompletion and static analysis.
All methods follow the convention of matching Redis command names, with camelCase transformations where applicable (e.g., HGETALL → hGetAll).
Sources: src/Facades/Redis.php9-272
Refresh this wiki