vesoft/nebula-console

NebulaGraph Console 镜像文档

镜像概述与主要用途

NebulaGraph Console（简称Console）是NebulaGraph 3.x的官方控制台工具，用于与NebulaGraph图数据库交互。通过该工具，用户可创建图模式（Schema）、导入示范数据集（如basketballplayer）、执行数据检索与管理操作，支持交互式（命令行直接输入）和非交互式（执行脚本文件）两种模式，是NebulaGraph数据库日常管理、开发调试及数据操作的核心工具。

核心功能与特性

• 双操作模式：支持交互式（实时输入命令）和非交互式（执行指定nGQL语句或脚本文件）操作。
• 历史命令管理：可查看、调用已执行的历史命令。
• 命令自动补全：提供命令关键字自动补全，提升操作效率。
• 跨平台兼容：支持多种操作系统及架构（推荐Linux/AMD64环境）。
• 数据导出能力：支持将查询结果导出为CSV文件，执行计划导出为DOT格式（可视化）或ASCII表格。

兼容性矩阵

使用场景与适用范围

• 数据库日常管理：图模式创建/修改、用户认证配置、集群状态监控等。
• 数据操作与查询：执行nGQL语句检索、分析图数据。
• 自动化脚本执行：通过非交互式模式批量执行nGQL脚本，实现自动化运维。
• 查询性能优化：导出执行计划，分析并优化nGQL语句性能。

安装与使用方法

Docker 部署（推荐）

前提条件

• 已安装Docker引擎。
• 若连接本地NebulaGraph容器集群，需确保Console容器与集群在同一网络（默认NebulaGraph Docker Compose网络为nebula-docker-compose_nebula-net）。

镜像版本选择

Docker镜像标签对应Console版本（如nightly为开发版，v3.0.0、v3.4.x为稳定版），需根据NebulaGraph版本选择兼容的Console版本（见兼容性矩阵）。

部署示例

方式一：进入容器Shell执行Console

启动容器并进入交互式Shell，容器内预装nebula-console：

bash
docker run --rm -ti --network nebula-docker-compose_nebula-net --entrypoint=/bin/sh vesoft/nebula-console:nightly

在容器Shell中连接NebulaGraph（示例连接默认集群，graphd服务名为graphd）：

bash
nebula-console -u root -p nebula --address=graphd --port=9669

方式二：直接执行Console命令

通过docker run直接执行Console命令，连接NebulaGraph：

bash
docker run --rm -ti --network nebula-net vesoft/nebula-console:nightly -addr graphd -port 9669 -u root -p nebula

参数说明：

• --rm：容器退出后自动删除。
• -ti：启用交互式终端。
• --network：指定网络（需与NebulaGraph集群网络一致）。
• vesoft/nebula-console:nightly：镜像名称及标签（替换为所需版本）。
• 连接参数：
  • -addr：graphd服务IP/主机名（容器网络中可直接使用服务名，如graphd）。
  • -port：graphd服务端口（默认9669）。
  • -u：NebulaGraph用户名（默认root）。
  • -p：用户密码（默认nebula）。
  • 可选参数：-t <超时时间>（毫秒，默认120）、-e "<nGQL语句>"（执行单条语句）、-f <文件路径>（执行脚本文件）、-enable_ssl（启用SSL连接）等。

其他安装方式（可选）

源码编译安装

1. 环境准备：安装Go 1.13及以上版本。
2. 克隆源码：

   bash
   git clone https://github.com/vesoft-inc/nebula-console && cd nebula-console
   

3. 编译二进制：

   bash
   make
   

   生成nebula-console二进制文件。
4. 连接数据库：

   bash
   ./nebula-console -addr <IP> -port <端口> -u <用户名> -p <密码> [-t 120] [-e "nGQL语句" | -f 脚本文件]
   

二进制文件安装

1. 从https://github.com/vesoft-inc/nebula-console/releases%E4%B8%8B%E8%BD%BD%E5%AF%B9%E5%BA%94%E5%B9%B3%E5%8F%B0%E7%9A%84%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E3%80%82
2. 添加执行权限：

   bash
   chmod +x <二进制文件名>
   

3. 连接数据库（同源码编译后的连接命令）。

控制台常用命令

说明：以下命令不区分大小写。

数据导出

• 导出查询结果至CSV：

  nGQL
  nebula> :csv a.csv  # 后续查询结果导出至a.csv
  

• 导出执行计划（DOT格式）： 配合PROFILE FORMAT="dot"使用，导出可视化执行计划：

  nGQL
  nebula> :dot a.dot
  nebula> PROFILE FORMAT="dot" GO FROM "player102" OVER serve YIELD dst(edge);
  

  DOT文件内容可粘贴至https://dreampuf.github.io/GraphvizOnline/%E5%8F%AF%E8%A7%86%E5%8C%96%E3%80%82

• 导出执行计划（ASCII表格）： 配合PROFILE/EXPLAIN导出执行计划至文件：

  nGQL
  nebula> :profile profile.log  # 导出PROFILE结果
  nebula> PROFILE GO FROM "player102" OVER serve YIELD dst(edge);
  
  nebula> :explain explain.log  # 导出EXPLAIN结果
  nebula> EXPLAIN GO FROM "player102" OVER serve YIELD dst(edge);
  

示范数据集导入

导入basketballplayer示范数据集：

nGQL
nebula> :play basketballplayer

命令重复执行

设置重复执行某语句n次（显示平均执行时间）：

nGQL
nebula> :repeat 3  # 重复执行3次后续语句

退出控制台

支持以下命令退出：

nGQL
nebula> :QUIT
nebula> :EXIT
nebula> quit
nebula> exit

键盘快捷键