BlazeGraph (blazegraph-gremlin 1.0.0 API)

java.lang.Object
- com.blazegraph.gremlin.structure.BlazeGraph

All Implemented Interfaces:

AutoCloseable, org.apache.tinkerpop.gremlin.structure.Graph, org.apache.tinkerpop.gremlin.structure.util.Host

Direct Known Subclasses:

BlazeGraphEmbedded
```
public abstract class BlazeGraph
extends Object
implements org.apache.tinkerpop.gremlin.structure.Graph
```
Blazegraph/tinkerpop3 integration. Handles the mapping between the tinkerpop3 data model and a custom RDF/PG data model using RDF*. Currently the only concrete implementation of this class is BlazeGraphEmbedded, which provides an embedded (same JVM) implementation of the Blazegraph/tinkerpop3 API. See BlazeGraphFeatures for what tinkerpop3 features this implementation supports. In addition to the tinkerpop3 features, this API also provides the following:
- History API - capture full or partial history of edits to the graph.
- Built-in full text index and search API to find graph elements.
- Automatic SPARQL to PG translation - run a SPARQL query and get your results back in property graph form.
- Query management API - list and cancel running Sparql queries.
- Bulk Load API for fast setup of new graphs.
And an additional two features specific to the embedded implementation:
- Listener API - subscribe to notifications about updates to the graph (adds and removes of vertices/edges/properties, commits, rollbacks, etc.)
- Support for MVCC concurrency model for high-concurrency read access.
Author:

