redis
  1. redis
    1. Description
    2. Dependencies
    3. API
      1. Exceptions
      2. Connection Management
      3. Running Commands
      4. Supported Data Types
    4. About this egg
      1. Source
      2. Author
      3. Version History
      4. License

Description

A library to access, read, and write a redis database.

Dependencies

SRFIs 34, 35, 69, 99, 113, 128, 133, 152, and 158.

API

Exceptions

This library defines an SRFI-35 exception type &redis-error that gets raised when Redis returns an error. The exception type has a single field called redis-error-message containing the error message returned by Redis.

Connection Management

This egg currently uses a simple TCP connection without any "bells and whistles". The two ports are kept in a record of type redis-connection in the fields input and output.

[procedure] (redis-connect host port #!optional (protocol-version 1))

Connects to a (hopefully) Redis server at host:port, using the given protocol version. Defaults, like Redis itself, to version 1.

[procedure] (redis-disconnect rconn)

Disconnects from rconn which must be a redis-connection.

Running Commands

[procedure] (redis-run rconn command . args)

Uses connection rconn to run command with args. The args will be appended to the command, space-separated. Returns the parsed reply.

[procedure] (redis-run-proc rconn proc . args)

Calls proc with the output port of the rconn as current output port, optionally with args. Returns the parsed reply.

Supported Data Types

This Redis client supports all data types up to and including as specified in RESP3. For details, see https://gitea.lyrion.ch/Chicken/redis.

About this egg

Source

The source code is hosted at https://gitea.lyrion.ch/Chicken/redis.

Author

Daniel Ziltener

Version History
0.6
Easier Protocol Version Setting
0.5
Initial Release

License

 
 Copyright (C) 2022-2024 Daniel Ziltener
 
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
     * Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
     * Neither the name of the <organization> nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.