S2Graph项目技术文档

1. 安装指南

要从源代码构建S2Graph，需要安装JDK 8和SBT。然后在项目根目录下运行以下命令：

sbt package

这将创建一个准备好部署的S2Graph发行版。可以在target/apache-s2graph-$version-incubating-bin目录下找到发行版。

2. 项目的使用说明

S2Graph是一个图数据库，旨在处理大规模的事务性图处理。其REST API允许您以完全异步和非阻塞的方式存储、管理和查询关系信息，使用边和顶点表示。

快速开始

一旦解压下载的二进制发行版或按照上述步骤从源代码构建，应该会在目录中找到以下文件和目录：

DISCLAIMER
LICENCE               # Apache许可证2.0
NOTICE
bin                   # 管理S2Graph生命周期的脚本
conf                  # 配置文件
lib                   # 包含二进制文件
logs                  # 应用日志
var                   # 应用数据

这个目录结构包含了启动S2Graph所需的所有二进制文件和脚本。logs和var目录最初可能不存在，会在S2Graph启动时创建。

以下命令将启动S2Graph，使用HBase作为数据存储的独立模式，以及H2作为元数据存储：

sh bin/start-s2graph.sh

要连接到远程HBase集群或使用MySQL作为元数据存储，请参考conf/application.conf中的说明。

3. 项目API使用文档

S2Graph提供了REST API来存储、管理和查询图数据。以下是API的基本使用示例：

创建服务

curl -XPOST localhost:9000/graphs/createService -H 'Content-Type: Application/json' -d '
{"serviceName": "KakaoFavorites", "compressionAlgorithm" : "gz"}
'

创建标签

curl -XPOST localhost:9000/graphs/createLabel -H 'Content-Type: Application/json' -d '
{
  "label": "friends",
  "srcServiceName": "KakaoFavorites",
  "srcColumnName": "userName",
  "srcColumnType": "string",
  "tgtServiceName": "KakaoFavorites",
  "tgtColumnName": "userName",
  "tgtColumnType": "string",
  "isDirected": "false",
  "indices": [],
  "props": [],
  "consistencyLevel": "strong"
}'

插入边

curl -XPOST localhost:9000/graphs/edges/insert -H 'Content-Type: Application/json' -d '
[
  {"from":"Elmo","to":"Big Bird","label":"friends","props":{},"timestamp":1444360152477},
  ...
]'

查询边

curl -XPOST localhost:9000/graphs/getEdges -H 'Content-Type: Application/json' -d '
{
  "srcVertices": [{"serviceName": "KakaoFavorites", "columnName": "userName", "id":"Elmo"}],
  "steps": [
    {"step": [{"label": "friends", "direction": "out", "offset": 0, "limit": 10}]}
  ]
}'

4. 项目安装方式

请参考“安装指南”部分，使用SBT从源代码构建S2Graph。

以上就是S2Graph项目的技术文档，包括安装指南、使用说明以及API使用文档，帮助用户使用和理解该项目。