The cl-ssdb Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-ssdb Reference Manual

This is the cl-ssdb Reference Manual, version 0.0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:24:22 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CL-SSDB - A fast and robus Common Lisp client for SSDB

Note: SSDB, A high performance NoSQL database supporting many data structures, an alternative to Redis.

Install

In Shell:

git clone https://github.com/muyinliu/cl-ssdb
cp -r cl-ssdb ~/quicklisp/local-projects/cl-ssdb

In Common Lisp REPL:

(ql:quickload 'cl-ssdb)

=>

To load "cl-ssdb":
  Load 1 ASDF system:
    cl-ssdb
; Loading "cl-ssdb"

(CL-SSDB)

Dependencies

Usage

connect to SSDB

(ssdb:connect)

=>

#<SSDB-CONNECTION {100C74B673}>

auth with password

(ssdb:auth "8AgYA/ougM9DCvtS9l172ddhb+v/nIAPvVpJjMdzHz0VnkB6Ji3qC904O1XuOj+6ZD9cqJq3xgsPQRUzGDA9YZfI8z/hA5G6fIxnB9g/VLUo4GrEHRJ5bMV3h8MknaHreQQ7wjxuzgkNLfrxsev6ZULCXWUizbNU3hthMIQjjtS6L+yRnOcKBH+f7IsCyZJsikCmNSFpyN2DaKqFnqTJphueuodkKAqK+N3iCjsrhuucvW3GkZOpXkBILicSDZ36dXQnKDQPctr8w4RTLzbg0lb7b5qcO134A6aVRl4WrBScwRf6HNB+r0p+8zeWAcmdtIQbYwY0wh7A6tS0mWOpTTD5BQCiqL+WwZkL3i2K3wAK0tx3WI9g8I4k8JBwxdLwi0I1UW2dF5oMpk4KppB6nqckya4ybkyGAFw6op3IhAa6m/jvWZUaZrN8im/tlcCoDFfQCywWx4V06eqa35221c+9DbpXfFvJcFxZ6xKJkf0I34SIarLI+pVqm/k3Q0Dc")

=>

"ok"

command examples

(ssdb:ping)

=>

"ok"
(ssdb:set "key1" "value1")

=>

"ok"
(ssdb:get "key1")

=>

"value1"

More examples please look at the file test/cl-ssdb-test.lisp

Run test case

First, make sure ssdb-server is running. You can use follow shell commands to run ssdb-server:

cd cl-ssdb/test
ssdb-server -d -s start ./ssdb.conf

Please make sure directory cl-ssdb/test/var is exists.

In Common Lisp REPL:

(asdf:test-system :cl-ssdb)

OR in Shell:

sbcl --eval "(asdf:test-system :cl-ssdb)" --eval "(quit)"

License

MIT (See LICENSE file for details).


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-ssdb

Author

Muyinliu Xing <muyinliu@gmail.com>

License

MIT

Description

SSDB client for Common Lisp.

Version

0.0.1

Dependencies
Source

cl-ssdb.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-ssdb.asd

Location

cl-ssdb.asd

Systems

cl-ssdb (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-ssdb/packages.lisp

Parent

cl-ssdb (system)

Location

packages.lisp

Packages

cl-ssdb


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-ssdb/connection.lisp

Dependency

packages.lisp (file)

Parent

cl-ssdb (system)

Location

connection.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-ssdb/cl-ssdb.lisp

Dependency

connection.lisp (file)

Parent

cl-ssdb (system)

Location

cl-ssdb.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-ssdb/commands.lisp

Dependency

cl-ssdb.lisp (file)

Parent

cl-ssdb (system)

Location

commands.lisp

Exported Definitions
Internal Definitions

version (function)


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-ssdb

Source

packages.lisp (file)

Nickname

ssdb

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *connection*

The current SSDB connection.

Package

cl-ssdb

Source

connection.lisp (file)

Special Variable: *echo-p*

Whether the server-client communication should be echoed to the stream specified by *ECHO-STREAM*. The default is NIL, meaning no echoing.

Package

cl-ssdb

Source

connection.lisp (file)

Special Variable: *echo-stream*

A stream to which the server-client communication will be echoed for debugging purposes. The default is *STANDARD-OUTPUT*.

Package

cl-ssdb

Source

connection.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: def-cmd CMD (&rest ARGS) REPLY-TYPE DOCSTRING

Define and export a function with the name <*CMD-REDIX*>-<CMD> for processing a SSDB command CMD. Here REPLY-TYPE is the expected reply format.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Macro: with-connection (&key HOST PORT AUTH) &body BODY

Evaluate BODY with the current connection bound to a new connection specified by the given HOST and PORT

Package

cl-ssdb

Source

connection.lisp (file)

Macro: with-persistent-connection (&key HOST PORT AUTH) &body BODY

Execute BODY inside WITH-CONNECTION. But if connection is broken due to SSDB-CONNECTION-ERROR (a network error or timeout), transparently reopen it.

Package

cl-ssdb

Source

connection.lisp (file)

Macro: with-pipelining &body BODY

Delay execution of EXPECT’s inside BODY to the end, so that all commands are first sent to the server and then their output is received and collected into a list. So commands return :PIPELINED instead of the expected results.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Macro: with-recursive-connection (&key HOST PORT AUTH) &body BODY

Execute BODY with *CONNECTION* bound to the default SSDB connection. If connection is already established, reuse it.

Package

cl-ssdb

Source

connection.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: add_allow_ip IP_RULE

Available since: 1.9.3

Add one allow ip rule.

Warning: After you have modify any allow/deny rule, you must modify both the configuration file! Or the rules will be reload from configuration file after you restart ssdb-server.

Parameters
rule - IP address filter rule, specify only the prefix, 127.0.1, 127.0, etc.

Return Value
Status reply.

Package

cl-ssdb

Source

commands.lisp (file)

Function: add_deny_ip IP_RULE

Available since: 1.9.3

Add one deny ip rule.

Warning: After you have modify any allow/deny rule, you must modify both the configuration file! Or the rules will be reload from configuration file after you restart ssdb-server.

Parameters
rule - IP address filter rule, specify only the prefix, 127.0.1, 127.0, etc.

Return Value
Status reply.

Package

cl-ssdb

Source

commands.lisp (file)

Function: auth PASS

Available since: 1.7.0.0

Authenticate the connection.

Warning: The password is sent in plain-text over the network!

Parameters
password - the password

Return Value
Status reply.

Package

cl-ssdb

Source

commands.lisp (file)

Function: bitcount KEY &optional START END

Count the number of set bits (population counting) in a string. Like Redis’s bitcount.
Parameters

key -
start - Optional, inclusive, if start is negative, count from start’th character from the end of string. unit: bytes end - Optional, inclusive. unit: bytes

Return Value
The number of bits set to 1.

Package

cl-ssdb

Source

commands.lisp (file)

Function: clear_binlog ()

Clear binlog, will get an "ok".
Note: It’s NOT a public command, but it works.

Package

cl-ssdb

Source

commands.lisp (file)

Function: close-connection CONN

Close the socket of CONN.

Package

cl-ssdb

Source

connection.lisp (file)

Function: compact ()

Compress database, will get an "ok".
Note: It’s NOT a public command, but it works.

Package

cl-ssdb

Source

commands.lisp (file)

Function: connect &key HOST PORT AUTH

Connect to SSDB server.

Package

cl-ssdb

Source

connection.lisp (file)

Function: connected-p ()

Is there a current connection?

Package

cl-ssdb

Source

connection.lisp (file)

Function: countbit KEY &optional START SIZE

Count the number of set bits (population counting) in a string. Unlike bitcount, it take part of the string by start and size, not start and end. Parameters

key -
start - Optional, inclusive, if start is negative, count from start’th character from the end of string.
size - Optional, if size is negative, then that many characters will be omitted from the end of string.

Return Value
The number of bits set to 1.

Package

cl-ssdb

Source

commands.lisp (file)

Function: dbsize ()

Return the approximate size of the database, in bytes. If compression is enabled, the size will be of the compressed data.

Return Value
Size in bytes.

Package

cl-ssdb

Source

commands.lisp (file)

Function: del KEY

Delete specified key.
Parameters

key -

Return Value
Status reply. You can not determine whether the key exists or not by delete command.

Package

cl-ssdb

Source

commands.lisp (file)

Function: del_allow_ip IP_RULE

Available since: 1.9.3

Delete one allow ip rule.

Warning: After you have modify any allow/deny rule, you must modify both the configuration file! Or the rules will be reload from configuration file after you restart ssdb-server.

Parameters
rule - IP address filter rule, specify only the prefix, 127.0.1, 127.0, etc.

Return Value
Status reply.

Package

cl-ssdb

Source

commands.lisp (file)

Function: del_deny_ip IP_RULE

Available since: 1.9.3

Delete one deny ip rule.

Warning: After you have modify any allow/deny rule, you must modify both the configuration file! Or the rules will be reload from configuration file after you restart ssdb-server.

Parameters
rule - IP address filter rule, specify only the prefix, 127.0.1, 127.0, etc.

Return Value
Status reply.

Package

cl-ssdb

Source

commands.lisp (file)

Function: disconnect ()

Disconnect from SSDB server.

Package

cl-ssdb

Source

connection.lisp (file)

Function: exists KEY

Verify if the specified key exists. Parameters

key -

Return Value
If the key exists, return 1, otherwise return 0.

Package

cl-ssdb

Source

commands.lisp (file)

Function: expire KEY TTL

Set the time left to live in seconds, only for keys of KV type.

Parameters
key -
ttl - number of seconds to live.

Return Value
If the key exists then ttl will be set/update, return 1, otherwise return 0.

Package

cl-ssdb

Source

commands.lisp (file)

Function: flushdb &optional DATA-TYPE

flushdb is NOT a standard command. But as ssdb-cli supported it as a client side command since 1.9.2, adding this command would be fine. It’s convenient for test.

Return Example:
10
("kv" . 1)
("hash" . 2)
("zset" . 3)
("list" . 4)

Package

cl-ssdb

Source

commands.lisp (file)

Function: get KEY

Get the value related to the specified key.

Parameters
key -

Return Value
Value reply.

Return the value to the key, if the key does not exists, return not_found Status Code.

Package

cl-ssdb

Source

commands.lisp (file)

Function: getbit KEY OFFSET

Return a single bit out of a string. Parameters

key -
offset - bit offset.

Return Value
0 or 1.

Package

cl-ssdb

Source

commands.lisp (file)

Function: getset KEY VALUE

Sets a value and returns the previous entry at that key.
Parameters

key -
value -

Return Value
If the key already exists, the value related to that key is returned. Otherwise return not_found Status Code. The value is either added or updated.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hclear NAME

Delete all keys in a hashmap. Parameters

name - The name of the hashmap.

Return Value
The number of key deleted in that hashmap.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hdel NAME KEY

Delete specified key of a hashmap. To delete the whole hashmap, use hclear. Parameters

name - The name of the hashmap
key - The key of the key-value pair in the hashmap

Return Value
If the key exists, return 1, otherwise return 0.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hexists NAME KEY

Verify if the specified key exists in a hashmap. Parameters

name - The name of the hashmap
key -

Return Value
If the key exists, return 1, otherwise return 0.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hget NAME KEY

Get the value related to the specified key of a hashmap
Parameters

name - The name of the hashmap
key - The key of the key-value pair in the hashmap

Return Value
Value reply.
Return the value to the key, if the key does not exists, return not_found Status Code.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hgetall NAME

Returns the whole hash, as an array of strings indexed by strings. Parameters

name - The name of the hashmap

Return Value
Key-Value list.
The key-value list is return as: k1 v1 k2 v2 ...

Package

cl-ssdb

Source

commands.lisp (file)

Function: hincr NAME KEY &optional NUM

Since 1.7.0.1, *incr methods return error if value cannot be converted to integer.
Increment the number stored at key in a hashmap by num. The num argument could be a negative integer. The old number is first converted to an integer before increment, assuming it was stored as literal integer. Parameters

name - the name of the hashmap
‘key -
num - Optional, must be a signed integer, default is 1

Return Value
The new value. If the old value cannot be converted to an integer, returns error Status Code.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hkeys NAME KEY_START KEY_END LIMIT

List keys of a hashmap in range (key_start, key_end].
("", ""] means no range limit.
Parameters

name - The name of the hashmap
key_start - The lower bound(not included) of keys to be returned, empty string means -inf(no limit). key_end - The upper bound(inclusive) of keys to be returned, empty string means +inf(no limit). limit - Up to that many elements will be returned.

Return Value
Key list.
The key list is return as: k1 k2 ...

Package

cl-ssdb

Source

commands.lisp (file)

Function: hlist NAME_START NAME_END LIMIT

List hashmap names in range (name_start, name_end].
("", ""] means no range limit.
Refer to scan command for more information about how it work.
Parameters

name_start - The lower bound(not included) of names to be returned, empty string means -inf(no limit). name_end - The upper bound(inclusive) of names to be returned, empty string means +inf(no limit). limit - Up to that many elements will be returned.

Return Value
Key-Value list.
The key-value list is return as: k1 v1 k2 v2 ...

Package

cl-ssdb

Source

commands.lisp (file)

Function: hrlist NAME_START NAME_END LIMIT

Like hlist, but in reverse order.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hrscan NAME KEY_START KEY_END LIMIT

Like hscan, but in reverse order.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hscan NAME KEY_START KEY_END LIMIT

List key-value pairs of a hashmap with keys in range (key_start, key_end].
("", ""] means no range limit.
Refer to scan command for more information about how it work.
Parameters

name - The name of the hashmap
key_start - The lower bound(not included) of keys to be returned, empty string means -inf(no limit). key_end - The upper bound(inclusive) of keys to be returned, empty string means +inf(no limit). limit - Up to that many pairs will be returned.

Return Value
Key-Value list.
The key-value list is return as: k1 v1 k2 v2 ...

Package

cl-ssdb

Source

commands.lisp (file)

Function: hset NAME KEY VALUE

Set the string value in argument as value of the key of a hashmap. Parameters

name - The name of the hashmap
key - The key of the key-value pair in the hashmap
value - The value of the key-value pair in the hashmap

Return Value
Returns 1 if key is a new key in the hashmap and value is set, else returns 0.

Package

cl-ssdb

Source

commands.lisp (file)

Function: hsize NAME

Return the number of key-value pairs in the hashmap. Parameters

name - The name of the hashmap

Return Value
Integer reply.

Package

cl-ssdb

Source

commands.lisp (file)

Function: incr KEY &optional NUM

Since 1.7.0.1, *incr methods return error if value cannot be converted to integer.
Increment the number stored at key by num. The num argument could be a negative integer. The old number is first converted to an integer before increment, assuming it was stored as literal integer. Parameters

key -
num - Optional, must be a signed integer, default is 1

Return Value
The new value. If the old value cannot be converted to an integer, returns error Status Code.

Package

cl-ssdb

Source

commands.lisp (file)

Function: info &optional OPT

Return information about the server.

Parameters
opt - Optional, could be cmd, leveldb

Return Value
Key-Value list.

The key-value list is return as: k1 v1 k2 v2 ...

Package

cl-ssdb

Source

commands.lisp (file)

Function: keys KEY_START KEY_END LIMIT

Refer to scan command for more information about how it work.

Parameters

Return Value
Return list of keys.

Package

cl-ssdb

Source

commands.lisp (file)

Function: list_allow_ip ()

Available since: 1.9.3

List all allow ip rules.

Parameters
None.

Return Value
List reply.

Package

cl-ssdb

Source

commands.lisp (file)

Function: list_deny_ip ()

Available since: 1.9.3

List all deny ip rules.

Parameters
None.

Return Value
List reply.

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_del &rest KEYS

Delete specified multiple keys. Parameters

key1 -
...

Return Value
false on error, other values indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_get &rest KEYS

Get the values related to the specified multiple keys
Parameters

key1 -
...

Return Value
Key-value list.
The keys not found will not be included in the reply, the key-value list is return as: k1 v1 k2 v2 ...

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_hdel NAME &rest KEYS

Delete specified multiple keys in a hashmap. Parameters

name -
key1 -
...

Return Value
false on error, other values indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_hget NAME &rest KEYS

Get the values related to the specified multiple keys of a hashmap.
Parameters

name -
key1 -
...

Return Value
Key-value list.
The keys not found will not be included in the reply, the key-value list is return as: k1 v1 k2 v2 ...

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_hset NAME &rest KEY-VALUE-PLIST

Set multiple key-value pairs(kvs) of a hashmap in one method call. Parameters

name -
key1 -
value1 -
...

Return Value
false on error, other values indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_set &rest KEY-VALUE-PLIST

Set multiple key-value pairs(kvs) in one method call. Parameters

key1 -
value1 -
...

Return Value
false on error, other values(count of keys) indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_zdel NAME &rest KEYS

Delete specified multiple keys of a zset. Parameters

name -
key1 -
...

Return Value
false on error, other values indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_zget NAME &rest KEYS

Get the values related to the specified multiple keys of a zset.
Parameters

name -
key1 -
...

Return Value
Key-value list.
The keys not found will not be included in the reply, the key-value list is return as: k1 v1 k2 v2 ...

Package

cl-ssdb

Source

commands.lisp (file)

Function: multi_zset NAME &rest KEY-SCORE-PLIST

Set multiple key-score pairs(kvs) of a zset in one method call. Parameters

name -
key1 -
score1 -
...

Return Value
false on error, other values indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: open-connection CONN

Create a socket connection to the host and port of CONNECTION and set the socket of CONN to the associated socket.

Package

cl-ssdb

Source

connection.lisp (file)

Function: ping ()

Ping server, will get an "ok", NOT a "pong". Note: It’s NOT a public command, but it works.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qback NAME

Returns the last element of a queue.
Parameters

name -

Return Value
false on error, null if queue empty, otherwise the item returned.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qclear NAME

Clear the queue. Parameters

name -

Return Value false on error.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qfront NAME

Returns the first element of a queue.
Parameters

name -

Return Value
false on error, null if queue empty, otherwise the item returned.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qget NAME INDEX

Returns the element a the specified index(position). 0 the first element, 1 the second ... -1 the last element. Parameters

name -
index - negative intexes accepted.

Return Value
false on error, null if no element corresponds to this index, otherwise the item returned.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qlist NAME_START NAME_END LIMIT

List list/queue names in range (name_start, name_end].
("", ""] means no range limit.
Refer to scan command for more information about how it work.

Parameters
name_start - The lower bound(not included) of names to be returned, empty string means -inf(no limit). name_end - The upper bound(inclusive) of names to be returned, empty string means +inf(no limit). limit - Up to that many elements will be returned.

Return Value
false on error, otherwise an array containing the names.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qpop NAME SIZE

Alias of qpop_front

Package

cl-ssdb

Source

commands.lisp (file)

Function: qpop_back NAME &optional SIZE

Pop out one or more elements from the tail of a queue.
Parameters

name -
size - Optional, number of elements to pop, default is 1

Return Value
false on error. When size is not specified or less than 2, returns null if queue empty, otherwise the item removed. When size is specified and greater than or equal to 2, returns an array of elements removed.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qpop_front NAME &optional SIZE

Pop out one or more elements from the head of a queue.
Parameters

name -
size - Optional, number of elements to pop, default is 1

Return Value
false on error. When size is not specified or less than 2, returns null if queue empty, otherwise the item removed. When size is specified and greater than or equal to 2, returns an array of elements removed.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qpush NAME &rest ITEMS

Alias of qpush_back

Package

cl-ssdb

Source

commands.lisp (file)

Function: qpush_back NAME &rest ITEMS

Add an or more than one element to the end of the queue. Parameters

name -
item1 -
...

Return Value
The length of the list after the push operation, false on error.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qpush_front NAME &rest ITEMS

Add one or more than one element to the head of the queue. Parameters

name -
item1 -
...

Return Value
The length of the list after the push operation, false on error.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qrange NAME OFFSET LIMIT

Returns a portion of elements from the queue at the specified range [offset, offset + limit]. Parameters

name -
offset -
limit -

Return Value
false on error, otherwise an array containing items.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qrlist NAME_START NAME_END LIMIT

Like qlist, but in reverse order.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qset NAME INDEX VAL

Sets the list element at index to value. An error is returned for out of range indexes. Parameters

name -
index - negative intexes accepted.
val -

Return Value
false on error, other values indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qsize NAME

Returns the number of items in the queue.
Parameters

name -

Return Value
false on error, otherwise an integer, 0 if the queue does not exist.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qslice NAME BEGIN END

Returns a portion of elements from the queue at the specified range [begin, end]. begin and end could be negative. Parameters

name -
begin -
end -

Return Value
false on error, otherwise an array containing items.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qtrim_back NAME SIZE

Remove multi elements from the tail of a queue. Parameters

name -
size - Number of elements to delete.

Return Value
false on error. Return the number of elements removed.

Package

cl-ssdb

Source

commands.lisp (file)

Function: qtrim_front NAME SIZE

Remove multi elements from the head of a queue. Parameters

name -
size - Number of elements to delete.

Return Value
false on error. Return the number of elements removed.

Package

cl-ssdb

Source

commands.lisp (file)

Function: reconnect ()

Close and reopen the connection to SSDB server.

Package

cl-ssdb

Source

connection.lisp (file)

Function: rkeys KEY_START KEY_END LIMIT

Since 1.9.0
Like keys, but in reverse order.

Package

cl-ssdb

Source

commands.lisp (file)

Function: rscan KEY_START KEY_END LIMIT

Like scan, but in reverse order.

Package

cl-ssdb

Source

commands.lisp (file)

Function: scan KEY_START KEY_END LIMIT

List key-value pairs with keys in range (key_start, key_end].
("", ""] means no range limit.
This command can do wildchar * like search, but only prefix search, and the * char must never occur in key_start and key_end! Parameters

key_start - The lower bound(not included) of keys to be returned, empty string means -inf(no limit).
key_end - The upper bound(inclusive) of keys to be returned, empty string means +inf(no limit).
limit - Up to that many pairs will be returned.

Return Value
false on error, otherwise an associative array containing the key-value pairs.

Package

cl-ssdb

Source

commands.lisp (file)

Function: set KEY VALUE

Set the value of the key.

Parameters
key -
value -

Return Value
false on error, other values indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: setbit KEY OFFSET VAL

Changes a single bit of a string. The string is auto expanded.
Parameters

key -
offset - bit offset, must in range of [0, 1073741824].
val - 0 or 1.

Return Value
The value of the bit before it was set: 0 or 1. If val is not 0 or 1, returns false.

Package

cl-ssdb

Source

commands.lisp (file)

Function: setnx KEY VALUE

Set the string value in argument as value of the key if and only if the key doesn’t exist.

Parameters
key -
value -

Return Value
1: value is set, 0: key already exists.

Package

cl-ssdb

Source

commands.lisp (file)

Function: setx KEY VALUE TTL

Set the value of the key, with a time to live.

Unlike Redis, the ttl will not be remove when later set the same key!

Parameters
key -
value -
ttl - number of seconds to live.

Return Value
false on error, other values indicate OK.

Package

cl-ssdb

Source

commands.lisp (file)

Function: strlen KEY

Return the number of bytes of a string.
Parameters

key -

Return Value
The number of bytes of the string, if key not exists, returns 0.

Package

cl-ssdb

Source

commands.lisp (file)

Function: substr KEY START SIZE

Return part of a string, like PHP’s substr() function.
Parameters

key -
start - Optional, the offset of first byte returned. If start is negative, the returned string will start at the start’th character from the end of string. size - Optional, number of bytes returned. If size is negative, then that many characters will be omitted from the end of string.

Return Value
The extracted part of the string.

Package

cl-ssdb

Source

commands.lisp (file)

Function: ttl KEY

Returns the time left to live in seconds, only for keys of KV type.

Parameters
key -

Return Value
Time to live of the key, in seconds, -1 if there is no associated expire to the key.

Package

cl-ssdb

Source

commands.lisp (file)

Function: zavg NAME SCORE_START SCORE_END

Returns the average of elements of the sorted set stored at the specified key which have scores in the range [start,end]. Parameters

name - The name of the zset.
score_start - The minimum score related to keys(inclusive), empty string means -inf(no limit).
score_end - The maximum score related to keys(inclusive), empty string means +inf(no limit).

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zclear NAME

Delete all keys in a zset. Parameters

name - Name of the zset

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zcount NAME SCORE_START SCORE_END

Returns the number of elements of the sorted set stored at the specified key which have scores in the range [start,end]. Parameters

name - The name of the zset.
score_start - The minimum score related to keys(inclusive), empty string means -inf(no limit).
score_end - The maximum score related to keys(inclusive), empty string means +inf(no limit).

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zdel NAME KEY

Delete specified key of a zset. Parameters

name - Name of the zset
key -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zexists NAME KEY

Verify if the specified key exists in a zset. Parameters

name - Name of the zset
key -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zget NAME KEY

Get the score related to the specified key of a zset Parameters

name - Name of the zset
key -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zincr NAME KEY NUM

Increment the number stored at key in a zset by num. Parameters

name - Name of the zset
key -
num - Must be a signed integer.

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zkeys NAME KEY_START SCORE_START SCORE_END LIMIT

List keys in a zset. Parameters

name - Name of the zset key_start - score_start - score_end -
limit -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zlist NAME_START NAME_END LIMIT

List zset names in range (name_start, name_end].
Refer to scan command for more information about how it work. Parameters

name - Name of the zset
name_start -
name_end -
limit -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zpop_back NAME LIMIT

Since 1.9.0
Delete and return limit element(s) from back of the zset. Parameters

name - The name of the zset
limit -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zpop_front NAME LIMIT

Since 1.9.0
Delete and return limit element(s) from front of the zset. Parameters

name - The name of the zset
limit -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zrange NAME OFFSET LIMIT

Returns a range of key-score pairs by index range [offset, offset + limit). Parameters

name - Name of the zset
offset - Positive integer, the returned pairs will start at this offset. limit - Positive integer, up to this number of pairs will be returned.

Return Value
key-score list

Package

cl-ssdb

Source

commands.lisp (file)

Function: zrank NAME KEY

Returns the rank(index) of a given key in the specified sorted set. Parameters

name - Name of the zset
key -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zremrangebyrank NAME START END

Delete the elements of the zset which have rank in the range [start,end]. Parameters

name - Name of the zset

Return Value
count of deleted keys

Package

cl-ssdb

Source

commands.lisp (file)

Function: zremrangebyscore NAME START END

Delete the elements of the zset which have score in the range [start,end]. Parameters

name - Name of the zset

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zrlist NAME_START NAME_END LIMIT

List zset names in range (name_start, name_end], in reverse order. Parameters

name - Name of the zset
name_start -
name_end -
limit -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zrrange NAME OFFSET LIMIT

Returns a range of key-score pairs by index range [offset, offset + limit), in reverse order. Parameters

name - Name of the zset

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zrrank NAME KEY

Returns the rank(index) of a given key in the specified sorted set, in reverse order. Parameters

name - Name of the zset

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zrscan NAME KEY_START SCORE_START SCORE_END LIMIT

List key-score pairs of a zset, in reverse order. See method zkeys(). Parameters

name - Name of the zset

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zscan NAME KEY_START SCORE_START SCORE_END LIMIT

List key-score pairs where key-score in range (key_start+score_start, score_end]. Refer to scan command for more information about how it work.
Parameters

name - Name of the zset

Return Value
key-score list

Package

cl-ssdb

Source

commands.lisp (file)

Function: zset NAME KEY SCORE

Set the score of the key of a zset. Parameters

name - Name of the zset
key -
score -

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zsize NAME

Return the number of pairs of a zset. Parameters

name - The name of the zset

Return Value

Package

cl-ssdb

Source

commands.lisp (file)

Function: zsum NAME SCORE_START SCORE_END

Returns the sum of elements of the sorted set stored at the specified key which have scores in the range [start,end]. Parameters

name - The name of the zset.
score_start - The minimum score related to keys(inclusive), empty string means -inf(no limit).
score_end - The maximum score related to keys(inclusive), empty string means +inf(no limit).

Return Value

Package

cl-ssdb

Source

commands.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: tell CMD &rest ARGS

Send a command to SSDB server over a socket connection.
CMD is the command name (a string or a symbol), and ARGS are its arguments (keyword arguments are also supported).

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Methods
Method: tell CMD &rest ARGS
Method: tell CMD &rest ARGS after

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: ssdb-bad-reply ()

SSDB protocol error is detected.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Direct superclasses

ssdb-error (condition)

Condition: ssdb-connection-error ()

Conditions of this type are signaled when errors occur
that break the connection stream. They offer a :RECONNECT restart.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Direct superclasses

ssdb-error (condition)

Condition: ssdb-error ()

Any SSDB-related error.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods
Direct slots
Slot: error
Initargs

:error

Initform

(quote nil)

Readers

ssdb-error-error (generic function)

Slot: message
Initargs

:message

Initform

(quote nil)

Readers

ssdb-error-message (generic function)

Condition: ssdb-error-reply ()

Error reply is received from SSDB server.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Direct superclasses

ssdb-error (condition)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 Classes

Class: ssdb-connection ()

Representation of a SSDB connection.

Package

cl-ssdb

Source

connection.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: host
Initargs

:host

Initform

cl-ssdb::+default-host+

Readers

conn-host (generic function)

Slot: port
Initargs

:port

Initform

cl-ssdb::+default-port+

Readers

conn-port (generic function)

Slot: auth
Initargs

:auth

Readers

conn-auth (generic function)

Slot: socket
Readers

conn-socket (generic function)

Writers

(setf conn-socket) (generic function)

Slot: stream
Readers

conn-stream (generic function)

Writers

(setf conn-stream) (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +default-host+
Package

cl-ssdb

Source

connection.lisp (file)

Constant: +default-port+
Package

cl-ssdb

Source

connection.lisp (file)

Constant: +utf8+
Package

cl-ssdb

Source

connection.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *cmd-prefix*

Prefix for functions names that implement SSDB commands.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Special Variable: *pipeline*

A list of expected results from the current pipeline.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Special Variable: *pipelined*

Indicates, that commands are sent in pipelined mode.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: defconstant NAME VALUE &optional DOC

Make sure VALUE is evaluated only once (to appease SBCL).

Package

cl-ssdb

Source

connection.lisp (file)

Macro: reconnect-restart-case (&key ERROR COMMENT) &body BODY

Signal the condition of type SSDB-CONNECTION-ERROR denoted by
the given ERROR and COMMENT offering a :RECONNECT restart to re-evaluate BODY.

Package

cl-ssdb

Source

connection.lisp (file)

Macro: with-reconnect-restart &body BODY

When, during the execution of BODY, an error occurs that breaks the connection, a SSDB-CONNECTION-ERROR is signalled, offering a :RECONNECT restart that will re-evaluate body after the conenction is re-established.

Package

cl-ssdb

Source

connection.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: connection-open-p CONN

Is the socket of CONNECTION open?

Package

cl-ssdb

Source

connection.lisp (file)

Function: ensure-string OBJ
Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Function: receive ()
Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Function: reopen-connection CONN

Close and reopen CONN.

Package

cl-ssdb

Source

connection.lisp (file)

Function: version ()

Return SSDB Server’s version string. Note: it is NOT a standard command.

Package

cl-ssdb

Source

commands.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Generic functions

Generic Function: conn-auth OBJECT
Package

cl-ssdb

Methods
Method: conn-auth (SSDB-CONNECTION ssdb-connection)

automatically generated reader method

Source

connection.lisp (file)

Generic Function: conn-host OBJECT
Package

cl-ssdb

Methods
Method: conn-host (SSDB-CONNECTION ssdb-connection)

automatically generated reader method

Source

connection.lisp (file)

Generic Function: conn-port OBJECT
Package

cl-ssdb

Methods
Method: conn-port (SSDB-CONNECTION ssdb-connection)

automatically generated reader method

Source

connection.lisp (file)

Generic Function: conn-socket OBJECT
Generic Function: (setf conn-socket) NEW-VALUE OBJECT
Package

cl-ssdb

Methods
Method: conn-socket (SSDB-CONNECTION ssdb-connection)

automatically generated reader method

Source

connection.lisp (file)

Method: (setf conn-socket) NEW-VALUE (SSDB-CONNECTION ssdb-connection)

automatically generated writer method

Source

connection.lisp (file)

Generic Function: conn-stream OBJECT
Generic Function: (setf conn-stream) NEW-VALUE OBJECT
Package

cl-ssdb

Methods
Method: conn-stream (SSDB-CONNECTION ssdb-connection)

automatically generated reader method

Source

connection.lisp (file)

Method: (setf conn-stream) NEW-VALUE (SSDB-CONNECTION ssdb-connection)

automatically generated writer method

Source

connection.lisp (file)

Generic Function: expect TYPE

Receive and process the reply of the given type from SSDB server.

Package

cl-ssdb

Source

cl-ssdb.lisp (file)

Methods
Method: expect (TYPE (eql end))
Method: expect (TYPE (eql bulk))

Receive and process data reply, which is just a string.

Method: expect (TYPE (eql list))

Receive and process data reply, which is a list of string.

Method: expect (TYPE (eql boolean))
Method: expect (TYPE (eql number))
Method: expect (TYPE (eql integer))
Method: expect (TYPE (eql status))

Receive and process status reply, which is just a string.

Method: expect TYPE around
Generic Function: ssdb-error-error CONDITION
Package

cl-ssdb

Methods
Method: ssdb-error-error (CONDITION ssdb-error)
Source

cl-ssdb.lisp (file)

Generic Function: ssdb-error-message CONDITION
Package

cl-ssdb

Methods
Method: ssdb-error-message (CONDITION ssdb-error)
Source

cl-ssdb.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-ssdb.asd: The cl-ssdb<dot>asd file
cl-ssdb/cl-ssdb.lisp: The cl-ssdb/cl-ssdb<dot>lisp file
cl-ssdb/commands.lisp: The cl-ssdb/commands<dot>lisp file
cl-ssdb/connection.lisp: The cl-ssdb/connection<dot>lisp file
cl-ssdb/packages.lisp: The cl-ssdb/packages<dot>lisp file

F
File, Lisp, cl-ssdb.asd: The cl-ssdb<dot>asd file
File, Lisp, cl-ssdb/cl-ssdb.lisp: The cl-ssdb/cl-ssdb<dot>lisp file
File, Lisp, cl-ssdb/commands.lisp: The cl-ssdb/commands<dot>lisp file
File, Lisp, cl-ssdb/connection.lisp: The cl-ssdb/connection<dot>lisp file
File, Lisp, cl-ssdb/packages.lisp: The cl-ssdb/packages<dot>lisp file

L
Lisp File, cl-ssdb.asd: The cl-ssdb<dot>asd file
Lisp File, cl-ssdb/cl-ssdb.lisp: The cl-ssdb/cl-ssdb<dot>lisp file
Lisp File, cl-ssdb/commands.lisp: The cl-ssdb/commands<dot>lisp file
Lisp File, cl-ssdb/connection.lisp: The cl-ssdb/connection<dot>lisp file
Lisp File, cl-ssdb/packages.lisp: The cl-ssdb/packages<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   K   L   M   O   P   Q   R   S   T   V   W   Z  
Index Entry  Section

(
(setf conn-socket): Internal generic functions
(setf conn-socket): Internal generic functions
(setf conn-stream): Internal generic functions
(setf conn-stream): Internal generic functions

A
add_allow_ip: Exported functions
add_deny_ip: Exported functions
auth: Exported functions

B
bitcount: Exported functions

C
clear_binlog: Exported functions
close-connection: Exported functions
compact: Exported functions
conn-auth: Internal generic functions
conn-auth: Internal generic functions
conn-host: Internal generic functions
conn-host: Internal generic functions
conn-port: Internal generic functions
conn-port: Internal generic functions
conn-socket: Internal generic functions
conn-socket: Internal generic functions
conn-stream: Internal generic functions
conn-stream: Internal generic functions
connect: Exported functions
connected-p: Exported functions
connection-open-p: Internal functions
countbit: Exported functions

D
dbsize: Exported functions
def-cmd: Exported macros
defconstant: Internal macros
del: Exported functions
del_allow_ip: Exported functions
del_deny_ip: Exported functions
disconnect: Exported functions

E
ensure-string: Internal functions
exists: Exported functions
expect: Internal generic functions
expect: Internal generic functions
expect: Internal generic functions
expect: Internal generic functions
expect: Internal generic functions
expect: Internal generic functions
expect: Internal generic functions
expect: Internal generic functions
expect: Internal generic functions
expire: Exported functions

F
flushdb: Exported functions
Function, add_allow_ip: Exported functions
Function, add_deny_ip: Exported functions
Function, auth: Exported functions
Function, bitcount: Exported functions
Function, clear_binlog: Exported functions
Function, close-connection: Exported functions
Function, compact: Exported functions
Function, connect: Exported functions
Function, connected-p: Exported functions
Function, connection-open-p: Internal functions
Function, countbit: Exported functions
Function, dbsize: Exported functions
Function, del: Exported functions
Function, del_allow_ip: Exported functions
Function, del_deny_ip: Exported functions
Function, disconnect: Exported functions
Function, ensure-string: Internal functions
Function, exists: Exported functions
Function, expire: Exported functions
Function, flushdb: Exported functions
Function, get: Exported functions
Function, getbit: Exported functions
Function, getset: Exported functions
Function, hclear: Exported functions
Function, hdel: Exported functions
Function, hexists: Exported functions
Function, hget: Exported functions
Function, hgetall: Exported functions
Function, hincr: Exported functions
Function, hkeys: Exported functions
Function, hlist: Exported functions
Function, hrlist: Exported functions
Function, hrscan: Exported functions
Function, hscan: Exported functions
Function, hset: Exported functions
Function, hsize: Exported functions
Function, incr: Exported functions
Function, info: Exported functions
Function, keys: Exported functions
Function, list_allow_ip: Exported functions
Function, list_deny_ip: Exported functions
Function, multi_del: Exported functions
Function, multi_get: Exported functions
Function, multi_hdel: Exported functions
Function, multi_hget: Exported functions
Function, multi_hset: Exported functions
Function, multi_set: Exported functions
Function, multi_zdel: Exported functions
Function, multi_zget: Exported functions
Function, multi_zset: Exported functions
Function, open-connection: Exported functions
Function, ping: Exported functions
Function, qback: Exported functions
Function, qclear: Exported functions
Function, qfront: Exported functions
Function, qget: Exported functions
Function, qlist: Exported functions
Function, qpop: Exported functions
Function, qpop_back: Exported functions
Function, qpop_front: Exported functions
Function, qpush: Exported functions
Function, qpush_back: Exported functions
Function, qpush_front: Exported functions
Function, qrange: Exported functions
Function, qrlist: Exported functions
Function, qset: Exported functions
Function, qsize: Exported functions
Function, qslice: Exported functions
Function, qtrim_back: Exported functions
Function, qtrim_front: Exported functions
Function, receive: Internal functions
Function, reconnect: Exported functions
Function, reopen-connection: Internal functions
Function, rkeys: Exported functions
Function, rscan: Exported functions
Function, scan: Exported functions
Function, set: Exported functions
Function, setbit: Exported functions
Function, setnx: Exported functions
Function, setx: Exported functions
Function, strlen: Exported functions
Function, substr: Exported functions
Function, ttl: Exported functions
Function, version: Internal functions
Function, zavg: Exported functions
Function, zclear: Exported functions
Function, zcount: Exported functions
Function, zdel: Exported functions
Function, zexists: Exported functions
Function, zget: Exported functions
Function, zincr: Exported functions
Function, zkeys: Exported functions
Function, zlist: Exported functions
Function, zpop_back: Exported functions
Function, zpop_front: Exported functions
Function, zrange: Exported functions
Function, zrank: Exported functions
Function, zremrangebyrank: Exported functions
Function, zremrangebyscore: Exported functions
Function, zrlist: Exported functions
Function, zrrange: Exported functions
Function, zrrank: Exported functions
Function, zrscan: Exported functions
Function, zscan: Exported functions
Function, zset: Exported functions
Function, zsize: Exported functions
Function, zsum: Exported functions

G
Generic Function, (setf conn-socket): Internal generic functions
Generic Function, (setf conn-stream): Internal generic functions
Generic Function, conn-auth: Internal generic functions
Generic Function, conn-host: Internal generic functions
Generic Function, conn-port: Internal generic functions
Generic Function, conn-socket: Internal generic functions
Generic Function, conn-stream: Internal generic functions
Generic Function, expect: Internal generic functions
Generic Function, ssdb-error-error: Internal generic functions
Generic Function, ssdb-error-message: Internal generic functions
Generic Function, tell: Exported generic functions
get: Exported functions
getbit: Exported functions
getset: Exported functions

H
hclear: Exported functions
hdel: Exported functions
hexists: Exported functions
hget: Exported functions
hgetall: Exported functions
hincr: Exported functions
hkeys: Exported functions
hlist: Exported functions
hrlist: Exported functions
hrscan: Exported functions
hscan: Exported functions
hset: Exported functions
hsize: Exported functions

I
incr: Exported functions
info: Exported functions

K
keys: Exported functions

L
list_allow_ip: Exported functions
list_deny_ip: Exported functions

M
Macro, def-cmd: Exported macros
Macro, defconstant: Internal macros
Macro, reconnect-restart-case: Internal macros
Macro, with-connection: Exported macros
Macro, with-persistent-connection: Exported macros
Macro, with-pipelining: Exported macros
Macro, with-reconnect-restart: Internal macros
Macro, with-recursive-connection: Exported macros
Method, (setf conn-socket): Internal generic functions
Method, (setf conn-stream): Internal generic functions
Method, conn-auth: Internal generic functions
Method, conn-host: Internal generic functions
Method, conn-port: Internal generic functions
Method, conn-socket: Internal generic functions
Method, conn-stream: Internal generic functions
Method, expect: Internal generic functions
Method, expect: Internal generic functions
Method, expect: Internal generic functions
Method, expect: Internal generic functions
Method, expect: Internal generic functions
Method, expect: Internal generic functions
Method, expect: Internal generic functions
Method, expect: Internal generic functions
Method, ssdb-error-error: Internal generic functions
Method, ssdb-error-message: Internal generic functions
Method, tell: Exported generic functions
Method, tell: Exported generic functions
multi_del: Exported functions
multi_get: Exported functions
multi_hdel: Exported functions
multi_hget: Exported functions
multi_hset: Exported functions
multi_set: Exported functions
multi_zdel: Exported functions
multi_zget: Exported functions
multi_zset: Exported functions

O
open-connection: Exported functions

P
ping: Exported functions

Q
qback: Exported functions
qclear: Exported functions
qfront: Exported functions
qget: Exported functions
qlist: Exported functions
qpop: Exported functions
qpop_back: Exported functions
qpop_front: Exported functions
qpush: Exported functions
qpush_back: Exported functions
qpush_front: Exported functions
qrange: Exported functions
qrlist: Exported functions
qset: Exported functions
qsize: Exported functions
qslice: Exported functions
qtrim_back: Exported functions
qtrim_front: Exported functions

R
receive: Internal functions
reconnect: Exported functions
reconnect-restart-case: Internal macros
reopen-connection: Internal functions
rkeys: Exported functions
rscan: Exported functions

S
scan: Exported functions
set: Exported functions
setbit: Exported functions
setnx: Exported functions
setx: Exported functions
ssdb-error-error: Internal generic functions
ssdb-error-error: Internal generic functions
ssdb-error-message: Internal generic functions
ssdb-error-message: Internal generic functions
strlen: Exported functions
substr: Exported functions

T
tell: Exported generic functions
tell: Exported generic functions
tell: Exported generic functions
ttl: Exported functions

V
version: Internal functions

W
with-connection: Exported macros
with-persistent-connection: Exported macros
with-pipelining: Exported macros
with-reconnect-restart: Internal macros
with-recursive-connection: Exported macros

Z
zavg: Exported functions
zclear: Exported functions
zcount: Exported functions
zdel: Exported functions
zexists: Exported functions
zget: Exported functions
zincr: Exported functions
zkeys: Exported functions
zlist: Exported functions
zpop_back: Exported functions
zpop_front: Exported functions
zrange: Exported functions
zrank: Exported functions
zremrangebyrank: Exported functions
zremrangebyscore: Exported functions
zrlist: Exported functions
zrrange: Exported functions
zrrank: Exported functions
zrscan: Exported functions
zscan: Exported functions
zset: Exported functions
zsize: Exported functions
zsum: Exported functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   K   L   M   O   P   Q   R   S   T   V   W   Z  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
A   C   E   H   M   P   S  
Index Entry  Section

*
*cmd-prefix*: Internal special variables
*connection*: Exported special variables
*echo-p*: Exported special variables
*echo-stream*: Exported special variables
*pipeline*: Internal special variables
*pipelined*: Internal special variables

+
+default-host+: Internal constants
+default-port+: Internal constants
+utf8+: Internal constants

A
auth: Exported classes

C
Constant, +default-host+: Internal constants
Constant, +default-port+: Internal constants
Constant, +utf8+: Internal constants

E
error: Exported conditions

H
host: Exported classes

M
message: Exported conditions

P
port: Exported classes

S
Slot, auth: Exported classes
Slot, error: Exported conditions
Slot, host: Exported classes
Slot, message: Exported conditions
Slot, port: Exported classes
Slot, socket: Exported classes
Slot, stream: Exported classes
socket: Exported classes
Special Variable, *cmd-prefix*: Internal special variables
Special Variable, *connection*: Exported special variables
Special Variable, *echo-p*: Exported special variables
Special Variable, *echo-stream*: Exported special variables
Special Variable, *pipeline*: Internal special variables
Special Variable, *pipelined*: Internal special variables
stream: Exported classes

Jump to:   *   +  
A   C   E   H   M   P   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-ssdb: The cl-ssdb system
cl-ssdb: The cl-ssdb package
Class, ssdb-connection: Exported classes
Condition, ssdb-bad-reply: Exported conditions
Condition, ssdb-connection-error: Exported conditions
Condition, ssdb-error: Exported conditions
Condition, ssdb-error-reply: Exported conditions

P
Package, cl-ssdb: The cl-ssdb package

S
ssdb-bad-reply: Exported conditions
ssdb-connection: Exported classes
ssdb-connection-error: Exported conditions
ssdb-error: Exported conditions
ssdb-error-reply: Exported conditions
System, cl-ssdb: The cl-ssdb system

Jump to:   C   P   S