PhpRedisClusterConnection

класс PhpRedisClusterConnection расширяет PhpRedisConnection (Просмотреть исходный код)

Трейты

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищённый Redis	$client	Клиент Redis.	из Connection
защищённый строка\|null	$name	Имя подключения к Redis.	из Connection
защищённый Dispatcher	$events	Экземпляр диспетчера событий.	из Connection
защищённый bool\|null	$supportsPacking	Указывает, поддерживает ли Redis упаковку.	из PacksPhpRedisValues
защищённый bool\|null	$supportsLzf	Указывает, поддерживает ли Redis сжатие LZF.	из PacksPhpRedisValues
защищённый bool\|null	$supportsZstd	Указывает, поддерживает ли Redis сжатие Zstd.	из PacksPhpRedisValues
защищённый вызываемый объект	$connector	Обратный вызов для создания подключения.	из PhpRedisConnection
защищённый массив	$config	Массив конфигурации подключения.	из PhpRedisConnection

Методы

static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательский макрос.	from Macroable
static void	mixin(object $mixin, bool $replace = true) Включить другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрирован ли макрос.	from Macroable
static void	flushMacros() Очистить существующие макросы.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывает вызовы класса.	from Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывает вызовы класса.	from Macroable
void	createSubscription(array\|string $channels, Closure $callback, string $method = 'subscribe') Подписаться на набор заданных каналов для сообщений.	from PhpRedisConnection
ConcurrencyLimiterBuilder	funnel(string $name) Канал для коллбека с максимальным числом одновременных выполнений.	from Connection
DurationLimiterBuilder	throttle(string $name) Ограничение коллбека по максимальному числу выполнений за заданный период времени.	from Connection
mixed	client() Получить базовый клиент Redis.	from Connection
void	subscribe(array\|string $channels, Closure $callback) Подписаться на набор заданных каналов для сообщений.	from PhpRedisConnection
void	psubscribe(array\|string $channels, Closure $callback) Подписаться на набор заданных каналов с использованием подстановочных знаков.	from PhpRedisConnection
mixed	command(string $method, array $parameters = []) Выполнить команду для базы данных Redis.	from PhpRedisConnection
array	parseParametersForEvent(array $parameters) Разобрать параметры команды для отправки события.	from Connection
void	event(mixed $event) Отправить заданное событие, если возможно.	from Connection
void	listen(Closure $callback) Зарегистрировать прослушиватель команд Redis с подключением.	from Connection
string\|null	getName() Получить имя подключения.	from Connection
$this	setName(string $name) Установить имя подключения.	from Connection
Dispatcher	getEventDispatcher() Получить диспетчер событий, используемый подключением.	from Connection
void	setEventDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий для подключения.	from Connection
void	unsetEventDispatcher() Сбросить экземпляр диспетчера событий для подключения.	from Connection
array	pack(array $values) Подготавливает заданные значения для использования с командой `eval`, включая сериализацию и сжатие.	from PacksPhpRedisValues
bool	compressed() Определить, включено ли сжатие.	from PacksPhpRedisValues
bool	lzfCompressed() Определить, включено ли сжатие LZF.	from PacksPhpRedisValues
bool	zstdCompressed() Определить, включено ли сжатие ZSTD.	from PacksPhpRedisValues
bool	lz4Compressed() Определить, включено ли сжатие LZ4.	from PacksPhpRedisValues
bool	supportsPacking() Определить, поддерживает ли текущая версия расширения PhpRedis упаковку.	from PacksPhpRedisValues
bool	supportsLzf() Определить, поддерживает ли текущая версия расширения PhpRedis сжатие LZF.	from PacksPhpRedisValues
bool	supportsZstd() Определить, поддерживает ли текущая версия расширения PhpRedis сжатие Zstd.	from PacksPhpRedisValues

