eZoo-Client使用说明 | ezoodb 文档

# eZoo-Client使用说明

# 简介

eZoo-Client是eZooDB的配套命令行工具（包名：ezoo-client），同时也是一个eZooDB的客户端，会随eZooDB服务端（包名：ezoo-server）一同安装。

# 支持快捷的备份、还原等运维常用能力的同时，也内嵌了eZoo-SDK，能够通过命令行开启与eZooDB服务端进程的会话，并进行标准的API请求。 <!--

启动参数详细说明

启动参数	描述	默认值
-p , --port	端口号	9090
:	用户名和密码之间的分隔符
@	IP地址和账号之间的分隔符

单机模式快速启动服务，指定数据文件路径与端口，使用默认日志输出路径也可以无参数启动服务；

eZoo-Client 127.0.0.1 -p 9090

单机模式快速启动服务，指定数据文件路径与端口，同时账户授权；

eZoo-Client username:password@127.0.0.1 -p 9090 -->

# 命令列表

通过help命令可获得完整的命令列表及相关说明。

# 命令行模式
eZoo-Client --help

# 会话模式
ezoo> --help

# 常用命令示例

# 开启服务端会话

启动eZoo-Client的控制台会话，并尝试连接到一个可用的eZooDB服务端进程。

# Shell命令示例：

eZoo-Client -p port username:password@ip
# 有效简写：
eZoo-Client ip
eZoo-Client username:password@ip
eZoo-Client username@ip
# 无参数开启服务
eZoo-Client

# 参数

参数列表	描述	是否可空	默认值	示例	备注
port	服务端口	是	9090	9090
username	账号	是	*	admin
password	密码	是	*	12345678	由字母或数字或下划线组成，8-32位
ip	sever的ip地址	否	*	192.168.1.1

# 结束服务端会话

# Shell命令示例：

ezoo> exit

# 认证

在控制台操作界面，登录账号密码，进行认证

# Shell命令示例：

ezoo> auth username 
ezoo> Enter password: your_password

# 参数

参数列表	描述	是否可空	示例	备注
username	账号	否	admin
password	密码	否	12345678	由字母或数字或下划线组成，8-32位

# 用户角色

eZooDB支持自定义用户，用户通过分配角色获得相应权限，角色权限由低到高分别为：

read, readwrite, graphadmin, graphowner, monitor, admin, root

# 创建用户

在控制台操作界面，以高级用户的身份创建低级用户。

# Shell命令示例：

ezoo> user -a username -g db_name -r "roles1,roles2" 
ezoo> Enter password: your_password

# 参数

参数列表	描述	是否可空	示例	备注
username	账号	否	admin
db_name	图名称	否	modelroom
rolels	权限集合，以逗号分割	否	read	可选角色
password	密码	是	12345678	由字母或数字或下划线组成，8-32位

# 修改用户权限

在控制台操作界面，以高级用户的身份修改低级用户权限

# Shell命令示例：

ezoo> user -m username -r "roles1,roles2" -g db_name

# 参数

参数列表	描述	是否可空	示例	备注
username	账号	否	admin
db_name	图名称	否	modelroom
rolels	权限集合，以逗号分割	否	read	可选角色

# 删除用户

在控制台操作界面，以高级用户的身份删除低级用户

# Shell命令示例：

ezoo> user -d username

# 参数

参数列表	描述	是否可空	示例	备注
username	账号	否	admin

# 查看所有用户

在控制台操作界面，查询某个图中的所有用户的相关信息

# Shell命令示例：

ezoo> user -l db_name

# 参数

参数列表	描述	是否可空	示例	备注
db_name	图名称	否	modelroom

# 修改用户密码

在控制台操作界面，修改用户密码

# Shell命令示例：

ezoo> passwd username
ezoo> Enter old password: old_password
ezoo> Enter new password: password

# 参数

参数列表	描述	是否可空	示例	备注
username	账号	否	admin
old_password	密码	否	12345678	由字母或数字或下划线组成，8-32位
password	密码	否	12345678	由字母或数字或下划线组成，8-32位

# 重置用户密码

在控制台操作界面，重置用户密码

# Shell命令示例：

ezoo> passwd -R username
ezoo> Enter password: password

# 参数

参数列表	描述	是否可空	示例	备注
username	账号	否	admin
password	密码	否	12345678	由字母或数字或下划线组成，8-32位

# 取消用户权限

在控制台操作界面，取消用户权限

# Shell命令示例：

ezoo> roles -d username -g db_name

# 参数

参数列表	描述	是否可空	示例	备注
username	账号	否	admin
db_name	图名称	否	modelroom

# 获取用户权限列表

在控制台操作界面，获取指定用户的权限列表

# Shell命令示例：

ezoo> roles -l username

# 参数

参数列表	描述	是否可空	示例	备注
username	账号	否	admin

# 通过文件创建图

在控制台操作界面，创建图并导入数据

# Shell命令示例：

ezoo> graph -c db_name --schema schema_path  --iconf iconf_path

# 参数

参数列表	描述	是否可空	示例
db_name	图名称	否	modelroom
schema_path	schema文件路径	否	data/loadtest/schema.txt
iconf_path	iconf文件路径	否	data/loadtest/import_conf.txt

# 创建图

在控制台操作界面，创建图

# Shell命令示例：

ezoo> graph -c db_name

# 参数

参数列表	描述	是否可空	示例	备注
db_name	图名称	否	modelroom

# 删除图

在控制台操作界面，删除指定图

# Shell命令示例：

ezoo> graph -d db_name

# 参数

参数列表	描述	是否可空	示例	备注
db_name	图名称	否	modelroom

# 关闭图

在控制台操作界面，关闭图

# Shell命令示例：

ezoo> close db_name

# 参数

参数列表	描述	是否可空	示例	备注
db_name	图名称	否	modelroom

# 加载图

在控制台操作界面，加载图，进入QL界面，直接使用cypher语言

# Shell命令示例：

ezoo> use db_name
ezoo db_name> match (r) return r

# 参数

参数列表	描述	是否可空	示例	备注
db_name	图名称	否	modelroom	cypher参考文档

# 退出图交互

在控制台操作界面，退出QL界面

# Shell命令示例：

ezoo> q
ezoo> quit

← 导入配置文件说明 DataX →