neo4django 技术文档

1. 安装指南

1.1 使用 pip 安装

你可以通过 pip 从 PyPi 安装 neo4django：

pip install neo4django

或者直接从 GitHub 安装：

pip install -e git+https://github.com/scholrly/neo4django/#egg=neo4django

2. 项目的使用说明

neo4django 是一个对象图映射器（Object Graph Mapper），它允许你使用熟悉的 Django 模型定义和查询来操作 Neo4j 图数据库。通过 neo4django，你可以像使用 Django ORM 一样来操作 Neo4j 数据库。

2.1 配置 Django 项目

在使用 neo4django 之前，你需要在 Django 项目的 settings.py 文件中进行配置。确保你已经安装了 Neo4j 数据库，并且数据库服务正在运行。

# settings.py

DATABASES = {
    'default': {
        'ENGINE': 'neo4django.db.backends.neo4j',
        'NAME': 'your_database_name',
        'USER': 'your_username',
        'PASSWORD': 'your_password',
        'HOST': 'localhost',
        'PORT': '7474',
    }
}

2.2 定义模型

你可以像定义 Django 模型一样定义 neo4django 模型。以下是一个简单的示例：

from neo4django.db import models

class Person(models.NodeModel):
    name = models.StringProperty()
    age = models.IntegerProperty()

class Friendship(models.Relationship):
    from_node = models.ForeignKey(Person, related_name='friends')
    to_node = models.ForeignKey(Person, related_name='friends_with')
    since = models.DateTimeProperty()

2.3 查询数据

你可以使用 Django 的查询 API 来查询 Neo4j 数据库中的数据。以下是一些示例：

# 查询所有 Person 节点
people = Person.objects.all()

# 查询年龄大于 30 的 Person 节点
adults = Person.objects.filter(age__gt=30)

# 查询某个人的朋友
person = Person.objects.get(name='Alice')
friends = person.friends.all()

3. 项目 API 使用文档

3.1 NodeModel API

NodeModel 是 neo4django 中的节点模型基类，所有节点模型都应继承自此类。

• save(): 保存节点到数据库。
• delete(): 从数据库中删除节点。
• objects: 用于查询节点的管理器。

3.2 Relationship API

Relationship 是 neo4django 中的关系模型基类，所有关系模型都应继承自此类。

• save(): 保存关系到数据库。
• delete(): 从数据库中删除关系。
• from_node: 关系的起始节点。
• to_node: 关系的目标节点。

3.3 QuerySet API

QuerySet 是 neo4django 中的查询集，用于查询节点和关系。

• all(): 返回所有节点或关系。
• filter(**kwargs): 根据条件过滤节点或关系。
• get(**kwargs): 获取单个节点或关系。
• exclude(**kwargs): 排除符合条件的节点或关系。

4. 项目安装方式

4.1 使用 pip 安装

你可以通过 pip 从 PyPi 安装 neo4django：

pip install neo4django

或者直接从 GitHub 安装：

pip install -e git+https://github.com/scholrly/neo4django/#egg=neo4django

4.2 配置环境

在安装完成后，确保你已经正确配置了 Django 项目的 settings.py 文件，并且 Neo4j 数据库服务正在运行。

4.3 验证安装

你可以通过运行 Django 的 manage.py 命令来验证 neo4django 是否安装成功：

python manage.py check

如果一切正常，你应该会看到类似以下的输出：

System check identified no issues (0 silenced).

至此，你已经成功安装并配置了 neo4django，可以开始使用它来操作 Neo4j 数据库了。