Skip to content
Branch: master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
doc
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

RediSQL: Fast, in memory, SQL. With Batteries included.

Gitter GitHub All Releases Docker Pulls Docker Pulls

RediSQL Logo

RediSQL is the Fast, in-memory, SQL engine with batteries included.

It provides several benefits for your application.

  1. Fast, it can top up to 130k inserts per second.
  2. Familiar, it works with standard SQL, no weird dialect or syntax to learn.
  3. Easy to Operate, it is based on Redis, just start the standard Redis binary and and pass the RediSQL binary.
  4. Easy to Use, being based on Redis there are already bindings for any language.

Jump start

RediSQL tutorial

You can follow the video above and the whole tutorial on the documentation.

We provide a demo machine at demo.redisql.com.

redis-cli -h demo.redisql.com

Or with docker

docker run -it redis redis-cli -h demo.redisql.com

Use cases

There are several use cases for RediSQL.

RediSQL to store Transient Data

RediSQL is wonderful for transient data. With supports for lightweights DBs, you can just store all the data that are important now, and trash them all together as soon as they are not necessary anymore.

RediSQL as main database

The product is stable, it does not lose data. Moreover RediSQL supports all the persistency features of Redis, hence RDB and AOF are both fully supported.

Much more to explore...

There are a lot of features in RediSQL that are worth exploring more. Here are short explanations of those features.

Lightweight DBs

RediSQL provides you with lightweight in-memory databases. It could completely shift your architecture. For example, you could create a new isolated database each day, one for each application tenant, or even one per user.

On disk storage

While RediSQL focuses on in-memory database, it can also store data in a regular file. Of course this makes operations slower, but it allows RediSQL to reach a level of data persistency on par with incumbent databases such as Postgres or MySQL.

Copy of DBs

With the concept of lightweight databases, it becomes necessary to have a way to duplicate your database. Indeed it is possible to copy a database into another one. This allows several interesting patterns. For example, you could copy an in-memory database into a file-backed database and then ship the file for storage or other analysis. Another pattern would be to copy a heavy read database into another for load balancing reasons. Moreover you may use the copy function to keep a "base-database" to grow when new data comes in.

Directly expose the DB to users

With the ability to create several lightweight databases, and the capability to copy those database, you could directly expose the databases to the end users instead of exposing an API that you would need to maintain. Just load all the data that the user may need into a RediSQL database, document the tables that are available, and give access to it to the users. They will write their own API without waiting on you.

Stream and cache query results

RediSQL can also store results of queries into a Redis Streams. This allows different clients to consume part of the result, or to delay the consuption of a result. Moreover, it allows caching the result of expensive queries as Redis Streams to consume them over and over again.

Complete JSON support

JSON is the de-facto standard for sharing data between applications. RediSQL exploits the JSON1 module of SQLite to bring that capability to easy and quickly manage JSON data inside SQL statements and tables. In RediSQL you are able to manipulate JSON in every standard way.

Full text search support

RediSQL fully supports also the FTS{3,4,5} engine from SQLite, giving you a full text engine at your fingertip. You will be able to manage and search for data.

Getting started

RediSQL is a Redis module, hence you will need a modern version of Redis (> 5.0) and the RediSQL .so file.

You can obtain RediSQL directly from our store.

Alternative you can download the module from github release.

Finally you could compile the source yourself, simpy with cargo build --release from the root of the project.

To start RediSQL you simply pass it as paramenter to the redis binary.

./redis-server --loadmodule /path/to/RediSQL.so 

At this point you have your standard redis instance working as you would expect plus all the RediSQL interface.

All the commands are documented in the references.

To explore RediSQL you can use the official client redis-cli which it will connect to the running server.

The free version requires connection to our servers, make sure to set up your firewall appropriately.

Docker image

Moreover, also a Docker image is provide. Is sufficient to run the image siscia/redisql to start the Redis server with RediSQL loaded.

$ docker run -it --net host siscia/redisql

The siscia/redisql image provides also the redis-cli client:

$ docker run -it --net host siscia/redisql redis-cli

Tutorials and walkthrought

We create a few tutorial to guide you on using RediSQL with Node.js, Go(lang) and Python:

Please open an issue and request a tutorial for any other language you are intereted in.

The fastest way to explore RediSQL is using the redis-cli.

