【持续更新】NebulaGraph详细学习文档

NebulaGraph

一、简介

图数据库是一种专门用于存储和管理图数据结构的数据库管理系统。图数据库使用图的概念来表示和处理数据，其中图是由节点和边组成的数据结构，用于表示实体（节点）之间的关系（边）。与传统的关系型数据库不同，图数据库的核心思想是侧重于节点和边的关系，从而更好地处理复杂的数据关联和查询。

图数据库具有以下特点：

1. 图结构：图数据库使用节点和边来表示数据。节点表示实体，边表示实体之间的关系。通过节点和边的连接，可以构建出复杂的数据网络。
2. 关系导向：图数据库以关系为中心，强调实体之间的关联和连接。这使得图数据库在处理复杂的关系型查询时更加高效。
3. 灵活性：图数据库具有很高的灵活性，可以适应数据结构的变化和扩展。新的实体和关系可以轻松地添加到数据库中，而不需要修改现有的表结构。
4. 高性能：图数据库在处理复杂的关联查询时非常高效。由于图数据库中的关系已经预先建立，查询可以直接通过边的引用进行导航，而无需进行多重的连接操作。
5. 查询能力：图数据库提供了强大的查询语言和操作，使得可以轻松地进行复杂的关联查询和路径分析。这使得图数据库在社交网络分析、推荐系统、网络安全等领域有着广泛的应用。

在图数据库的应用方面，它可以被用于许多不同的场景，如社交网络分析、知识图谱构建、推荐系统、路径规划、股权穿透等。例如，在社交网络分析中，图数据库可以存储社交用户之间的关注关系、好友关系等，并进行高效的关联查询；在推荐系统中，可以使用图数据库存储用户行为和物品关系，以提供个性化的推荐结果。

2.1系统架构

NebulaGraph由三种服务构成：Graph 服务、Meta 服务和 Storage 服务，是一种存储与计算分离的架构。

每个服务都有可执行的二进制文件和对应进程，用户可以使用这些二进制文件在一个或多个计算机上部署NebulaGraph集群。

下图展示了NebulaGraph集群的经典架构。

Meta 服务¶

在NebulaGraph架构中，Meta 服务是由 nebula-metad 进程提供的，负责数据管理，例如 Schema 操作、集群管理和用户权限管理等。

Meta 服务的详细说明，请参见 Meta 服务。

Graph 服务和 Storage 服务¶

NebulaGraph采用计算存储分离架构。Graph 服务负责处理计算请求，Storage 服务负责存储数据。它们由不同的进程提供，Graph 服务是由 nebula-graphd 进程提供，Storage 服务是由 nebula-storaged 进程提供。计算存储分离架构的优势如下：

• 易扩展

  分布式架构保证了 Graph 服务和 Storage 服务的灵活性，方便扩容和缩容。

• 高可用

  如果提供 Graph 服务的服务器有一部分出现故障，其余服务器可以继续为客户端提供服务，而且 Storage 服务存储的数据不会丢失。服务恢复速度较快，甚至能做到用户无感知。

• 节约成本

  计算存储分离架构能够提高资源利用率，而且可根据业务需求灵活控制成本。

• 更多可能性

  基于分离架构的特性，Graph 服务将可以在更多类型的存储引擎上单独运行，Storage 服务也可以为多种目的计算引擎提供服务。

Graph 服务和 Storage 服务的详细说明，请参见 Graph 服务和 Storage 服务。

二、部署

2.1 单机部署

系统：CentOS7

版本：v3.5.0

2.1.1下载安装包

进入官网选择对应的安装包进行下载

NebulaGraph 安装下载 (nebula-graph.com.cn)

2.1.2上传至虚拟机中

#创建nebula目录，将安装包传入目录中
mkdir /usr/local/nebula/
1
2

2.1.3rpm安裝

下载xxx.rpm格式的安装包则进行该步骤

cd /usr/local/nebula/
sudo rpm -ivh xxx.rpm
1
2

2.1.3*压缩包安装

下载xxx.tar.gz格式的安装包则进行该步骤

cd /usr/local/nebula/
tar -xzvf xxx.tar.gz
1
2

2.1.4关闭防火墙

systemctl stop firewalld
systemctl enable firewalld
1
2

2.1.5使用 NTP 服务同步时间

防止集群时间不统一

sudo yum install ntpdate
sudo ntpdate ntp1.aliyun.com
1
2

2.1.6Meta 服务配置¶

Meta 服务提供了两份初始配置文件nebula-metad.conf.default和nebula-metad.conf.production，方便在不同场景中使用。文件的默认路径为/usr/local/nebula/etc/

如需使用初始配置文件，从上述两个文件选择其一，删除后缀.default或.production，Meta 服务才能将其识别为配置文件并从中获取配置信息。

配置文件内没有设置某个参数表示参数使用的是默认值。文件内只预设了部分参数的值，而且两份初始配置文件内的参数值也略有不同，本文的预设值以nebula-metad.conf.default为准

basics 配置¶

Note

• 在插入时间类型的属性值时，NebulaGraph会根据timezone_name设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。
• timezone_name参数只用于转换NebulaGraph中存储的数据，NebulaGraph进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。

logging 配置¶

networking 配置¶

必须在配置文件中使用真实的 IP 地址。否则某些情况下127.0.0.1/0.0.0.0无法正确解析。

storage 配置¶

misc 配置¶

rocksdb options 配置¶

2.1.6Graph 服务配置¶

basics 配置¶

Note

• 在插入时间类型 的属性值时，NebulaGraph会根据timezone_name设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。
• timezone_name参数只用于转换NebulaGraph中存储的数据，NebulaGraph进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。

logging 配置¶

query 配置¶

networking 配置¶

必须在配置文件中使用真实的 IP 地址。否则某些情况下127.0.0.1/0.0.0.0无法正确解析。

charset and collate 配置¶

authorization 配置¶

memory 配置¶

metrics 配置¶

session 配置¶

experimental 配置¶

memory tracker 配置¶

performance optimization 配置¶

2.1.7Storage 服务配置¶

basics 配置¶

• 在插入时间类型的属性值时，NebulaGraph会根据timezone_name设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。
• timezone_name参数只用于转换NebulaGraph中存储的数据，NebulaGraph进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。

logging 配置¶

networking 配置¶

Caution

必须在配置文件中使用真实的 IP 地址。否则某些情况下127.0.0.1/0.0.0.0无法正确解析。

raft 配置¶

disk 配置¶

misc 配置¶

下表中的snapshot与NebulaGraph快照是不同的概念，这里的snapshot指 Raft 同步过程中 leader 上的存量数据。

