You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by rv...@apache.org on 2014/11/12 18:00:11 UTC

svn commit: r1638854 - in /jena/site/trunk/content/documentation/hadoop: ./ artifacts.mdtext index.mdtext

Author: rvesse
Date: Wed Nov 12 17:00:10 2014
New Revision: 1638854

URL: http://svn.apache.org/r1638854
Log:
Stub for RDF Tools for Hadoop documentation

Added:
    jena/site/trunk/content/documentation/hadoop/
    jena/site/trunk/content/documentation/hadoop/artifacts.mdtext
    jena/site/trunk/content/documentation/hadoop/index.mdtext

Added: jena/site/trunk/content/documentation/hadoop/artifacts.mdtext
URL: http://svn.apache.org/viewvc/jena/site/trunk/content/documentation/hadoop/artifacts.mdtext?rev=1638854&view=auto
==============================================================================
--- jena/site/trunk/content/documentation/hadoop/artifacts.mdtext (added)
+++ jena/site/trunk/content/documentation/hadoop/artifacts.mdtext Wed Nov 12 17:00:10 2014
@@ -0,0 +1,49 @@
+Title: Maven Artifacts for Jena RDF Tools for Hadoop
+
+The Jena RDF Tools for Hadoop libraries are a collection of maven artifacts which can be used individually
+or together as desired.  These are available from the same locations as any other Jena
+artifact, see [Using Jena with Maven](/download/maven.html) for more information.
+
+## Common API
+
+The `jena-hadoop-rdf-common` artifact provides common classes for enabling RDF on Hadoop.  This is mainly
+composed of relevant `Writable` implementations for the various supported RDF primitives.
+
+    <dependency>
+      <groupId>org.apache.jena</groupId>
+      <artifactId>jena-hadoop-rdf-common</artifactId>
+      <version>x.y.z</version>
+    </dependency>
+
+## IO API
+
+The [IO API](io.html) artifact provides support for reading and writing RDF in Hadoop:
+
+    <dependency>
+      <groupId>org.apache.jena</groupId>
+      <artifactId>jena-hadoop-rdf-io</artifactId>
+      <version>x.y.z</version>
+    </dependency>
+
+## Map/Reduce
+
+The [Map/Reduce](mapred.html) artifact provides various building block mapper and reducer implementations
+to help you get started writing Map/Reduce jobs over RDF data quicker:
+
+    <dependency>
+      <groupId>org.apache.jena</groupId>
+      <artifactId>jena-hadoop-rdf-mapreduce</artifactId>
+      <version>x.y.z</version>
+    </dependency>
+
+## RDF Stats Demo
+
+The [RDF Stats Demo](demo.html) artifact is a Hadoop job jar which can be used to run some simple demo applications over your
+own RDF data:
+
+    <dependency>
+      <groupId>org.apache.jena</groupId>
+      <artifactId>jena-hadoop-rdf-stats</artifactId>
+      <version>x.y.z</version>
+      <classifier>hadoop-job</classifier>
+    </dependency>
\ No newline at end of file

Added: jena/site/trunk/content/documentation/hadoop/index.mdtext
URL: http://svn.apache.org/viewvc/jena/site/trunk/content/documentation/hadoop/index.mdtext?rev=1638854&view=auto
==============================================================================
--- jena/site/trunk/content/documentation/hadoop/index.mdtext (added)
+++ jena/site/trunk/content/documentation/hadoop/index.mdtext Wed Nov 12 17:00:10 2014
@@ -0,0 +1,62 @@
+Title: RDF Tools for Hadoop
+
+RDF Tools for Hadoop is a set of libraries which provide various basic building blocks which enable
+you to start writing Hadoop based applications which work with RDF data.
+
+
+
+## Documentation
+
+- [Overview](#overview)
+- [Getting Started](#getting-started)
+- APIs
+    - [Common](common.html)
+    - [IO](io.html)
+    - [Map/Reduce](mapred.html)
+- Examples
+    - [RDF Stats Demo](demo.html)
+- [Maven Artifacts for Jena JDBC](artifacts.html)
+
+## Overview
+
+Jena JDBC aims to be a pure SPARQL over JDBC driver, it assumes that all commands that come in are
+either SPARQL queries or updates and processes them as such.
+
+As detailed on the [drivers](drivers.html) page there are actually three drivers provided currently:
+
+- [In-Memory](drivers.html#in-memory) - uses an in-memory dataset to provide non-persistent storage
+- [TDB](drivers.html#tdb) - uses a [TDB](/documentation/tdb/) dataset to provide persistent and transactional storage
+- [Remote Endpoint](drivers.html#remote-endpoint) - uses HTTP based remote endpoints to access any SPARQL protocol compliant storage
+
+These are all built on a core library which can be used to build [custom drivers](custom_driver.html)
+if desired.  This means that all drivers share common infrastructure and thus exhibit broadly speaking
+the same behavior around handling queries, updates and results.
+
+Jena JDBC is published as a Maven module via its [maven artifacts](artifacts.html).  The source for Jena JDBC may be [downloaded](/download/index.cgi) as part of the source distribution.
+
+## Getting Started
+
+To get started you will need to add the relevant dependencies to your project, the exact dependencies necessary will depend 
+on what you are trying to do.  Typically you will likely need at least the IO library and possibly the Map/Reduce library:
+
+    <dependency>
+      <groupId>org.apache.jena</groupId>
+      <artifactId>jena-hadoop-rdf-io</artifactId>
+      <version>x.y.z</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.jena</groupId>
+      <artifactId>jena-hadoop-rdf-mapreduce</artifactId>
+      <version>x.y.z</version>
+    </dependency>
+
+## APIs
+
+There are three main libraries each with their own API:
+
+- [Common](common.html) - this provides the basic data model for representing RDF data within Hadoop
+- [IO](io.html) - this provides support for reading and writing RDF
+- [Map/Reduce](mapred.html) - this provides support for writing Map/Reduce jobs that work with RDF
+
+
+