$ ~/redis-4.0-rc1/src/redis-cli 
127.0.0.1:6379> 
127.0.0.1:6379> SET A 3
OK
127.0.0.1:6379> GET A
"3"
# Great, still the old good redis we know, but now with extra commands.
127.0.0.1:6379> REDISQL.CREATE_DB DB
OK
# Start creating a table on the default DB
127.0.0.1:6379> REDISQL.EXEC DB "CREATE TABLE foo(A INT, B TEXT);"
DONE
# Insert some data into the table
127.0.0.1:6379> REDISQL.EXEC DB "INSERT INTO foo VALUES(3, 'bar');"
OK
# Retrieve the data you just inserted
127.0.0.1:6379> REDISQL.EXEC DB "SELECT * FROM foo;"
1) 1) (integer) 3
   2) "bar"
# Of course you can make multiple tables
127.0.0.1:6379> REDISQL.EXEC DB "CREATE TABLE baz(C INT, B TEXT);"
OK
127.0.0.1:6379> REDISQL.EXEC DB "INSERT INTO baz VALUES(3, 'aaa');"
OK
127.0.0.1:6379> REDISQL.EXEC DB "INSERT INTO baz VALUES(3, 'bbb');"
OK
127.0.0.1:6379> REDISQL.EXEC DB "INSERT INTO baz VALUES(3, 'ccc');"
OK
# And of course you can use joins
127.0.0.1:6379> REDISQL.EXEC DB "SELECT * FROM foo, baz WHERE foo.A = baz.C;"

1) 1) (integer) 3
   2) "bar"
   3) (integer) 3
   4) "aaa"
2) 1) (integer) 3
   2) "bar"
   3) (integer) 3
   4) "bbb"
3) 1) (integer) 3
   2) "bar"
   3) (integer) 3
   4) "ccc"
127.0.0.1:6379> 

Telemetrics and commercial product

From version 1.0.0 we move away from an open-core model where some features where not released as open source to a different model that force not-paying user to send telemetrics data to our servers. This allow us to release all the features of RediSQL as open source while retaining our possibilities to fund the project. The full announcement on our blog.

Of course the telemetrics data are not sensible (it is the result of the REDISQL.STATISTICS command) and we took all the precaution to allow smooth operation of the telementrics, more details in the technical blog post.

The main idea behind forced telemetrics is that small users won’t be bothered by them too much. Moreover they usually have the resource, knowledge and will to set up their own firewall and invest time instead of money.

All the other users can instead use the PRO version, the PRO version does not requires any connectivity to our servers, all the telemetrics part is simply not compiled into the code.

We hope to have strike a good balance with this new policy.

For a company is a bargain to just paid to don’t have one more thing to keep track of.

For small users we allow them to use all the PRO features of RediSQL while just requiring a little more time and attention, of course small users can purchase the PRO version as well.

The PRO version -- no telemetrics required -- version of RediSQL can be purchased on our store.

Documentation

The complete API are explained in the official documentation that you can access here: API References

Community and contribution

This project is very open about accepting pull request and answer to issues.

Moreover we encourage users to report any kind of issue, problem or possible ergonomic improvements.

We encorage user feedback and contribution with a free copy of RediSQL PRO.

Chat on gitter: Gitter

For any other information feel free to write me directly: simone@redbeardlab.com

For any comment, idea or solution on any of the issues with label "PRO version if contribution", you will receive a free copy of the latest RediSQL version released.

Troubleshooting

This section will explain how to overcome the most common problem when running RediSQL.

If you find and report other problem, you will be rewarded with a copy of the PRO version of RediSQL.

Impossible to send telemetrics

RediSQL doesn't start and show this lines:

[2019-05-06T21:29:00Z WARN  telemetrics] Warning, impossible to send the telemetrics.
[2019-05-06T21:29:00Z ERROR telemetrics] Telemetrics not reachables, exit!

This error means that you are using the free edition of RediSQL which need to comunicate with the telemetric servers. In this case was not possible for RediSQL to establish a connection to the server, hence RediSQL refuse to start.

If you are running RediSQL inside docker, likely you forgot to pass the flag: --net=host that in this case is necessary. Another culprint could be the fiewall of your host, make sure that you are able to do HTTPS request from your server.

A simple test in this case is to use curl to get the main page from Google: curl google.com. If curl does return an error is a good clue that you may not have outbound HTTP connectivity.

License and commercial product

This software is released under a custom license inspired by the MIT License.

The "RediSQL License" add one clause to the MIT license that simply requires that you leave the telemetrics alone.

It is possible to purchase more permissive licenses.

<RediSQL, SQL steroids for Redis.> Copyright (C) 2019 Simone Mosciatti

You can’t perform that action at this time.