rocksdb options 配置¶

2.1.8Linux 内核配置¶

本文介绍与NebulaGraph相关的 Linux 内核配置，并介绍如何修改配置。

资源控制¶

ulimit 注意事项¶

命令ulimit用于为当前 shell 会话设置资源阈值，注意事项如下：

• ulimit所做的更改仅对当前会话或子进程生效。

• 资源的阈值（软阈值）不能超过硬阈值。

• 普通用户不能使用命令调整硬阈值，即使使用sudo也不能调整。

• 修改系统级别或调整硬性阈值，请编辑文件/etc/security/limits.conf。这种方式需要重新登录才生效。

ulimit -c¶

ulimit -c用于限制 core 文件的大小，建议设置为unlimited，命令如下：

ulimit -c unlimited
1

ulimit -n¶

ulimit -n用于限制打开文件的数量，建议设置为超过 10 万，例如：

ulimit -n 130000
1

内存¶

vm.swappiness¶

vm.swappiness是触发虚拟内存（swap）的空闲内存百分比。值越大，使用 swap 的可能性就越大，建议设置为 0，表示首先删除页缓存。需要注意的是，0 表示尽量不使用 swap。

vm.min_free_kbytes¶

vm.min_free_kbytes用于设置 Linux 内核保留的最小空闲千字节数。如果系统内存足够，建议设置较大值。例如物理内存为 128 GB，可以将vm.min_free_kbytes设置为 5 GB。如果值太小，会导致系统无法申请足够的连续物理内存。

vm.max_map_count¶

vm.max_map_count用于限制单个进程的 VMA（虚拟内存区域）数量。默认值为65530，对于绝大多数应用程序来说已经足够。如果应用程序因为内存消耗过大而报错，请增大本参数的值。

vm.dirty_¶

vm.dirty_*是一系列控制系统脏数据缓存的参数。对于写密集型场景，用户可以根据需要进行调整（吞吐量优先或延迟优先），建议使用系统默认值。

Transparent huge page¶

为了降低延迟，用户必须关闭 THP（transparent huge page）。命令如下：

root# echo never > /sys/kernel/mm/transparent_hugepage/enabled
root# echo never > /sys/kernel/mm/transparent_hugepage/defrag
root# swapoff -a && swapon -a
1
2
3

为了防止系统重启后该配置失效，可以在GRUB配置文件或/etc/rc.local中添加相关配置，使系统启动时自动关闭 THP。

网络¶

net.ipv4.tcp_slow_start_after_idle¶

net.ipv4.tcp_slow_start_after_idle默认值为 1，会导致闲置一段时间后拥塞窗口超时，建议设置为0，尤其适合大带宽高延迟场景。

net.core.somaxconn¶

net.core.somaxconn用于限制 socket 监听的连接队列数量。默认值为128。对于有大量突发连接的场景，建议设置为不低于1024。

net.ipv4.tcp_max_syn_backlog¶

net.ipv4.tcp_max_syn_backlog用于限制处于 SYN_RECV（半连接）状态的 TCP 连接数量。默认值为128。对于有大量突发连接的场景，建议设置为不低于1024。

net.core.netdev_max_backlog¶

net.core.netdev_max_backlog用于限制队列中数据包的数量。默认值为1000，建议设置为10000以上，尤其是万兆网卡。

net.ipv4.tcp_keepalive_*¶

net.ipv4.tcp_keepalive_*是一系列保持 TCP 连接存活的参数。对于使用四层透明负载均衡的应用程序，如果空闲连接异常断开，请增大tcp_keepalive_time和tcp_keepalive_intvl的值。

net.ipv4.tcp_wmem/rmem¶

TCP 套接字发送/接收缓冲池的最小、最大、默认空间。对于大连接，建议设置为带宽 (GB) *往返时延 (ms)。

scheduler¶

对于 SSD 设备，建议将scheduler设置为noop或者none，路径为/sys/block/DEV_NAME/queue/scheduler。

其他参数¶

kernel.core_pattern¶

建议设置为core，并且将kernel.core_uses_pid设置为1。

修改参数¶

sysctl 命令¶

• sysctl <conf_name>

  查看当前参数值。

• sysctl -w <conf_name>=<value>

  临时修改参数值，立即生效，重启后恢复原值。

• sysctl -p [<file_path>]

  从指定配置文件里加载 Linux 系统参数，默认从/etc/sysctl.conf加载。

prlimit¶

命令prlimit可以获取和设置进程资源的限制，结合sudo可以修改硬阈值，例如，prlimit --nofile=140000 --pid=$$调整当前进程允许的打开文件的最大数量为140000，立即生效，此命令仅支持 RedHat 7u 或更高版本。

2.1.9运行日志

NebulaGraph默认使用 glog 打印运行日志，使用 gflags 控制日志级别，并在运行时通过 HTTP 接口动态修改日志级别，方便跟踪问题
运行日志的默认目录为/usr/local/nebula/logs/。
如果在NebulaGraph运行过程中删除运行日志目录，日志不会继续打印，但是不会影响业务。重启服务可以恢复正常。

配置说明

minloglevel：最小日志级别，即不会记录低于这个级别的日志。可选值为0（INFO）、1（WARNING）、2（ERROR）、3（FATAL）。建议在调试时设置为0，生产环境中设置为1。如果设置为4，NebulaGraph不会记录任何日志。
v：日志详细级别，值越大，日志记录越详细。可选值为0、1、2、3。
Meta 服务、Graph 服务和 Storage 服务的日志级别可以在各自的配置文件中查看，默认路径为/usr/local/nebula/etc/。

查看运行日志级别

使用如下命令查看当前所有的 gflags 参数（包括日志参数）：

curl <ws_ip>:<ws_port>/flags
1

示例如下：
查看 Meta 服务当前的最小日志级别：

curl 127.0.0.1:19559/flags | grep 'minloglevel'
1

查看 Storage 服务当前的日志详细级别：

curl 127.0.0.1:19779/flags | grep -w 'v'
1

修改运行日志级别

使用如下命令修改运行日志级别：

curl -X PUT -H "Content-Type: application/json" -d '{"<key>":<value>[,"<key>":<value>]}' "<ws_ip>:<ws_port>/flags"
1

示例如下：

curl -X PUT -H "Content-Type: application/json" -d '{"minloglevel":0,"v":3}' "127.0.0.1:19779/flags" #storaged
curl -X PUT -H "Content-Type: application/json" -d '{"minloglevel":0,"v":3}' "127.0.0.1:19669/flags" #graphd
curl -X PUT -H "Content-Type: application/json" -d '{"minloglevel":0,"v":3}' "127.0.0.1:19559/flags" # metad
1
2
3

