informaticsmatters/neo4j

InformaticsMatters neo4j容器镜像

镜像概述和主要用途

这是InformaticsMatters多个项目使用的专门构建的neo4j镜像。该仓库包含图数据库的镜像定义，以及从AWS S3路径填充图数据的加载器。

核心功能和特性

• 集成neo4j图数据库和AWS S3数据加载器
• 支持启动前执行批处理加载脚本（如load-neo4j.sh）
• 提供数据库启动后运行Cypher命令的能力，支持一次性（.once）和每次启动（.always）执行模式
• 可自定义数据目录、日志目录和导入目录
• 配套Ansible角色和剧本，简化部署流程

使用场景和适用范围

适用于InformaticsMatters项目中需要部署neo4j图数据库，并从AWS S3加载数据，或需在数据库启动后执行初始化Cypher命令（如创建索引、缓存预热）的场景。

使用方法和配置说明

构建和推送镜像

bash
$ docker-compose build
$ docker-compose push

典型执行（Docker）

假设已准备以下目录：

1. 数据目录（如~/neo4j-import）：包含图文件和启动前批处理加载脚本load-neo4j.sh
2. 日志目录（如~/neo4j-container-logs）：用于存储日志
3. 数据库目录（如~/neo4j-container-graph）：用于挂载生成的Neo4j数据库

可通过以下命令启动数据库：

bash
$ docker run --rm \
    -v $HOME/neo4j-import:/data-import \
    -v $HOME/neo4j-container-logs:/graph-logs \
    -v $HOME/neo4j-container-graph:/graph \
    -p 7474:7474 \
    -p 7687:7687 \
    -e NEO4J_AUTH=none \
    -e NEO4J_dbms_directories_data=/graph \
    -e NEO4J_dbms_directories_logs=/graph-logs \
    -e IMPORT_DIRECTORY=/data-import \
    -e IMPORT_TO=graph \
    -e EXTENSION_SCRIPT=/data-import/load-neo4j.sh \
    informaticsmatters/neo4j:3.5.2

环境变量说明

• NEO4J_AUTH：Neo4j认证配置，none表示禁用认证
• NEO4J_dbms_directories_data：数据库数据存储路径
• NEO4J_dbms_directories_logs：日志文件存储路径
• IMPORT_DIRECTORY：数据导入源目录
• IMPORT_TO：数据导入目标位置
• EXTENSION_SCRIPT：启动前执行的批处理脚本路径

运行数据库后Cypher命令

镜像通过/cypher-runner/cypher-runner.sh脚本支持在数据库启动后执行Cypher命令。该脚本在docker-entrypoint.sh末尾执行，后台运行直至命令完成。

使用方法

1. 提供Cypher命令文件：
   • /cypher-runner/cypher-script.once：仅首次启动时执行
   • /cypher-runner/cypher-script.always：每次启动时执行
2. 定义环境变量NEO4J_USERNAME和NEO4J_PASSWORD提供认证信息

示例脚本

• .once脚本（创建索引）：

  cypher
  CREATE INDEX ON :F2(smiles);
  CREATE INDEX ON :VENDOR(cmpd_id);
  

• .always脚本（缓存预热）：

  cypher
  CALL apoc.warmup.run(true, true, true);
  

  此命令通过并行访问页面（可选加载属性记录、动态属性和索引）快速预热页面缓存，有助于提高查询性能。

注意：Cypher运行器在neo4j启动后等待约60秒再尝试首次执行脚本，等待时间可通过镜像中的环境变量配置（参考cypher-runner脚本查看具体变量）。

Ansible角色和剧本

Ansible角色及配套剧本用于简化neo4j镜像部署，包含基于AWS S3的图数据加载功能。该角色在启动neo4j实例前部署S3加载器。