图管理接口 | ezoodb 文档

# 图管理接口

# 接口列表：

创建数据库
通过文件创建数据库
删除数据库
导出图数据
打开数据库
关闭数据库
刷新数据库
获取数据库列表
获取活跃数据库列表
获取数据库状态

# 创建数据库

# 方法

void create(Response &_return,
            const string& db_name, 
            const map<string, string> &parameters);

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
db_name	string	数据库名称	否	""	"ezoo"
parameters	`map`	可选参数列表	否	*	{}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	创建数据库响应结果	否	*	*

# 通过文件创建数据库

# 方法

void create_graph(Response &_return, 
                  const string &db_name,
                  const string &schema_path, 
                  const string &import_conf_path)

# 参数

参数列表	类型	描述	是否可空	默认值	示例
db_name	string	数据库名称	否	""	"ezoo"
schema_path	string	schema文件路径	否	""	*
import_conf_path	string	数据文件路径	否	""	*

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	创建数据库响应结果	否	*	*

# 删除数据库

# 方法

void drop(Response &_return,
          const std::string &db_name,
          const map<string, string> &parameters);

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
db_name	string	数据库名称	否	""	"ezoo"
parameters	`map`	可选参数列表	否	*	{}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	删除数据库响应结果	否	*	*

# 导出图数据

# 方法

void export_graph(Response &_return,
	              const std::string &db_name,
                  const map<string, string> &parameters)

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
db_name	string	数据库名称	否	""	"ezoo"
parameters	`map`	可选参数列表	否	*	{}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	刷新数据库响应结果	否	*	*

# 打开数据库

# 方法

void close_graph(Response &_return,
                const std::string &db_name,
                const map<string, string> &parameters);

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
db_name	string	数据库名称	否	""	"ezoo"
parameters	`map`	可选参数列表	否	*	{}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	打开数据库响应结果	否	*	*

# 关闭数据库

# 方法

void open_graph(Response &_return,
                const std::string &db_name,
                const map<string, string> &parameters);

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
db_name	string	数据库名称	否	""	"ezoo"
parameters	`map`	可选参数列表	否	*	{}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	关闭数据库响应结果	否	*	*

# 刷新数据库

# 方法

void reload_graph(Response &_return,
                  const std::string &db_name,
                  const map<string, string> &parameters);

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
db_name	string	数据库名称	否	""	"ezoo"
parameters	`map`	可选参数列表	否	*	{}

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	Response	刷新数据库响应结果	否	*	*

# 获取数据库列表

# 简述

通过此接口，可以获取当前服务中所有数据库的名称。

# 方法

void get_graph_list(graph_list &_return,
                    const map<string, string> &parameters);

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
parameters	`map`	可选参数列表	否	*	{}	key-value形式参数，暂时传空map。

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	graph_list	数据库列表结构	否	*	*

# 获取活跃数据库列表

# 简述

通过此接口，可以获取当前服务中所有启动的数据库的名称。

# 方法

void get_active_graph_list(graph_list &_return,
                           const map<string, string> &parameters);

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
parameters	`map`	可选参数列表	否	*	{}	key-value形式参数，暂时传空map。

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	graph_list	数据库列表结构	否	*	*

# 获取数据库状态

# 简述

通过此接口，可以获取当前服务中所有数据库的服务状态。此接口用于分布式服务与监控服务。

# 方法

void get_status(server_info &_return, 
                const map<string, string> &parameters);

# 参数

参数列表	类型	描述	是否可空	默认值	示例	备注
parameters	`map`	可选参数列表	否	*	{}	key-value形式参数，暂时传空map。

# 返回值

参数列表	类型	描述	是否可空	默认值	示例	备注
_return	server_info	获取数据库状态响应结果	否	*	*

← 图更新接口图查询接口 →