如果在NebulaGraph运行时修改了运行日志级别，重启服务后会恢复为配置文件中设置的级别，如果需要永久修改，请修改配置文件。

2.2 集群部署

2.2.1集群角色

将单机版复制的基础虚拟机复制为三份，配置其IP如下

2.2.2hosts

10.8.16.150 nebula1
10.8.16.151 nebula2
10.8.16.152 nebula3
1
2
3

2.2.3修改配置

复制nebula-storaged.conf.production为nebula-storaged.conf

cd /usr/local/nebula/etc/
cp nebula-graphd.conf.production nebula-graphd.conf
cp nebula-storaged.conf.production nebula-storaged.conf
cp nebula-metad.conf.production nebula-metad.conf
1
2
3
4

修改三个文件中对应配置如以下配置

• nebula-graphd.conf

  ########## networking ##########
  # Comma separated Meta Server Addresses
  --meta_server_addrs=10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559
  # Local IP used to identify the nebula-graphd process.
  # Change it to an address other than loopback if the service is distributed or
  # will be accessed remotely.
  --local_ip=10.8.16.150
  # Network device to listen on
  --listen_netdev=any
  # Port to listen on
  --port=9669
  ########## authentication ##########
  # 设置用户认证
  --enable_authorize=true
  # User login authentication type, password for nebula authentication, ldap for ldap authentication, cloud for cloud authentication
  --auth_type=password
  --failed_login_attempts=15
  # 可选项，需要手动添加该参数。单个 Graph 节点允许连续输入错误密码的次数。超过该次数时，账户会被锁定。如果有多个 Graph 节点，允许的次数为节点数 * 次数。
  --password_lock_time_in_secs=60
  #可选项，需要手动添加该参数。多次输入错误后，账户被锁定的时间。单位：秒。
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20

• nebula-storaged.conf

  ########## networking ##########
  # Comma separated Meta server addresses
  --meta_server_addrs=10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559
  # Local IP used to identify the nebula-storaged process.
  # Change it to an address other than loopback if the service is distributed or
  # will be accessed remotely.
  --local_ip=10.8.16.150
  # Storage daemon listening port
  --port=9779
  1
  2
  3
  4
  5
  6
  7
  8
  9

• nebula-metad.conf

  ########## networking ##########
  # Comma separated Meta Server addresses
  --meta_server_addrs=10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559
  # Local IP used to identify the nebula-metad process.
  # Change it to an address other than loopback if the service is distributed or
  # will be accessed remotely.
  --local_ip=10.8.16.150
  # Meta daemon listening port
  --port=9559
  1
  2
  3
  4
  5
  6
  7
  8
  9

2.2.4启动集群

在每台计算机上启动相应的服务。说明如下。

#启动命令
sudo /usr/local/nebula/scripts/nebula.service start all
sudo /usr/local/nebula/scripts/nebula.service start metad
sudo /usr/local/nebula/scripts/nebula.service start graphd
sudo /usr/local/nebula/scripts/nebula.service start storaged
1
2
3
4
5

2.2.5连接集群

原生CLI客户端连接

• 下载原生CLI客户端安装包

​ 发布 ·维软公司/星云控制台 (github.com)

• 解压重命名文件为nebula-console,对于 Windows，请将文件重命名为 。nebula-console.exe
• 授予原生CLI客户端二进制文件的执行权限。对于 Windows，请跳过此步骤。
• 连接控制台

#对于 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]
1
2
3
4
5
6

NebulaGraph Studio

为了方便连接数据库，需要部署NebulaGraph Studio，它是一款可以通过 Web 访问的开源图数据库可视化工具。

• 下载安装包

最新活动-NebulaGraph 图数据库 (nebula-graph.com.cn)

• 解压

tar -xzvf nebula-graph-studio-3.5.0.x86_64.tar.gz
1

• 启动

cd /usr/local/nebula/nebula-graph-studio
nohup ./server start &
1
2

• 访问web

如果未开启认证，输入ip端口后，用户为root，密码root(随意输入即可登录)，如果开了默认密码为nebula

http://10.8.16.150:7001/login

注：连接后控制台输入以下SQL,集群才能正常运转

ADD HOSTS 10.8.16.150:9779, 10.8.16.151:9779, 10.8.16.152:9779;
1

三、NebulaGraph监控指标¶

3.1监控指标结构说明

NebulaGraph的每个监控指标都由三个部分组成，中间用英文句号（.）隔开，例如num_queries.sum.600。不同的NebulaGraph服务支持查询的监控指标也不同。指标结构的说明如下。

3.2通过 HTTP 端口查询监控指标

语法

curl -G "http://<ip>:<port>/stats?stats=<metric_name_list> [&format=json]"
1

• 如果NebulaGraph服务部署在容器中，需要执行docker-compose ps命令查看映射到容器外部的端口，然后通过该端口查询。

3.3查询图空间监控指标

Graph 服务支持一系列基于图空间的监控指标，对不同图空间的数据分别记录。

图空间指标只能通过查询所有监控指标的形式查询到，例如curl -G "http://10.8.16.150:19559/stats"，返回结果中以{space=space_name}的形式包含图空间名称，例如num_active_queries{space=basketballplayer}.sum.5=0。

• 如需开启图空间监控指标，先在 Graph 服务的配置文件中将enable_space_level_metrics参数的值修改为true，再启动NebulaGraph。修改配置的详细方式参见配置管理。

3.4监控指标说明

3.4.1Graph

3.4.2Meta

3.4.3Storage

3.4.4图空间级别监控指标

• 图空间级别监控指标是动态创建的, 只有当图空间内触发该行为时，对应的指标才会创建，用户才能查询到。

3.2 RocksDB 统计数据¶

3.3 NebulaGraph Dashboard

NebulaGraph Dashboard（简称 Dashboard）是一款用于监控NebulaGraph集群中机器和服务状态的可视化工具。

3.3.1前置条件

• NebulaGraph服务已经部署并启动。详细信息参考 NebulaGraph安装部署。

• 确保以下端口未被使用：

  9200、9100、9090、8090、7003

• 待监控的所有机器上已经安装 node-exporter。

yum install wget
cd /usr/local/nebula
#下载不了官网手动下载 https://prometheus.io/download/#node_exporter
wget https://github.com/prometheus/node_exporter/releases/tag/v1.6.1/node_exporter-1.6.1.linux-amd64.tar.gz
tar xvfz node_exporter-1.6.1.linux-amd64.tar.gz
mv node_exporter-1.6.1.linux-amd64 /node_exporter
cd node_exporter
1
2
3
4
5
6
7

