【Firefly API 新版文档】Package dbentrust


package dbentrust

       该包下面主要是数据库的处理与memcached存储。里面封装了,从memcached数据到python对象的映射。可以以操纵python对象的方式进行memcached中存储的数据的操作,只要在不同的进程中实例化相同名称的memobject对象,就能保证对象中的数据是一致的。还包含了将这个对象中的数据同步到数据库的出来方法。这里不需去写一句sql语句。

class DBPool
数据库连接池

InitPool
初始化数据库连接池

  1. type method

  2. //cwd firefly/dbentrust/dbpool.py

  3. Prams initPool(**kw)

复制代码

**kw,关键字参数,是个字典,key:value分别对应为 config.json 这个配置文件中填写的对应值:
  1. "host":"localhost",

  2. "user":"root",

  3. "passwd":"111",

  4. "port":3306,

  5. "db":"test",

  6. "charset":"utf8"

复制代码

用于初始化数据库连接池

connection
获取一条数据库连接
  1. type method 

  2. //cwd firefly/dbentrust/dbpool.py

  3. Params connecton(self)

复制代码

class Memclient
memcached 客户端连接类,通过加上前缀的方式类分配不同的命名空间。

connect
连接memcached服务
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params connect(urls,hostname)

复制代码

Urls,连接memcached服务所需的ip和端口号
Hostname,所连接的主机名
上面两个参数的值为config.json 这个配置文件中填写的对应值:
  1. "urls":["127.0.0.1:11211"],

  2. "hostname":"anheisg"

复制代码

用于连接memcached服务


produceKey(keyname)
重新生成key
  1. [b]type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params produceKey(self,keyname)[/b]

复制代码

Key,存取值时的key名,根据key生成统一规则的新key名
Key必须为str型,否则返回 type error

get
获取key对应的值
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Prams get(key)

复制代码

get_multi
一次获取多个key的值,比for循环调用get方法快        
@param  key: list(str) key的列表
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params get_multi(keys)

复制代码

keys为list型,keys = [key1,key2,...keyn],key1,key2为str型

set
将keyname的值设置成value
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params set(keyname, value)

复制代码

成功返回True,失败返回0

set_multi
设置多个键值对
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params set_multi(mapping)

复制代码

mapping 为dic型,mapping = {key1:balue1,key2:value2},成功返回True,失败返回0

incr
自增
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params incr(key, delta)

复制代码

key,key名
delta,增加的值
给key的value值增加 delta,返回增加后的value值

delete
删除指定key
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params delete(key)

复制代码

key,key名
将key及对应的value值删除,返回值为1

delete_multi
一次删除多个key
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params delete_multi(keys)

复制代码

keys为list型,keys = [key1,key2,...keyn],key1,key2为str型

flush_all
清空所有数据,慎用
  1. type method

  2. //cwd firefly/dbentrust/memclient.py

  3. Params flush_all(self)

复制代码

class MemObject
memcached 数据到python对象的映射类。通过继承这个类来实现memcached数据格式的自定义。

produceKey
重新生成key
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params produceKey(self,keyname)

复制代码

Key,存取值时的key名,根据key生成统一规则的新key名
Key必须为str型,否则返回 type error

locked
检测对象是否被锁定
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params lock(self)

复制代码

返回对象的状态,1表示对象被锁定无法进行修改,0表示可以修改

lock
锁定对象
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params lock(self)

复制代码

将对象的锁定状态更改为1

release
释放锁
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params release(self)

复制代码

将对象的锁定状态更改为1

get
获取key对应的值
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params get(key)

复制代码

get_multi
一次获取多个key的值,比for循环调用get方法快
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params get_multi(keys)

复制代码

keys为list型,keys = [key1,key2,...keyn],key1,key2为str型

update
将key的值设置成values
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params update(key, values)

复制代码

update_multi
同时修改多个键值对的值
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params update_multi(mapping)

复制代码

mapping 为dict型,mapping = {key1:balue1,key2:value2},成功返回True,失败返回0或False

mdelete
删除本类包含的所有的数据
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params mdelete(self)

复制代码

incr
自增
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params incr(key, delta)

复制代码

key,key名
delta,增加的值
给key的value值增加 delta,返回增加后的value值

insert
插入本类包含的所有的数据
  1. type method

  2. //cwd firefly/dbentrust/memobject.py

  3. Params insert()

复制代码

class Mmode
数据库到memcached直接的映射类。可以实现延迟异步的去修改数据库中的数据,减轻数据库压力。并有自定义的过期时间,过期后memcached中的数据会被自动的清理掉。这里对过期的定义的,这个对象被访问中间的间隔时间。这个类通过继承MemObject实现

update
将key的值设置成values
  1. type method

  2. //cwd firefly/dbentrust/mmode.py

  3. Params update(key, values)

复制代码

update_multi
同时修改多个键值对的值
  1. type method

  2. //cwd firefly/dbentrust/ mmode.py

  3. Params update_multi(mapping)

复制代码

mapping 为dict型,mapping = {key1:balue1,key2:value2},成功返回True,失败返回0或False

get
获取key对应的值
  1. type method

  2. //cwd firefly/dbentrust/ mmode.py

  3. Params get(self, key)

复制代码

get_multi
一次获取多个key的值,比for循环调用get方法快
  1. type method

  2. //cwd firefly/dbentrust/ mmode.py

  3. Params get_multi(self, keys)

复制代码

keys为list型,keys = [key1,key2,...keyn],key1,key2为str型

delete
删除对象,这里只是将数据的状态修改为已经删除的状态
  1. type method

  2. //cwd firefly/dbentrust/ mmode.py

  3. Params delete(self)

复制代码

mdelete
清理对象,先将数据同步到数据库,然后真正的清理掉memcached里的本条数据
  1.  


你可能感兴趣的:(【Firefly API 新版文档】Package dbentrust)