Neography 技术文档

1. 安装指南

使用 Gemfile 安装

将 Neography 添加到你的 Gemfile 中：

gem 'neography'

然后运行 Bundler：

$ bundle

手动安装

或者手动安装 Neography：

$ gem install 'neography'

在 Ruby 代码中引入宝石：

require 'rubygems'
require 'neography'

有关依赖项的更多信息，请查阅依赖项文档。

2. 项目使用说明

Neography 是一个轻量级的 Ruby 包装器，用于 Neo4j Rest API。以下是配置和初始化 Neography 的步骤：

Neography.configure do |config|
  config.protocol             = "http"
  config.server               = "localhost"
  config.port                 = 7474
  config.directory            = ""  # 前缀路径与 '/'
  config.cypher_path          = "/cypher"
  config.gremlin_path         = "/ext/GremlinPlugin/graphdb/execute_script"
  config.log_file             = "neography.log"
  config.log_enabled          = false
  config.slow_log_threshold   = 0    # 查询日志的毫秒时间
  config.max_threads          = 20
  config.authentication       = nil  # 'basic' 或 'digest'
  config.username             = nil
  config.password             = nil
  config.parser               = MultiJsonParser
  config.http_send_timeout    = 1200
  config.http_receive_timeout = 1200
  config.persistent           = true
end

初始化 Rest 实例：

@neo = Neography::Rest.new
@neo = Neography::Rest.new({:authentication => 'basic', :username => "neo4j", :password => "swordfish"})
@neo = Neography::Rest.new("http://neo4j:swordfish@localhost:7474")

有关更多配置和初始化方法，请参阅配置和初始化文档。

3. 项目API使用文档

Neography 支持通过 Neo4j REST 接口创建和检索节点和关系。它支持索引、Gremlin 脚本、Cypher 查询和批处理操作。

以下是部分功能示例：

节点创建

node1 = @neo.create_node("age" => 31, "name" => "Max")
node2 = @neo.create_node("age" => 33, "name" => "Roel")

节点属性

@neo.set_node_properties(node1, {"weight" => 200})

节点关系

@neo.create_relationship("coding_buddies", node1, node2)

获取节点关系

@neo.get_node_relationships(node2, "in", "coding_buddies")

使用索引

@neo.add_node_to_index("people", "name", "max", node1)
@neo.get_node_index("people", "name", "max")

批处理

@neo.batch [:create_node, {"name" => "Max"}],
           [:create_node, {"name" => "Marc"}]

Cypher 查询

@neo.execute_query("start n=node(0) return n")

更多 API 信息，请参考Wiki 文档。

4. 项目安装方式

请按照以上“安装指南”部分中所述的步骤进行安装。您可以使用 Gemfile 进行自动安装，也可以手动安装宝石并引入到您的 Ruby 代码中。