vi /etc/systemd/system/node_exporter.service
#添加以下内容
[Unit]
Description=node_exporter server
After=network.target
[Service]
ExecStart=/usr/local/nebula/node_exporter/node_exporter
Restart=always
[Install]
WantedBy=multi-user.target
1
2
3
4
5
6
7
8
9
10

systemctl start node_exporter.service
systemctl enable node_exporter.service
1
2

3.3.2安装Dashboard

安裝包部署

• 下载 TAR 包 nebula-dashboard-3.4.0.x86_64.tar.gz。

• 执行命令tar -xvf nebula-dashboard-3.4.0.x86_64.tar.gz解压缩。

• 进入解压缩的nebula-dashboard文件夹，并修改配置文件config.yaml。

配置文件内主要包含 4 种依赖服务的配置和集群的配置。依赖服务的说明如下。

配置文件说明如下。

port: 7003   # Web 服务端口。
gateway:
  ip: 10.8.16.150   # 部署 Dashboard 的机器 IP。
  port: 8090
  https: false  # 是否为 HTTPS 端口。
  runmode: dev  # 程序运行模式，包括 dev、test、prod。一般用于区分不同运行环境。
stats-exporter:
  ip: 10.8.16.150   # 部署 Dashboard 的机器 IP。
  nebulaPort: 9200
  https: false  # 是否为 HTTPS 端口。
node-exporter:
  - ip: 10.8.16.150 # 部署node-exporter的机器 IP。
    port: 9100
    https: false # 是否为 HTTPS 端口。
  - ip: 10.8.16.151
    port: 9100
    https: false
  - ip: 10.8.16.153
    port: 9100
    https: false
prometheus:
  ip: 10.8.16.150    # 部署 Dashboard 的机器 IP。
  prometheusPort: 9090
  https: false  # 是否为 HTTPS 端口。
  scrape_interval: 5s  # 收集监控数据的间隔时间。默认为 1 分钟。
  evaluation_interval: 5s  # 告警规则扫描时间间隔。默认为 1 分钟。
# 集群节点信息
nebula-cluster:
  name: 'default' # 集群名称
  metad:
    - name: metad0
      endpointIP: 10.8.16.150  # 部署 Meta 服务的机器 IP。
      port: 9559
      endpointPort: 19559
    - name: metad1
      endpointIP: 10.8.16.151  # 部署 Meta 服务的机器 IP。
      port: 9559
      endpointPort: 19559
    - name: metad2
      endpointIP: 10.8.16.152  # 部署 Meta 服务的机器 IP。
      port: 9559
      endpointPort: 19559 
  graphd:
    - name: graphd0
      endpointIP: 10.8.16.150  # 部署 Graph 服务的机器 IP。
      port: 9669
      endpointPort: 19669
    - name: graphd1
      endpointIP: 10.8.16.151  # 部署 Graph 服务的机器 IP。
      port: 9669
      endpointPort: 19669
    - name: graphd2
      endpointIP: 10.8.16.152  # 部署 Graph 服务的机器 IP。
      port: 9669
      endpointPort: 19669 
  storaged:
    - name: storaged0
      endpointIP: 10.8.16.150  # 部署 Storage 服务的机器 IP。
      port: 9779
      endpointPort: 19779
    - name: storaged1
      endpointIP: 10.8.16.151  # 部署 Storage 服务的机器 IP。
      port: 9779
      endpointPort: 19779
    - name: storaged2
      endpointIP: 10.8.16.152  # 部署 Storage 服务的机器 IP。
      port: 9779
      endpointPort: 19779
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

• 执行./dashboard.service start all一键启动服务。

容器部署¶

如果使用容器部署 Dashboard，同样是修改配置文件config.yaml，修改完成后，执行docker-compose up -d即可启动容器。

如果修改了config.yaml内的端口号，docker-compose.yaml里的端口号也需要保持一致。

执行docker-compose stop命令停止容器部署的 Dashboard。

3.2.3管理 Dashboard 服务¶

Dashboard 使用脚本dashboard.service管理服务，包括启动、重启、停止和查看状态。

sudo <dashboard_path>/dashboard.service
[-v] [-h]
<start|restart|stop|status>  <prometheus|webserver|exporter|gateway|all>
1
2
3

查看 Dashboard 版本可以使用命令./dashboard.service -version

四、NebulaGraph客户端

NebulaGraph提供多种类型客户端，便于用户连接、管理NebulaGraph图数据库。

4.1 NebulaGraph Console:原生客户端

4.2 NebulaGraph CPP：C++ 客户端

4.3 NebulaGraph Java：Java 客户端

4.4 NebulaGraph Python：Python 客户端

下面是一个简单的案例

'''
pip install nebula3-python
'''
from nebula3.gclient.net import ConnectionPool
from nebula3.Config import Config
config = Config()
config.max_connection_pool_size = 2
# init connection pool
connection_pool = ConnectionPool()
assert connection_pool.init([('10.8.16.150', 9669)], config)
client = connection_pool.get_session('root', 'nebula')
#查询
res=client.execute_json('use `股权穿透-test`;match (v2)-[e1:投资*0..6]->(v:企业)-[e2:投资*0..6]->(v3) where id(v)=="2d5e50c1-945e-4b69-befe-fdd06a3336fd" and (e1 or e2) and (v2!=v or v3!=v) return v2 as `shareHolders`,v3 as `investmentCompany`,e1 as `shareholdingRatio`,e2 as `investmentRatio`;')
assert res.is_succeeded(),(res.error_code,res.error_msg)
from nebula3.data.ResultSet import ResultSet
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

4.5 NebulaGraph Go：Go 客户端

五、启动所有服务

cd /usr/local/nebula
scripts/nebula.service start all
cd /usr/local/nebula/nebula-graph-studio/
nohup ./server start &
systemctl start node_exporter.service
cd /usr/local/nebula/nebula-dashboard/
./dashboard.service start all
1
2
3
4
5
6
7

六、数据导入

6.1 NebulaGraph Importer¶

NebulaGraph Importer（简称 Importer）是一款NebulaGraph的 CSV 文件单机导入工具，可以读取并导入多种数据源的 CSV 文件数据。

功能¶

• 支持多种数据源，包括本地、S3、OSS、HDFS、FTP、SFTP。
• 支持导入 CSV 格式文件的数据。单个文件内可以包含多种 Tag、多种 Edge type 或者二者混合的数据。
• 支持同时连接多个 Graph 服务进行导入并且动态负载均衡。
• 支持失败后重连、重试。
• 支持多维度显示统计信息，包括导入时间、导入百分比等。统计信息支持打印在 Console 或日志中。

