Kazoo
xlib.db.kazoo
Last updated
xlib.db.kazoo
Last updated
使用KazooClient对象建立连接：
一旦连接上，客户端会尽力保持连接，不管间歇性的连接丢失。如果要主动丢弃连接，可以使用zk.stop()，该方法会断开连接和关闭该连接的 session, 同时该连接创建的所有临时节点都会立即移除，并触发这些临时节点的 DataWatch 和这些临时节点的父节点的 ChildrenWatch。
参数说明：
hosts: 指定 ZooKeeper 的 ip 和端口，可以是以逗号分隔的多个 ZooKeeper 服务器 IP 和端口，客户端会随机选择一个来连接；
timeout: 会话超时时间，在连接断开后就开始计算，如果在此会话时间内重新连接上的话，该连接创建的临时节点就不会移除；
client_id: 传入一个可切片类型列表或者元组，【会话 id, 密码】，用于重新连接先前的会话；
handler: 传入一个~kazoo.interfaces.IHandler 的类实例，用于回调操作；
default_acl: 创建节点时设置访问控制的模式，类似 UNIX 的文件访问权限；
auth_data: 验证证书；
read_only: 创建一个只读连接；
randomize_hosts: 随机从 hosts 中选择一个 zk 服务器连接；
connection_retry: 传入 kazoo.retry.KazooRetry 中的一个类实例，用于重试 zk 连接；
logger: 自定义的 logger 对象，用来替代原有的日志；
如果代码你没有设置 logging，运行时将会提醒你没有 log handler:
除非你在代码中加入日志对象：
zk.client_state
返回客户端连接状态，状态一般有：AUTH_FAILED、CONNECTED、CONNECTED_RO、CONNECTING、CLOSED、EXPIRED_SESSION;
zk.connected
客户端是否已连接到 zk 服务器，已连接上返回 True;
zk.add_listener(listener)
添加一个回调函数，当 zk 连接状态发生改变时会被调用；
zk.remove_listener(listener)
移出 add_listener 添加的 function;
zk.start(timeout)
初始化到 zookeeper 服务器的连接，超过 timeout 时间没连接到 zk 服务器则会抛出 timeout_exception 异常，默认时间是 15 秒；
zk.stop()
关闭连接；
zk.restart()
重新连接 zk，内部直接就是先后调用 stop()和 start();
zk.close()
释放客户端占用的资源，这个方法应该在 stop()之前使用；
zk.command(self, cmd=b'ruok')
执行 zk 服务器的四字命令，传入二进制字符串；常见的命令如下：
conf
输出相关服务配置的详细信息。
cons
列出所有连接到服务器的客户端的完全的连接/会话的详细信息。包括“接受/发送”的包数量、会话 id 、操作延迟、最后的操作执行等等信息。
dump
列出未经处理的会话和临时节点。
envi
输出关于服务环境的详细信息（区别于 conf 命令）。
reqs
列出未经处理的请求
ruok
测试服务是否处于正确状态。如果确实如此，那么服务返回“ imok ”，否则不做任何相应。
stat
输出关于性能和连接的客户端的列表。
wchs
列出服务器 watch 的详细信息。
wchc
通过 session 列出服务器 watch 的详细信息，它的输出是一个与 watch 相关的会话的列表。
wchp
通过路径列出服务器 watch 的详细信息。它输出一个与 session 相关的路径。
zk.sync(path)
阻塞并等待指定节点同步到所有 zk 服务器，返回同步的节点；
zk.create(path, value=b"")
创建一个新的节点，节点数据为 value;
zk.ensure_path(path)
如何这个节点的父节点不存在，自动创建父节点路径；
zk.exists(path,watch=None)
检查节点是否存在，存在返回节点的 ZnodeStat 信息，否则返回 None。可传入回调方法 watch,当节点 create/delete 或是 set 的时候该方法会被调用
zk.get(path)
获取节点值。
zk.get_children(path)
获取所有子节点，返回列表形式。
zk.set(path, value)
设置节点的值。
zk.delete(path recursive=False)
删除节点，recursive 为 True 表示递归删除节点及其子节点，如果有子节点且 recursive 为 False，则会产生 NotEmptyError 异常，表示该节点有子节点不能删除
可用来知道 ZooKeeper 连接删除、恢复或者过期的消息。为了简化这个过程，Kazoo 使用一个状态系统，并允许你注册监听函数，以便在状态改变时被调用。
当使用kazoo.recipe.lock.Lock或创建临时节点时，最好添加一个状态监听器，以便在连接中断或 Zookeeper 会话丢失时做出应对动作。
KazooState对象表示客户端链接的几个状态。客户端的当前状态总是可以通过查看 state 属性来确定。可能的状态有：
LOST
CONNECTED
SUSPENDED
首次创建 KazooClient 实例时，它处于 LOST 状态。建立连接后，它将转换到 CONNECTED 状态。如果出现连接问题或者需要连接到其他的 Zookeeper 集群节点，状态将转换为 SUSPENDED，此时无法执行任何命令。如果 Zookeeper 节点不再是 Quorum 的一部分，连接也将丢失，状态置为 SUSPENDED。
再重新建立连接时，如果会话已经过期，则客户端可以转换到 LOST，或者如果会话仍然有效，则客户端可以转换为 CONNECTED。
注：在实际应用中最好使用前文提出的监听函数监视这些状态，以便客户端根据连接的状态正确运行。
当连接状态为 SUSPENDED 时，此时客户端应当暂停执行需要与其他系统协议的操作（例如分布式锁），当连接重新建立后，如果状态转换为 CONNECTED 才可以继续。当连接状态为 LOST 时，Zookeeper 将删除已创建的任何临时节点。这会影响创建临时节点的所有 recipes。
LOST -> CONNECTED
建立新连接，或丢失的连接恢复。
CONNECTED -> SUSPENDED
Connection 丢失了服务端的连接。
CONNECTED -> LOST
仅在连接建立后提供无效的身份验证凭证时才会发生。
SUSPENDED -> LOST
Connection 服务端已恢复，但是会话已过期而丢失。
SUSPENDED -> CONNECTED
丢失的连接已恢复。
ZooKeeper3.4 及以上版本支持只读模式。只有 ZooKeeper 集群服务启用此模式，客户端才能使用它。只要将 KazooClient 的 read_only 设置为 True 便可以使客户端连接到只读的 Zookeeper 节点。
