Vertex.js 技术文档

1. 安装指南

在开始使用 Vertex.js 之前，您需要确保已经安装以下依赖：

• Node.js
• Tokyo Cabinet

安装 Node.js

请根据您的操作系统，从 Node.js 官方网站下载并安装最新版本的 Node.js。

安装 Tokyo Cabinet

从 Tokyo Cabinet 的官方网站下载源代码，并按照以下步骤编译安装：

wget http://fallabs.com/tokyocabinet/tokyocabinet-1.4.48.tar.gz
tar zxvf tokyocabinet-1.4.48.tar.gz
cd tokyocabinet-1.4.48
./configure
make
sudo make install

启动 Vertex.js

在 Vertex.js 文件夹中，运行以下命令启动服务：

node server.js

要获取更多命令行选项，可以运行：

node server.js -help

2. 项目的使用说明

Vertex.js 是一个基于 Node.js 和 Tokyo Cabinet 构建的图数据库，使用 HTTP 作为通信协议，JSON 作为请求数据和响应数据格式。以下是使用 Vertex.js 的基本步骤：

• 创建节点（mk）
• 链接节点（link）
• 列出节点槽（ls）
• 删除节点槽（rm）
• 重命名节点槽（rename）
• 写入元数据（mwrite）
• 读取元数据（mread）
• 列出元数据（mls）
• 删除元数据（mrm）
• 重命名元数据（mrename）
• 同步数据库（sync）

3. 项目API使用文档

Vertex.js 的 API 请求通过 HTTP POST 消息发送，内容类型为 application/json-request。以下是 API 请求和响应的示例：

请求示例

[
    { 
        'path': ['customers', 'John Doe', 'street'], 
        'do': 'mk',    
        'meta': { 'type': 'String', 'value': '203 Oak' }
    },
    { 
        'path': ['customers', 'John Doe', 'street'],
        'do': 'mread'
    }
]

成功响应示例

[
    null,
    { 'type': 'String', 'value': '203 Oak' }
]

错误响应示例

{
    "action": { 'do': 'mwrite', 'path': ['customers', 'Joe Shmoe', 'first name'] },
    "message": "invalid path"
}

4. 项目安装方式

请参考上述“安装指南”部分，按照步骤安装所需的依赖，并启动 Vertex.js 服务。