Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/delano/redis-dump

Backup and restore your Redis data to and from JSON.
https://github.com/delano/redis-dump

Last synced: 3 months ago
JSON representation

Backup and restore your Redis data to and from JSON.

Lists

README 

        
= Redis-Dump v0.4 BETA



Backup and restore your Redis data to and from JSON.



NOTE: This is beta software. TEST IT BEFORE RELYING ON IT.



== Usage



There are two executables: redis-dump and redis-load.



    $ redis-dump

    $ redis-dump -u 127.0.0.1:6371 > db_full.json

    $ redis-dump -u 127.0.0.1:6371 -d 15 > db_db15.json



    $ < db_full.json redis-load

    $ < db_db15.json redis-load -d 15

    # OR

    $ cat db_full | redis-load

    $ cat db_db15.json | redis-load -d 15



    # You can specify the redis URI via an environment variable

    $ export REDIS_URI=127.0.0.1:6371

    $ redis-dump



    # If your instance uses a password (such as on RedisToGo), you

    # can specify the Redis URL as such:

    # :@:

    # Note the leading colon is important for specifying no username.

    $ redis-dump -u :[email protected]:9055



== Output format



All redis datatypes are output to a simple JSON object. All objects have the following 5 fields:



* db (Integer)

* key (String)

* ttl (Integer): The amount of time in seconds that the key will live. If no expire is set, it's -1.

* type (String), one of: string, list, set, zset, hash, none.

* value (String): A JSON-encoded string. For keys of type list, set, zset, and hash, the data is given a specific structure (see below).



Here are examples of each datatype:



    {"db":0,"key":"hashkey","ttl":-1,"type":"hash","value":{"field_a":"value_a","field_b":"value_b","field_c":"value_c"},"size":42}

    {"db":0,"key":"listkey","ttl":-1,"type":"list","value":["value_0","value_1","value_2","value_0","value_1","value_2"],"size":42}

    {"db":0,"key":"setkey","ttl":-1,"type":"set","value":["value_2","value_0","value_1","value_3"],"size":28}

    {"db":0,"key":"zsetkey","ttl":-1,"type":"zset","value":[["value_0","100"],["value_1","100"],["value_2","200"],["value_3","300"],["value_4","400"]],"size":50}

    {"db":0,"key":"stringkey","ttl":79,"type":"string","value":"stringvalue","size":11}



=== Important note about TTLs



One of the purposes of redis-dump is the ability to restore the database to a known state. When you restore a redis database from a redis-dump file, the expires are reset to their values at the time the dump was created. This is different from restoring from Redis' native .rdb or .aof files (expires are stored relative to the actual time they were set).



== Output directly to an encrypted file



For most sensitive data, you should consider encrypting the data directly without writing first to a temp file. You can do this using the power of [gpg](http://www.gnupg.org/) and file descriptors. Here are a couple examples:



    # Encrypt the data (interactive)

    $ redis-dump -u 127.0.0.1:6371 -d 15 | gpg --force-mdc -v -c > path/2/backup-db15.json.gpg



    # Encrypt the data (automated)

    $ redis-dump -u 127.0.0.1:6371 -d 15 | 3 path/2/backup-db15.json.gpg



    # Decrypt the file (interactive)

    $ gpg path/2/backup-db15.json.gpg

    Enter passphrase: *******



    # Decrypt the file (automated)

    $  3