bool	phpRedisVersionAtLeast(string $version) Определить, соответствует ли версия расширения PhpRedis указанной версии или выше.	from PacksPhpRedisValues
void	__construct(Redis $client, callable $connector = null, array $config = []) Создать новое подключение PhpRedis.	from PhpRedisConnection
string\|null	get(string $key) Возвращает значение заданного ключа.	from PhpRedisConnection
array	mget(array $keys) Получить значения всех заданных ключей.	from PhpRedisConnection
bool	set(string $key, mixed $value, string\|null $expireResolution = null, int\|null $expireTTL = null, string\|null $flag = null) Установить строковое значение аргумента в качестве значения ключа.	from PhpRedisConnection
int	setnx(string $key, string $value) Установить заданный ключ, если он не существует.	from PhpRedisConnection
array	hmget(string $key, mixed ...$dictionary) Получить значение заданных полей хэш-таблицы.	from PhpRedisConnection
int	hmset(string $key, mixed ...$dictionary) Установить заданные поля хэш-таблицы в соответствующие значения.	from PhpRedisConnection
int	hsetnx(string $hash, string $key, string $value) Установить заданное поле хэш-таблицы, если оно не существует.	from PhpRedisConnection
int\|false	lrem(string $key, int $count, mixed $value) Удаляет первые count вхождений элемента value из списка.	from PhpRedisConnection
array\|null	blpop(mixed ...$arguments) Удаляет и возвращает первый элемент списка, хранящегося в ключе.	from PhpRedisConnection
array\|null	brpop(mixed ...$arguments) Удаляет и возвращает последний элемент списка, хранящегося в ключе.	from PhpRedisConnection
mixed\|false	spop(string $key, int\|null $count = 1) Удаляет и возвращает случайный элемент из множества, хранящегося в ключе.	from PhpRedisConnection
int	zadd(string $key, mixed ...$dictionary) Добавить одного или нескольких членов в упорядоченное множество или обновить его оценку, если он уже существует.	from PhpRedisConnection
array	zrangebyscore(string $key, mixed $min, mixed $max, array $options = []) Возвратить элементы с оценкой между $min и $max.	from PhpRedisConnection
array	zrevrangebyscore(string $key, mixed $min, mixed $max, array $options = []) Возвратить элементы с оценкой между $min и $max.	from PhpRedisConnection
int	zinterstore(string $output, array $keys, array $options = []) Найти пересечение множеств и сохранить в новом множестве.	from PhpRedisConnection
int	zunionstore(string $output, array $keys, array $options = []) Найти объединение множеств и сохранить в новом множестве.	from PhpRedisConnection
mixed	scan(mixed $cursor, array $options = []) Сканирует все ключи на основе параметров.	from PhpRedisConnection
mixed	zscan(string $key, mixed $cursor, array $options = []) Сканирует заданное множество для всех значений на основе параметров.	from PhpRedisConnection
mixed	hscan(string $key, mixed $cursor, array $options = []) Сканирует заданную хэш-таблицу для всех значений на основе параметров.	from PhpRedisConnection
mixed	sscan(string $key, mixed $cursor, array $options = []) Сканирует заданное множество для всех значений на основе параметров.	from PhpRedisConnection
Redis\|array	pipeline(callable $callback = null) Выполнить команды в конвейере.	from PhpRedisConnection
Redis\|array	transaction(callable $callback = null) Выполнить команды в транзакции.	from PhpRedisConnection
mixed	evalsha(string $script, int $numkeys, mixed ...$arguments) Выполнить LUA-скрипт на стороне сервера по SHA1-хешу скрипта вместо самого скрипта.	from PhpRedisConnection
mixed	eval(string $script, int $numberOfKeys, dynamic ...$arguments) Выполнить скрипт и вернуть результат.	from PhpRedisConnection
mixed	flushdb() Очистить выбранную базу данных Redis на всех узлах-мастерах.
mixed	executeRaw(array $parameters) Выполнить сырую команду.	from PhpRedisConnection
void	disconnect() Отключиться от экземпляра Redis.	from PhpRedisConnection

Подробности

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательскую макрокоманду.

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирована ли макрокоманда.

Parameters

string

$name

Return Value

bool

static void flushMacros()

Очистить существующие макрокоманды.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')

Подписаться на набор заданных каналов для сообщений.

Parameters

array\|string	$channels
Closure	$callback
string	$method

Return Value

void

ConcurrencyLimiterBuilder funnel(string $name)