优势¶

• 轻量快捷：不需要复杂环境即可使用，快速导入数据。

• 灵活筛选：通过配置文件可以实现对 CSV 文件数据的灵活筛选。

6.1.1下载并解压

Release NebulaGraph Importer 4.0.0 · vesoft-inc/nebula-importer (github.com)

6.1.2job.yaml配置

• Client 配置¶

Client 配置存储客户端连接NebulaGraph相关的配置。

示例配置如下：

client:
  version: v3
  address: "192.168.1.100:9669,192.168.1.101:9669"
  user: root
  password: nebula
  concurrencyPerAddress: 10
  reconnectInitialInterval: 1s
  retry: 3
  retryInitialInterval: 1s
1
2
3
4
5
6
7
8
9

• Manager 配置¶

Manager 配置是连接数据库后的人为控制配置。

示例配置如下：

manager:
  spaceName: basic_string_examples
  batch: 128
  readerConcurrency: 50
  importerConcurrency: 512
  statsInterval: 10s
  hooks:
    before:
      - statements:
        - |
            DROP SPACE IF EXISTS basic_string_examples;
            CREATE SPACE IF NOT EXISTS basic_string_examples(partition_num=5, replica_factor=1, vid_type=int);
            USE basic_string_examples;
        wait: 10s
    after:
      - statements:
          - |
            SHOW SPACES;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

• Log 配置¶

Log 配置是设置日志相关配置。

示例配置如下：

log:
  level: INFO
  console: true
  files:
   - logs/nebula-importer.log   
1
2
3
4
5

• Source 配置¶

Source 配置中需要配置数据源信息、数据处理方式和 Schema 映射。

示例配置如下：

sources:
  - path: ./person.csv  # 指定存储数据文件的路径。如果使用相对路径，则路径和当前配置文件目录拼接。也支持通配符文件名，例如：./follower-*.csv，请确保所有匹配的文件具有相同的架构。
#  - s3: # AWS S3
#      endpoint: endpoint    # 可选。S3 服务端点，如果使用 AWS S3 可以省略。
#      region: us-east-1     # 必填。S3 服务的区域。
#      bucket: gdelt-open-data    # 必填。S3 服务中的 bucket。
#      key: events/20190918.export.csv     # 必填。S3 服务中文件的 key。
#      accessKeyID: ""    # 可选。S3 服务的访问密钥。如果是公共数据，则无需配置。
#      accessKeySecret: ""     # 可选。S3 服务的密钥。如果是公共数据，则无需配置。
#  - oss:
#      endpoint: https://oss-cn-hangzhou.aliyuncs.com    # 必填。OSS 服务端点。
#      bucket: bucketName    # 必填。OSS 服务中的 bucket。
#      key: objectKey    # 必填。OSS 服务中文件的 object key。
#      accessKeyID: accessKey    # 必填。OSS 服务的访问密钥。
#      accessKeySecret: secretKey    # 必填。OSS 服务的秘钥。
#  - ftp:
#      host: 192.168.0.10    # 必填。FTP 服务的主机。
#      port: 21    # 必填。FTP 服务的端口。
#      user: user    # 必填。FTP 服务的用户名。
#      password: password    # 必填。FTP 服务的密码。
#      path: "/events/20190918.export.csv"    # FTP 服务中文件的路径。
#  - sftp:
#      host: 192.168.0.10    # 必填。SFTP 服务的主机。
#      port: 22    # 必填。SFTP 服务的端口。
#      user: user    # 必填。SFTP 服务的用户名。
#      password: password    # 可选。SFTP 服务的密码。
#      keyFile: keyFile    # 可选。SFTP 服务的 SSH 密钥文件路径。
#      keyData: keyData    $ 可选。SFTP 服务的 SSH 密钥文件内容。
#      passphrase: passphrase    # 可选。SFTP 服务的 SSH 密钥密码。
#      path: "/events/20190918.export.csv"    # 必填。SFTP 服务中文件的路径。
#  - hdfs:
#      address: "127.0.0.1:8020"    # 必填。HDFS 服务的地址。
#      user: "hdfs"    # 可选。HDFS 服务的用户名。
#      path: "/events/20190918.export.csv"    # 必填。HDFS 服务中文件的路径。
    batch: 256
    csv:
      delimiter: "|"
      withHeader: false
      lazyQuotes: false
    tags:
    - name: Person
      id:
        type: "STRING"
        function: "hash"
#       index: 0        
        concatItems:
          - person_
          - 0
          - _id
      props:
        - name: "firstName"
          type: "STRING"
          index: 1
        - name: "lastName"
          type: "STRING"
          index: 2
        - name: "gender"
          type: "STRING"
          index: 3
          nullable: true
          defaultValue: female
        - name: "birthday"
          type: "DATE"
          index: 4
          nullable: true
          nullValue: _NULL_
        - name: "creationDate"
          type: "DATETIME"
          index: 5
        - name: "locationIP"
          type: "STRING"
          index: 6
        - name: "browserUsed"
          type: "STRING"
          index: 7
  - path: ./knows.csv
    batch: 256
    edges:
    - name: KNOWS # person_knows_person
      src:
        id:
          type: "STRING"
          concatItems:
            - person_
            - 0
            - _id
      dst:
        id:
          type: "STRING"
          concatItems:
            - person_
            - 1
            - _id
      props:
        - name: "creationDate"
          type: "DATETIME"
          index: 2
          nullable: true
          nullValue: _NULL_
          defaultValue: 0000-00-00T00:00:00
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

配置主要包括以下几个部分：

• 指定数据源信息。
• 指定执行语句的批处理量。
• 指定 CSV 文件格式信息。
• 指定 Tag 的模式映射。
• 指定 Edge type 的模式映射。

6.1.3编写job.yaml案例

本文以导出hdfs上的csv文件到nebula为例

更多导入模板

client:
  version: v3
  address: "10.8.16.150:9669,10.8.16.151:9669,10.8.16.152:9669"
  user: root
  password: nebula
  concurrencyPerAddress: 10
  reconnectInitialInterval: 1s
  retry: 3
  retryInitialInterval: 1s
