Current File : //usr/lib/python2.7/site-packages/salt/modules/redismod.pyc
�
���^c @@ s d Z d d l m Z m Z m Z d d l m Z d d l m Z d d l m Z d d l
Z y d d l Z e
Z Wn e k
r� e Z n Xd Z d � Z d d d d d � Z d d d d
� Z d d d d d � Z d d d d d � Z d
d d d d d � Z d d d d d � Z d d d d d � Z d � Z d d d d d � Z d d d d d � Z d d d d d � Z d d d d d � Z d d d d d � Z d d d d d � Z! d � Z" d d d d d � Z# d d d d d � Z$ d d d d d � Z% d d d d d d � Z& d d d d d d � Z' d d d d d � Z( d! � Z) d" � Z* d d d d d# � Z+ d d d d d$ � Z, d d d d d% � Z- d d d d d d d d& � Z. d d d d d' � Z/ d
d d d d d( � Z0 d d d d d) � Z1 d d d d d* � Z2 d d d d d+ � Z3 d d d d d, � Z4 d d d d d- � Z5 d d d d d. � Z6 d d d d d/ � Z7 d d d d d0 � Z8 d d d d d d d1 � Z9 d d d d d2 � Z: d d d d d3 � Z; d d d d d4 � Z< d d d d d5 � Z= d d d d6 � Z> d d d d7 � Z? d S(8 uN
Module to provide redis functionality to Salt
.. versionadded:: 2014.7.0
:configuration: This module requires the redis python module and uses the
following defaults which may be overridden in the minion configuration:
.. code-block:: yaml
redis.host: 'salt'
redis.port: 6379
redis.db: 0
redis.password: None
i ( t absolute_importt unicode_literalst print_function( t zip( t six( t datetimeNu redisc C@ s t r
t St d f Sd S( uC
Only load this module if redis python module is installed
uU The redis execution module failed to load: the redis python library is not available.N( t HAS_REDISt __virtualname__t False( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt __virtual__# s c C@ s� | s t d d � } n | s2 t d d � } n | sK t d d � } n | sd t d d � } n t j | | | | d t �S( u1
Returns an instance of the redis client
u
config.optionu
redis.hostu
redis.portu redis.dbu redis.passwordt decode_responses( t __salt__t redist StrictRedist True( t hostt portt dbt password( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt _connect- s c C@ s | d k r" t d d d � } n | d k rD t d d d � } n | d k rc t d d � } n t j | | d | d t �S(
u1
Returns an instance of the redis client
u
config.optionu redis_sentinel.hostu localhostu redis_sentinel.porti g u redis_sentinel.passwordR R
N( t NoneR R R
R ( R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt _sconnect= s c C@ s t | | | | � } | j � S( u�
Asynchronously rewrite the append-only file
CLI Example:
.. code-block:: bash
salt '*' redis.bgrewriteaof
( R t bgrewriteaof( R R R R t server( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR K s
c C@ s t | | | | � } | j � S( u|
Asynchronously save the dataset to disk
CLI Example:
.. code-block:: bash
salt '*' redis.bgsave
( R t bgsave( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR Y s
u *c C@ s" t | | | | � } | j | � S( u�
Get redis server configuration values
CLI Example:
.. code-block:: bash
salt '*' redis.config_get
salt '*' redis.config_get port
( R t
config_get( t patternR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR g s c C@ s% t | | | | � } | j | | � S( u�
Set redis server configuration values
CLI Example:
.. code-block:: bash
salt '*' redis.config_set masterauth luv_kittens
( R t
config_set( t namet valueR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR v s
c C@ s t | | | | � } | j � S( u�
Return the number of keys in the selected database
CLI Example:
.. code-block:: bash
salt '*' redis.dbsize
( R t dbsize( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR � s
c O@ sY i } x7 d d d d g D]# } | | k r | | | | <q q Wt | � } | j | � S( u�
Deletes the keys from redis, returns number of keys deleted
CLI Example:
.. code-block:: bash
salt '*' redis.delete foo
u hostu portu dbu password( R t delete( t keyst connection_argst conn_argst argR ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR � s c C@ s" t | | | | � } | j | � S( u
Return true if the key exists in redis
CLI Example:
.. code-block:: bash
salt '*' redis.exists foo
( R t exists( t keyR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR$ � s
c C@ s% t | | | | � } | j | | � S( u
Set a keys time to live in seconds
CLI Example:
.. code-block:: bash
salt '*' redis.expire foo 300
( R t expire( R% t secondsR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR& � s
c C@ s% t | | | | � } | j | | � S( u�
Set a keys expire at given UNIX time
CLI Example:
.. code-block:: bash
salt '*' redis.expireat foo 1400000000
( R t expireat( R% t timestampR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR( � s
c C@ s t | | | | � } | j � S( uy
Remove all keys from all databases
CLI Example:
.. code-block:: bash
salt '*' redis.flushall
( R t flushall( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR* � s
c C@ s t | | | | � } | j � S( u�
Remove all keys from the selected database
CLI Example:
.. code-block:: bash
salt '*' redis.flushdb
( R t flushdb( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR+ � s
c C@ s" t | | | | � } | j | � S( um
Get redis key value
CLI Example:
.. code-block:: bash
salt '*' redis.get_key foo
( R t get( R% R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt get_key� s
c O@ sm | j d d � } | j d d � } | j d d � } | j d d � } t | | | | � } | j | | � S( u�
Delete one of more hash fields.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hdel foo_hash bar_field1 bar_field2
u hostu portu dbu passwordN( R, R R t hdel( R% t fieldst optionsR R t databaseR R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR. � s c C@ s% t | | | | � } | j | | � S( u�
Determine if a hash fields exists.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hexists foo_hash bar_field
( R t hexists( R% t fieldR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR2 s c C@ s% t | | | | � } | j | | � S( u�
Get specific field value from a redis hash, returns dict
CLI Example:
.. code-block:: bash
salt '*' redis.hget foo_hash bar_field
( R t hget( R% R3 R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR4 s
c C@ s" t | | | | � } | j | � S( u�
Get all fields and values from a redis hash, returns dict
CLI Example:
.. code-block:: bash
salt '*' redis.hgetall foo_hash
( R t hgetall( R% R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR5 , s
i c C@ s+ t | | | | � } | j | | d | �S( u�
Increment the integer value of a hash field by the given number.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hincrby foo_hash bar_field 5
t amount( R t hincrby( R% R3 t incrementR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR7 : s g �?c C@ s+ t | | | | � } | j | | d | �S( u�
Increment the float value of a hash field by the given number.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hincrbyfloat foo_hash bar_field 5.17
R6 ( R t hincrbyfloat( R% R3 R8 R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR9 J s c C@ s" t | | | | � } | j | � S( u�
Returns number of fields of a hash.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hlen foo_hash
( R t hlen( R% R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR: Z s c O@ sm | j d d � } | j d d � } | j d d � } | j d d � } t | | | | � } | j | | � S( u�
Returns the values of all the given hash fields.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hmget foo_hash bar_field1 bar_field2
u hostu portu dbu passwordN( R, R R t hmget( R% R/ R0 R R R1 R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR; j s c K@ s| | j d d � } | j d d � } | j d d � } | j d d � } t | | | | � } | j | t j j j | � � S( u�
Sets multiple hash fields to multiple values.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hmset foo_hash bar_field1=bar_value1 bar_field2=bar_value2
u hostu portu dbu passwordN( t popR R t hmsett saltt utilst argst clean_kwargs( R% t
fieldsvalsR R R1 R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR= ~ s c C@ s( t | | | | � } | j | | | � S( u�
Set the value of a hash field.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hset foo_hash bar_field bar_value
( R t hset( R% R3 R R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRC � s c C@ s( t | | | | � } | j | | | � S( u�
Set the value of a hash field only if the field does not exist.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hsetnx foo_hash bar_field bar_value
( R t hsetnx( R% R3 R R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRD � s c C@ s" t | | | | � } | j | � S( u�
Return all the values in a hash.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hvals foo_hash bar_field1 bar_value1
( R t hvals( R% R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRE � s c C@ s4 t | | | | � } | j | d | d | d | �S( u�
Incrementally iterate hash fields and associated values.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' redis.hscan foo_hash match='field_prefix_*' count=1
t cursort matcht count( R t hscan( R% RF RG RH R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRI � s c C@ s t | | | | � } | j � S( u�
Get information and statistics about the server
CLI Example:
.. code-block:: bash
salt '*' redis.info
( R t info( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRJ � s
c C@ s" t | | | | � } | j | � S( u�
Get redis keys, supports glob style patterns
CLI Example:
.. code-block:: bash
salt '*' redis.keys
salt '*' redis.keys test*
( R R ( R R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR � s c C@ s" t | | | | � } | j | � S( ui
Get redis key type
CLI Example:
.. code-block:: bash
salt '*' redis.type foo
( R t type( R% R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt key_type� s
c C@ s^ t | | | | � } t j rD t | j � t d d d � j � � St | j � j � � Sd S( u�
Get the UNIX time in seconds of the last successful save to disk
CLI Example:
.. code-block:: bash
salt '*' redis.lastsave
i� i N( R R t PY2t intt lastsaveR t
total_secondsR) ( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRO � s
&c C@ s" t | | | | � } | j | � S( u}
Get the length of a list in Redis
CLI Example:
.. code-block:: bash
salt '*' redis.llen foo_list
( R t llen( R% R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRQ s
c C@ s( t | | | | � } | j | | | � S( u�
Get a range of values from a list in Redis
CLI Example:
.. code-block:: bash
salt '*' redis.lrange foo_list 0 10
( R t lrange( R% t startt stopR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRR s
c C@ s? t | | | | � } y | j � SWn t j k
r: t SXd S( u�
Ping the server, returns False on connection errors
CLI Example:
.. code-block:: bash
salt '*' redis.ping
N( R t pingR t ConnectionErrorR ( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRU - s
c C@ s t | | | | � } | j � S( uy
Synchronously save the dataset to disk
CLI Example:
.. code-block:: bash
salt '*' redis.save
( R t save( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRW > s
c C@ s% t | | | | � } | j | | � S( uq
Set redis key value
CLI Example:
.. code-block:: bash
salt '*' redis.set_key foo bar
( R t set( R% R R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt set_keyL s
c C@ so t | | | | � } y | j � Wn t j k
r: t SX| j � y | j � Wn t j k
rj t SXt S( u�
Synchronously save the dataset to disk and then shut down the server
CLI Example:
.. code-block:: bash
salt '*' redis.shutdown
( R RU R RV R t shutdownR ( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRZ Z s
c C@ s; | r | r d } n t | | | | � } | j | | � S( uV
Make the server a slave of another instance, or promote it as master
CLI Example:
.. code-block:: bash
# Become slave of redis-n01.example.com:6379
salt '*' redis.slaveof redis-n01.example.com 6379
salt '*' redis.slaveof redis-n01.example.com
# Become master
salt '*' redis.slaveof
i� ( R t slaveof( t master_hostt master_portR R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR[ t s
c C@ s( t | | | | � } t | j | � � S( uy
Get members in a Redis set
CLI Example:
.. code-block:: bash
salt '*' redis.smembers foo_set
( R t listt smembers( R% R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR_ � s
c C@ s# t | | | | � } | j � d S( u�
Return the current server UNIX time in seconds
CLI Example:
.. code-block:: bash
salt '*' redis.time
i ( R t time( R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyR` � s
c C@ s" t | | | | � } | j | � S( u�
Get the length of a sorted set in Redis
CLI Example:
.. code-block:: bash
salt '*' redis.zcard foo_sorted
( R t zcard( R% R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRa � s
c C@ s( t | | | | � } | j | | | � S( u�
Get a range of values from a sorted set in Redis by index
CLI Example:
.. code-block:: bash
salt '*' redis.zrange foo_sorted 0 10
( R t zrange( R% RS RT R R R R R ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyRb � s
c C@ s: t | | | � } | j | � } t t t d | � � � S( u�
Get ip for sentinel master
.. versionadded: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' redis.sentinel_get_master_ip 'mymaster'
u master_hostu master_port( u master_hostu master_port( R t sentinel_get_master_addr_by_namet dictR^ R ( t masterR R R R t ret( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt sentinel_get_master_ip� s c C@ s[ t | | | � } | j � } | j d d � | j d d � f } t t t d | � � � S( u�
Get host information about slave
.. versionadded: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' redis.get_master_ip
u master_hostu u master_port( u master_hostu master_port( R RJ R, Rd R^ R ( R R R R t srv_infoRf ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt
get_master_ip� s $(@ t __doc__t
__future__R R R t salt.ext.six.movesR t salt.extR R t salt.utils.argsR> R R R t ImportErrorR R R R R R R R R R R R R$ R& R( R* R+ R- R. R2 R4 R5 R7 R9 R: R; R= RC RD RE RI RJ R RL RO RQ RR RU RW RY RZ R[ R_ R` Ra Rb Rg Ri ( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/redismod.pyt <module> sr
Mini Shell