附录 A. 联机帮助

优质

小牛编辑

123浏览

2023-12-01

A.1. neo4j

A.1.1. 名称

neo4j - Neo4j服务器控制和管理

A.1.2. 语法

neo4j<command>

A.1.3. 描述

Neo4j是一个图数据库，在高度关联的数据中拥有很好的性能。

A.1.4. 命令

console

将服务器作为一个前台进程启动运行，停止服务器请使用 `CTRL-C`。

start

以后台服务形式启动服务器。

stop

停止一个后台运行的服务器。

restart

重启服务器

status

返回当前运行的服务器状态。

install

安装服务器作为一个平台相关的系统服务。

remove

卸载系统服务。

info

显示配置信息，比如当前的NEO4J_HOME和CLASSPATH。

A.1.5. 用法 - Windows

Neo4j.bat双击Neo4j.bat脚本在命令行启动服务器。在命令行窗口按下 control-C来退出服务。

Neo4j.bat install/remove

Neo4j可以被安装作为Windows系统服务而不用显示控制台窗口。你需要使用管理员权限来运行这个脚本。 Neo4j.bat脚本包括如下命令选项：

- Neo4j.bat install - 安装作为一个windows系统服务

o将安装作为一个windows系统服务

- Neo4j.bat remove - 移除Neo4j服务

o将停止和移除Neo4j服务

- Neo4j.bat start - 启动Neo4j系统服务

o如果安装了Neo4j系统服务，则会启动，

o否则只会启动一次基于命令行的Neo4j服务。

- Neo4j.bat stop - 如果Neo4j系统服务在运行则停止它

- Neo4j.bat restart - 如果Neo4j系统服务已经安装则重启它

- Neo4j.bat status - 报告Neo4j服务的运行状态

o返回 RUNNING, STOPPED 或者 NOT INSTALLED

A.1.6. 涉及到的配置文件

conf/neo4j-server.properties

服务器配置。

conf/neo4j-wrapper.conf

服务封装配置

conf/neo4j.properties

数据库调优配置

A.2. neo4j-shell

A.2.1. 名称

neo4j-shell - 浏览和维护一个图数据库的命令行工具

A.2.2. 语法

neo4j-shell[远程选项]

neo4j-shell[本地选项]

A.2.3. 描述

Neo4j命令行是一个用于浏览图数据库的命令行工具，非常像Unix命令行，可以使用像 cd, ls和 pwd等命令浏览本地文件系统一样的浏览图数据库。命令行可以直接连接到图数据库。为了其他进程能访问这个本地数据库，你可以使用只读模式。

A.2.4. 远程选项

-portPORT

连接到主机的端口（默认：1337）。

-hostHOST

连接到的主机的域名或者IP地址（默认：localhost）。

-nameNAME

RMI名称, 比如：rmi://<host>:<port>/<name> (默认: shell)。

-readonly

以只读模式访问数据库

A.2.5. 本地选项

-pathPATH

数据库的目录。如果在这个目录没有数据库存在，则会自动创建一个新的数据库。

-pidPID

连接到的进程编号。

-readonly

以只读模式访问数据库。

-cCOMMAND

在命令行执行命令，执行完成后命令行会退出。

-configCONFIG

Neo4j配置文件路径。

A.2.6. 范例

远程使用范例：

neo4j-shell

neo4j-shell -port 1337

neo4j-shell -host 192.168.1.234 -port 1337 -name shell

neo4j-shell -host localhost -readonly

本地使用范例：

neo4j-shell -path /path/to/db

neo4j-shell -path /path/to/db -config /path/to/neo4j.config

neo4j-shell -path /path/to/db -readonly

A.3. neo4j-backup

A.3.1. 名称

neo4j-backup - Neo4j备份工具

A.3.2. 语法

neo4j-backup{-full|-incremental} -from 来源数据库地址 -to 目标目录名称 [-cluster 集群名称]

A.3.3. 描述

它是一个通过网络将运行在线上的数据库备份到本地文件系统的工具。备份可以是完整或者增量备份。第一次备份必须是完整备份，以后可以采用增量备份。

像URI一样的源地址是按指定格式构成的，目标地址是本地文件系统地址。