manager:
  #导入的图空间
  spaceName: "股权穿透"
  batch: 128
  readerConcurrency: 50
  importerConcurrency: 512
  statsInterval: 10s
  hooks:
    before:
      - statements:
        - | 
            CREATE SPACE IF NOT EXISTS `股权穿透` (partition_num = 10, replica_factor = 1, charset = utf8, collate = utf8_bin, vid_type = FIXED_STRING(36)) comment = '股权穿透';
            USE 股权穿透;
            CREATE TAG IF NOT EXISTS `企业` ( `firm_name` string NULL COMMENT "企业名", `e_type` string NULL COMMENT "企业类型");
            CREATE EDGE IF NOT EXISTS `投资` ( `sha_id_type` string NULL, `stock_percent` string NULL, `total_should_capi` string NULL, `total_real_capi` string NULL, `sha_type` string NULL);
            CREATE TAG INDEX IF NOT EXISTS `firm_eid` ON `企业` ();
            CREATE EDGE INDEX IF NOT EXISTS `sha_id` ON `投资` ();
        wait: 3s
    after:
      - statements:
          - |
            SHOW SPACES;
log:
  level: INFO
  console: true
  files:
   - ../logs/nebula-importer.log
sources:
 - hdfs:
    address: "10.8.16.99:8020"    # 必填。HDFS 服务的地址。
    user: "cdh"    # 可选。HDFS 服务的用户名。
    path: "/user/cdh/点.csv"    # 必填。HDFS 服务中文件的路径。
   batch: 256
   csv:
      #分隔符
      delimiter: ","
      #是否有表头
      withHeader: true
      lazyQuotes: false
   tags:
    - name: "企业"
      id:
         type: "STRING"
         index: 0        
      props:
       - name: "firm_name"
         type: "STRING"
         index: 1
       - name: "e_type"
         type: "STRING"
         index: 2
 - hdfs:
    address: "10.8.16.99:8020"    # 必填。HDFS 服务的地址。
    user: "cdh"    # 可选。HDFS 服务的用户名。
    path: "/user/cdh/边.csv"     # 必填。HDFS 服务中文件的路径。
   batch: 256
   csv:
      #分隔符
      delimiter: ","
      #是否有表头
      withHeader: true
      lazyQuotes: false
   edges:
    - name: "投资"
      src:
        id:
          type: "STRING"
          index: 1
      dst:
        id:
          type: "STRING"
          index: 0
      props:
       - name: "sha_type"
         type: "STRING"
         index: 2
       - name: "sha_id_type"
         type: "STRING"
         index: 3
       - name: "stock_percent"
         type: "STRING"
         index: 4
       - name: "total_should_capi"
         type: "STRING"
         index: 5
       - name: "total_real_capi"
         type: "STRING"
         index: 6
         
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

6.1.4提交job

./nebula-importer --config job.yaml
1

6.2 NebulaGraph Exchange

NebulaGraph Exchange（简称 Exchange）是一款 Apache Spark™ 应用，用于在分布式环境中将集群中的数据批量迁移到NebulaGraph中，能支持多种不同格式的批式数据和流式数据的迁移。

Exchange 由 Reader、Processor 和 Writer 三部分组成。Reader 读取不同来源的数据返回 DataFrame 后，Processor 遍历 DataFrame 的每一行，根据配置文件中fields的映射关系，按列名获取对应的值。在遍历指定批处理的行数后，Writer 会将获取的数据一次性写入到NebulaGraph中。下图描述了 Exchange 完成数据转换和迁移的过程。

优点

• 适应性强：支持将多种不同格式或不同来源的数据导入NebulaGraph，便于迁移数据。

• 支持导入 SST：支持将不同来源的数据转换为 SST 文件，用于数据导入。

• 支持 SSL 加密：支持在 Exchange 与NebulaGraph之间建立 SSL 加密传输通道，保障数据安全。

• 支持断点续传：导入数据时支持断点续传，有助于节省时间，提高数据导入效率。

• 异步操作：会在源数据中生成一条插入语句，发送给 Graph 服务，最后再执行插入操作。

• 灵活性强：支持同时导入多个 Tag 和 Edge type，不同 Tag 和 Edge type 可以是不同的数据来源或格式。

• 统计功能：使用 Apache Spark™ 中的累加器统计插入操作的成功和失败次数。

• 易于使用：采用 HOCON（Human-Optimized Config Object Notation）配置文件格式，具有面向对象风格，便于理解和操作。

6.2.1下载 JAR 文件¶

社区版 Exchange 的 JAR 文件可以直接下载。

要下载企业版 Exchange，需先获取NebulaGraph企业版套餐。

6.2.2配置application.conf

本文介绍使用 NebulaGraph Exchange 时如何修改配置文件 application.conf。

修改配置文件之前，建议根据数据源复制并修改文件名称，便于区分。例如数据源为 CSV 文件，可以复制为csv_application.conf。

配置文件的内容主要分为如下几类：

• Spark 相关配置

• Hive 配置（可选）

• NebulaGraph相关配置

• 点配置

• 边配置

Spark 相关配置¶

本文只列出部分 Spark 参数，更多参数请参见官方文档。

Hive 配置（可选）¶

如果 Spark 和 Hive 部署在不同集群，才需要配置连接 Hive 的参数，否则请忽略这些配置。

NebulaGraph相关配置¶

NebulaGraph默认不支持无 Tag 的点。如果需要导入无 Tag 的点，需要先在集群内开启支持无 Tag 点，然后在 Exchange 的配置文件内新增nebula.enableTagless参数，值为true。示例如下：

nebula: {
    address:{
      graph:["127.0.0.1:9669"]
      meta:["127.0.0.1:9559"]
    }
    user: root
    pswd: nebula
    space: test
    enableTagless: true
    ......

 }
1
2
3
4
5
6
7
8
9
10
11
12

点配置¶

对于不同的数据源，点的配置也有所不同，有很多通用参数，也有部分特有参数，配置时需要配置通用参数和不同数据源的特有参数。

通用参数¶

Parquet/JSON/ORC 源特有参数¶

CSV 源特有参数¶

Hive 源特有参数¶

MaxCompute 源特有参数¶

Neo4j 源特有参数¶

MySQL/PostgreSQL 源特有参数¶

Oracle 源特有参数¶

ClickHouse 源特有参数¶

Hbase 源特有参数¶

Pulsar 源特有参数¶

Kafka 源特有参数¶

生成 SST 时的特有参数¶

边配置¶

对于不同的数据源，边的配置也有所不同，有很多通用参数，也有部分特有参数，配置时需要配置通用参数和不同数据源的特有参数。

边配置的不同数据源特有参数请参见上方点配置内的特有参数介绍，注意区分 tags 和 edges 即可。

通用参数¶

生成 SST 时的特有参数¶

NebulaGraph源特有参数¶

导入模板

更多模板

6.2.3提交spark任务

