NebulaGraph CPP¶
NebulaGraph CPP 是一款 C++ 语言的客户端,可以连接、管理 NebulaGraph 图数据库。
使用限制¶
请确保已安装 C++ 且 GCC 版本为 4.8 及以上。
版本对照表¶
NebulaGraph 版本 | NebulaGraph CPP 版本 |
---|---|
3.3.0 | 3.3.0 |
3.1.0 ~ 3.2.x | 3.0.2 |
3.0.0 | 3.0.0 |
2.6.x | 2.5.0 |
2.5.x | 2.5.0 |
2.0.x | 2.0.0 |
安装 NebulaGraph CPP¶
本文介绍通过编译方式安装 NebulaGraph CPP。
前提条件¶
- 准备正确的编译环境,详情请参见软硬件要求和安装三方库依赖包。
- 确保已安装 C++ 且 GCC 版本为:{10.1.0 | 9.3.0 | 9.2.0 | 9.1.0 | 8.3.0 | 7.5.0 | 7.1.0}。详情请参见 gcc_preset_versions 参数。
安装步骤¶
-
克隆 NebulaGraph CPP 源码到机器。
-
(推荐)如果需要安装指定版本的 NebulaGraph CPP,请使用选项
--branch
指定分支。例如安装 v3.4.0发布版本,请执行如下命令:$ git clone --branch release-3.4 https://github.com/vesoft-inc/nebula-cpp.git
-
如果需要安装日常开发版本,请执行如下命令下载
master
分支的源码:$ git clone https://github.com/vesoft-inc/nebula-cpp.git
-
-
进入目录 nebula-cpp。
$ cd nebula-cpp
-
创建目录 build 并进入该目录。
$ mkdir build && cd build
-
使用 CMake 生成 makefile 文件。
Note
默认安装路径为
/usr/local/nebula
,如果需要修改路径,请在下方命令内增加参数-DCMAKE_INSTALL_PREFIX=<installation_path>
。$ cmake -DCMAKE_BUILD_TYPE=Release ..
Note
如果 g++ 不支持 C++11,请添加选项
-DDISABLE_CXX11_ABI=ON
。 -
编译 NebulaGraph CPP。
为了适当地加快编译速度,可以使用选项
-j
并行编译。并行数量N
建议为\(\min(\text{CPU}核数,\frac{内存 (GB)}{2})\)。$ make -j{N}
-
安装 NebulaGraph CPP。
$ sudo make install
-
更新动态链接库。
$ sudo ldconfig
使用方法¶
将 CPP 文件编译为可执行文件即可。接下来以SessionExample.cpp
为例,介绍如何操作。
-
使用示例代码创建
SessionExample.cpp
文件。 -
编译文件,命令如下:
$ LIBRARY_PATH=<library_folder_path>:$LIBRARY_PATH g++ -std=c++11 SessionExample.cpp -I<include_folder_path> -lnebula_graph_client -o session_example
library_folder_path
:NebulaGraph 动态库文件存储路径,默认为/usr/local/nebula/lib64
。
include_folder_path
:NebulaGraph 头文件存储路径,默认为/usr/local/nebula/include
。
示例:
$ LIBRARY_PATH=/usr/local/nebula/lib64:$LIBRARY_PATH g++ -std=c++11 SessionExample.cpp -I/usr/local/nebula/include -lnebula_graph_client -o session_example
核心代码¶
NebulaGraph CPP 客户端提供 Session Pool 和 Connection Pool 两种方式连接 NebulaGraph。使用 Connection Pool 需要用户自行管理 Session 实例。
-
Session Pool
详细示例请参见 SessionPoolExample。
-
Connection Pool
详细示例请参见 SessionExample。