跳转至

连接 Nebula Graph 服务

Nebula Graph 支持多种类型客户端,包括 CLI 客户端、GUI 客户端和流行编程语言开发的客户端。本文将概述 Nebula Graph 客户端,并介绍如何使用原生 CLI 客户端 Nebula Console。

Nebula Graph 客户端

用户可以使用已支持的客户端或者命令行工具来连接 Nebula Graph 数据库。

使用 Nebula Console 连接 Nebula Graph

前提条件

  • Nebula Graph 服务已启动
  • 运行 Nebula Console 的机器和运行 Nebula Graph 的服务器网络互通。
  • Nebula Console 版本兼容 Nebula Graph 版本。

    Note

    版本相同的 Nebula Console 和 Nebula Graph 兼容程度最高,版本不同的 Nebula Console 连接 Nebula Graph 时,可能会有兼容问题,或者无法连接并报错incompatible version between client and server

操作步骤

  1. Nebula Console 下载页面,确认需要的版本,单击 Assets

    Note

    建议选择最新版本。

  2. Assets 区域找到机器运行所需的二进制文件,下载文件到机器上。

  3. (可选)为方便使用,重命名文件为nebula-console

    Note

    在 Windows 系统中,请重命名为nebula-console.exe

  4. 在运行 Nebula Console 的机器上执行如下命令,为用户授予 nebula-console 文件的执行权限。

    Note

    Windows 系统请跳过此步骤。

    $ chmod 111 nebula-console
    
  5. 在命令行界面中,切换工作目录至 nebula-console 文件所在目录。

  6. 执行如下命令连接 Nebula Graph。

    • Linux 或 macOS

      $ ./nebula-console -addr <ip> -port <port> -u <username> -p <password>
        [-t 120] [-e "nGQL_statement" | -f filename.nGQL]
      
    • Windows

      > nebula-console.exe -addr <ip> -port <port> -u <username> -p <password>
        [-t 120] [-e "nGQL_statement" | -f filename.nGQL]
      

    参数说明如下。

    参数 说明
    -h 显示帮助菜单。
    -addr 设置要连接的 graphd 服务的 IP 地址。默认地址为 127.0.0.1。
    -port 设置要连接的 graphd 服务的端口。默认端口为 9669。
    -u/-user 设置 Nebula Graph 账号的用户名。未启用身份认证时,可以使用任意已存在的用户名(默认为root)。
    -p/-password 设置用户名对应的密码。未启用身份认证时,密码可以填写任意字符。
    -t/-timeout 设置整数类型的连接超时时间。单位为秒,默认值为 120。
    -e/-eval 设置字符串类型的 nGQL 语句。连接成功后会执行一次该语句并返回结果,然后自动断开连接。
    -f/-file 设置存储 nGQL 语句的文件的路径。连接成功后会执行该文件内的 nGQL 语句并返回结果,执行完毕后自动断开连接。

用户可以使用./nebula-console --help命令获取所有参数的说明,也可以在项目仓库找到更多说明。


最后更新: March 7, 2023