Направить обратный вызов для максимального количества одновременных выполнений.

Parameters

string

$name

Return Value

ConcurrencyLimiterBuilder

DurationLimiterBuilder throttle(string $name)

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

Parameters

string

$name

Return Value

DurationLimiterBuilder

mixed client()

Получить базовый клиент Redis.

Return Value

mixed

void subscribe(array|string $channels, Closure $callback)

Подписаться на набор заданных каналов для сообщений.

Parameters

array\|string	$channels
Closure	$callback

Return Value

void

void psubscribe(array|string $channels, Closure $callback)

Подписаться на набор заданных каналов с подстановочными знаками.

Parameters

array\|string	$channels
Closure	$callback

Return Value

void

mixed command(string $method, array $parameters = [])

Выполнить команду в базе данных Redis.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

RedisException

protected array parseParametersForEvent(array $parameters)

Обработать параметры команды для отправки событий.

Parameters

array

$parameters

Return Value

array

protected void event(mixed $event)

Сгенерировать событие, если это возможно.

Parameters

mixed

$event

Return Value

void

void listen(Closure $callback)

Зарегистрировать слушателя команд Redis с подключением.

Parameters

Closure

$callback

Return Value

void

string|null getName()

Получить имя подключения.

Return Value

string|null

$this setName(string $name)

Установить имя подключения.

Parameters

string

$name

Return Value

$this

Dispatcher getEventDispatcher()

Получить диспетчер событий, используемый подключением.

Return Value

Dispatcher

void setEventDispatcher(Dispatcher $events)

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

Parameters

Dispatcher

$events

Return Value

void

void unsetEventDispatcher()

Удалите экземпляр диспетчера событий на подключении.

Return Value

void

array pack(array $values)

Подготавливает заданные значения для использования с командой eval, включая сериализацию и сжатие.

Parameters

array

$values

Return Value

array

bool compressed()

Определите, включено ли сжатие.

Return Value

bool

bool lzfCompressed()

Определите, включено ли сжатие LZF.

Return Value

bool

bool zstdCompressed()

Определите, включено ли сжатие ZSTD.

Return Value

bool

bool lz4Compressed()

Определите, включено ли сжатие LZ4.

Return Value

bool

protected bool supportsPacking()

Определите, поддерживает ли текущая версия расширения PhpRedis упаковку.

Return Value

bool

protected bool supportsLzf()

Определите, поддерживает ли текущая версия расширения PhpRedis сжатие LZF.

Return Value

bool

protected bool supportsZstd()

Определите, поддерживает ли текущая версия расширения PhpRedis сжатие Zstd.

Return Value

bool

protected bool phpRedisVersionAtLeast(string $version)

Определите, является ли версия расширения PhpRedis как минимум заданной версией.

Parameters

string

$version

Return Value

bool

void __construct(Redis $client, callable $connector = null, array $config = [])

Создайте новое подключение PhpRedis.

Parameters

Redis	$client
callable	$connector
array	$config

Return Value

void

string|null get(string $key)

Возвращает значение заданного ключа.

Parameters

string

$key

Return Value

string|null

array mget(array $keys)

Получите значения всех заданных ключей.

Parameters

array

$keys

Return Value

array

bool set(string $key, mixed $value, string|null $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)

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

Parameters

string	$key
mixed	$value
string\|null	$expireResolution
int\|null	$expireTTL
string\|null	$flag

Return Value

bool

int setnx(string $key, string $value)

Установите заданный ключ, если он не существует.

Parameters

string	$key
string	$value

Return Value

int

array hmget(string $key, mixed ...$dictionary)

Получите значения заданных полей хеш-таблицы.

Parameters

string	$key
mixed	...$dictionary

Return Value

array

int hmset(string $key, mixed ...$dictionary)

Установите заданные поля хеш-таблицы в соответствующие значения.

Parameters

string	$key
mixed	...$dictionary

Return Value

int

int hsetnx(string $hash, string $key, string $value)

Установите заданное поле хеш-таблицы, если оно не существует.

Parameters

string	$hash
string	$key
string	$value

Return Value

int

int|false lrem(string $key, int $count, mixed $value)