• 首次导入

  <spark_install_path>/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange <nebula-exchange-2.x.y.jar_path> -c <application.conf_path> 
  1

• 导入 reload 文件

  如果首次导入时有一些数据导入失败，会将导入失败的数据存入 reload 文件，可以用参数-r尝试导入 reload 文件。

  <spark_install_path>/bin/spark-submit --master "local" --class com.vesoft.nebula.exchange.Exchange <nebula-exchange-2.x.y.jar_path> -c <application.conf_path> 
  1

• spark-yarn模式

  spark-submit \
  --class com.vesoft.nebula.exchange.Exchange \
  --master yarn  --deploy-mode cluster \
  --conf spark.driver.extraClassPath=./ \
  --conf spark.executor.extraClassPath=./ \
  --conf spark.driver.extraJavaOptions=-Dfile.encoding=utf-8 \
  --conf spark.executor.extraJavaOptions=-Dfile.encoding=utf-8 \
  hdfs:///user/spark/nebula-exchange_spark_2.4-3.5.0.jar \
  -c hdfs:///user/spark/application.conf
  1
  2
  3
  4
  5
  6
  7
  8
  9

6.3 NebulaGraph Spark Connector

6.3.1下载对应的jar包并上传到hdfs

​ vesoft-inc/nebula-spark-connector (github.com)

6.3.2获取spark对象

import findspark
findspark.init()
from pyspark.sql import SparkSession
from pyspark.sql import functions as F
from pyspark.sql.types import *
spark = SparkSession.builder \
    .appName("mysql_to_hive") \
    .master('local') \
    .config('spark.sql.shuffle.partitions', '200') \
    .config('spark.jars', 'hdfs:///user/cdh/jars/nebula-spark-connector-3.4.0.jar') \
    .getOrCreate()
1
2
3
4
5
6
7
8
9
10
11

6.3.3pyspark读取

#type：vertex(点) or edge(边)
#spaceName: 图空间名
#label：点/边的名称
#returnCols：读取的字段

df = spark.read.format(
  "com.vesoft.nebula.connector.NebulaDataSource").option(
    "type", "edge").option(
    "spaceName", "股权穿透-test").option(
    "label", "投资").option(
    "returnCols", "sha_id_type,stock_percent,total_should_capi,total_real_capi,sha_type").option(
    "metaAddress", "10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559").option(
    "partitionNumber", 1).load()

df1 = spark.read.format("com.vesoft.nebula.connector.NebulaDataSource")\
.option("metaAddress", "10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559")\
.option("user", "root")\
.option("passwd", "nebula")\
.option("partitionNumber", 1)\
.option("type", "vertex")\
.option("spaceName", "股权穿透")\
.option("label", "企业")\
.option("returnCols", "firm_name,e_type")\
.load()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

6.3.4pyspark写入

#vertex

#type：vertex(点) or edge(边)
#spaceName: 图空间名
#vidPolicy: vid处理方式 如(hash,"")
#vertexField: vid字段
#writeMode：inser delete update

#**df字段名需与schema字段名对应**
df1.write.format("com.vesoft.nebula.connector.NebulaDataSource")\
.mode("overwrite")\
.options(**{
    "label": "企业",
    "vidPolicy": "",
    "vertexField": "_vertexId",
    "user":"root",
    "passwd": "nebula",
    "type": "vertex",
    "spaceName": "股权穿透",
    "batch": 100,
    "metaAddress": "10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559",
    "graphAddress": "10.8.16.150:9669,10.8.16.151:9669,10.8.16.152:9669,10.8.16.153:9669,10.8.16.152:9669",
    "writeMode": "insert"
}).save()
#srcVertexField: 出点字段名
#dstVertexField： 入点字段名
#rankField： 排名字段（可为空）
df.write.format("com.vesoft.nebula.connector.NebulaDataSource")\
.mode("overwrite").options(**{
        "srcPolicy": "",
        "dstPolicy": "",
        "user": "root",
        "passwd": "nebula",
        "type": "edge",
        "spaceName": "股权穿透",
        "label": "投资",
        "srcVertexField": "_srcId",
        "dstVertexField": "_dstId",
        "rankField": "_rank",
        "metaAddress": "10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559",
        "graphAddress": "10.8.16.150:9669,10.8.16.151:9669,10.8.16.152:9669,10.8.16.153:9669,10.8.16.154:9669",
        "writeMode": "update",
        "batch": "100"
    }).save()
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

6.3.5完整案例

#job.py
# NebulaGraph Importer从hdfs导入股权穿透-test
#使用spark导入数据到股权穿透
from pyspark.sql import SparkSession
from pyspark.sql.types import *
spark = SparkSession.builder \
    .appName("ngraph") \
    .config('spark.sql.shuffle.partitions', '200') \
    .config('spark.jars', 'hdfs:///user/cdh/jars/nebula-spark-connector-3.4.0.jar') \
    .config("spark.executor.extraJavaOptions", "-Dfile.encoding=UTF-8") \
    .config("spark.driver.extraJavaOptions", "-Dfile.encoding=UTF-8") \
    .getOrCreate()
# 读取nebula数据
df=spark.read.format("com.vesoft.nebula.connector.NebulaDataSource")\
.options(**{
    'spaceName':"股权穿透-test",
    'type':'vertex',
    'label':'企业',
    'returnCols':'firm_name,e_type',
    "partitionNumber": 1,
    "user": "root",
    "passwd": "nebula",
    "metaAddress": "10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559",
    "graphAddress": "10.8.16.150:9669,10.8.16.151:9669,10.8.16.152:9669,10.8.16.153:9669,10.8.16.154:9669",
    "batch": "100"
}).load()
df1=spark.read.format("com.vesoft.nebula.connector.NebulaDataSource")\
.options(**{
    'spaceName':"股权穿透-test",
    'type':'edge',
    'label':'投资',
    'returnCols':'sha_id_type,stock_percent,total_should_capi,total_real_capi,sha_type',
    "partitionNumber":1,
    "user": "root",
    "passwd": "nebula",
    "metaAddress": "10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559",
    "graphAddress": "10.8.16.150:9669,10.8.16.151:9669,10.8.16.152:9669,10.8.16.153:9669,10.8.16.154:9669",
    "batch": "100"
}).load()
# 将df导入nebula
df.write.format("com.vesoft.nebula.connector.NebulaDataSource")\
.mode("overwrite").options(**{
    	'spaceName':"股权穿透spark",
        "type": "vertex",
        "label": "企业",
        "vidPolicy": "",
        "vertexField": "_vertexId",
        "writeMode": "insert",
        "user": "root",
        "passwd": "nebula",
        "metaAddress": "10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559",
        "graphAddress": "10.8.16.150:9669,10.8.16.151:9669,10.8.16.152:9669,10.8.16.153:9669,10.8.16.154:9669",
        "batch": "100"
    }).save()