mikepersonick

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`BlazeGraph.Exceptions`
`protected class`	`BlazeGraph.GraphStreamer<E>` Convert a Sesame iteration into a Java 8 Stream.
`static class`	`BlazeGraph.Match` Enum used by the full text search API.
`static interface`	`BlazeGraph.Options` Options that can be specified in the graph configuration.
`protected class`	`BlazeGraph.Transforms` Transform functions from RDF results (binding sets and statements) to property graph results.

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Graph
org.apache.tinkerpop.gremlin.structure.Graph.Features, org.apache.tinkerpop.gremlin.structure.Graph.Hidden, org.apache.tinkerpop.gremlin.structure.Graph.OptIn, org.apache.tinkerpop.gremlin.structure.Graph.OptIns, org.apache.tinkerpop.gremlin.structure.Graph.OptOut, org.apache.tinkerpop.gremlin.structure.Graph.OptOuts, org.apache.tinkerpop.gremlin.structure.Graph.Variables

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.apache.commons.configuration.Configuration`	`config` Configuration of this graph instance.
`protected static LambdaLogger`	`log`
`protected static LambdaLogger`	`sparqlLog`
`protected int`	`sparqlLogMax` Maximum number of chars to print through the SparqlLogger.
`protected BlazeGraph.Transforms`	`transforms` Transform functions for converting from RDF query results to property graph results.

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Graph
GRAPH

Constructor Summary

Constructors
Modifier Constructor and Description

protected BlazeGraph(org.apache.commons.configuration.Configuration config)
Construct an instance using the supplied configuration.

Constructors
Modifier	Constructor and Description
`protected`	`BlazeGraph(org.apache.commons.configuration.Configuration config)` Construct an instance using the supplied configuration.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract boolean`	`_ask(String queryStr, String extQueryId)` Internal Sparql ask method.
`protected abstract Stream<org.openrdf.model.Statement>`	`_project(String queryStr, String extQueryId)` Internal Sparql project method.
`protected abstract Stream<org.openrdf.query.BindingSet>`	`_select(String queryStr, String extQueryId)` Internal Sparql select method.
`protected abstract void`	`_update(String queryStr, String extQueryId)` Internal Sparql update method.
`BlazeEdge`	`addEdge(BlazeVertex from, BlazeVertex to, String label, Object... kvs)` Add an edge.
`BlazeVertex`	`addVertex(Object... kvs)` Add a vertex.
`boolean`	`ask(String queryStr)` Select results using a SPARQL query.
`boolean`	`ask(String queryStr, String extQueryId)` Select results using a SPARQL query.
`void`	`bulkLoad(Code code)` Execute the supplied code fragment in bulk load mode and reset to incremental mode when finished.
`void`	`bulkLoad(org.apache.tinkerpop.gremlin.structure.Graph g)` Bulk load a Graph (TinkerGraph or otherwise).
`void`	`bulkLoad(org.apache.tinkerpop.gremlin.structure.Graph g, Function<String,org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality> getCardinality)` Bulk load a Graph (TinkerGraph or otherwise), using the supplied function to determine VertexProperty key cardinality.
`abstract void`	`cancel(com.bigdata.rdf.sail.model.RunningQuery r)` Kill a running query specified by the RunningQuery object.
`abstract void`	`cancel(UUID queryId)` Kill a running query specified by the UUID.
`abstract void`	`close()` Close the graph.
`org.apache.tinkerpop.gremlin.process.computer.GraphComputer`	`compute()` GraphComputer not currently supported.
`<C extends org.apache.tinkerpop.gremlin.process.computer.GraphComputer> C`	`compute(Class<C> graphComputerClass)` GraphComputer not currently supported.
`org.apache.commons.configuration.Configuration`	`configuration()` Return the graph configuration.
`protected abstract org.openrdf.repository.RepositoryConnection`	`cxn()` Provide a connection to the SAIL repository for read and write operations.
`Optional<BlazeEdge>`	`edge(Object edgeId)` Lookup an edge by id.
`int`	`edgeCount()` Fast edge count using Sparql aggregation.
`CloseableIterator<org.apache.tinkerpop.gremlin.structure.Edge>`	`edges(Object... edgeIds)` Lookup edges by (optional) ids.
`BlazeGraphFeatures`	`features()` Return the features.
`abstract Collection<com.bigdata.rdf.sail.model.RunningQuery>`	`getRunningQueries()` Return a Collection of running queries
`protected Function<org.openrdf.model.Statement,Optional<BlazeGraphAtom>>`	`graphAtomTransform()` So that BlazeGraphEmbedded can use it for listeners.
`CloseableIterator<BlazeGraphEdit>`	`history(List<String> ids)`
`CloseableIterator<BlazeGraphEdit>`	`history(String... ids)` If history is enabled, return an iterator of historical graph edits related to any of the supplied ids.
`boolean`	`isBulkLoad()` Returns whether the graph is in bulkLoad (true) or incremental update (false) mode.
`CloseableIterator<BlazeGraphAtom>`	`project(String queryStr)` Project a subgraph using a SPARQL query.
`CloseableIterator<BlazeGraphAtom>`	`project(String queryStr, String externalQueryId)` Project a subgraph using a SPARQL query.
`abstract com.bigdata.rdf.model.BigdataValueFactory`	`rdfValueFactory()` RDF value factory for Sesame model objects.
`<V> CloseableIterator<org.apache.tinkerpop.gremlin.structure.Property<V>>`	`search(String search, BlazeGraph.Match match)` Search for properties in the graph using the built-in full text index.
`CloseableIterator<BlazeBindingSet>`	`select(String queryStr)` Select results using a SPARQL query.
`CloseableIterator<BlazeBindingSet>`	`select(String queryStr, String extQueryId)` Select results using a SPARQL query.
`void`	`setBulkLoad(boolean bulkLoad)` When this is set to true, disables any implicit reads/removes that are interleaved with the process of adding new data.
`protected void`	`setMaxQueryTime(org.openrdf.query.Query query)` Utility function to set the Query timeout to the global setting if it is configured.
`String`	`toString()` Standard graph toString() representation using TP3 StringFactory.
`abstract org.apache.tinkerpop.gremlin.structure.Transaction`	`tx()` Return the transaction object for this graph.
`void`	`update(String queryStr)` Update graph using SPARQL Update.
`void`	`update(String queryStr, String extQueryId)` Update graph using SPARQL Update.
`BlazeValueFactory`	`valueFactory()` Return the factory used to round-trip between Tinkerpop values and RDF values.
`org.apache.tinkerpop.gremlin.structure.Graph.Variables`	`variables()` Variables not currently supported.
`Optional<BlazeVertex>`	`vertex(String vertexId)` Lookup a vertex by id.
`int`	`vertexCount()` Fast vertex count using Sparql aggregation.
`CloseableIterator<org.apache.tinkerpop.gremlin.structure.Vertex>`	`vertices(Object... vertexIds)` Lookup vertices by (optional) ids.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Graph
addVertex, io, traversal, traversal

