Back to Pikiwidb

Pika 当前支持 Redis 接口情况

docs/ops/API.md

4.0.26.8 KB
Original Source

Pika 当前支持 Redis 接口情况

pika支持redis五种类型(分别为 string、hash、list、set、zset)的接口,先列出其对redis的五种数据结构兼容统计。

统计所用的标记含义如下:

图标含义
o该接口完全支持,使用方式与redis没有任何区别
!功能支持,但使用或输出与redis有部分差异,需注意
×当前还未支持

Keys

接口DELDUMPEXISTSEXPIREEXPIREATKEYSMIGRATEMOVEOBJECT
状态oxooooxxx
接口PERSISTPEXPIREPEXPIREATPTTLRANDOMKEYRENAMERENAMENXRESTORESORT
状态o!!oxxxxx
接口TOUCHTTLTYPEUNLINKWAITSCAN
状态xo!ox!

备注:

  • PEXPIRE:无法精确到毫秒,底层会自动截断按秒级别进行处理;
  • PEXPIREAT:无法精确到毫秒,底层会自动截断按秒级别进行处理;
  • SCAN:会顺序迭代当前db的快照,由于pika允许重名五次,所以scan有优先输出顺序,依次为:string -> hash -> list -> zset -> set;
  • TYPE:另外由于pika允许重名五次,所以type有优先输出顺序,依次为:string -> hash -> list -> zset -> set,如果这个key在string中存在,那么只输出sting,如果不存在,那么则输出hash的,依次类推。
  • KEYS: KEYS命令支持参数支持扫描指定类型的数据,用法如 "keys * [string, hash, list, zset, set]"

Strings

接口APPENDBITCOUNTBITFIELDBITOPBITPOSDECRDECRBYGETGETBIT
状态oox!oooo!
接口GETRANGEGETSETINCRINCRBYINCRBYFLOATMGETMSETMSETNXSTRLEN
状态ooooooooo
接口PSETEXSETSETBITSETEXSETNXSETRANGE
状态oo!ooo

备注:

  • BIT操作:与Redis不同,Pika的bit操作范围为2^21, bitmap的最大值为256Kb。redis setbit 只是对key的value值更新。但是pika使用rocksdb作为存储引擎,rocksdb只会新写入数据并且只在compact的时候才从硬盘删除旧数据。如果pika的bit操作范围和redis一致都是2^32的话,那么有可能每次对同一个key setbit时,rocksdb都会存储一个512M大小的value。这会产生 严重的性能隐患。因此我们对pika的bit操作范围作了取舍。

Hashes

接口HDELHEXISTSHGETHGETALLHINCRBYHINCRBYFLOATHKEYSHLENHMGETHMSET
状态oooooooooo
接口HSETHSETNXHVALSHSCANHSTRLEN
状态!oooo

备注:

  • HSET操作:暂不支持单条命令设置多个field value,如有需求请用HMSET

Lists

接口LINDEXLINSERTLLENLPOPLPUSHLPUSHXLRANGELREMLSETLTRIM
状态oooooxoooo
接口RPOPRPOPLPUSHRPUSHRPUSHXBLPOPBRPOPBRPOPLPUSH
状态oooooox

Sets

接口SADDSCARDSDIFFSDIFFSTORESINTERSINTERSTORESISMEMBERSMEMBERSSMOVESPOP
状态oooooooooo
接口SRANDMEMBERSREMSUNIONSUNIONSTORESSCAN
状态!oooo

备注:

  • SRANDMEMBER:时间复杂度O( n ),耗时较多

Sorted Sets

接口ZADDZCARDZCOUNTZINCRBYZRANGEZRANGEBYSCOREZRANKZREMZREMRANGEBYRANKZREMRANGEBYSCORE
状态oooooooooo
接口ZREVRANGEZREVRANGEBYSCOREZREVRANKZSCOREZUNIONSTOREZINTERSTOREZSCANZRANGEBYLEXZLEXCOUNTZREMRANGEBYLEX
状态oooooooooo
接口ZPOPMAXZPOPMINZREVERANGEBYLEX
状态ooo
  • ZADD 的选项 [NX|XX] [CH] [INCR] 暂不支持

HyperLogLog

接口PFADDPFCOUNTPFMERGE
状态ooo

备注:

  • 50w以内误差均小于1%, 100w以内误差小于3%, 但付出了时间代价.

GEO

接口GEOADDGEODISTGEOHASHGEOPOSGEORADIUSGEORADIUSBYMEMBER
状态oooooo

BitMap

接口SETBITGETBITBITPOSBITOPBITCOUNT
状态ooooo

Pub/Sub

接口PSUBSCRIBEPUBSUBPUBLISHPUNSUBSCRIBESUBSCRIBEUNSUBSCRIBE
状态oooooo

备注:

  • 暂不支持keyspace notifications

管理命令(这里仅列出pika兼容的)

接口INFOCONFIGCLIENTPINGBGSAVESHUTDOWNSELECTTYPEHELLO
状态!o!ooo!!o

备注:

  • info:info支持全部输出,也支持匹配形式的输出,例如可以通过info stats查看状态信息,需要注意的是key space与redis不同,pika对于key space的展示选择了分类型展示而非redis的分库展示(因为pika没有库),pika对于key space的统计是被动的,需要手动触发,然后pika会在后台进行统计,pika的key space统计是精确的。触发方式为执行:keyspace命令即可,然后pika会在后台统计,此时可以使用: keyspace readonly命令来进行查看,readonly参数可以避免反复进行统计,如果当前数据为0,则证明还在统计中.info commandstats 可以查询到各个命令的调用次数和统计用时以及平均用时,和redis不同的是我们统计耗时的时间单位是毫秒;

  • client:当前client命令支持client list及client kill还有client setname,client list显示的内容少于redis;

  • select:该命令在3.1.0版前无任何效果,自3.1.0版开始与Redis一致;

  • ping: 该命令仅支持无参数使用,即使用PING,客户端返回PONG.


Pika Pub/Sub文档

可用版本: >= 2.3.0

注意: 暂不支持键空间通知功能

Pika 发布订阅命令

以下为Pub/Sub发布订阅命令, 与Redis完全兼容

  • PUBSUB subcommand [argument [argument ...]]
  • PUBLISH channel message
  • SUBSCRIBE channel [channel ...]
  • PSUBSCRIBE pattern [pattern ...]
  • UNSUBSCRIBE [channel [channel ...]]
  • PUNSUBSCRIBE [pattern [pattern ...]]

具体使用方法参考Redis的Pub/Sub文档

重要说明

  • 重名问题:由于pika每个类型独立运作, 所以允许重名。例如在key abc在string中存在的时候也同样允许在hash中存在,一个key最多重名5次(5大类型),但在同一接口中是无法重名的。所以建议在使用的时候对于不同类型不要使用完全相同的key;

  • 分库问题:pika自3.1.0版起支持多库,相关命令、参数的变化请参考Pika3.1.0多库版命令、参数变化参考文档

  • 数据展示:pika对于keyspace的展示选择了分类型展示而非redis的分库展示(因为pika没有分库概念),pika对于keyspace的统计是被动的,需要手动触发并不会立即输出,命令为:info keyspace [ 0|1 ],默认为0不触发,pika的keyspace统计是精确的。