LemonGraph 使用教程

1. 项目目录结构及介绍

LemonGraph 是一个基于日志的事务性图数据库引擎，其目录结构如下：

lemongraph/
├── deps/              # 项目依赖库
├── lib/               # 核心代码库
├── scripts/           # 脚本文件
├── .gitignore         # Git 忽略文件
├── .gitmodules        # Git 子模块配置文件
├── LICENSE            # 项目许可证文件
├── MANIFEST.in        # 打包配置文件
├── Makefile           # Makefile 文件
├── README.md          # 项目说明文件
├── RESTAPI            # REST API 相关文件
├── bench.py           # 性能测试脚本
├── lg_cffi_setup.py   # CFFI 设置文件
├── requirements.txt   # 项目依赖文件
├── setup.py           # 项目安装脚本
└── test.py            # 测试脚本

• deps/: 存放项目依赖的第三方库。
• lib/: LemonGraph 的核心代码库，包括图数据库的实现。
• scripts/: 存放项目相关的脚本文件，如启动脚本、辅助脚本等。
• .gitignore: 指定 Git 忽略的文件和目录。
• .gitmodules: 如果项目包含子模块，该文件用于配置子模块。
• LICENSE: 项目使用的许可证信息。
• MANIFEST.in: 指定打包时包含的文件和目录。
• Makefile: 用于构建项目的 Makefile 文件。
• README.md: 项目说明文件，包含项目的介绍、使用方法和联系方式等。
• RESTAPI: REST API 相关的实现和配置文件。
• bench.py: 用于测试项目性能的脚本。
• lg_cffi_setup.py: 用于设置 CFFI 的脚本。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 用于安装项目的 Python 脚本。
• test.py: 用于测试项目功能的脚本。

2. 项目的启动文件介绍

LemonGraph 的启动主要通过 setup.py 文件进行。该文件定义了如何安装项目依赖和项目本身。

安装 LemonGraph 的基本命令如下：

python setup.py install

如果你想在没有安装的情况下运行 LemonGraph，你需要手动安装所有依赖项，命令如下：

easy_install lazy msgpack pysigset python-dateutil six ujson

安装完成后，可以通过 Python 代码来创建和操作图：

import LemonGraph

# 创建图实例
g = LemonGraph.Graph(path)

# 使用写事务
with g.transaction(write=True) as txn:
    # 创建节点和边
    # ...

# 使用读事务
with g.transaction(write=False) as txn:
    # 查询图数据
    # ...

3. 项目的配置文件介绍

LemonGraph 的配置主要通过代码中的参数进行设置。目前项目没有专门的配置文件，但以下是一些主要的配置选项：

• 数据库文件路径：在创建 Graph 实例时，可以通过 path 参数指定数据库文件的存储路径。
• 事务类型：在创建事务时，可以通过 write 参数指定是创建写事务还是读事务。

# 创建图实例，指定数据库文件路径
g = LemonGraph.Graph(path="/path/to/your/database/file")

# 创建写事务
with g.transaction(write=True) as txn:
    # 在事务中进行写操作
    # ...

# 创建读事务
with g.transaction(write=False) as txn:
    # 在事务中进行读操作
    # ...

在项目的实际使用中，可能需要根据具体情况调整其他参数和配置选项，以达到最佳性能和效果。