Удаляет первые count вхождений элемента value из списка.

Parameters

string	$key
int	$count
mixed	$value

Return Value

int|false

array|null blpop(mixed ...$arguments)

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

Parameters

mixed

...$arguments

Return Value

array|null

array|null brpop(mixed ...$arguments)

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

Parameters

mixed

...$arguments

Return Value

array|null

END_OF_DOCUMENT_MARKER

смешанный|ложь spop(строка $key, целое число|null $count = 1)

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

Параметры

строка	$key
целое число\|null	$count

Возвращаемое значение

смешанный|ложь

целое число zadd(строка $key, смешанный ...$dictionary)

Добавляет один или несколько элементов в упорядоченное множество или обновляет его значение, если элемент уже существует.

Параметры

строка	$key
смешанный	...$dictionary

Возвращаемое значение

целое число

массив zrangebyscore(строка $key, смешанный $min, смешанный $max, массив $options = [])

Возвращает элементы со значением между $min и $max.

Параметры

строка	$key
смешанный	$min
смешанный	$max
массив	$options

Возвращаемое значение

массив

массив zrevrangebyscore(строка $key, смешанный $min, смешанный $max, массив $options = [])

Возвращает элементы со значением между $min и $max.

Параметры

строка	$key
смешанный	$min
смешанный	$max
массив	$options

Возвращаемое значение

массив

целое число zinterstore(строка $output, массив $keys, массив $options = [])

Находит пересечение множеств и сохраняет его в новом множестве.

Параметры

строка	$output
массив	$keys
массив	$options

Возвращаемое значение

целое число

целое число zunionstore(строка $output, массив $keys, массив $options = [])

Находит объединение множеств и сохраняет его в новом множестве.

Параметры

строка	$output
массив	$keys
массив	$options

Возвращаемое значение

целое число

смешанный scan(смешанный $cursor, массив $options = [])

Сканирует все ключи на основе параметров.

Параметры

смешанный	$cursor
массив	$options

Возвращаемое значение

смешанный

смешанный zscan(строка $key, смешанный $cursor, массив $options = [])

Сканирует заданное множество по всем значениям на основе параметров.

Параметры

строка	$key
смешанный	$cursor
массив	$options

Возвращаемое значение

смешанный

смешанный hscan(строка $key, смешанный $cursor, массив $options = [])

Сканирует заданный хэш по всем значениям на основе параметров.

Параметры

строка	$key
смешанный	$cursor
массив	$options

Возвращаемое значение

смешанный

смешанный sscan(строка $key, смешанный $cursor, массив $options = [])

Сканирует заданное множество по всем значениям на основе параметров.

Параметры

строка	$key
смешанный	$cursor
массив	$options

Возвращаемое значение

смешанный

Redis|массив pipeline(вызываемый объект $callback = null)

Выполняет команды в конвейере.

Параметры

вызываемый объект

$callback

Возвращаемое значение

Redis|массив

Redis|массив transaction(вызываемый объект $callback = null)

Выполняет команды в транзакции.

Параметры

вызываемый объект

$callback

Возвращаемое значение

Redis|массив

смешанный evalsha(строка $script, целое число $numkeys, смешанный ...$arguments)

Оценивает скрипт LUA на сервере по хэшу SHA1 скрипта, а не по самому скрипту.

Параметры

строка	$script
целое число	$numkeys
смешанный	...$arguments

Возвращаемое значение

смешанный

смешанный eval(строка $script, целое число $numberOfKeys, динамический ...$arguments)

Оценивает скрипт и возвращает его результат.

Параметры

строка	$script
целое число	$numberOfKeys
динамический	...$arguments

Возвращаемое значение

смешанный

смешанный flushdb()

Очищает выбранную базу данных Redis на всех узлах-мастерах.

Возвращаемое значение

смешанный

смешанный executeRaw(массив $parameters)

Выполняет сырую команду.

Параметры

массив

$parameters

Возвращаемое значение

смешанный

пустое значение disconnect()

Отключается от экземпляра Redis.

Возвращаемое значение

пустое значение

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Redis/Connections/PhpRedisClusterConnection.html