Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/matsumotory/mruby-redis

redis class for mruby.
https://github.com/matsumotory/mruby-redis
Last synced: about 2 months ago
JSON representation
redis class for mruby.
Host: GitHub
URL: https://github.com/matsumotory/mruby-redis
Owner: matsumotory
Created: 2012-12-11T15:04:56.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2023-02-23T12:32:16.000Z (almost 2 years ago)
Last Synced: 2024-10-18T18:23:05.362Z (3 months ago)
Language: C
Size: 246 KB
Stars: 49
Watchers: 8
Forks: 33
Open Issues: 4
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # mruby-redis [![Build Status](https://travis-ci.org/matsumotory/mruby-redis.svg?branch=master)](https://travis-ci.org/matsumotory/mruby-redis)

[Hiredis](https://github.com/redis/hiredis) binding for mruby. Hiredis is a

minimalistic C client library for the Redis database. Redis is an open source,

BSD-licensed, advanced key-value store. It is often referred to as a data

structure server since keys can contain strings, hashes, lists, sets and sorted

sets. Plese visit [redis' official website](http://redis.io/) for more details

about Redis.

__Running Redis might be impossible for memory/CPU-constrained environments,__

so we can recommend [mruby-vedis](https://github.com/matsumoto-r/mruby-vedis).

`vedis` is an embeddable datastore distributed as a C library. It supports over

70 commands similar to Redis, but runs in memory (hence doesn't require a

networking layer).

Please visit [vedis' website](http://vedis.symisc.net/index.html) for more

details.

## INSTALLATION

#### Using mrbgems

Add conf.gem line to `build_config.rb`:

```ruby

MRuby::Build.new do |conf|

    # ... (snip) ...

    conf.gem :git => 'https://github.com/matsumoto-r/mruby-redis.git'

end

```

## USAGE

### Connecting to a Redis server

```ruby

client = Redis.new "127.0.0.1", 6379, 2 # Connect to the server

client.host                             # => "127.0.0.1"

client.port                             # => 6379

client.select 0                         # Select the database

client.auth "secret"                    # Required if Redis is password-protected

client.enable_keepalive                 # Turn on TCP keepalive if needed

client.keepalive                        # => :on

```

### Commands

#### `Redis#auth` [doc](http://redis.io/commands/auth)

```ruby

client.auth "secret"

```

#### `Redis#asking`

```ruby

client.asking

```

#### `Redis#[]=`

TBD

#### `Redis#[]`

```ruby

client["key"]

```

#### `Redis#bulk_reply`

TBD

#### `Redis#close`

TBD

#### `Redis#cluster` [doc](http://redis.io/commands/cluster-info)

```ruby

client.cluster "info"

client.cluster "nodes"

client.cluster "slots"

```

#### `Redis#decr` [doc](http://redis.io/commands/decr)

```ruby

client.decr "key"

```

#### `Redis#decrby` [doc](http://redis.io/commands/decrby)

TBD

#### `Redis#del` [doc](http://redis.io/commands/del)

```ruby

client.del "key"

```

#### `Redis#discard` [doc](http://redis.io/commands/discard)

```ruby

# discard the transaction

client.discard

```

#### `Redis#exec` [doc](http://redis.io/commands/exec)

```ruby

# execute the transaction

client.exec

```

#### `Redis#exists?` [doc](http://redis.io/commands/exists?)

```ruby

client.exists?("key")

```

#### `Redis#expire` [doc](http://redis.io/commands/expire)

TBD

#### `Redis#flushall` [doc](http://redis.io/commands/flushall)

```ruby

client.flushall

```

#### `Redis#flushdb` [doc](http://redis.io/commands/flushdb)

```ruby

client.flushdb

```

#### `Redis#get` [doc](http://redis.io/commands/get)

```ruby

client.get "key"

```

#### `Redis#hdel` [doc](http://redis.io/commands/hdel)

```ruby

client.hdel "myhash", "field1"

```

#### `Redis#hexists?` [doc](http://redis.io/commands/hexists)

```ruby

client.hexists? "myhash", "field1"

```

#### `Redis#hget` [doc](http://redis.io/commands/hget)

```ruby

client.hget "myhash", "field1"

```

#### `Redis#hgetall` [doc](http://redis.io/commands/hgetall)

TBD

#### `Redis#hkeys` [doc](http://redis.io/commands/hkeys)

TBD

#### `Redis#hmset` [doc](http://redis.io/commands/hmset)

```ruby

client.hmset "myhash", "field1", "a", "field2", "b"

```

#### `Redis#hmget` [doc](http://redis.io/commands/hmget)

```ruby

client.hmget "myhash", "field1", "field2"

```

#### `Redis#hvals` [doc](http://redis.io/commands/hvals)

```ruby

client.hvals "myhash"

```

#### `Redis#hset` [doc](http://redis.io/commands/hset)

```ruby

client.hset "myhash", "field1", "a"

```

#### `Redis#hsetnx` [doc](http://redis.io/commands/hsetnx)

```ruby

client.hsetnx "myhash", "field1", "a"

```

#### `Redis#hincrby` [doc](http://redis.io/commands/hincrby)

```ruby

client.hincrby "myhash", "field", 1

```

#### `Redis#incr` [doc](http://redis.io/commands/incr)

```ruby

client.incr "key"

```

#### `Redis#incrby` [doc](http://redis.io/commands/incrby)

TBD

#### `Redis#keys` [doc](http://redis.io/commands/keys)

TBD

#### `Redis#lindex` [doc](http://redis.io/commands/lindex)

TBD

#### `Redis#llen` [doc](http://redis.io/commands/llen)

TBD

#### `Redis#lpop` [doc](http://redis.io/commands/lpop)

TBD

#### `Redis#lpush` [doc](http://redis.io/commands/lpush)

TBD

#### `Redis#lrange` [doc](http://redis.io/commands/lrange)

```ruby

client.lrange "logs", 0, -1

```

#### `Redis#ltrim` [doc](http://redis.io/commands/ltrim)

```ruby

client.ltrim "logs", 1, -1

```

#### `Redis#mget` [doc](http://redis.io/commnads/mget)

```ruby

client.mget "key1", "key2"

```

#### `Redis#mset` [doc](http://redis.io/commnads/mset)

```ruby

client.mset "key1", "value1", "key2", "value2"

```

#### `Redis#multi` [doc](http://redis.io/commands/multi)

```ruby

# start new transaction. Its finished by exec or discard

client.multi

```

#### `Redis#ping` [doc](http://redis.io/commands/ping)

```ruby

pong = client.ping

```

#### `Redis#publish` [doc](http://redis.io/commands/publish)

```ruby

number_of_subscribed_clients = client.publish "queue", "some value"

```

#### `Redis#pfadd` [doc](http://redis.io/commands/pfadd)

```ruby

number_of_internal_registers_altered = client.pfadd "hyperloglog_structure", "some value"

```

#### `Redis#pfcount` [doc](http://redis.io/commands/pfcount)

```ruby

approximated_number_of_unique_elements = client.pfcount "hyperloglog_structure"

```

#### `Redis#pfmerge` [doc](http://redis.io/commands/pfmerge)

```ruby

client.pfmerge "hll3", "hll1", "hll2"

```

#### `Redis#queue` [doc](http://redis.io/commands/queue)

TBD

#### `Redis#randomkey` [doc](http://redis.io/commands/randomkey)

TBD

#### `Redis#reply` [doc](http://redis.io/commands/reply)

TBD

#### `Redis#rpop` [doc](http://redis.io/commands/rpop)

TBD

#### `Redis#rpush` [doc](http://redis.io/commands/rpush)

TBD

#### `Redis#sadd` [doc](http://redis.io/commands/sadd)

TBD

#### `Redis#scard` [doc](http://redis.io/commands/scard)

TBD

#### `Redis#set` [doc](http://redis.io/commands/set)

```ruby

client.set key, "200"

```

#### `Redis#setnx` [doc](http://redis.io/commands/setnx)

```ruby

client.setnx key, "foo" # => true

client.setnx key, "bar" # => false

client.get key          # => "foo"

```

#### `Redis#sismember` [doc](http://redis.io/commands/sismember)

TBD

#### `Redis#smembers` [doc](http://redis.io/commands/smembers)

TBD

#### `Redis#spop` [doc](http://redis.io/commands/spop)

TBD

#### `Redis#srem` [doc](http://redis.io/commands/srem)

```ruby

client.srem "set", "fuge", "hoga"

```

#### `Redis#ttl` [doc](http://redis.io/commands/ttl)

TBD

#### `Redis#unwatch` [doc](http://redis.io/commands/unwatch)

```ruby

client.unwatch

```

#### `Redis#watch` [doc](http://redis.io/commands/watch)

```ruby

# watch key(s) for a transaction

client.watch "key1", "key2"

```

#### `Redis#zadd` [doc](http://redis.io/commands/zadd)

```ruby

client.zadd "hs", 80, "a"

```

#### `Redis#zcard` [doc](http://redis.io/commands/zcard)

TBD

#### `Redis#zrange` [doc](http://redis.io/commands/zrange)

```ruby

client.zrange "hs", 0, -1

```

#### `Redis#zrank` [doc](http://redis.io/commands/zrank)

```ruby

client.zrank "hs", "a"

```

#### `Redis#zrevrange` [doc](http://redis.io/commands/zrevrange)

```ruby

client.zrevrange "hs", 0, -1

```

#### `Redis#zrevrank` [doc](http://redis.io/commands/zrevrank)

```ruby

client.zrevrank "hs", "a"

```

#### `Redis#zscore` [doc](http://redis.io/commands/zscore)

```ruby

client.zscore "hs", "a"

```

See [`example/redis.rb`](https://github.com/matsumoto-r/mruby-redis/blob/master/example/redis.rb) for more details.

## LICENSE

MIT License - Copyright (c) mod\_mruby developers 2012