https://github.com/soveran/stal-crystal
Set algebra solver for Redis
https://github.com/soveran/stal-crystal
Last synced: 7 months ago
JSON representation
Set algebra solver for Redis
- Host: GitHub
- URL: https://github.com/soveran/stal-crystal
- Owner: soveran
- License: mit
- Created: 2016-04-15T17:24:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-01-10T09:40:00.000Z (almost 4 years ago)
- Last Synced: 2025-03-22T15:50:02.162Z (7 months ago)
- Language: Crystal
- Size: 9.77 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - stal-crystal - Set algebra solver for Redis (ORM/ODM Extensions)
- awesome-crystal - stal-crystal - Set algebra solver for Redis (ORM/ODM Extensions)
README
# Stal
Set algebra solver for Redis
## Description
`Stal` receives an array with an s-expression composed of commands
and key names and resolves the set operations in [Redis][redis].
## Community
Meet us on IRC: [#lesscode](irc://chat.freenode.net/#lesscode) on
[freenode.net](http://freenode.net/).
## Getting started
Install [Redis][redis]. On most platforms it's as easy as grabbing
the sources, running make and then putting the `redis-server` binary
in the PATH.
Once you have it installed, you can execute `redis-server` and it
will run on `localhost:6379` by default. Check the `redis.conf`
file that comes with the sources if you want to change some settings.
## Usage
`Stal` requires a [Resp][resp] compatible client. To make things
easier, `resp` is listed as a runtime dependency so the examples
in this document will work.
```crystal
require "stal"
# Connect the client to the default host
resp = Resp.new("redis://localhost:6379")
# Use the Redis client to populate some sets
resp.call("SADD", "foo", "a", "b", "c")
resp.call("SADD", "bar", "b", "c", "d")
resp.call("SADD", "baz", "c", "d", "e")
resp.call("SADD", "qux", "x", "y", "z")
```
Now we can perform some set operations with `Stal`:
```crystal
expr = ["SUNION", "qux", ["SDIFF", ["SINTER", "foo", "bar"], "baz"]]
Stal.solve(resp, expr)
#=> ["b", "x", "y", "z"]
```
`Stal` translates the internal calls to `"SUNION"`, `"SDIFF"` and
`"SINTER"` into `SDIFFSTORE`, `SINTERSTORE` and `SUNIONSTORE` to
perform the underlying operations, and it takes care of generating
and deleting any temporary keys.
For more information, refer to the repository of the [Stal][stal]
script.
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
stal:
github: soveran/stal-crystal
branch: master
```
[redis]: http://redis.io
[resp]: https://github.com/soveran/resp-crystal
[stal]: https://github.com/soveran/stal