Redis和StrictRedis
Redis庫提供了兩個類Redis和StrictRedis用於實現Redis的命令操作。
StrictRedis實現了絕大部分官方文檔的命令,參數也一一對應,比如set方法就對應Redis命令的set方法。而Redis是StrictRedis的子類,它的功能主要是用於向后兼容舊版本的Redis類里面的幾個方法,將方法改寫,比如lrem方法就將value和num的位置互換,和Redis命令行的命令參數不一致。
官方推薦使用StrictRedis
連接Redis
1 from redis import StrictRedis 2 3 redis = StrictRedis(host='localhost',port=6379,db=0,password='xxx') 4 redis.set('name','bob') 5 print(redis.get('name'))
在這里我們傳入了Redis的地址,運行端口,使用的數據庫,密碼信息。在默認不傳的情況下,這四個參數分別為localhost、6379、0、None。現在我們聲明了一個StrictRedis對象,然后接下來調用了set方法,設置一個鍵值對,然后在將其獲取打印。
運行結果:
b'bob'
這樣就說明我們連接成功,並可以執行set()、get()操作了。
當然我們還可以使用ConnectionPool來連接,示例如下:
from redis import StrictRedis, ConnectionPool pool = ConnectionPool(host='localhost', port=6379, db=0, password='foobared') redis = StrictRedis(connection_pool=pool)
這樣的連接效果是一樣的,觀察源碼可以發現StrictRedis內其實就是用host、port等參數又構造了一個ConnectionPool,所以我們直接將ConnectionPool當參數傳給StrictRedis也是一樣的。
另外ConnectionPool還支持通過URL來構建,URL的格式支持如下三種:
redis://[:password]@localhost:6379/0 rediss://[:password]@localhost:6379/0 unix://[:password]@/path/to/socket.sock?db=0
這三種URL分別表示創建Redis TCP連接、Redis TCP+SSL連接、Redis Unix Socket連接,我們只需要構造上面任意一種連接URL即可,其中password部分如果有則可以寫,沒有可以省略,下面我們再用URL連接演示一下:
url = 'redis://:foobared@localhost:6379/0' pool = ConnectionPool.from_url(url) redis = StrictRedis(connection_pool=pool)
我們首先聲明了一個Redis連接字符串,然后調用from_url()方法創建一個ConnectionPool,然后將其傳給StrictRedis即可完成連接,所以使用URL的連接方式還是比較方便的。
KEY操作
在這里主要將Key的一些判斷和操作方法做下總結
方法 | 作用 | 參數說明 | 示例 | 示例說明 | 示例結果 |
exists(name) | 判斷一個key是否存在 | name:key名 | redis.exists('name') | 是否存在name這個key | True |
delete(name) | 刪除一個key | name:key名 | redis.delete('name') | 刪除name這個key | 1 |
type(name) | 判斷key類型 | name:Key名 | redis.type('name') | 判斷name這個key類型 | b'string' |
keys(pattern) | 獲取所有符合規則的key | pattern:匹配規則 | redis.keys('n*') | 獲取所有以n開頭的key | [b'name'] |
randomkey() |
隨機獲取一個key | randomkey() | 獲取隨機的一個key | b'name' | |
rename(src,dst) | 將key重命名 | src:原key dst:新key |
redis.rename('name', 'nickname') | 將name重命名為nickname | True |
dbsize() | 獲取當前數據庫中key的數目 | dbsize() | 獲取當前數據庫中key的數目 | 100 | |
expire(name,time) | 設定key的過期時間,單位秒 | name:key名 time:秒數 |
redis.expire('name', 2) | 將name這key的過期時間設置2秒 | True |
ttl(name) | 獲取key的過期時間,但為秒,-1為永久不過期 | name:Key名 | redis.ttl('name') | 獲取name這key的過期時間 | -1 |
move(name,db) | 將key移動到其他數據庫 | name:Key名 db:數據庫代號 |
move('name', 2) | 將name移動到2號數據庫 | True |
flushdb() | 刪除當前選擇數據庫中的所有key | flushdb() | 刪除當前選擇數據庫中的所有key | True | |
flushall() | 刪除所有數據庫中所有的key | flushall() | 刪除所有數據庫中的所有key | True |
String操作
方法 | 作用 | 參數說明 | 示例 | 示例說明 | 示例結果 |
set(name,value) | 給數據庫中key為name的string賦予值value | name: key名 value: 值 | redis.set('name', 'Bob') | 給name這個key的value賦值為Bob | True |
get(name) | 返回數據庫中key為name的string的value | name: key名 | redis.get('name') | 返回name這個key的value | b'Bob' |
getset(name,value) | 給數據庫中key為name的string賦予值value並返回上次的value | name: key名 value: 新值 | redis.getset('name', 'Mike') | 賦值name為Mike並得到上次的value | b'Bob' |
mget(keys,*args) | 返回多個key對應的value | keys: key的列表 | redis.mget(['name', 'nickname']) | 返回name和nickname的value | [b'Mike', b'Miker'] |
setnx(name,value) | 如果key不存在才設置value | name: key名 | redis.setnx('newname', 'James') | 如果newname這key不存在則設置值為James | 第一次運行True,第二次False |
setex(name,time,value) | 設置可以對應的值為string類型的value,並指定此鍵值對應的有效期 | name: key名 time: 有效期 value: 值 | redis.setex('name', 1, 'James') | 將name這key的值設為James,有效期1秒 | True |
setrange(name,offset,value) | 設置指定key的value值的子字符串 | name: key名 offset: 偏移量 value: 值 | redis.set('name', 'Hello') redis.setrange('name', 6, 'World') | 設置name為Hello字符串,並在index為6的位置補World | 11,修改后的字符串長度 |
mset(mapping) | 批量賦值 | mapping: 字典 | redis.mset({'name1': 'Durant', 'name2': 'James'}) | 將name1設為Durant,name2設為James | True |
msetnx(mapping) | key均不存在時才批量賦值 | mapping: 字典 | redis.msetnx({'name3': 'Smith', 'name4': 'Curry'}) | 在name3和name4均不存在的情況下才設置二者值 | True |
incr(name,amount=1) | key為name的value增值操作,默認1,key不存在則被創建並設為amount | name: key名 amount:增長的值 | redis.incr('age', 1) | age對應的值增1,若不存在則會創建並設置為1 | 1,即修改后的值 |
decr(name,amount=1) | key為name的value減值操作,默認1,key不存在則被創建並設置為-amount | name: key名 amount:減少的值 | redis.decr('age', 1) | age對應的值減1,若不存在則會創建並設置為-1 | -1,即修改后的值 |
append(key,value) | key為name的string的值附加value | key: key名 | redis.append('nickname', 'OK') | 向key為nickname的值后追加OK | 13,即修改后的字符串長度 |
substr(name,start,end=-1) | 返回key為name的string的value的子串 | name: key名 start: 起始索引 end: 終止索引,默認-1截取到末尾 | redis.substr('name', 1, 4) | 返回key為name的值的字符串,截取索引為1-4的字符 | b'ello' |
getrange(key,start,end) | 獲取key的value值從start到end的子字符串 | key: key名 start: 起始索引 end: 終止索引 | redis.getrange('name', 1, 4) | 返回key為name的值的字符串,截取索引為1-4的字符 | b'ello' |
List操作
方法 | 作用 | 參數說明 | 示例 | 實例說明 | 示例結果 |
rpush(name, *values) | 在key為name的list尾添加值為value的元素,可以傳多個 | name: key名 values: 值 | redis.rpush('list', 1, 2, 3) | 給list這個key的list尾添加1、2、3 | 3,list大小 |
lpush(name, *values) | 在key為name的list頭添加值為value的元素,可以傳多個 | name: key名 values: 值 | redis.lpush('list', 0) | 給list這個key的list頭添加0 | 4,list大小 |
llen(name) | 返回key為name的list的長度 | name: key名 | redis.llen('list') | 返回key為list的列表的長度 | 4 |
lrange(name, start, end) | 返回key為name的list中start至end之間的元素 | name: key名 start: 起始索引 end: 終止索引 | redis.lrange('list', 1, 3) | 返回起始為1終止為3的索引范圍對應的list | [b'3', b'2', b'1'] |
ltrim(name, start, end) | 截取key為name的list,保留索引為start到end的內容 | name:key名 start: 起始索引 end: 終止索引 | ltrim('list', 1, 3) | 保留key為list的索引為1到3的元素 | True |
lindex(name, index) | 返回key為name的list中index位置的元素 | name: key名 index: 索引 | redis.lindex('list', 1) | 返回key為list的列表index為1的元素 | b'2' |
lset(name, index, value) | 給key為name的list中index位置的元素賦值,越界則報錯 | name: key名 index: 索引位置 value: 值 | redis.lset('list', 1, 5) | 將key為list的list索引1位置賦值為5 | True |
lrem(name, count, value) | 刪除count個key的list中值為value的元素 | name: key名 count: 刪除個數 value: 值 | redis.lrem('list', 2, 3) | 將key為list的列表刪除2個3 | 1,即刪除的個數 |
lpop(name) | 返回並刪除key為name的list中的首元素 | name: key名 | redis.lpop('list') | 返回並刪除名為list的list第一個元素 | b'5' |
rpop(name) | 返回並刪除key為name的list中的尾元素 | name: key名 | redis.rpop('list') | 返回並刪除名為list的list最后一個元素 | b'2' |
blpop(keys, timeout=0) | 返回並刪除名稱為在keys中的list中的首元素,如果list為空,則會一直阻塞等待 | keys: key列表 timeout: 超時等待時間,0為一直等待 | redis.blpop('list') | 返回並刪除名為list的list的第一個元素 | [b'5'] |
brpop(keys, timeout=0) | 返回並刪除key為name的list中的尾元素,如果list為空,則會一直阻塞等待 | keys: key列表 timeout: 超時等待時間,0為一直等待 | redis.brpop('list') | 返回並刪除名為list的list的最后一個元素 | [b'2'] |
rpoplpush(src, dst) | 返回並刪除名稱為src的list的尾元素,並將該元素添加到名稱為dst的list的頭部 | src: 原list的key dst: 目標list的key | redis.rpoplpush('list', 'list2') | 將key為list的list尾元素刪除並返回並將其添加到key為list2的list頭部 | b'2' |
Set操作
方法 | 作用 | 參數說明 | 示例 | 實例說明 | 示例結果 | ||
zadd(name, args, *kwargs) | 向key為name的zset中添加元素member,score用於排序。如果該元素存在,則更新其順序 | name: key名 args: 可變參數 | redis.zadd('grade', 100, 'Bob', 98, 'Mike') | 向key為grade的zset中添加Bob,score為100,添加Mike,score為98 | 2,即添加的元素個數 | ||
zrem(name, *values) | 刪除key為name的zset中的元素 |
|
redis.zrem('grade', 'Mike') | 從key為grade的zset中刪除Mike | 1,即刪除的元素個數 | ||
zincrby(name, value, amount=1) | 如果在key為name的zset中已經存在元素value,則該元素的score增加amount,否則向該集合中添加該元素,其score的值為amount | name: key名 value: 元素 amount: 增長的score值 | redis.zincrby('grade', 'Bob', -2) | key為grade的zset中Bob的score減2 | 98.0,即修改后的值 | ||
zrank(name, value) | 返回key為name的zset中元素的排名(按score從小到大排序)即下標 | name: key名 value: 元素值 | redis.zrank('grade', 'Amy') | 得到key為grade的zset中Amy的排名 | 1 | ||
zrevrank(name, value) | 返回key為name的zset中元素的倒數排名(按score從大到小排序)即下標 | name: key名 value: 元素值 |
|
得到key為grade的zset中Amy的倒數排名 | 2 | ||
zrevrange(name, start, end, withscores=False) | 返回key為name的zset(按score從大到小排序)中的index從start到end的所有元素 |
name: key值 start: 開始索引 end: 結束索引 withscores: 是否帶score | redis.zrevrange('grade', 0, 3) | 返回key為grade的zset前四名元素 | [b'Bob', b'Mike', b'Amy', b'James'] | ||
zrangebyscore(name, min, max, start=None, num=None, withscores=False) | 返回key為name的zset中score在給定區間的元素 | name:key名 min: 最低score max:最高score start: 起始索引 num: 個數 withscores: 是否帶score | redis.zrangebyscore('grade', 80, 95) | 返回key為grade的zset中score在80和95之間的元素 | |||
zcount(name, min, max) | 返回key為name的zset中score在給定區間的數量 | name:key名 min: 最低score max: 最高score |
|
|
2 | ||
zcard(name) | 返回key為name的zset中score在給定區間的數量 | name: key名 | redis.zcard('grade') | 獲取key為grade的zset中元素個數 | 3 | ||
zremrangebyrank(name, min, max) | 返回key為name的zset的元素個數 | name:key名 min: 最低位次 max: 最高位次 | redis.zremrangebyrank('grade', 0, 0) | 刪除key為grade的zset中排名第一的元素 | 1,即刪除的元素個數 | ||
zremrangebyscore(name, min, max) | 刪除key為name的zset中score在給定區間的元素 | name:key名 min: 最低score max:最高score | redis.zremrangebyscore('grade', 80, 90) | 刪除score在80到90之間的元素 | 1,即刪除的元素個數 |
Sorted Set操作
方法 | 作用 | 參數說明 | 示例 | 實例說明 | 實力結果 |
sadd(name,*values) | 向key為name的set中添加元素 | name: key名 values: 值,可為多個 | redis.sadd('tags', 'Book', 'Tea', 'Coffee') | 向key為tags的set中添加Book、Tea、Coffee三個內容 | 3,即插入的數據個數 |
srem(name,*values) | 從key為name的set中刪除元素 | name: key名 values: 值,可為多個 | redis.srem('tags', 'Book') | 從key為tags的set中刪除Book | 1,即刪除的數據個數 |
spop(name) | 隨機返回並刪除key為name的set中一個元素 | name: key名 | redis.spop('tags') | 從key為tags的set中隨機刪除並返回該元素 | b'Tea' |
smove(src,dst,value) | 從src對應的set中移除元素並添加到dst對應的set中 | src: 源set dst: 目標set value: 元素值 | redis.smove('tags', 'tags2', 'Coffee') | 從key為tags的set中刪除元素Coffee並添加到key為tags2的set | True |
scrad(name) | 返回key為name的set的元素個數 | name: key名 | redis.scard('tags') | 獲取key為tags的set中元素個數 | 3 |
sismember(name,value) | 測試member是否是key為name的set的元素 | name:key值 | redis.sismember('tags', 'Book') | 判斷Book是否為key為tags的set元素 | True |
sinter(keys,*args) | 返回所有給定key的set的交集 | keys: key列表 | redis.sinter(['tags', 'tags2']) | 返回key為tags的set和key為tags2的set的交集 | {b'Coffee'} |
sinterstore(dest,keys,*args) | 求交集並將交集保存到dest的集合 | dest:結果集合 keys:key列表 | redis.sinterstore('inttag', ['tags', 'tags2']) | 求key為tags的set和key為tags2的set的交集並保存為inttag | 1 |
sunion(keys,*args) | 返回所有給定key的set的並集 | keys: key列表 | redis.sunion(['tags', 'tags2']) | 返回key為tags的set和key為tags2的set的並集 | {b'Coffee', b'Book', b'Pen'} |
sunionstore(dest,keys,*args) | 求並集並將並集保存到dest的集合 | dest:結果集合 keys:key列表 | redis.sunionstore('inttag', ['tags', 'tags2']) | 求key為tags的set和key為tags2的set的並集並保存為inttag | 3 |
sdiff(keys,*args) | 返回所有給定key的set的差集 | keys: key列表 | redis.sdiff(['tags', 'tags2']) | 返回key為tags的set和key為tags2的set的差集 | {b'Book', b'Pen'} |
sdiffstore(dest,keys,*args) | 求差集並將差集保存到dest的集合 | dest:結果集合 keys:key列表 | redis.sdiffstore('inttag', ['tags', 'tags2']) | 求key為tags的set和key為tags2的set的差集並保存為inttag | 3 |
smembers(name) | 返回key為name的set的所有元素 | name: key名 | redis.smembers('tags') | 返回key為tags的set的所有元素 | {b'Pen', b'Book', b'Coffee'} |
srandmember(name) | 隨機返回key為name的set的一個元素,但不刪除元素 | name: key值 | redis.srandmember('tags') | 隨機返回key為tags的set的一個元素 |