A.3.4. 备份类型

-full

拷贝完整的数据库到一个目录。

-incremental

差量备份，只拷贝自动上次完整备份以后的变化部分到一个存在的备份存储。

A.3.5. 数据源地址

备份源地址格式如下：

<运行模式>://<主机>[:<端口>][,<主机>[:<端口>]]…

注意可以同时定义多个主机。

运行模式

'single' 或者 'ha'. 'ha' 是用于高性能模式，而 'single' 则适合独立数据库。

主机

在单例模式，主机就是数据库服务器地址; 在高性能模式，主机是协调器的地址。注意当使用高性能模式时可以指定多个主机。

端口

在单例模式，端口是源数据库备份服务的端口; 在高性能模式，端口是一个协调器实例备份服务的端口。如果没有给定端口，默认端口是 6362。

集群名称

*-cluster*::

如果你给你的高性能集群指定了一个集群名称，你需要在备份的时候指定它。

增加这个配置参数：-cluster _my_custom_cluster_name_

[[neo4j-backup-manpage-usage-important]]

重点

当配置参数 enable_online_backup=true设置了以后才能在数据库上面执行备份。这将在默认端口 (6362) 启用备份服务。如果要在其他端口启用备份服务，请通过参数 enable_online_backup=port=9999配置。

A.3.6. 用法 - Windows

*`Neo4jBackup.bat`* 脚本的用法跟Linux版本是一样的。

范例

[source,shell]

# 执行一次完整备份 neo4j-backup -full -from single://192.168.1.34 -to /mnt/backup/neo4j-backup

# 执行一次差量备份 neo4j-backup -incremental -from single://freja -to /mnt/backup/neo4j-backup

# 在一个自定义端口执行一次差量备份 neo4j-backup -incremental -from single://freja:9999 -to /mnt/backup/neo4j-backup

# 指定两个可能的协调器从高性能集群服务器中执行一次完整备份 ./neo4j-backup -full -from ha://oden:2181,loke:2181 -to /mnt/backup/neo4j-backup

# 指定一个可能的协调器从高性能集群服务器中执行一次增量备份 ./neo4j-backup -incremental -from ha://oden:2181 -to /mnt/backup/neo4j-backup

# 用一个指定的名称从高性能集群服务器中执行一次增量备份 # (名称通过 ha.cluster_name配置) ./neo4j-backup -incremental -from ha://balder:2181 -to /mnt/backup/neo4j-backup -cluster my-cluster

[[neo4j-backup-manpage-restore]]

从备份中恢复

Neo4j备份的是完整功能的数据库。所以要使用你的备份，只需要用你备份的数据库目录代替正式数据库目录即可。

A.4. neo4j-coordinator

A.4.1. 名称

neo4j-coordinator - 为Neo4j的高可用性集群提供的协调员

A.4.2. 语法

neo4j-coordinator<command>

A.4.3. 描述

Neo4j协调器是一个提供对Neo4j高性能模式数据集群协调管理的服务器。一个"Neo4j协调器集群"必须在"数据库集群"之前启动。这个服务器是集群服务器之一。

A.4.4. 命令

console

启动服务器作为一个应用在前端运行，使用命令 CTRL-C来结束运行。

start

启动服务器作为一个应用作为后台服务运行。

stop

停止一个在后台运行的服务器。

restart

重启一个正在运行的服务器。

status

返回当前服务器状态。

install

安装服务器作为系统服务运行。

remove

卸载系统服务。

A.4.5. 涉及到的相关配置文件

conf/coord.cfg

协调服务器配置。

conf/coord-wrapper.cfg

协调服务器系统服务配置。

data/coordinator/myid

协调服务器实例的标识符。

A.5. neo4j-coordinator-shell

A.5.1. 名称

neo4j-coordinator-shell - Neo4j协调器命令行交互接口

A.5.2. 语法

neo4j-coordinator-shell-server <host:port> [<cmd> <args>]

A.5.3. 描述

Neo4j协调器命令行交互接口提供了一个与一个运行的Neo4j协调服务器交互的接口。

A.5.4. 选项

-serverHOST:PORT

通过提供服务器和端口连接到指定的Neo4j协调服务器。