df1.write.format("com.vesoft.nebula.connector.NebulaDataSource")\
.mode("overwrite").options(**{
    	'spaceName':"股权穿透spark",
        "srcPolicy": "",
        "dstPolicy": "",
        "type": "edge",
        "label": "投资",
        "srcVertexField": "_srcId",
        "dstVertexField": "_dstId",
        "rankField": "_rank",
        "writeMode": "insert",
        "user": "root",
        "passwd": "nebula",
        "metaAddress": "10.8.16.150:9559,10.8.16.151:9559,10.8.16.152:9559",
        "graphAddress": "10.8.16.150:9669,10.8.16.151:9669,10.8.16.152:9669,10.8.16.153:9669,10.8.16.154:9669",
        "batch": "100"
    }).save()
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

6.3.6spark-submit提交

spark-submit \
--master yarn  --deploy-mode cluster \
--conf spark.driver.extraJavaOptions=-Dfile.encoding=utf-8 \
--conf spark.executor.extraJavaOptions=-Dfile.encoding=utf-8 \
--queue "root.users.cdh" \
--conf "spark.network.timeout=300s" \
--jars "hdfs:///user/cdh/jars/nebula-spark-connector-3.4.0.jar" \
./job.py
1
2
3
4
5
6
7
8

6.4如何选择导入工具

两种Spark工具的区别

NebulaGraph Exchange和NebulaGraph Spark Connector在功能和使用方式上有一些区别。

• 功能范围：NebulaGraph Exchange是一个用于数据导入和导出的工具，它可以与多种数据源进行连接，并支持数据格式转换和数据传输。它的重点在于数据的迁移和共享。而NebulaGraph Spark Connector专注于在Apache Spark中读写NebulaGraph数据，它提供了直接在Spark应用中操作NebulaGraph数据的能力，可以利用Spark的数据处理和分析能力进行复杂的计算和分析操作。
• 应用方式：NebulaGraph Exchange通常以独立应用的形式运行，你可以使用命令行界面或配置文件来执行数据导入和导出。NebulaGraph Exchange也有一个Spark Connector版本，可以与Spark集成，利用Spark的并行计算优势。而NebulaGraph Spark Connector是作为一个Spark库（Jar包）存在，你可以在Spark应用中直接使用Spark的DataFrame和DataSet API来读写NebulaGraph数据。
• 性能和扩展性：NebulaGraph Spark Connector利用Spark的分布式计算能力，可以处理大规模数据集并实现高性能的数据读写。它支持Spark的并行处理和在集群中的扩展性，适用于对大量数据进行复杂处理和分析的场景。NebulaGraph Exchange也可以通过Spark Connector版本来提高性能，但作为独立工具，其扩展性可能没有NebulaGraph Spark Connector更强大。

总的来说，NebulaGraph Exchange适用于数据导入和导出的场景，而NebulaGraph Spark Connector适用于在Spark中进行大规模数据处理和分析的场景，并与NebulaGraph数据库进行交互。选择哪个工具取决于具体的使用场景和需求。

6.5导入数据遇到的问题

6.5.1导入数据后中文乱码

提交spark任务时加上以下配置

--conf spark.driver.extraJavaOptions=-Dfile.encoding=utf-8 \
--conf spark.executor.extraJavaOptions=-Dfile.encoding=utf-8 \
1
2

6.5.2导入数据中途失败:Blacklisting behavior can be configured via spark.blacklist.*.

降低速率，加大超时时间，提交spark任务时加上以下配置

--conf spark.blacklist.enable=true
1

七、Nebula数据备份

7.1NebulaGraph BR（社区版）

7.1.1安装BR-client

只安装在一台机器上

• 下载 BR。

wget https://github.com/vesoft-inc/nebula-br/releases/download/v3.5.0/br-3.5.0-linux-amd64
1

• 修改文件名称为br。

sudo mv br-3.5.0-linux-amd64 br
1

• 授予 BR 执行权限。

sudo chmod +x br
1

• 执行./br version查看 BR 版本。

[nebula-br]$ ./br version
Nebula Backup And Restore Utility Tool,V-3.5.0
1
2

7.1.2安装BR-agent

安装在集群的所有机器上

• 下载 Agent。

wget https://github.com/vesoft-inc/nebula-agent/releases/download/v3.4.0/agent-3.4.0-linux-amd64
1

• 修改 Agent 的名称为agent。

sudo mv agent-3.4.0-linux-amd64 agent
1

• 授予 Agent 可执行权限。

sudo chmod +x agent
1

• 执行以下命令启动 Agent。

sudo nohup ./agent --agent="<当前服务器_ip>:8888" --meta="<当前服务器_ip>:9559" > nebula_agent.log 2>&1 &
1

• 查看服务状态

集群控制台输入

show hosts agent
1

7.1.3使用 BR 备份数据

• ./br backup full --meta "192.168.8.129:9559" --storage "local:///home/nebula/backup/"
  1

• 运行以下命令对 meta 服务的地址为192.168.8.129:9559的整个集群进行全量备份操作，并将备份文件保存到兼容 s3 协议的对象存储服务 br-test 桶下的backup中。

  ./br backup full --meta "192.168.8.129:9559" --s3.endpoint "http://192.168.8.129:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region=default
  1

以下列出命令的相关参数。

7.1.4使用 BR 恢复数据

• 用户可以使用以下命令列出现有备份信息：

./br show --storage <storage_path>
1

例如，可以使用以下命令列出在本地 /home/nebula/backup 路径中的备份的信息。

$ ./br show --storage "local:///home/nebula/backup"
+----------------------------+---------------------+------------------------+-------------+------------+
|            NAME            |     CREATE TIME     |         SPACES         | FULL BACKUP | ALL SPACES |
+----------------------------+---------------------+------------------------+-------------+------------+
| BACKUP_2022_02_10_07_40_41 | 2022-02-10 07:40:41 | basketballplayer       | true        | true       |
| BACKUP_2022_02_11_08_26_43 | 2022-02-11 08:26:47 | basketballplayer,foesa | true        | true       |
+----------------------------+---------------------+------------------------+-------------+------------+
1
2
3
4
5
6
7

或使用以下命令列出在兼容 s3 协议的对象存储服务 br-test 桶下的backup中的备份的信息。

./br show --s3.endpoint "http://192.168.8.129:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --s3.region=default
1

以下列出命令的相关参数。