- Field Detail
  - log
```
protected static final transient LambdaLogger log
```
  - sparqlLog
```
protected static final transient LambdaLogger sparqlLog
```
  - config
```
protected final org.apache.commons.configuration.Configuration config
```
    Configuration of this graph instance.
  - transforms
```
protected final BlazeGraph.Transforms transforms
```
    Transform functions for converting from RDF query results to property graph results.
  - sparqlLogMax
```
protected final int sparqlLogMax
```
    Maximum number of chars to print through the SparqlLogger. Defaults to 10k.
- Constructor Detail
  - BlazeGraph
```
protected BlazeGraph(org.apache.commons.configuration.Configuration config)
```
    Construct an instance using the supplied configuration.
- Method Detail
  - valueFactory
```
public BlazeValueFactory valueFactory()
```
    Return the factory used to round-trip between Tinkerpop values and RDF values.
  - rdfValueFactory
```
public abstract com.bigdata.rdf.model.BigdataValueFactory rdfValueFactory()
```
    RDF value factory for Sesame model objects.
  - cxn
```
protected abstract org.openrdf.repository.RepositoryConnection cxn()
```
    Provide a connection to the SAIL repository for read and write operations.
  - isBulkLoad
```
public boolean isBulkLoad()
```
    Returns whether the graph is in bulkLoad (true) or incremental update (false) mode. Incremental update is the default mode
    
    See Also:
    
    setBulkLoad(boolean)
  - setBulkLoad
```
public void setBulkLoad(boolean bulkLoad)
```
    When this is set to true, disables any implicit reads/removes that are interleaved with the process of adding new data. This means no checking on vertex and edge id reuse and no cleaning of old property values (applies to all properties on Edges and VertexProperties and Cardinality.single properties on Vertices). This results in considerably greater write throughput and is suitable for loading a new data set into an empty graph or loading data that does overlap with any data already in an existing graph. Default is incremental update (bulkLoad = false).
  - bulkLoad
```
public void bulkLoad(Code code)
```
    Execute the supplied code fragment in bulk load mode and reset to incremental mode when finished.
    
    See Also:
    
    setBulkLoad(boolean)
  - bulkLoad
```
public void bulkLoad(org.apache.tinkerpop.gremlin.structure.Graph g)
```
    Bulk load a Graph (TinkerGraph or otherwise). Uses the Graph's features to determine VertexProperty key cardinality. Vertex and Edge ids will be toString()-ed, VertexProperty ids will be ignored.
  - bulkLoad
```
public void bulkLoad(org.apache.tinkerpop.gremlin.structure.Graph g,
                     Function<String,org.apache.tinkerpop.gremlin.structure.VertexProperty.Cardinality> getCardinality)
```
    Bulk load a Graph (TinkerGraph or otherwise), using the supplied function to determine VertexProperty key cardinality. Vertex and Edge ids will be toString()-ed, VertexProperty ids will be ignored.
  - addVertex
```
public BlazeVertex addVertex(Object... kvs)
```
    Add a vertex.
    
    Specified by:
    
    addVertex in interface org.apache.tinkerpop.gremlin.structure.Graph
    
    See Also:
    
    Graph.addVertex(Object...)
  - addEdge
```
public BlazeEdge addEdge(BlazeVertex from,
                         BlazeVertex to,
                         String label,
                         Object... kvs)
```
    Add an edge. Helper for BlazeVertex.addEdge(String, Vertex, Object...) to consolidate these operations in one place.
    
    See Also:
    
    Vertex.addEdge(String, Vertex, Object...)
  - vertexCount
```
public int vertexCount()
```
    Fast vertex count using Sparql aggregation.
    
    Returns:
    
    vertex count
  - vertex
```
public Optional<BlazeVertex> vertex(String vertexId)
```
    Lookup a vertex by id.
    
    Parameters:
    
    vertexId - the id
    
    Returns:
    
    the BlazeVertex, if one exists for the supplied id
  - vertices
