rootslab/syllabus

/*
 * KEYS info mix-ins.
 */

exports.infos = ( function () {

    return {

        del : {
            rtype : ':'
            , since : '1.0.0'
            , hint : 'DEL key [key ...]'
            , descr : 'Delete a key.'
        }

        , dump : {
            rtype : '$'
            , since : '2.6.0'
            , hint : 'DUMP key'
            , descr : 'Return a serialized version of the value stored at the specified key..'
        }

        , exists : {
            rtype : ':'
            , always : [ 0, 1 ]
            , since : '1.0.0'
            , hint : 'EXISTS key'
            , descr : 'Determine if a key exists.'
        }

        , expire : {
            rtype : ':'
            , always : [ 0, 1 ]
            , since : '1.0.0'
            , hint : 'EXPIRE key seconds'
            , descr : 'Set a key\'s time to live in seconds.'
        }

        , expireat : {
            rtype : ':'
            , always : [ 0, 1 ]
            , since : '1.2.0'
            , hint : 'EXPIREAT key timestamp'
            , descr : 'Set the expiration for a key as a UNIX timestamp.'
        }

        , keys : {
            rtype : '*'
            , since : '1.0.0'
            , hint : 'KEYS pattern'
            , descr : 'Find all keys matching the given pattern.'
        }

        , migrate : {
            rtype : '+'
            , since : '2.6.0'
            , hint : 'MIGRATE host port key destination-db timeout [COPY] [REPLACE]'
            , descr : 'Atomically transfer a key from a Redis instance to another one.'
        }

        , move : {
            rtype : ':'
            , always : [ 0, 1 ]
            , since : '1.0.0'
            , hint : 'MOVE key db'
            , descr : 'Move a key to another database.'
        }

        , object : {

            refcount : {
                rtype : ':'
                , since : '2.2.3'
                , hint : 'OBJECT REFCOUNT <key>'
                , descr : 'It returns the number of references of the value associated with the specified key. This command is mainly useful for debugging.'
                , url : 'http://redis.io/commands/object'
            }

            , encoding : {
                rtype : '$'
                , since : '2.2.3'
                , hint : 'OBJECT ENCODING <key>'
                , descr : 'It returns the kind of internal representation used in order to store the value associated with a key.'
                , url : 'http://redis.io/commands/object'
        }

            , idletime : {
                rtype : ':'
                , since : '2.2.3'
                , hint : 'OBJECT IDLETIME <key>'
                , descr : 'It returns the number of seconds since the object stored at the specified key is idle (not requested by read or write operations).'
                , url : 'http://redis.io/commands/object'
            }

        }

        , persist : {
            rtype : ':'
            , always : [ 0, 1 ]
            , since : '2.2.0'
            , hint : 'PERSIST key'
            , descr : 'Remove the expiration from a key.'
        }

        , pexpire : {
            rtype : ':'
            , always : [ 0, 1 ]
            , since : '2.6.0'
            , hint : 'PEXPIRE key milliseconds'
            , descr : 'Set a key\'s time to live in milliseconds.'
        }

        , pexpireat : {
            rtype : ':'
            , always : [ 0, 1 ]
            , since : '2.6.0'
            , hint : 'PEXPIREAT key milliseconds-timestamp'
            , descr : 'Set the expiration for a key as a UNIX timestamp specified in milliseconds.'
        }

        , pttl : {
            rtype : ':'
            , since : '2.6.0'
            , hint : 'PTTL key'
            , descr : 'Get the time to live for a key in milliseconds.'
        }

        , randomkey : {
            rtype : '$'
            , since : '1.0.0'
            , hint : 'RANDOMKEY'
            , descr : 'Return a random key from the keyspace.'
        }

        , rename : {
            rtype : '+'
            , since : '1.0.0'
            , hint : 'RENAME key newkey'
            , descr : 'Rename a key.'
        }

        , renamenx : {
            rtype : ':'
            , always : [ 0, 1 ]
            , since : '1.0.0'
            , hint : 'RENAMENX key newkey'
            , descr : 'Rename a key, only if the new key does not exist.'
        }

        , restore : {
           rtype : '+'
            , since : '2.6.0'
            , hint : 'RESTORE key ttl serialized-value'
            , descr : 'Create a key using the provided serialized value, previously obtained using DUMP.'
        }

        , scan : {
            rtype : '*'
            , since : '2.8.0'
            , hint : 'SCAN cursor [MATCH pattern] [COUNT count]'
            , descr : 'Incrementally iterate the keys space.'
        }

        , sort : {
            rtype : '*'
            , since : '1.0.0'
            , hint : 'SORT key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC|DESC] [ALPHA] [STORE destination]'
            , descr : 'Sort the elements in a list, set or sorted set.'
        }

        , ttl : {
            rtype : ':'
            , since : '1.0.0'
            , hint : 'TTL key'
            , descr : 'Get the time to live for a key.'
        }

        , type : {
            rtype : '+'
            , since : '1.0.0'
            , hint : 'TYPE key'
            , descr : 'Determine the type stored at key.'
        }

        , touch : {
            rtype : ':'
            , since : '3.2.1'
            , hint : 'TOUCH key [key ...]'
            , descr : 'Alters the last access time of a key(s). Returns the number of existing keys specified.'
        }

        , unlink : {
            rtype : ':'
            , since : '4.0.0'
            , hint : 'UNLINK key [key ...]'
            , descr : 'Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.'
        }

        , wait : {
            rtype : '+'
            , since : '3.0.0'
            , hint : 'WAIT numslaves timeout'
            , descr : 'Wait for the synchronous replication of all the write commands sent in the context of the current connection.'
        }

    };

} )();