mumez / redistick

A Redis client for Pharo using Stick auto-reconnection layer

RediStick

A Redis client for Pharo using Stick auto-reconnection layer

Many parts are borrowed from RedisClient.

However RediStick use Stick for supporting auto reconnection.

Installation

Default (Core only):

Metacello new
  baseline: 'RediStick';
  repository: 'github://mumez/RediStick/repository';
  load.

With Connection-Pool package:

Metacello new
  baseline: 'RediStick';
  repository: 'github://mumez/RediStick/repository';
  load: #('Core' 'ConnectionPool').

With Pubsub package:

Metacello new
  baseline: 'RediStick';
  repository: 'github://mumez/RediStick/repository';
  load: #('Core' 'Pubsub').

With Stream package:

Metacello new
  baseline: 'RediStick';
  repository: 'github://mumez/RediStick/repository';
  load: #('Core' 'Stream').

With Search package:

Metacello new
  baseline: 'RediStick';
  repository: 'github://mumez/RediStick/repository';
  load: #('Core' 'Search').

Sample Code

Basic usage

stick := RsRediStick targetUrl: 'sync://localhost'.
stick connect.

stick beSticky. "Auto reconnect when server is not accessible"
stick beSwitchy: 'sync://otherhost'. "Or connect to the secondary server"
stick onError: [ :e | e pass ]. "Or just pass an error (not reconnect) - mainly for debug"

stick endpoint info.
stick endpoint get: 'a'.
stick endpoint set: 'a' value: 999.

Using a connection pool with a wrapper class

RsRedisConnectionPool primaryUrl: 'sync://localhost:6379'.
redis := RsRedisProxy of: #client1.
redis at: 'a'.
redis at: 'a' put: 999.

In this example, the default connection pool is implicitly used through RedisProxy.

Using Pubsub channel

RediStick provides a channel class for using redis pubsub API very easily.

Please read Pubsub.md.

Using Stream

RediStick supports Redis Streams - distributed event streaming API.

(Basic usage will be documented soon).

Using Search

RediStick supports RediSearch - a full-text search extension for Redis.

Please read Search.md.

redistick's Issues

give me way to talk with you

You can send me a mail on this temporary mail address
[email protected]
I will respond by another mail address

add methods to RsEndpoint for ReJSON & normal redis

ReJSON is a redis module to support JSON
see more information here
https://oss.redislabs.com/redisjson/

I will add command like

RsRedisEndpoint >> jsonAt: aKey 
^ self unifiedCommand: { 'JSON.GET' . aKey }

RsRedisConnectionPoolTest Pharo 10 blocks

I'm currently using RediStick as a dependency for https://sebastianconcept.github.io/Mapless/ and I'd very much like to continue using it to leverage some Mapless features.

RediStick loads and all basic tests pass but from Pharo 10 the RsRedisConnectionPoolTest tests gets blocked. I didn't have a chance to look further yet but wanted to register here at this time.

typo error on RsConnectionPool

my bad I did a typo error

createStickAt: key
	"override"

	| stick |
	stick := RsRediStick targetUrl: self primaryUrl.
	stick beSticky.
	stick username: self userName password: self password.
	stick connect.
	^ stick

stick username: self userName password: self password. should be stick userName: self userName password: self password.

PR will come

add support to authentification

I will suport to authentication for RsConnectionPool + tests

RsRedisConnectionPool connections instance variable do not store stick

when we use this method createStickAt: aKey.
We should store it in the dictionary connections

is RsRedisProxy usefull ?

Understanding PubSub case

On Pharo 11 on macOS.

When trying to use the RediStick PUBSUB feature at a basic level I've ran the following snippets which do not end up printing "Hello" in the Transcript as I'd expect. Shouldn't that work?

Metacello new
  baseline: 'RediStick';
  repository: 'github://mumez/RediStick/repository';
  load: #('Core' 'ConnectionPool' 'Pubsub' ).

RsRedisConnectionPool primaryUrl: 'sync://localhost:6379'.
redis := RsRedisProxy of: #client1.
redis at: 'a'.
redis at: 'a' put: 999.

redis
channel := #greeting.
channels := { channel }.

onMessage := [ :msg | Transcript crShow: msg ].
redis endpoint subscribe: channels callback: onMessage.

redis numberOfSubscribers: channels. 
"nil"

content := 'Hello'.
redis endpoint publish: #greeting message: (STONJSON toString: content). "nil"

redis endpoint unsubscribe: channels. 
"RsRedisEndpoint(localhost:6379)"