跳转至

连接 NebulaGraph 服务

本文介绍如何使用原生命令行客户端 Nebula Console 连接 NebulaGraph。

Caution

首次连接到 NebulaGraph 后,必须先注册 Storage 服务,才能正常查询数据。

NebulaGraph 支持多种类型的客户端,包括命令行客户端、可视化界面客户端和流行编程语言客户端。详情参见客户端列表

前提条件

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

    Note

    版本相同的 Nebula Console 和 NebulaGraph 兼容程度最高,版本不同的 Nebula Console 连接 NebulaGraph 时,可能会有兼容问题,或者无法连接并报错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. 执行如下命令连接 NebulaGraph。

    • 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/-help 显示帮助菜单。
    -addr/-address 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。
    -P/-port 设置要连接的 Graph 服务的端口。默认端口为 9669。
    -u/-user 设置 NebulaGraph 账号的用户名。未启用身份认证时,可以使用任意已存在的用户名(默认为root)。
    -p/-password 设置用户名对应的密码。未启用身份认证时,密码可以填写任意字符。
    -t/-timeout 设置整数类型的连接超时时间。单位为毫秒,默认值为 120。
    -e/-eval 设置字符串类型的 nGQL 语句。连接成功后会执行一次该语句并返回结果,然后自动断开连接。
    -f/-file 设置存储 nGQL 语句的文件的路径。连接成功后会执行该文件内的 nGQL 语句并返回结果,执行完毕后自动断开连接。
    -enable_ssl 连接 NebulaGraph 时使用 SSL 加密。
    -ssl_root_ca_path 指定 CA 证书的存储路径。
    -ssl_cert_path 指定 CRT 证书的存储路径。
    -ssl_private_key_path 指定私钥文件的存储路径。

    更多参数参见项目仓库


最后更新: September 4, 2023