```
public CloseableIterator<org.apache.tinkerpop.gremlin.structure.Vertex> vertices(Object... vertexIds)
```
    Lookup vertices by (optional) ids. Return type strengthened from normal iterator. You MUST close this iterator when finished.
    
    Specified by:
    
    vertices in interface org.apache.tinkerpop.gremlin.structure.Graph
  - edgeCount
```
public int edgeCount()
```
    Fast edge count using Sparql aggregation.
    
    Returns:
    
    edge count
  - edge
```
public Optional<BlazeEdge> edge(Object edgeId)
```
    Lookup an edge by id.
    
    Parameters:
    
    edgeId - the id
    
    Returns:
    
    the BlazeEdge, if one exists for the supplied id
  - edges
```
public CloseableIterator<org.apache.tinkerpop.gremlin.structure.Edge> edges(Object... edgeIds)
```
    Lookup edges by (optional) ids. Return type strengthened from normal iterator. You MUST close this iterator when finished.
    
    Specified by:
    
    edges in interface org.apache.tinkerpop.gremlin.structure.Graph
  - tx
```
public abstract org.apache.tinkerpop.gremlin.structure.Transaction tx()
```
    Return the transaction object for this graph. Implementation-specific.
    
    Specified by:
    
    tx in interface org.apache.tinkerpop.gremlin.structure.Graph
    
    See Also:
    
    BlazeGraphEmbedded.BlazeTransaction
  - close
```
public abstract void close()
```
    Close the graph. Implementation-specific.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface org.apache.tinkerpop.gremlin.structure.Graph
    
    See Also:
    
    BlazeGraphEmbedded.close()
  - configuration
```
public org.apache.commons.configuration.Configuration configuration()
```
    Return the graph configuration.
    
    Specified by:
    
    configuration in interface org.apache.tinkerpop.gremlin.structure.Graph
  - features
```
public BlazeGraphFeatures features()
```
    Return the features.
    
    Specified by:
    
    features in interface org.apache.tinkerpop.gremlin.structure.Graph
    
    See Also:
    
    BlazeGraphFeatures
  - toString
```
public String toString()
```
    Standard graph toString() representation using TP3 StringFactory.
    
    Overrides:
    
    toString in class Object
  - variables
```
public org.apache.tinkerpop.gremlin.structure.Graph.Variables variables()
```
    Variables not currently supported. TODO FIXME
    
    Specified by:
    
    variables in interface org.apache.tinkerpop.gremlin.structure.Graph
  - compute
```
public org.apache.tinkerpop.gremlin.process.computer.GraphComputer compute()
                                                                    throws IllegalArgumentException
```
    GraphComputer not currently supported. TODO FIXME Implement GraphComputer over DASL API
    
    Specified by:
    
    compute in interface org.apache.tinkerpop.gremlin.structure.Graph
    
    Throws:
    
    IllegalArgumentException
  - compute
```
public <C extends org.apache.tinkerpop.gremlin.process.computer.GraphComputer> C compute(Class<C> graphComputerClass)
                                                                                  throws IllegalArgumentException
```
    GraphComputer not currently supported. TODO FIXME Implement GraphComputer over DASL API
    
    Specified by:
    
    compute in interface org.apache.tinkerpop.gremlin.structure.Graph
    
    Throws:
    
    IllegalArgumentException
  - project
```
public CloseableIterator<BlazeGraphAtom> project(String queryStr)
                                          throws Exception
```
    Project a subgraph using a SPARQL query.
    Warning: You MUST close this iterator when finished.
    
    Throws:
    
    Exception
  - project
```
public CloseableIterator<BlazeGraphAtom> project(String queryStr,
                                                 String externalQueryId)
                                          throws Exception
```
    Project a subgraph using a SPARQL query. This version allows passing an external system ID to allow association between queries in the query engine when using an Embedded Client.
    Warning: You MUST close this iterator when finished.
    
    Throws:
    
    Exception
  - select
```
public CloseableIterator<BlazeBindingSet> select(String queryStr)
```
    Select results using a SPARQL query.
    Warning: You MUST close this iterator when finished.
  - select
