rdfstore-js 技术文档

1. 安装指南

通过 NPM 安装

$ npm install rdfstore

通过 Bower 安装

$ bower install rdfstore

2. 项目的使用说明

简介

rdfstore-js 是一个纯 JavaScript 实现的 RDF 图存储库，支持 SPARQL 查询和数据操作语言。它可以在 Web 浏览器中运行，也可以作为 Node.js 应用程序的库使用，甚至可以作为独立的 SPARQL 端点，接受 SPARQL RDF 协议的 HTTP 请求。

主要特性

• 支持 SPARQL 1.0 和 SPARQL 1.1/Update
• 部分支持 SPARQL 1.1 查询
• JSON-LD 解析器
• Turtle/N3 解析器
• W3C RDF Interfaces API
• RDF 图事件 API
• 自定义过滤函数
• 使用 IndexedDB 的浏览器持久化

3. 项目 API 使用文档

存储创建

// 在 Node.js 中
var rdfstore = require('rdfstore');

// 在浏览器中，rdfstore 对象已经定义

// 方式 1
rdfstore.create(function(err, store) {
  // 新存储已准备就绪
});

// 方式 2
new rdfstore.Store(function(err, store) {
  // 新存储已准备就绪
});

查询执行

// 简单查询执行
store.execute("SELECT * { ?s ?p ?o }", function(err, results){
  if(!err) {
    // 处理结果
    if(results[0].s.token === 'uri') {
      console.log(results[0].s.value);
    }
  }
});

// 使用显式默认图和命名图执行
var defaultGraph = [{'token':'uri', 'value': graph1}, {'token':'uri', 'value': graph2}, ...];
var namedGraphs  = [{'token':'uri', 'value': graph3}, {'token':'uri', 'value': graph4}, ...];

store.executeWithEnvironment("SELECT * { ?s ?p ?o }", defaultGraph, namedGraphs, function(err, results) {
  if(err) {
    // 处理结果
  }
});

加载远程图

store.execute('LOAD <http://dbpedialite.org/titles/Lisp_%28programming_language%29> INTO GRAPH <lisp>', function(err){
  if(err) {
    var query = 'PREFIX foaf:<http://xmlns.com/foaf/0.1/> SELECT ?o FROM NAMED <lisp> { GRAPH <lisp> { ?s foaf:page ?o} }';
    store.execute(query, function(err, results) {
      // 处理结果
    });
  }
});

高层次接口

// 将整个图作为 JS 接口 API 图对象检索
store.graph(graphUri, function(err, graph){
  // 处理图
});

// 将图导出为 N3（此函数不是 W3C API 的一部分）
store.graph(graphUri, function(err, graph){
  var serialized = graph.toNT();
});

// 将图中的单个节点作为 JS 接口 API 图对象检索
store.node(subjectUri, function(err, node) {
  // 处理节点
});

store.node(subjectUri, graphUri, function(err, node) {
  // 处理节点
});

4. 项目安装方式

使用 NPM 安装

$ npm install rdfstore

使用 Bower 安装

$ bower install rdfstore

构建项目

在运行构建脚本之前，必须使用 npm 安装 JavaScript 依赖项：

$ npm install

使用 gulp 构建库：

$ gulp

构建浏览器版本：

$ gulp browser

运行测试

执行整个测试套件，包括 SPARQL 1.0 的 DAWG 测试用例和当前实现的 SPARQL 1.1 测试用例：

$ gulp specs

此外，还有一些针对浏览器版本的冒烟测试，可以在 spec/browser 目录中找到。