graphaware/neo4j-config-cli

neo4j-config-cli

镜像概述和主要用途

neo4j-config-cli是一个Neo4j实用工具，用于基于JSON配置文件定义确保Neo4j数据库的期望配置状态。它能够自动化执行数据库创建、删除、角色管理等操作，特别适用于部署流程中确保数据库环境的一致性。

核心功能和特性

• 支持两种配置文件类型：Database（数据库管理）和Role（角色管理）
• 自动等待Neo4j服务启动后执行配置操作
• 操作完成后容器自动停止
• 支持删除并重新创建数据库（通过dropIfExists参数）
• 支持数据库索引和约束定义
• 支持角色与权限管理
• 兼容Neo4j Aura环境
• 支持从本地文件或远程URL导入配置
• 支持仅向现有数据库导入种子数据

使用场景和适用范围

• Neo4j数据库初始化（创建、删除数据库）
• 数据库索引和约束自动化配置
• 角色与权限标准化管理
• 自动化部署流程中确保数据库状态一致性
• Neo4j Aura环境下的数据库配置管理
• 向现有数据库导入初始数据（种子数据）

使用方法和配置说明

Docker Compose部署示例

以下是使用docker-compose部署Neo4j与neo4j-config-cli的示例配置：

yaml
version: '3.7'
services:
  neo4j:
    image: neo4j:4.4.11-enterprise
    ports:
      - "7474:7474"
      - "7687:7687"
    environment:
      - NEO4J_ACCEPT_LICENSE_AGREEMENT=yes
      - NEO4J_AUTH=neo4j/${NEO4J_PASSWORD:-password}
  neo4j-config-cli:
    image: graphaware/neo4j-config-cli:1.2.0
    environment:
      - NEO4J_USER=neo4j
      - NEO4J_PASSWORD=password
      - NEO4J_URI=bolt://neo4j:7687
      - IMPORT_PATH=/config
    volumes:
      - "./config:/config"

环境变量说明

配置文件类型

Database配置文件

用于管理数据库的创建、删除、索引和约束等。

结构示例：

json
{
  "kind": "Database",
  "name": "movies",
  "dropIfExists": true,
  "skipCreate": false,
  "indexes": {
    "fulltext" : [
      {
        "labels": ["Person"],
        "properties": ["name"],
        "name": "Person"
      }
    ]
  },
  "constraints": {
    "unique": [
      {
        "label": "Movie",
        "property": "title",
        "type": "UNIQUE"
      }
    ]
  },
  "seeds": ["movies.cypher"]
}

字段说明：

• kind: 配置类型，固定为"Database"
• name: 数据库名称
• dropIfExists: 是否在数据库存在时删除（true/false）
• skipCreate: 是否跳过数据库创建（true/false，适用于Neo4j Aura）
• indexes: 索引配置，支持fulltext等类型
• constraints: 约束配置，支持unique等类型
• seeds: 种子数据文件列表（Cypher文件路径）

Role配置文件

用于管理Neo4j角色和权限。

结构示例：

json
{
  "kind": "Role",
  "name": "ut1",
  "dropIfExists": true,
  "privileges": [
    {
      "graph": "*",
      "access": true,
      "rules": [
        {
          "target": "node",
          "labels": "*",
          "action": "match",
          "resource": "all_properties",
          "access": "GRANTED"
        },
        {
          "target": "node",
          "labels": "Person",
          "action": "read",
          "resource": "born",
          "access": "DENIED"
        }
      ]
    }
  ]
}

字段说明：

• kind: 配置类型，固定为"Role"
• name: 角色名称
• dropIfExists: 是否在角色存在时删除（true/false）
• privileges: 权限配置列表
  • graph: 应用权限的图（*表示所有图）
  • access: 是否允许访问（true/false）
  • rules: 具体权限规则
    • target: 目标类型（node/relationship）
    • labels: 标签（*表示所有标签）
    • action: 操作类型（match/read等）
    • resource: 资源（all_properties/具体属性名）
    • access: 权限类型（GRANTED/DENIED）

典型使用示例

创建数据库示例

1. 创建配置文件config/simple-db-create.json：

json
{
    "kind": "Database",
    "name": "movies",
    "dropIfExists": true
}

2. 使用前述docker-compose.yml配置启动服务：

shell
docker-compose up

执行后，neo4j-config-cli会等待Neo4j启动，然后删除并重新创建movies数据库，操作完成后容器自动退出。

Neo4j Aura支持

在Neo4j Aura环境中不支持CREATE DATABASE命令，需设置skipCreate: true：

json
{
  "kind": "Database",
  "name": "neo4j",
  "skipCreate": true
}

从远程文件导入配置

支持通过URL指定远程配置文件（如GitHub Gist）：

yaml
version: '3.7'
services:
  neo4j-config-cli:
    image: graphaware/neo4j-config-cli:1.2.0
    environment:
      - NEO4J_PASSWORD=password
      - NEO4J_URI=bolt://neo4j:7687
      - IMPORT_PATH=https://gist.githubusercontent.com/ikwattro/f99c1ed085673065fcb4e850526ccd49/raw/35f077b71e3f7a9fd95b0288cf6d622eea3d6501/db-demo.json

仅种子现有数据库

使用seed-only参数仅向现有数据库导入种子数据：

shell
docker run --rm -it \
    -e NEO4J_URI=neo4j+s://18894d85.databases.neo4j.io \
    -e NEO4J_PASSWORD=tT3h3ieK4sw-MATaEaimFFHY9YqkgYNo9WNYcEBqMZ4 \
    -e seed-only=true \
    -e seed-url=https://bit.ly/2XnJzFn \
    graphaware/neo4j-config-cli:1.3.0

许可证

请参考本仓库中附带的LICENSE.txt文件。

支持

本仓库基于"尽力而为"原则提供支持。