```
public CloseableIterator<BlazeBindingSet> select(String queryStr,
                                                 String extQueryId)
```
    Select results using a SPARQL query.
    Warning: You MUST close this iterator when finished.
  - ask
```
public boolean ask(String queryStr)
```
    Select results using a SPARQL query.
  - ask
```
public boolean ask(String queryStr,
                   String extQueryId)
```
    Select results using a SPARQL query.
  - update
```
public void update(String queryStr)
```
    Update graph using SPARQL Update.
  - update
```
public void update(String queryStr,
                   String extQueryId)
```
    Update graph using SPARQL Update.
  - history
```
public CloseableIterator<BlazeGraphEdit> history(String... ids)
```
    If history is enabled, return an iterator of historical graph edits related to any of the supplied ids. To enable history, make sure that the RDR History class is enabled (it is by default with BasicRepositoryProvider. Only vertex and edges ids currently supported.
    Warning: You MUST close this iterator when finished.
    
    See Also:
    
    AbstractTripleStore.Options#STATEMENT_IDENTIFIERS, AbstractTripleStore.Options#RDR_HISTORY_CLASS, RDRHistory
  - history
```
public CloseableIterator<BlazeGraphEdit> history(List<String> ids)
```
    See Also:
    
    history(String...)
  - search
```
public <V> CloseableIterator<org.apache.tinkerpop.gremlin.structure.Property<V>> search(String search,
                                                                                        BlazeGraph.Match match)
```
    Search for properties in the graph using the built-in full text index.
    
    Parameters:
    
    search - The search string. Tokens in the search string will be matched according to the supplied match parameter.
    
    match - The match behavior.
    
    Returns:
    
    Any properties whose value matches the search.
  - _select
```
protected abstract Stream<org.openrdf.query.BindingSet> _select(String queryStr,
                                                                String extQueryId)
```
    Internal Sparql select method. Prepare a Sparql select query, turn Sesame iteration into a stream of binding sets using BlazeGraph.GraphStreamer. Callers MUST close this stream when finished.
  - _project
```
protected abstract Stream<org.openrdf.model.Statement> _project(String queryStr,
                                                                String extQueryId)
```
    Internal Sparql project method. Prepare a Sparql graph query, turn Sesame iteration into a stream of statements using BlazeGraph.GraphStreamer. Callers MUST close this stream when finished.
  - _ask
```
protected abstract boolean _ask(String queryStr,
                                String extQueryId)
```
    Internal Sparql ask method. Prepare a Sparql ask query and return result.
  - _update
```
protected abstract void _update(String queryStr,
                                String extQueryId)
```
    Internal Sparql update method. Prepare a Sparql Update and execute.
  - setMaxQueryTime
```
protected void setMaxQueryTime(org.openrdf.query.Query query)
```
    Utility function to set the Query timeout to the global setting if it is configured.
  - getRunningQueries
```
public abstract Collection<com.bigdata.rdf.sail.model.RunningQuery> getRunningQueries()
```
    Return a Collection of running queries
  - cancel
```
public abstract void cancel(UUID queryId)
```
    Kill a running query specified by the UUID. Do nothing if the query has completed.
  - cancel
```
public abstract void cancel(com.bigdata.rdf.sail.model.RunningQuery r)
```
    Kill a running query specified by the RunningQuery object. Do nothing if the query has completed.
  - graphAtomTransform
```
protected Function<org.openrdf.model.Statement,Optional<BlazeGraphAtom>> graphAtomTransform()
```
    So that BlazeGraphEmbedded can use it for listeners.

Class BlazeGraph

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

Field Summary

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

Field Detail

log

sparqlLog

config

transforms

sparqlLogMax

Constructor Detail

BlazeGraph

Method Detail

valueFactory

rdfValueFactory

cxn

isBulkLoad

setBulkLoad

bulkLoad

bulkLoad

bulkLoad

addVertex

addEdge

vertexCount

vertex

vertices

edgeCount

edge

edges

tx

close

configuration

features

toString

variables

compute

compute

project

project

select

select

ask

ask

update

update

history

history

search

_select

_project

_ask

_update

setMaxQueryTime

getRunningQueries

cancel

cancel

graphAtomTransform