oracle.pg.hbase

Class OraclePropertyGraph

java.lang.Object

oracle.pg.common.OraclePropertyGraphBase

oracle.pg.hbase.OraclePropertyGraph

All Implemented Interfaces:

com.tinkerpop.blueprints.Graph, com.tinkerpop.blueprints.IndexableGraph, com.tinkerpop.blueprints.KeyIndexableGraph, com.tinkerpop.blueprints.TransactionalGraph, java.io.Closeable, java.lang.AutoCloseable, MesgConsts, OracleCSVDatatypeConstants, OracleMessageConstants, OraclePropertyGraphConstants, OraclePropertyGraphDatatypeConstants, Host

public class OraclePropertyGraph
extends OraclePropertyGraphBase

This class implements the Blueprints Graph interface on top an Apache HBase backend database. Note that this implementation is not thread safe. To safely perform concurrent operations against a single graph, multiple instances of OraclePropertyGraph are recommended.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.pg.common.OraclePropertyGraphBase

OraclePropertyGraphBase.OptimizationFlag

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

Graph.Exceptions, Graph.Features, Graph.Hidden, Graph.OptIn, Graph.OptIns, Graph.OptOut, Graph.OptOuts, Graph.Variables

Nested classes/interfaces inherited from interface oracle.pg.common.OraclePropertyGraphConstants

OraclePropertyGraphConstants.QueueAction

Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.TransactionalGraph

com.tinkerpop.blueprints.TransactionalGraph.Conclusion

Field Summary

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

GRAPH

Fields inherited from interface oracle.pg.common.OracleCSVDatatypeConstants

CSV_DATE_TIME_FORMATS, CSV_DT_KEYWORD_BOOLEAN, CSV_DT_KEYWORD_BYTE, CSV_DT_KEYWORD_CHAR, CSV_DT_KEYWORD_DATE, CSV_DT_KEYWORD_DOUBLE, CSV_DT_KEYWORD_FLOAT, CSV_DT_KEYWORD_INTEGER, CSV_DT_KEYWORD_JSON, CSV_DT_KEYWORD_LONG, CSV_DT_KEYWORD_RDF, CSV_DT_KEYWORD_SHORT, CSV_DT_KEYWORD_SPATIAL, CSV_DT_KEYWORD_STRING, OPG_DATETIME_FORMAT

Fields inherited from interface oracle.pg.common.OraclePropertyGraphDatatypeConstants

TYPE_DT_BOOL, TYPE_DT_BYTE, TYPE_DT_CHAR, TYPE_DT_DATE, TYPE_DT_DOUBLE, TYPE_DT_EMPTY, TYPE_DT_FLOAT, TYPE_DT_INTEGER, TYPE_DT_JSON, TYPE_DT_LONG, TYPE_DT_SERI, TYPE_DT_SHORT, TYPE_DT_SPATIAL, TYPE_DT_STRING, TYPE_DT_URI

Fields inherited from interface oracle.pg.common.OracleMessageConstants

MG_ERR_USER_REQ_OP_CANCEL, MSG_E_AUTO_IDX_MUST_SOLR_OR_LUCENE, MSG_E_AUTO_IDX_NOT_EXIST, MSG_ERR_ARG_CANNOT_BE_NULL, MSG_ERR_ID_CANNOT_BE_NULL, MSG_ERR_NO_ELEM_TO_BE_CONSUMED, MSG_ERR_NO_OP_SUPPORTED, MSG_IDX_KEY_NOT_NULL, MSG_IDX_KEYS_NOT_NULL, MSG_TXT_IDX_NOT_FOUND, MSG_V_AUTO_IDX_MUST_SOLR_OR_LUCENE, MSG_V_AUTO_IDX_NOT_EXIST

Fields inherited from interface oracle.pg.common.messages.MesgConsts

ERR_ARG_CANNOT_BE_NULL, ERR_CODE_NOT_IN_LIST, ERR_DOP_CONSTRAINT, ERR_E_AUTO_IDX_MUST_SOLR_OR_LUCENE, ERR_E_AUTO_IDX_NOT_EXIST, ERR_E_DS_MUSTBE_FILE_OR_IS, ERR_E_MAX_LINE_CONSTRAINT, ERR_EDGE_DIR_NOT_BOTH, ERR_EDGE_WORK_TBL_NOT_CLEAN, ERR_GRAPH_NAME_CANT_BENULL, ERR_HIT_EXCEPTION, ERR_HIT_INTERRUPT, ERR_HIT_IO, ERR_HIT_OPGE, ERR_HIT_PARSEE, ERR_ID_CANNOT_BE_NULL, ERR_IDX_KEY_CANNOT_BE_NULL, ERR_IDX_KEY_NOT_NULL, ERR_IDX_KEYS_NOT_NULL, ERR_IN_DS_EDGE_CANTBE_NULL, ERR_IN_DS_VERT_CANTBE_NULL, ERR_IN_E_FLAT_DOESNT_EXIST, ERR_IN_V_FLAT_DOESNT_EXIST, ERR_INPUT_LIST_NOT_NULL, ERR_INPUT_NOT_NULL, ERR_INVALID_CHANGE_ACTION, ERR_INVALID_NUM_FIELDS, ERR_INVALID_NUM_NOARG, ERR_INVALID_NUMBER, ERR_INVALID_VAL, ERR_KEY_CANNOT_BE_ID, ERR_KEY_CANNOT_BE_NULL, ERR_KEY_CANNOT_BE_NULL_EMPTY, ERR_KEY_NOT_SET_TO, ERR_NO_ELEM_TO_BE_CONSUMED, ERR_NO_OP_SUPPORTED, ERR_NOT_IMPLEMENTED_YET, ERR_NOT_ORACLE_V_E, ERR_NUM_PART_CONSTRAINT, ERR_OFFSET_CONSTRAINT, ERR_OFFSET_E_MUST_BE_POS, ERR_OFFSET_V_MUST_BE_POS, ERR_OPT_FLAG_EDGE_INVALID, ERR_OPT_FLAG_VERT_INVALID, ERR_ORA_TEXT_INVALID_KEY, ERR_ORA_TEXT_ONLY_AUTO, ERR_OUTPUT_LIST_NOT_NULL, ERR_PG_ALREADY_EXISTS, ERR_PG_NOT_EMPTY, ERR_PG_NOT_NULL, ERR_SIZE_MUST_BE_POS, ERR_TIMEOUT_TAB_CREATION, ERR_TXT_IDX_NOT_FOUND, ERR_TYPE_ID_NOT_RECO, ERR_UNSUPPORTED_VAL_TYP, ERR_USER_REQ_OP_CANCEL, ERR_V_AUTO_IDX_MUST_SOLR_OR_LUCENE, ERR_V_AUTO_IDX_NOT_EXIST, ERR_V_DS_MUSTBE_FILE_OR_IS, ERR_V_MAX_LINE_CONSTRAINT, ERR_VALUE_CANNOT_BE_NULL, INFO_EMP_K_NO_P_VAL, INFO_NUL_K_NO_P_VAL

Method Summary

Modifier and Type	Method and Description
void	addAttributeToAllEdges(EdgeOpCallback eoc, boolean skipStoreToCache, int dop, ProgressListener pl) Adds an attribute to all edges based on the specified EdgeOpCallback.
void	addAttributeToAllVertices(VertexOpCallback voc, boolean skipStoreToCache, int dop, ProgressListener pl) Adds an attribute to all vertices based on the specified VertexOpCallback.
com.tinkerpop.blueprints.Edge	addEdge(java.lang.Object id, com.tinkerpop.blueprints.Vertex outVertex, com.tinkerpop.blueprints.Vertex inVertex, java.lang.String label) This method adds an edge to the graph instance.
Edge	addEdge(java.lang.Object id, Vertex v, Vertex anotherv, java.lang.String label) Adds a new Edge
Vertex	addVertex(java.lang.Object... keyValues) Add a Vertex to the graph given an optional series of key/value pairs.
com.tinkerpop.blueprints.Vertex	addVertex(java.lang.Object id) This method adds an vertex to the graph instance.
Vertex	addVertex(java.lang.String label) Add a Vertex to the graph with provided vertex label.
void	clearCache() This method clear the Vertex and Edge caches associated to this property graph instance.
void	clearRepository() This method removes all vertices and edges from this property graph instance.
void	clearRepository(boolean removeUsingIterators) This method removes all vertices and edges from this property graph instance.
void	commit() Commit changes done to this property graph instace.
GraphComputer	compute() Generate a GraphComputer using the default engine of the underlying graph system.
<C extends GraphComputer> C	compute(java.lang.Class<C> graphComputerClass) Declare the GraphComputer to use for OLAP operations on the graph.
static byte[]	concatenate(byte[] ba1, byte[] ba2) This method returns a byte array that concatenates the two given byte array If one of the argument is null, the return value will be the other argument.
static byte[]	concatenate(byte[] ba1, byte[] ba2, byte[] ba3) This method returns a byte array that concatenates the two given byte array If one of the argument is null, the return value will be the other argument.
org.apache.commons.configuration.Configuration	configuration() Get the org.apache.commons.configuration.Configuration associated with the construction of this graph.
long	countEdges(int dop, ProgressListener pl) Counts all Edges using parallel scan and the specified DOP.
long	countVertices(int dop, ProgressListener pl) Counts all vertices using parallel scans and the specified DOP.
void	dispose() Closes the graph without commiting any changes
void	dropIndexTable() This method removes all indices meta data from this property graph instance.
java.util.Iterator<Edge>	edges(java.lang.Object... edgeIds) Get the Edge objects in this graph with the provided edge ids or Edge objects.
Graph.Features	features() Gets the particular features of the graph implementation for Tinkerpop 2.3
void	flushHbaseCommits() Flush HBase tables so property graph changes are commited into Apache HBase.
java.lang.String	getCompression() Get the type of compression used in the property graph tables
org.apache.hadoop.hbase.io.compress.Compression.Algorithm	getCompressionAlgorithm(java.lang.String compress) An utility to get a Compression Algorithm based on the specified string
org.apache.hadoop.conf.Configuration	getConfiguration() This method returns the underlying Configuration instance used for HBase
org.apache.hadoop.hbase.io.encoding.DataBlockEncoding	getDataBlockEncoding() Gets the data block encoding algorithm used in block cache and optionally on disk for all property graph tables
OracleEdge	getEdge(java.lang.Object id) Return the edge referenced by the object identifier.
int	getEdgeBlockCacheSize() Gets the size of the block cache (in bytes) associated to the edge table
int	getEdgeInitialNumRegions() Get the initial number of regions defined for the Apache HBase Edge tables associated to this property graph.
OracleEdgeBase	getEdgeInstance(java.lang.Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdgeBase.
OracleEdgeBase	getEdgeInstance(OracleVertexBase outVertex, OracleVertexBase inVertex, java.lang.String edgeLabel, java.lang.Long eid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleEdgeBase.
int	getEdgePropertyNames(int dop, int timeout, java.util.Set<java.lang.String> propertyNames, ProgressListener pl) Gets the property names of all edges using parallel scans and the specified DOP.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>	getEdges(java.lang.String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag flag) Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>	getEdges(java.lang.String[] keys, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag flag, int dop) Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>	getEdges(java.lang.String key, java.lang.Object value, java.lang.Class dtClass, boolean acceptWildcard, boolean preferredLuceneQuery) Return an iterable to all matching edges that have a particular key/value property.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesFromKey(org.apache.hadoop.hbase.client.HConnection[] conns, boolean skipStoreToCache, int startSplitID, java.lang.String[] keys) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback by executing a lookup over the secondary index table.
int	getEdgeSndIndexBlockCacheSize() Gets the size of the block cache (in bytes) associated to the secondary index edge table
java.lang.String	getEdgeSndIndexTabName() Get the name of the Apache HBase table used to store secondary indexes on edges in this property graph.
long	getEdgeSndIndexWriteBufferSize() Set the write buffer size associated to the edge secondary index table
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID) Gets an array of Iterable objects that hold all the edges in the graph.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, boolean bClonedGraph) Gets an array of Iterable objects that hold all the edges in the graph.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, EdgeFilterCallback efc) Gets an array of Iterable objects that hold all the edges in the graph that satisfy the specified edge filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag flag) Gets an array of Iterable objects that hold all the edges in the graph that satisfy the specified edge filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, OraclePropertyGraphBase.OptimizationFlag flag) Gets an array of Iterable objects that hold all the edges in the graph.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String key) Gets an array of Iterable objects that hold all the edges in the graph that have a particular key.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String[] keys) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String[] keys, boolean bClonedGraph, EdgeFilterCallback efc) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String[] keys, boolean bClonedGraph, EdgeFilterCallback efc, OraclePropertyGraphBase.OptimizationFlag flag) Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Edge>[]	getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String key, boolean bClonedGraph) Gets an array of Iterable objects that hold all the edges in the graph that have a particular key.
java.util.Set<org.apache.hadoop.hbase.HRegionInfo>	getEdgeTableRegionsInfo() Gets the information of all HBase regions of the edge table
int	getEdgeTableSplits() Get the number of Edge table splits based on the current number of splits per region associated to this graph and the number of regions in the edge table.
java.lang.String	getEdgeTabName() Get the name of the Apache HBase table used to store edges in this property graph.
long	getEdgeWriteBufferSize() Set the write buffer size associated to the edge table
java.lang.Iterable<java.util.Map.Entry<java.lang.Object,java.lang.Object>>	getElementsProperties(java.lang.Object[] ids, java.lang.String propertyName, int dop, java.lang.Class<? extends com.tinkerpop.blueprints.Element> elementClass)
com.tinkerpop.blueprints.Features	getFeatures() Gets the particular features of the graph implementation for Tinkerpop 3
java.lang.String	getGraphName() This method returns the name of this property graph instance
static org.apache.hadoop.conf.Configuration	getHbaseConfiguration(oracle.pgx.config.PgHbaseGraphConfig config) Gets a HBase configuration from a PgHbaseGraphConfig object
org.apache.hadoop.hbase.client.HConnection	getHConnection() Gets the underlying connection for this property graph
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, int initialNumRegions) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, int initialNumRegions, int splitsPerRegion) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, int initialNumRegions, int splitsPerRegion, int blockCacheSize) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, java.lang.String compress, org.apache.hadoop.hbase.io.encoding.DataBlockEncoding dbe, int splitsPerRegion, int blockCacheSize, int initialVertexNumRegions, int initialEdgeNumRegions) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, java.lang.String compress, int initialNumRegions) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, java.lang.String compress, int initialNumRegions, int splitsPerRegion) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, java.lang.String compress, int initialNumRegions, int splitsPerRegion, int blockCacheSize) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, java.lang.String compress, int splitsPerRegion, int blockCacheSize, int initialVertexNumRegions, int initialEdgeNumRegions) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.
static OraclePropertyGraph	getInstance(oracle.pgx.config.PgHbaseGraphConfig config) Returns an instance of OraclePropertyGraph using a PGX PgHbaseGraphConfig object.
static OraclePropertyGraph	getInstance(oracle.pgx.config.PgHbaseGraphConfig config, long maxRowSize) Returns an instance of OraclePropertyGraph using a PGX PgHbaseGraphConfig object.
static OraclePropertyGraph	getInstanceWithSplits(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.HConnection hconn, java.lang.String szGraphName, int splitsPerRegion) Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided and the specified number of splits per region.
java.util.Set<java.lang.Long>	getInvalidEdgeIDSet(int dop, ProgressListener pl) Gets a set of invalid edges that are stored in the property graph.
int	getLuceneBlockCacheSize() Gets the size of the block cache (in bytes) associated to the Lucene index table
java.lang.String	getLuceneTabName() Get the name of the Apache HBase table used to store index metadata in this property graph.
long	getLuceneWriteBufferSize() Set the write buffer size associated to the Lucene index table
long	getMaxEdgeID(int dop, ProgressListener pl) Get the maximum edge ID using parallel scan and the specified DOP.
long	getMaxVertexID(int dop, ProgressListener pl) Get maximum vertex ID using parallel scans and the specified DOP.
long	getMinEdgeID(int dop, ProgressListener pl) Get the minimum edge ID using parallel scan with dop threads
long	getMinVertexID(int dop, ProgressListener pl) Get minimum vertex ID using parallel scans and the specified DOP.
int	getNumSplitsPerRegion() Get the number of splits per region to use when scanning vertices/edges
long	getOperationQueueSize() Get the size of the operation queue
HBaseIndexManager	getOracleIndexManager() Gets the OracleIndexManager object associated to this property graph instance.
static int	getSaltSize() Gets the salt size
int	getScanCachingSize() Get the caching size used in Scan operations
int	getSecondaryIndexNumBuckets() Return the number of buckets used to store secondary index data into the vertex/edge secondary index tables
OracleVertex	getVertex(java.lang.Object id) Return the vertex referenced by the object identifier.
int	getVertexBlockCacheSize() Gets the size of the block cache (in bytes) associated to the vertex table
java.util.Set<java.lang.Long>	getVertexIDSet(int dop, ProgressListener pl) Gets a set of Vertex IDs that are stored in the property graph
int	getVertexInitialNumRegions() Get the initial number of regions defined for the Apache HBase Vertex tables associated to this property graph.
OracleVertexBase	getVertexInstance(java.lang.Long vid, boolean bCreateIfAbsentFromCache, boolean bSkipStoreToCache) Returns an instance of OracleVertexBase.
int	getVertexPropertyNames(int dop, int timeout, java.util.Set<java.lang.String> propertyNames, ProgressListener pl) Gets the property names of all vertices using parallel scans and the specified DOP.
int	getVertexSndIndexBlockCacheSize() Gets the size of the block cache (in bytes) associated to the secondary index vertex table
java.lang.String	getVertexSndIndexTabName() Get the name of the Apache HBase table used to store secondary indexes on vertices in this property graph.
long	getVertexSndIndexWriteBufferSize() Get the write buffer size associated to the vertex secondary index table
java.util.Set<org.apache.hadoop.hbase.HRegionInfo>	getVertexTableRegionsInfo() Gets the information of all HBase regions of the vertex table
int	getVertexTableSplits() Get the number of Vertex table splits based on the current number of splits per region associated to this graph and the number of regions in the vertex table.
java.lang.String	getVertexTabName() Get the name of the Apache HBase table used to store vertices in this property graph.
long	getVertexWriteBufferSize() Get the write buffer size associated to the vertex table
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>	getVertices() Return an iterable to all the vertices in the graph.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>	getVertices(java.lang.String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag flag) Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>	getVertices(java.lang.String[] keys, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag flag, int dop) Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>	getVertices(java.lang.String key, java.lang.Object value, java.lang.Class dtClass, boolean acceptWildcard, boolean preferredLuceneQuery) Return an iterable to all matching vertices that have a particular key/value property.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesFromKey(org.apache.hadoop.hbase.client.HConnection[] conns, boolean skipStoreToCache, int startSplitID, java.lang.String[] keys) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback by executing a lookup over the secondary index table.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID) Gets an array of Iterable objects that hold all the vertices in the graph.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, boolean bClonedGraph) Gets an array of Iterable objects that hold all the vertices in the graph.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, OraclePropertyGraphBase.OptimizationFlag flag) Gets an array of Iterable objects that hold all the vertices in the graph.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String key) Gets an array of Iterable objects that hold all the vertices in the graph that have a particular key.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String[] keys) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String[] keys, boolean bCloneGraph, VertexFilterCallback vfc) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String[] keys, boolean bCloneGraph, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag flag) Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, java.lang.String key, boolean bCloneGraph) Gets an array of Iterable objects that hold all the vertices in the graph that have a particular key.
java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[]	getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections, boolean bSkipStoreToCache, int startSplitID, VertexFilterCallback vfc, OraclePropertyGraphBase.OptimizationFlag flag) Gets an array of Iterable objects that hold all the vertices in the graph that satisfy the specified vertex filter callback.
long	getWriteBufferSize() Get the write buffer size associated to the vertex table
<I extends Io> I	io(Io.Builder<I> builder) Construct a particular Io implementation for reading and writing the Graph and other data.
static org.apache.hadoop.conf.Configuration	prepareSecureConfig(org.apache.hadoop.conf.Configuration config, java.lang.String hbaseSecAuth, java.lang.String hadoopSecAuth, java.lang.String hmKerberosPrincipal, java.lang.String rsKerberosPrincipal, java.lang.String userPrincipal, java.lang.String keytab) Prepares the Apache HBase configuration object to work with HBase secure cluster
static void	quietlyClose(org.apache.hadoop.hbase.client.HTable htable) Quietly close the specified HTable object.
static void	quietlyClose(org.apache.hadoop.hbase.client.HTableInterface htable) Quietly close the specified HTableInterface object.
void	rebuildEdgeSecondaryIndexTable() Rebuilds the secondary index on edges.
void	rebuildEdgeSecondaryIndexTable(int dop) Rebuilds the secondary index on edges.
void	rebuildVertexSecondaryIndexTable() Rebuilds the secondary index on vertices.
void	rebuildVertexSecondaryIndexTable(int dop) Rebuilds the secondary index on edges.
void	removeAttributeFromAllEdges(EdgeOpCallback eoc, boolean skipStoreToCache, int dop, ProgressListener pl) Removes an attribute from all edges based on the specified EdgeOpCallback.
void	removeAttributeFromAllVertices(VertexOpCallback voc, boolean skipStoreToCache, int dop, ProgressListener pl) Removes an attribute from all vertices based on the specified VertexOpCallback.
void	removeEdge(com.tinkerpop.blueprints.Edge edge) Remove the provided edge from the graph
void	removeVertex(com.tinkerpop.blueprints.Vertex vertex) Remove the provided vertex from the graph
static byte[]	saltEdge(byte[] ba) Salts an edge ID represented as a byte array
static byte[]	saltVertex(byte[] ba) Salts a vertex ID represented as a byte array
void	setCompression(java.lang.String compress) Set the type of compression used in the property graph tables.
void	setDataBlockEncoding(org.apache.hadoop.hbase.io.encoding.DataBlockEncoding dbe) Set the data block encoding used in the property graph tables.
void	setEdgeBlockCacheSize(int blockCSize) Set the size of the block cache (in bytes) associated to the edge table This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the edge tables.
void	setEdgeInitialNumRegions(int numRegions) Set the initial number of regions defined for the Apache HBase edge tables associated to this property graph.
void	setEdgeSndIndexBlockCacheSize(int blockCSize) Set the size of the block cache (in bytes) associated to the edge secondary table This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the edge tables.
void	setEdgeSndIndexWriteBufferSize(long writebuffer) Set the size of the write buffer associated to the edge secondary index table
void	setEdgeWriteBufferSize(long writebuffer) Set the maximum size of the write buffer associated to the edge table
void	setIndexLuceneWriteBufferSize(long writebuffer) Set the maxium size of the write buffer associated to the Lucene index table
void	setInitialNumRegions(int numRegions) Set the initial number of regions defined for the Apache HBase tables associated to this property graph.
void	setLuceneBlockCacheSize(int blockCSize) Set the size of the block cache (in bytes) associated to the Lucene index table This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the lucene tables.
void	setNumSplitsPerRegion(int iNumSplitsPerRegion) Set the number of splits per region to use when scanning vertices/edges
void	setScanCachingSize(int iScanCachingSize) Set the caching size used in Scan operations
void	setVertexBlockCacheSize(int blockCSize) Set the size of the block cache (in bytes) associated to the vertex table
void	setVertexInitialNumRegions(int numRegions) Set the initial number of regions defined for the Apache HBase Vertex tables associated to this property graph.
void	setVertexSndIndexBlockCacheSize(int blockCSize) Set the size of the block cache (in bytes) associated to the vertex secondary table This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the vertex tables.
void	setVertexSndIndexWriteBufferSize(long writebuffer) Set the maximum size of the write buffer associated to the vertex secondary index table
void	setVertexWriteBufferSize(long writebuffer) Set the maximum size of the write buffer associated to the vertex table
void	setWriteBufferSize(long writebuffer) Set the maximum size of the write buffer associated to the graph tables
void	shutdown() A shutdown function is required to properly close the graph.
java.lang.String	toString() Returns a very succinct String representation of this Graph instance
GraphTraversalSource	traversal() Generate a reusable GraphTraversalSource instance.
<C extends TraversalSource> C	traversal(java.lang.Class<C> traversalSourceClass) Generate a TraversalSource using the specified TraversalSource class.
Transaction	tx() Configure and control the transactions for those graphs that support this feature.
Graph.Variables	variables() A collection of global Graph.Variables associated with the graph.
java.util.Iterator<Vertex>	vertices(java.lang.Object... vertexIds) Get the Vertex objects in this graph with the provided vertex ids or Vertex objects themselves.

Methods inherited from class oracle.pg.common.OraclePropertyGraphBase

addAttributeToAllEdges, addAttributeToAllEdges, addAttributeToAllVertices, addAttributeToAllVertices, close, commitIndices, countEdges, countEdges, countVertices, countVertices, createIndex, createKeyIndex, createKeyIndex, createKeyIndex, dropAllAutoIndices, dropAllIndices, dropAllManualIndices, dropIndex, dropKeyIndex, dropKeyIndex, dropKeyIndex, getAdjacentEdgesFromVertices, getAdjacentEdgesFromVertices, getAutoIndex, getBatchSize, getConfig, getDatatypeClassFromValueObjForTextIndex, getDefaultEdgeOptFlag, getDefaultIndexParameters, getDefaultVertexOptFlag, getEdgeFilterCallback, getEdgePropertyNames, getEdges, getEdges, getEdges, getEdges, getEdges, getEdges, getEdges, getEdges, getEdgesByIds, getEdgesByIds, getEdgesUsingTextSearch, getElementsProperties, getIndex, getIndexedKeys, getIndexParameters, getIndices, getInvalidEdgeIDSet, getInvalidEdgeIDSet, getJustEdgeIdOptFlag, getJustVertexIdOptFlag, getMaxEdgeID, getMaxEdgeID, getMaxVertexID, getMaxVertexID, getMinEdgeID, getMinEdgeID, getMinVertexID, getMinVertexID, getProgressListener, getQueueSize, getShortestPath, getShortestPath, getSimpleDateFormat, getStringForObj, getTextIndexDirectoryPrefix, getVertexFilterCallback, getVertexIDSet, getVertexIDSet, getVertexPropertyNames, getVertices, getVertices, getVertices, getVertices, getVertices, getVertices, getVertices, getVerticesByIds, getVerticesByIds, getVerticesUsingTextSearch, isDisposed, isEdgeAutoIndexEnabled, isEmpty, isShutdown, isTransientPropertyGraphInstance, isVertexAutoIndexEnabled, query, refreshAutoIndices, removeAttributeFromAllEdges, removeAttributeFromAllEdges, removeAttributeFromAllVertices, removeAttributeFromAllVertices, rollback, serializableToStr, setBatchSize, setDefaultEdgeOptFlag, setDefaultIndexParameters, setDefaultVertexOptFlag, setEdgeFilterCallback, setProgressListener, setQueueSize, setSolrJavaBinFormat, setTransientPropertyGraphInstance, setVertexFilterCallback, startTransaction, stopTransaction, strToSerializable, sum, useSolrJavaBinFormat

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addAttributeToAllEdges

public void addAttributeToAllEdges(EdgeOpCallback eoc,
                                   boolean skipStoreToCache,
                                   int dop,
                                   ProgressListener pl)

Adds an attribute to all edges based on the specified EdgeOpCallback.

Specified by:

addAttributeToAllEdges in class OraclePropertyGraphBase

Parameters:

eoc - an EdgeOpCallback object.

skipStoreToCache - if true, the edges instances will not be stored into the cache.

dop - a positive integer defining the number of threads to use when parallel processing the edges.

pl - a ProgressListener object.

addAttributeToAllVertices

public void addAttributeToAllVertices(VertexOpCallback voc,
                                      boolean skipStoreToCache,
                                      int dop,
                                      ProgressListener pl)

Adds an attribute to all vertices based on the specified VertexOpCallback.

Specified by:

addAttributeToAllVertices in class OraclePropertyGraphBase

Parameters:

voc - a VertexOpCallback object.

skipStoreToCache - if true, the vertices instances will not be stored into the cache.

dop - a positive integer defining the number of threads to use when parallel processing the vertices.

pl - a ProgressListener object.

addEdge

public com.tinkerpop.blueprints.Edge addEdge(java.lang.Object id,
                                             com.tinkerpop.blueprints.Vertex outVertex,
                                             com.tinkerpop.blueprints.Vertex inVertex,
                                             java.lang.String label)

This method adds an edge to the graph instance. Note that this is just a logical operation. Note that this is not a thread safe method.

Specified by:

addEdge in interface com.tinkerpop.blueprints.Graph

Specified by:

addEdge in class OraclePropertyGraphBase

Parameters:

id - the id of the vertex

outVertex - has to be of type OracleVertex

inVertex - has to be of type OracleVertex

label - edge label

Returns:

an OracleEdge object.

addEdge

public Edge addEdge(java.lang.Object id,
                    Vertex v,
                    Vertex anotherv,
                    java.lang.String label)

Adds a new Edge

addVertex

public Vertex addVertex(java.lang.Object... keyValues)

Add a Vertex to the graph given an optional series of key/value pairs. These key/values must be provided in an even number where the odd numbered arguments are String property keys and the even numbered arguments are the related property values.

Parameters:

keyValues - The key/value pairs to turn into vertex properties

Returns:

the newly created vertex

addVertex

public com.tinkerpop.blueprints.Vertex addVertex(java.lang.Object id)

This method adds an vertex to the graph instance. Note that this is just a logical operation. Note that this is not a thread safe method.

Specified by:

addVertex in interface com.tinkerpop.blueprints.Graph

Specified by:

addVertex in class OraclePropertyGraphBase

Parameters:

id - the id of the vertex

Returns:

an OracleVertex object.

addVertex

public Vertex addVertex(java.lang.String label)

Add a Vertex to the graph with provided vertex label.

Parameters:

label - the label of the vertex

Returns:

the newly created labeled vertex

Throws:

java.lang.UnsupportedOperationException

clearCache

public void clearCache()

This method clear the Vertex and Edge caches associated to this property graph instance.

Specified by:

clearCache in class OraclePropertyGraphBase

clearRepository

public void clearRepository()
                     throws org.apache.hadoop.hbase.MasterNotRunningException,
                            java.io.IOException

This method removes all vertices and edges from this property graph instance. Additionally, all existing index are removed from this property graph instance. A DDL (truncate) is executed so there is no way to rollback.

Specified by:

clearRepository in class OraclePropertyGraphBase

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

java.io.IOException

clearRepository

public void clearRepository(boolean removeUsingIterators)
                     throws org.apache.hadoop.hbase.MasterNotRunningException,
                            java.io.IOException

This method removes all vertices and edges from this property graph instance. Additionally, all existing index are removed from this property graph instance. A DDL (truncate) is executed so there is no way to rollback.

Parameters:

removeUsingIterators - specifies if the tables should be cleared up by iterating over all the elements instead of doing a table truncate.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

java.io.IOException

commit

public void commit()

Commit changes done to this property graph instace.

compute

public GraphComputer compute()
                      throws java.lang.IllegalArgumentException

Generate a GraphComputer using the default engine of the underlying graph system. This is a shorthand method for the more involved method that uses compute(Class).

Throws:

java.lang.UnsupportedOperationException

java.lang.IllegalArgumentException

compute

public <C extends GraphComputer> C compute(java.lang.Class<C> graphComputerClass)
                                    throws java.lang.IllegalArgumentException

Declare the GraphComputer to use for OLAP operations on the graph. If the graph does not support graph computer then an UnsupportedOperationException is thrown.

Parameters:

graphComputerClass - the graph computer class to use

Throws:

java.lang.IllegalArgumentException - if the provided GraphComputer class is not supported

java.lang.UnsupportedOperationException

concatenate

public static byte[] concatenate(byte[] ba1,
                                 byte[] ba2)

This method returns a byte array that concatenates the two given byte array If one of the argument is null, the return value will be the other argument.

concatenate

public static byte[] concatenate(byte[] ba1,
                                 byte[] ba2,
                                 byte[] ba3)

This method returns a byte array that concatenates the two given byte array If one of the argument is null, the return value will be the other argument.

configuration

public org.apache.commons.configuration.Configuration configuration()

Get the org.apache.commons.configuration.Configuration associated with the construction of this graph.

Throws:

java.lang.UnsupportedOperationException

countEdges

public long countEdges(int dop,
                       ProgressListener pl)

Counts all Edges using parallel scan and the specified DOP.

Specified by:

countEdges in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the edges.

pl - a ProgressListener object.

Returns:

number of edges in the graph

countVertices

public long countVertices(int dop,
                          ProgressListener pl)

Counts all vertices using parallel scans and the specified DOP.

Specified by:

countVertices in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

the number of vertices in the graph

dispose

public void dispose()

Closes the graph without commiting any changes

dropIndexTable

public void dropIndexTable()
                    throws org.apache.hadoop.hbase.MasterNotRunningException,
                           java.io.IOException

This method removes all indices meta data from this property graph instance. A DDL (truncate) is executed so there is no way to rollback.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

java.io.IOException

edges

public java.util.Iterator<Edge> edges(java.lang.Object... edgeIds)

Get the Edge objects in this graph with the provided edge ids or Edge objects. If no ids are provided, get all edges. Note that an edge identifier does not need to correspond to the actual id used in the graph. It needs to be a bit more flexible than that in that given the Graph.Features around id support, multiple arguments might be applicable here. If the graph return true for Graph.Features.ElementFeatures.supportsNumericIds() then it should support filters as with: g.edges(e) g.edges(e.id()) g.edges(1) g.edges(1L) g.edges(1.0d) g.edges(1.0f) g.edges("1") If the graph return true for Graph.Features.ElementFeatures.supportsCustomIds() ()} then it should support filters as with: g.edges(e) g.edges(e.id()) g.edges(e.id().toString()) If the graph return true for Graph.Features.ElementFeatures.supportsAnyIds() ()} then it should support filters as with: g.edges(e) g.edges(e.id()) If the graph return true for Graph.Features.ElementFeatures.supportsStringIds() ()} then it should support filters as with: g.edges(e) g.edges(e.id().toString()) g.edges("id")

Parameters:

edgeIds - the ids of the edges to get

Returns:

an Iterator of edges that match the provided edge ids

features

public Graph.Features features()

Gets the particular features of the graph implementation for Tinkerpop 2.3

flushHbaseCommits

public void flushHbaseCommits()

Flush HBase tables so property graph changes are commited into Apache HBase.

getCompression

public java.lang.String getCompression()

Get the type of compression used in the property graph tables

Returns:

the compression used in the property graph tables

getCompressionAlgorithm

public org.apache.hadoop.hbase.io.compress.Compression.Algorithm getCompressionAlgorithm(java.lang.String compress)

An utility to get a Compression Algorithm based on the specified string

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

This method returns the underlying Configuration instance used for HBase

getDataBlockEncoding

public org.apache.hadoop.hbase.io.encoding.DataBlockEncoding getDataBlockEncoding()

Gets the data block encoding algorithm used in block cache and optionally on disk for all property graph tables

getEdge

public OracleEdge getEdge(java.lang.Object id)

Return the edge referenced by the object identifier.

Specified by:

getEdge in interface com.tinkerpop.blueprints.Graph

Specified by:

getEdge in class OraclePropertyGraphBase

Parameters:

id - the object identifier of the referenced edge

Returns:

an OracleEdge object

getEdgeBlockCacheSize

public int getEdgeBlockCacheSize()

Gets the size of the block cache (in bytes) associated to the edge table

getEdgeInitialNumRegions

public int getEdgeInitialNumRegions()

Get the initial number of regions defined for the Apache HBase Edge tables associated to this property graph. Default value is set to 24 regions.

Returns:

the initial number of regions.

getEdgeInstance

public OracleEdgeBase getEdgeInstance(java.lang.Long eid,
                                      boolean bCreateIfAbsentFromCache,
                                      boolean bSkipStoreToCache)

Returns an instance of OracleEdgeBase. If there is no match in the cache and bCreateIfAbsentFromCache is false, then a NULL value will be returned. If the skipStoreToCache is true, then the vertex will not be stored into the cache.

Specified by:

getEdgeInstance in class OraclePropertyGraphBase

Parameters:

eid - the id of the edge

bCreateIfAbsentFromCache - if false, returns a NULL value if there is no match in the cache.

bSkipStoreToCache - if true, the vertex instance will not be stored into the cache.

Returns:

a OracleEdgeBase object.

getEdgeInstance

public OracleEdgeBase getEdgeInstance(OracleVertexBase outVertex,
                                      OracleVertexBase inVertex,
                                      java.lang.String edgeLabel,
                                      java.lang.Long eid,
                                      boolean bCreateIfAbsentFromCache,
                                      boolean bSkipStoreToCache)

Returns an instance of OracleEdgeBase. If there is no match in the cache and bCreateIfAbsentFromCache is false, then a NULL value will be returned. If the skipStoreToCache is true, then the vertex will not be stored into the cache.

Specified by:

getEdgeInstance in class OraclePropertyGraphBase

Parameters:

eid - the id of the edge

outVertex - the outgoing Vertex of the edge

inVertex - the incoming Vertex of the edge

edgeLabel - the label for the Edge.

bCreateIfAbsentFromCache - if false, returns a NULL value if there is no match in the cache.

bSkipStoreToCache - if true, the vertex instance will not be stored into the cache.

Returns:

a OracleEdgeBase object.

getEdgePropertyNames

public int getEdgePropertyNames(int dop,
                                int timeout,
                                java.util.Set<java.lang.String> propertyNames,
                                ProgressListener pl)

Gets the property names of all edges using parallel scans and the specified DOP.

Specified by:

getEdgePropertyNames in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the edges

timeout - time out in the unit of seconds

propertyNames - a set of property names to be returned

pl - a ProgressListener object.

getEdges

public java.lang.Iterable<com.tinkerpop.blueprints.Edge> getEdges(java.lang.String[] keys,
                                                                  EdgeFilterCallback efc,
                                                                  OraclePropertyGraphBase.OptimizationFlag flag)

Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified.

Specified by:

getEdges in class OraclePropertyGraphBase

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the edge filter callback will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep a edge in the Iterable.

flag - an OptimizationFlag object specifying if a partial or complete edge object will be returned. It can be NULL which implies the edges created must be complete.

getEdges

public java.lang.Iterable<com.tinkerpop.blueprints.Edge> getEdges(java.lang.String[] keys,
                                                                  EdgeFilterCallback efc,
                                                                  OraclePropertyGraphBase.OptimizationFlag flag,
                                                                  int dop)

Return an Iterable to all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the edge filter callback will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep a edge in the Iterable.

flag - an OptimizationFlag object specifying if a partial or complete edge object will be returned. It can be NULL which implies the edges created must be complete.

getEdges

public java.lang.Iterable<com.tinkerpop.blueprints.Edge> getEdges(java.lang.String key,
                                                                  java.lang.Object value,
                                                                  java.lang.Class dtClass,
                                                                  boolean acceptWildcard,
                                                                  boolean preferredLuceneQuery)

Return an iterable to all matching edges that have a particular key/value property. When an automatic text index on the given key is absent, a full table scan will be carried out to find matching edges.

Specified by:

getEdges in class OraclePropertyGraphBase

Parameters:

key - the name of the property. It MUST not be NULL.

value - the value of the property. It can be NULL which will cause all vertices with the given key to be returned.

dtClass - the data type of the value object.

acceptWildcard - specifies if wild cards can be used in the value object. Wild cards can be used only when an automatic text index on the given key is present.

preferredLuceneQuery - if true, a look up to the automatic index will be executed to find the matches.

getEdgesFromKey

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesFromKey(org.apache.hadoop.hbase.client.HConnection[] conns,
                                                                           boolean skipStoreToCache,
                                                                           int startSplitID,
                                                                           java.lang.String[] keys)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback by executing a lookup over the secondary index table. The information read back from the edges will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

conns - an array of connections to Apache HBase.

skipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all edges in the graph satisfying the edge filter callback will be returned.

Returns:

an Iterable array object.

getEdgeSndIndexBlockCacheSize

public int getEdgeSndIndexBlockCacheSize()

Gets the size of the block cache (in bytes) associated to the secondary index edge table

getEdgeSndIndexTabName

public java.lang.String getEdgeSndIndexTabName()

Get the name of the Apache HBase table used to store secondary indexes on edges in this property graph.

Returns:

the edge secondary index table name.

getEdgeSndIndexWriteBufferSize

public long getEdgeSndIndexWriteBufferSize()

Set the write buffer size associated to the edge secondary index table

Returns:

the size of the write buffer used in the edge secondary index table

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID)

Gets an array of Iterable objects that hold all the edges in the graph. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               boolean bClonedGraph)

Gets an array of Iterable objects that hold all the edges in the graph. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

bClonedGraph - if true, each Iterable in the array will use a new OraclePropertyGraph instance behind the scenes. If there are writing operations done over the retrieved edges, the associated property graphs need to be commited for the changes to be persisted into Apache HBase.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               EdgeFilterCallback efc)

Gets an array of Iterable objects that hold all the edges in the graph that satisfy the specified edge filter callback. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               EdgeFilterCallback efc,
                                                                               OraclePropertyGraphBase.OptimizationFlag flag)

Gets an array of Iterable objects that hold all the edges in the graph that satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

flag - an OptimizationFlag object specifying if a partial or complete edge object will be returned. It can be NULL which implies the edges created must be complete.

startSplitID - the ID of the starting split.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               OraclePropertyGraphBase.OptimizationFlag flag)

Gets an array of Iterable objects that hold all the edges in the graph. The information read back from the edges will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

flag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the edges created must be complete.

startSplitID - the ID of the starting split.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               java.lang.String key)

Gets an array of Iterable objects that hold all the edges in the graph that have a particular key. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

key - name of the property. It can be NULL which implies all edges in the graph will be returned.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               java.lang.String[] keys)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all edges in the graph will be returned.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               java.lang.String[] keys,
                                                                               boolean bClonedGraph,
                                                                               EdgeFilterCallback efc)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

keys - an array of property key names. It can be NULL which implies all edges in the graph satisfying the edge filter callback will be returned.

bClonedGraph - if true, each Iterable in the array will use a new OraclePropertyGraph instance behind the scenes. If there are writing operations done over the retrieved edges, the associated property graphs need to be commited for the changes to be persisted into Apache HBase.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               java.lang.String[] keys,
                                                                               boolean bClonedGraph,
                                                                               EdgeFilterCallback efc,
                                                                               OraclePropertyGraphBase.OptimizationFlag flag)

Gets an array of Iterable objects that hold all the edges in the graph that have any of the specified keys and satisfy the specified edge filter callback. The information read back from the edges will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

flag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the edges created must be complete.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all edges in the graph satisfying the edge filter callback will be returned.

efc - a EdgeFilterCallback object specifying the conditions to keep an edge in the Iterable.

bClonedGraph - if true, each Iterable in the array will use a new OraclePropertyGraph instance behind the scenes. If there are writing operations done over the retrieved edges, the associated property graphs need to be commited for the changes to be persisted into Apache HBase.

Returns:

an Iterable array object.

getEdgesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Edge>[] getEdgesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                               boolean bSkipStoreToCache,
                                                                               int startSplitID,
                                                                               java.lang.String key,
                                                                               boolean bClonedGraph)

Gets an array of Iterable objects that hold all the edges in the graph that have a particular key. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the edges instances will not be stored into the cache.

startSplitID - the ID of the starting split.

key - name of the property. It can be NULL which implies all edges in the graph will be returned.

bClonedGraph - if true, each Iterable in the array will use a new OraclePropertyGraph instance behind the scenes. If there are writing operations done over the retrieved edges, the associated property graphs need to be commited for the changes to be persisted into Apache HBase.

Returns:

an Iterable array object.

getEdgeTableRegionsInfo

public java.util.Set<org.apache.hadoop.hbase.HRegionInfo> getEdgeTableRegionsInfo()
                                                                           throws java.io.IOException

Gets the information of all HBase regions of the edge table

Returns:

a Set<HRegionInfo> with all information of this edge table regions.

Throws:

java.io.IOException

getEdgeTableSplits

public int getEdgeTableSplits()
                       throws java.io.IOException

Get the number of Edge table splits based on the current number of splits per region associated to this graph and the number of regions in the edge table.

Returns:

the number of splits in the edge table

Throws:

java.io.IOException

getEdgeTabName

public java.lang.String getEdgeTabName()

Get the name of the Apache HBase table used to store edges in this property graph.

Returns:

the edge table name.

getEdgeWriteBufferSize

public long getEdgeWriteBufferSize()

Set the write buffer size associated to the edge table

Returns:

the size of the write buffer used in the edge table

getElementsProperties

public java.lang.Iterable<java.util.Map.Entry<java.lang.Object,java.lang.Object>> getElementsProperties(java.lang.Object[] ids,
                                                                                                        java.lang.String propertyName,
                                                                                                        int dop,
                                                                                                        java.lang.Class<? extends com.tinkerpop.blueprints.Element> elementClass)

Specified by:

getElementsProperties in class OraclePropertyGraphBase

getFeatures

public com.tinkerpop.blueprints.Features getFeatures()

Gets the particular features of the graph implementation for Tinkerpop 3

getGraphName

public java.lang.String getGraphName()

This method returns the name of this property graph instance

Overrides:

getGraphName in class OraclePropertyGraphBase

getHbaseConfiguration

public static org.apache.hadoop.conf.Configuration getHbaseConfiguration(oracle.pgx.config.PgHbaseGraphConfig config)

Gets a HBase configuration from a PgHbaseGraphConfig object

Parameters:

config - the PGX PgHbaseGraphConfig object

Returns:

the Configuration object

getHConnection

public org.apache.hadoop.hbase.client.HConnection getHConnection()

Gets the underlying connection for this property graph

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName,
                                              int initialNumRegions)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

initialNumRegions - the initial number of regions used for vertex/edge tables. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName,
                                              int initialNumRegions,
                                              int splitsPerRegion)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

initialNumRegions - the initial number of regions used for vertex/edge tables. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

splitsPerRegion - a positive integer specifying the number of splits per region to use when scanning vertices/edges.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName,
                                              int initialNumRegions,
                                              int splitsPerRegion,
                                              int blockCacheSize)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

initialNumRegions - the initial number of regions used for vertex/edge tables. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

splitsPerRegion - a positive integer specifying the number of splits per region to use when scanning vertices/edges.

blockCacheSize - the size of the block cache (in bytes) used for vertex/edge tables. Blocksize to use when writing out storefiles/hfiles on these tables.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName,
                                              java.lang.String compress,
                                              org.apache.hadoop.hbase.io.encoding.DataBlockEncoding dbe,
                                              int splitsPerRegion,
                                              int blockCacheSize,
                                              int initialVertexNumRegions,
                                              int initialEdgeNumRegions)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

compress - the compression used in the property graph tables. Default value is set to "SNAPPY"

dbe - the data block encoding used in the property graph tables

splitsPerRegion - a positive integer specifying the number of splits per region to use when scanning vertices/edges.

blockCacheSize - the size of the block cache (in bytes) used for vertex/edge tables. Blocksize to use when writing out storefiles/hfiles on these tables.

initialVertexNumRegions - the initial number of regions used for vertex table. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

initialEdgeNumRegions - the initial number of regions used for edge table. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName,
                                              java.lang.String compress,
                                              int initialNumRegions)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

compress - the compression used in the property graph tables. Default value is set to "SNAPPY"

initialNumRegions - the initial number of regions used for vertex/edge tables. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName,
                                              java.lang.String compress,
                                              int initialNumRegions,
                                              int splitsPerRegion)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

compress - the compression used in the property graph tables. Default value is set to "SNAPPY"

initialNumRegions - the initial number of regions used for vertex/edge tables. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

splitsPerRegion - a positive integer specifying the number of splits per region to use when scanning vertices/edges.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName,
                                              java.lang.String compress,
                                              int initialNumRegions,
                                              int splitsPerRegion,
                                              int blockCacheSize)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

compress - the compression used in the property graph tables. Default value is set to "SNAPPY"

initialNumRegions - the initial number of regions used for vertex/edge tables. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

splitsPerRegion - a positive integer specifying the number of splits per region to use when scanning vertices/edges.

blockCacheSize - the size of the block cache (in bytes) used for vertex/edge tables. Blocksize to use when writing out storefiles/hfiles on these tables.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(org.apache.hadoop.conf.Configuration conf,
                                              org.apache.hadoop.hbase.client.HConnection hconn,
                                              java.lang.String szGraphName,
                                              java.lang.String compress,
                                              int splitsPerRegion,
                                              int blockCacheSize,
                                              int initialVertexNumRegions,
                                              int initialEdgeNumRegions)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

compress - the compression used in the property graph tables. Default value is set to "SNAPPY"

splitsPerRegion - a positive integer specifying the number of splits per region to use when scanning vertices/edges.

blockCacheSize - the size of the block cache (in bytes) used for vertex/edge tables. Blocksize to use when writing out storefiles/hfiles on these tables.

initialVertexNumRegions - the initial number of regions used for vertex table. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

initialEdgeNumRegions - the initial number of regions used for edge table. Both vertex and edge tables will be created using the specified number of regions. If the graph already exists, a clearRepository operation must be executed in order to truncate the tables and set the new number of regions.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(oracle.pgx.config.PgHbaseGraphConfig config)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using a PGX PgHbaseGraphConfig object.

Parameters:

config - a PgHbaseGraphConfig object.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstance

public static OraclePropertyGraph getInstance(oracle.pgx.config.PgHbaseGraphConfig config,
                                              long maxRowSize)
                                       throws org.apache.hadoop.hbase.MasterNotRunningException,
                                              org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                              java.io.IOException

Returns an instance of OraclePropertyGraph using a PGX PgHbaseGraphConfig object.

Parameters:

config - a PgHbaseGraphConfig object.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInstanceWithSplits

public static OraclePropertyGraph getInstanceWithSplits(org.apache.hadoop.conf.Configuration conf,
                                                        org.apache.hadoop.hbase.client.HConnection hconn,
                                                        java.lang.String szGraphName,
                                                        int splitsPerRegion)
                                                 throws org.apache.hadoop.hbase.MasterNotRunningException,
                                                        org.apache.hadoop.hbase.ZooKeeperConnectionException,
                                                        java.io.IOException

Returns an instance of OraclePropertyGraph using the Apache HBase connection and graph name provided and the specified number of splits per region.

Parameters:

conf - the Configuration object with all the Apache HBase connection information.

hconn - an HConnection object handling a connection to HBase.

szGraphName - the name of the graph

splitsPerRegion - a positive integer specifying the number of splits per region to use when scanning vertices/edges.

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

java.io.IOException

getInvalidEdgeIDSet

public java.util.Set<java.lang.Long> getInvalidEdgeIDSet(int dop,
                                                         ProgressListener pl)

Gets a set of invalid edges that are stored in the property graph. An invalid edge is an edge whose IN or OUT vertex does not exist in the property graph

Specified by:

getInvalidEdgeIDSet in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the edges and the vertices tables.

pl - a ProgressListener object.

getLuceneBlockCacheSize

public int getLuceneBlockCacheSize()

Gets the size of the block cache (in bytes) associated to the Lucene index table

getLuceneTabName

public java.lang.String getLuceneTabName()

Get the name of the Apache HBase table used to store index metadata in this property graph.

Returns:

the index table name.

getLuceneWriteBufferSize

public long getLuceneWriteBufferSize()

Set the write buffer size associated to the Lucene index table

Returns:

the size of the write buffer used in the index table

getMaxEdgeID

public long getMaxEdgeID(int dop,
                         ProgressListener pl)

Get the maximum edge ID using parallel scan and the specified DOP.

Specified by:

getMaxEdgeID in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

maximum edge ID in the graph

getMaxVertexID

public long getMaxVertexID(int dop,
                           ProgressListener pl)

Get maximum vertex ID using parallel scans and the specified DOP.

Specified by:

getMaxVertexID in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

maximum vertex ID in the graph

getMinEdgeID

public long getMinEdgeID(int dop,
                         ProgressListener pl)

Get the minimum edge ID using parallel scan with dop threads

Specified by:

getMinEdgeID in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

minimum edge ID in the graph

getMinVertexID

public long getMinVertexID(int dop,
                           ProgressListener pl)

Get minimum vertex ID using parallel scans and the specified DOP.

Specified by:

getMinVertexID in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices.

pl - a ProgressListener object.

Returns:

minimum vertex ID in the graph

getNumSplitsPerRegion

public int getNumSplitsPerRegion()

Get the number of splits per region to use when scanning vertices/edges

Returns:

the number of splits per region

getOperationQueueSize

public long getOperationQueueSize()

Get the size of the operation queue

getOracleIndexManager

public HBaseIndexManager getOracleIndexManager()

Gets the OracleIndexManager object associated to this property graph instance.

Specified by:

getOracleIndexManager in class OraclePropertyGraphBase

Returns:

a HBaseIndexManager object.

getSaltSize

public static int getSaltSize()

Gets the salt size

Returns:

the salt size

getScanCachingSize

public int getScanCachingSize()

Get the caching size used in Scan operations

Returns:

the cache size used in Scan operations.

getSecondaryIndexNumBuckets

public int getSecondaryIndexNumBuckets()

Return the number of buckets used to store secondary index data into the vertex/edge secondary index tables

Returns:

the number of buckets used to store secondary index data

getVertex

public OracleVertex getVertex(java.lang.Object id)

Return the vertex referenced by the object identifier.

Specified by:

getVertex in interface com.tinkerpop.blueprints.Graph

Specified by:

getVertex in class OraclePropertyGraphBase

Parameters:

id - the object identifier of the referenced vertex

Returns:

an Vertex object

getVertexBlockCacheSize

public int getVertexBlockCacheSize()

Gets the size of the block cache (in bytes) associated to the vertex table

getVertexIDSet

public java.util.Set<java.lang.Long> getVertexIDSet(int dop,
                                                    ProgressListener pl)

Gets a set of Vertex IDs that are stored in the property graph

Specified by:

getVertexIDSet in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices table.

pl - a ProgressListener object.

getVertexInitialNumRegions

public int getVertexInitialNumRegions()

Get the initial number of regions defined for the Apache HBase Vertex tables associated to this property graph. Default value is set to 24 regions.

Returns:

the initial number of regions.

getVertexInstance

public OracleVertexBase getVertexInstance(java.lang.Long vid,
                                          boolean bCreateIfAbsentFromCache,
                                          boolean bSkipStoreToCache)

Returns an instance of OracleVertexBase. If there is no match in the cache and bCreateIfAbsentFromCache is false, then a NULL value will be returned. If the skipStoreToCache is true, then the vertex will not be stored into the cache.

Specified by:

getVertexInstance in class OraclePropertyGraphBase

Parameters:

vid - the id of the vertex

bCreateIfAbsentFromCache - if false, returns a NULL value if there is no match in the cache.

bSkipStoreToCache - if true, the vertex instance will not be stored into the cache.

Returns:

a OracleVertexBase object.

getVertexPropertyNames

public int getVertexPropertyNames(int dop,
                                  int timeout,
                                  java.util.Set<java.lang.String> propertyNames,
                                  ProgressListener pl)

Gets the property names of all vertices using parallel scans and the specified DOP.

Specified by:

getVertexPropertyNames in class OraclePropertyGraphBase

Parameters:

dop - a positive integer defining the number of threads to use when parallel scanning the vertices

timeout - time out in the unit of seconds

propertyNames - a set of property names to be returned

pl - a ProgressListener object.

getVertexSndIndexBlockCacheSize

public int getVertexSndIndexBlockCacheSize()

Gets the size of the block cache (in bytes) associated to the secondary index vertex table

getVertexSndIndexTabName

public java.lang.String getVertexSndIndexTabName()

Get the name of the Apache HBase table used to store secondary indexes on vertices in this property graph.

Returns:

the vertex table name.

getVertexSndIndexWriteBufferSize

public long getVertexSndIndexWriteBufferSize()

Get the write buffer size associated to the vertex secondary index table

Returns:

the size of the write buffer used in the vertex secondary index table

getVertexTableRegionsInfo

public java.util.Set<org.apache.hadoop.hbase.HRegionInfo> getVertexTableRegionsInfo()
                                                                             throws java.io.IOException

Gets the information of all HBase regions of the vertex table

Returns:

a Set<HRegionInfo> with all information of this vertex table regions.

Throws:

java.io.IOException

getVertexTableSplits

public int getVertexTableSplits()
                         throws java.io.IOException

Get the number of Vertex table splits based on the current number of splits per region associated to this graph and the number of regions in the vertex table.

Returns:

the number of splits in the vertex table

Throws:

java.io.IOException

getVertexTabName

public java.lang.String getVertexTabName()

Get the name of the Apache HBase table used to store vertices in this property graph.

Returns:

the vertex table name.

getVertexWriteBufferSize

public long getVertexWriteBufferSize()

Get the write buffer size associated to the vertex table

Returns:

the size of the write buffer used in the vertex table

getVertices

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex> getVertices()

Return an iterable to all the vertices in the graph.

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

Overrides:

getVertices in class OraclePropertyGraphBase

getVertices

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex> getVertices(java.lang.String[] keys,
                                                                       VertexFilterCallback vfc,
                                                                       OraclePropertyGraphBase.OptimizationFlag flag)

Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified.

Specified by:

getVertices in class OraclePropertyGraphBase

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep a vertex in the Iterable.

flag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

getVertices

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex> getVertices(java.lang.String[] keys,
                                                                       VertexFilterCallback vfc,
                                                                       OraclePropertyGraphBase.OptimizationFlag flag,
                                                                       int dop)

Return an Iterable to all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified.

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep a vertex in the Iterable.

flag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

getVertices

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex> getVertices(java.lang.String key,
                                                                       java.lang.Object value,
                                                                       java.lang.Class dtClass,
                                                                       boolean acceptWildcard,
                                                                       boolean preferredLuceneQuery)

Return an iterable to all matching vertices that have a particular key/value property. When an automatic text index on the given key is absent, a full table scan will be carried out to find matching vertices.

Specified by:

getVertices in class OraclePropertyGraphBase

Parameters:

key - the name of the property. It MUST not be NULL.

value - the value of the property. It can be NULL which will cause all vertices with the given key to be returned.

dtClass - the datatype of the value object

acceptWildcard - specifies if wild cards can be used in the value object. Wild cards can be used only when an automatic text index on the given key is present.

preferredLuceneQuery - if true, a look up to the automatic index will be executed to find the matches.

getVerticesFromKey

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesFromKey(org.apache.hadoop.hbase.client.HConnection[] conns,
                                                                                boolean skipStoreToCache,
                                                                                int startSplitID,
                                                                                java.lang.String[] keys)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback by executing a lookup over the secondary index table. The information read back from the vertices will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

conns - an array of connections to Apache HBase.

skipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

Returns:

an Iterable array object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID)

Gets an array of Iterable objects that hold all the vertices in the graph. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

Returns:

a Iterable object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID,
                                                                                    boolean bClonedGraph)

Gets an array of Iterable objects that hold all the vertices in the graph. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

bClonedGraph - if true, each Iterable in the array will use a new OraclePropertyGraph instance behind the scenes. If there are writing operations done over the retrieved vertices, the associated property graphs need to be commited for the changes to be persisted into Apache HBase.

Returns:

an Iterable array object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID,
                                                                                    OraclePropertyGraphBase.OptimizationFlag flag)

Gets an array of Iterable objects that hold all the vertices in the graph. The information read back from the vertices will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

flag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

startSplitID - the ID of the starting split.

Returns:

an Iterable array object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID,
                                                                                    java.lang.String key)

Gets an array of Iterable objects that hold all the vertices in the graph that have a particular key. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

key - name of the property. It can be NULL which implies all vertices in the graph will be returned.

Returns:

an Iterable array object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID,
                                                                                    java.lang.String[] keys)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

Returns:

an Iterable array object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID,
                                                                                    java.lang.String[] keys,
                                                                                    boolean bCloneGraph,
                                                                                    VertexFilterCallback vfc)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

vfc - a VertexFilterCallback object specifying the conditions to keep an vertex in the Iterable.

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

bCloneGraph - if true, each Iterable in the array will use a new OraclePropertyGraph instance behind the scenes. If there are writing operations done over the retrieved vertices, the associated property graphs need to be commited for the changes to be persisted into Apache HBase.

Returns:

an Iterable array object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID,
                                                                                    java.lang.String[] keys,
                                                                                    boolean bCloneGraph,
                                                                                    VertexFilterCallback vfc,
                                                                                    OraclePropertyGraphBase.OptimizationFlag flag)

Gets an array of Iterable objects that hold all the vertices in the graph that have any of the specified keys and satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

flag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

startSplitID - the ID of the starting split.

keys - an array of property key names. It can be NULL which implies all vertices in the graph satisfying the vertex filter callback will be returned.

vfc - a VertexFilterCallback object specifying the conditions to keep an vertex in the Iterable.

bCloneGraph - if true, each Iterable in the array will use a new OraclePropertyGraph instance behind the scenes. If there are writing operations done over the retrieved vertices, the associated property graphs need to be commited for the changes to be persisted into Apache HBase.

Returns:

an Iterable array object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID,
                                                                                    java.lang.String key,
                                                                                    boolean bCloneGraph)

Gets an array of Iterable objects that hold all the vertices in the graph that have a particular key. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

startSplitID - the ID of the starting split.

key - name of the property. It can be NULL which implies all vertices in the graph will be returned.

bCloneGraph - if true, each Iterable in the array will use a new OraclePropertyGraph instance behind the scenes. If there are writing operations done over the retrieved vertices, the associated property graphs need to be commited for the changes to be persisted into Apache HBase.

Returns:

an Iterable array object.

getVerticesPartitioned

public java.lang.Iterable<com.tinkerpop.blueprints.Vertex>[] getVerticesPartitioned(org.apache.hadoop.hbase.client.HConnection[] connections,
                                                                                    boolean bSkipStoreToCache,
                                                                                    int startSplitID,
                                                                                    VertexFilterCallback vfc,
                                                                                    OraclePropertyGraphBase.OptimizationFlag flag)

Gets an array of Iterable objects that hold all the vertices in the graph that satisfy the specified vertex filter callback. The information read back from the vertices will be complete or partial based on the optimization flag specified. Each element in the Iterable array uses a separate connection provided to fetch a subset of the results from the corresponding split. The splits are determined by # of regions & num of splits per region for the table. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits in the vertex table with N splits. The subset of splits queried will consist of those splits with ID value in the range of [startSplitID, startSplit - 1 + size of connections array].

Parameters:

connections - an array of connections to Apache HBase.

bSkipStoreToCache - if true, the vertices instances will not be stored into the cache.

flag - an OptimizationFlag object specifying if a partial or complete vertex object will be returned. It can be NULL which implies the vertices created must be complete.

startSplitID - the ID of the starting split.

vfc - a VertexFilterCallback object specifying the conditions to keep an vertex in the Iterable.

Returns:

an Iterable array object.

getWriteBufferSize

public long getWriteBufferSize()

Get the write buffer size associated to the vertex table

Returns:

the size of the write buffer used in the vertex table

io

public <I extends Io> I io(Io.Builder<I> builder)

Construct a particular Io implementation for reading and writing the Graph and other data. End-users will "select" the Io implementation that they want to use by supplying the Io.Builder that constructs it. In this way, Graph vendors can supply their IoRegistry to that builder thus allowing for custom serializers to be auto-configured into the Io instance. Registering custom serializers is particularly useful for those graphs that have complex types for Element identifiers. For those graphs that do not need to register any custom serializers, the default implementation should suffice. If the default is overridden, take care to register the current graph via the Io.Builder.graph(Graph) method.

prepareSecureConfig

public static org.apache.hadoop.conf.Configuration prepareSecureConfig(org.apache.hadoop.conf.Configuration config,
                                                                       java.lang.String hbaseSecAuth,
                                                                       java.lang.String hadoopSecAuth,
                                                                       java.lang.String hmKerberosPrincipal,
                                                                       java.lang.String rsKerberosPrincipal,
                                                                       java.lang.String userPrincipal,
                                                                       java.lang.String keytab)

Prepares the Apache HBase configuration object to work with HBase secure cluster

Parameters:

config - the Apache HBase configuration object

hbaseSecAuth - the hbase authentication kerberos/simple

hadoopSecAuth - the hadoop authentication kerberos/simple

hmKerberosPrincipal - The kerberos principal name that should be used to run the HMaster process. The principal name should be in the form: user/hostname@DOMAIN. If "_HOST" is used as the hostname portion, it will be replaced with the actual hostname of the running instance.

rsKerberosPrincipal - Ex. "hbase/_HOST@EXAMPLE.COM".The kerberos principal name that should be used to run the HRegionServer process. The principal name should be in the form: user/hostname@DOMAIN. If _HOST is used as the hostname portion, it will be replaced with the actual hostname of the running instance.

userPrincipal - the user to login

keytab - the keytab containing the password of the login

Returns:

a Configuration Configuration object.

quietlyClose

public static void quietlyClose(org.apache.hadoop.hbase.client.HTable htable)

Quietly close the specified HTable object.

Parameters:

htable - the HTable object to close.

quietlyClose

public static void quietlyClose(org.apache.hadoop.hbase.client.HTableInterface htable)

Quietly close the specified HTableInterface object.

Parameters:

htable - the HTableInterface object to close.

rebuildEdgeSecondaryIndexTable

public void rebuildEdgeSecondaryIndexTable()

Rebuilds the secondary index on edges. This operations forces a commit of all the changes done to the property graph before execution. This operation truncates the previous contents of the exiting index.

rebuildEdgeSecondaryIndexTable

public void rebuildEdgeSecondaryIndexTable(int dop)

Rebuilds the secondary index on edges. This operations forces a commit of all the changes done to the property graph before execution. This operation truncates the previous contents of the exiting index.

rebuildVertexSecondaryIndexTable

public void rebuildVertexSecondaryIndexTable()

Rebuilds the secondary index on vertices. This operations forces a commit of all the changes done to the property graph before execution. This operation truncates the previous contents of the exiting index.

rebuildVertexSecondaryIndexTable

public void rebuildVertexSecondaryIndexTable(int dop)

Rebuilds the secondary index on edges. This operations forces a commit of all the changes done to the property graph before execution. This operation truncates the previous contents of the exiting index.

removeAttributeFromAllEdges

public void removeAttributeFromAllEdges(EdgeOpCallback eoc,
                                        boolean skipStoreToCache,
                                        int dop,
                                        ProgressListener pl)

Removes an attribute from all edges based on the specified EdgeOpCallback.

Specified by:

removeAttributeFromAllEdges in class OraclePropertyGraphBase

Parameters:

eoc - a EdgeOpCallback object.

skipStoreToCache - if true, the edges instances will not be stored into the cache.

dop - a positive integer defining the number of threads to use when parallel processing the edges.

pl - a ProgressListener object.

removeAttributeFromAllVertices

public void removeAttributeFromAllVertices(VertexOpCallback voc,
                                           boolean skipStoreToCache,
                                           int dop,
                                           ProgressListener pl)

Removes an attribute from all vertices based on the specified VertexOpCallback.

Specified by:

removeAttributeFromAllVertices in class OraclePropertyGraphBase

Parameters:

voc - a VertexOpCallback object.

skipStoreToCache - if true, the vertices instances will not be stored into the cache.

dop - a positive integer defining the number of threads to use when parallel processing the vertices.

pl - a ProgressListener object.

removeEdge

public void removeEdge(com.tinkerpop.blueprints.Edge edge)

Remove the provided edge from the graph

Specified by:

removeEdge in interface com.tinkerpop.blueprints.Graph

Specified by:

removeEdge in class OraclePropertyGraphBase

Parameters:

edge - an Edge object to be removed

removeVertex

public void removeVertex(com.tinkerpop.blueprints.Vertex vertex)

Remove the provided vertex from the graph

Parameters:

vertex - a Vertex object to be removed

saltEdge

public static byte[] saltEdge(byte[] ba)

Salts an edge ID represented as a byte array

Parameters:

ba - the edge ID represented as a byte array

Returns:

a salted byte array

saltVertex

public static byte[] saltVertex(byte[] ba)

Salts a vertex ID represented as a byte array

Parameters:

ba - the vertex ID represented as a byte array

Returns:

a salted byte array

setCompression

public void setCompression(java.lang.String compress)

Set the type of compression used in the property graph tables. This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the vertex/edge tables.

Parameters:

compress - the compression used in the property graph tables

setDataBlockEncoding

public void setDataBlockEncoding(org.apache.hadoop.hbase.io.encoding.DataBlockEncoding dbe)

Set the data block encoding used in the property graph tables. This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the vertex/edge tables.

Parameters:

dbe - the data block encoding used in the property graph tables

setEdgeBlockCacheSize

public void setEdgeBlockCacheSize(int blockCSize)

Set the size of the block cache (in bytes) associated to the edge table This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the edge tables.

Parameters:

blockCSize - a positive integer representing the size of the block cache (in bytes) used in the vertex table. Default value set to 131072 bytes.

setEdgeInitialNumRegions

public void setEdgeInitialNumRegions(int numRegions)

Set the initial number of regions defined for the Apache HBase edge tables associated to this property graph. Number of regions should be greater than 2. This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the edge tables.

Parameters:

numRegions - a positive integer with the initial number of regions for edge table. Default value set to 4

setEdgeSndIndexBlockCacheSize

public void setEdgeSndIndexBlockCacheSize(int blockCSize)

Set the size of the block cache (in bytes) associated to the edge secondary table This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the edge tables.

Parameters:

blockCSize - a positive integer representing the size of the block cache (in bytes) used in the vertex table. Default value set to 131072 bytes.

setEdgeSndIndexWriteBufferSize

public void setEdgeSndIndexWriteBufferSize(long writebuffer)

Set the size of the write buffer associated to the edge secondary index table

Parameters:

writebuffer - the size of the write buffer used in the edge secondary index table

setEdgeWriteBufferSize

public void setEdgeWriteBufferSize(long writebuffer)

Set the maximum size of the write buffer associated to the edge table

Parameters:

writebuffer - the maximum size of the write buffer used in the edge table

setIndexLuceneWriteBufferSize

public void setIndexLuceneWriteBufferSize(long writebuffer)

Set the maxium size of the write buffer associated to the Lucene index table

Parameters:

writebuffer - the maximum size of the write buffer used in the index table

setInitialNumRegions

public void setInitialNumRegions(int numRegions)

Set the initial number of regions defined for the Apache HBase tables associated to this property graph. Number of regions should be greater than 1. This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the vertex/edge tables.

Parameters:

numRegions - the initial number of regions.

setLuceneBlockCacheSize

public void setLuceneBlockCacheSize(int blockCSize)

Set the size of the block cache (in bytes) associated to the Lucene index table This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the lucene tables.

Parameters:

blockCSize - a positive integer representing the size of the block cache (in bytes) used in the vertex table. Default value set to 131072 bytes.

setNumSplitsPerRegion

public void setNumSplitsPerRegion(int iNumSplitsPerRegion)

Set the number of splits per region to use when scanning vertices/edges

Parameters:

iNumSplitsPerRegion - a positive integer specifying the number of splits per region to use when scanning vertices/edges. Default value set to 1.

setScanCachingSize

public void setScanCachingSize(int iScanCachingSize)

Set the caching size used in Scan operations

Parameters:

iScanCachingSize - the cache size to use.

setVertexBlockCacheSize

public void setVertexBlockCacheSize(int blockCSize)

Set the size of the block cache (in bytes) associated to the vertex table

Parameters:

blockCSize - a positive integer representing the size of the block cache (in bytes) used in the vertex table. This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the vertex tables. Default value set to 131072 bytes.

setVertexInitialNumRegions

public void setVertexInitialNumRegions(int numRegions)

Set the initial number of regions defined for the Apache HBase Vertex tables associated to this property graph. Number of regions should be greater than 2. This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the vertex tables.

Parameters:

numRegions - a positive integer with the initial number of regions for vertex table. Default value set to 4

setVertexSndIndexBlockCacheSize

public void setVertexSndIndexBlockCacheSize(int blockCSize)

Set the size of the block cache (in bytes) associated to the vertex secondary table This is a meta data operation, so changes to this setting will show after clearing the repository and recreating the vertex tables.

Parameters:

blockCSize - a positive integer representing the size of the block cache (in bytes) used in the vertex table. Default value set to 131072 bytes.

setVertexSndIndexWriteBufferSize

public void setVertexSndIndexWriteBufferSize(long writebuffer)

Set the maximum size of the write buffer associated to the vertex secondary index table

Parameters:

writebuffer - the maximum size of the write buffer used in the vertex secondary index table

setVertexWriteBufferSize

public void setVertexWriteBufferSize(long writebuffer)

Set the maximum size of the write buffer associated to the vertex table

Parameters:

writebuffer - the maximum size of the write buffer used in the vertex table

setWriteBufferSize

public void setWriteBufferSize(long writebuffer)

Set the maximum size of the write buffer associated to the graph tables

Parameters:

writebuffer - the maximum size of the write buffer used in the vertex table

shutdown

public void shutdown()

A shutdown function is required to properly close the graph.

toString

public java.lang.String toString()

Returns a very succinct String representation of this Graph instance

Overrides:

toString in class java.lang.Object

traversal

public GraphTraversalSource traversal()

Generate a reusable GraphTraversalSource instance. The GraphTraversalSource provides methods for creating GraphTraversal instances.

Returns:

a graph traversal source

traversal

public <C extends TraversalSource> C traversal(java.lang.Class<C> traversalSourceClass)

Generate a TraversalSource using the specified TraversalSource class. The reusable TraversalSource provides methods for spawning Traversal instances.

Parameters:

traversalSourceClass - the traversal source class

tx

public Transaction tx()

Configure and control the transactions for those graphs that support this feature. Note that this method does not indicate the creation of a "transaction" object. A Transaction in the TinkerPop context is a transaction "factory" or "controller" that helps manage transactions owned by the underlying graph database.

variables

public Graph.Variables variables()

A collection of global Graph.Variables associated with the graph. Variables are used for storing metadata about the graph.

vertices

public java.util.Iterator<Vertex> vertices(java.lang.Object... vertexIds)

Get the Vertex objects in this graph with the provided vertex ids or Vertex objects themselves. If no ids are provided, get all vertices. Note that a vertex identifier does not need to correspond to the actual id used in the graph. It needs to be a bit more flexible than that in that given the Graph.Features around id support, multiple arguments might be applicable here. If the graph return true for Graph.Features.ElementFeatures.supportsNumericIds() then it should support filters as with: g.vertices(v) g.vertices(v.id()) g.vertices(1) g.vertices(1L) g.vertices(1.0d) g.vertices(1.0f) g.vertices("1") If the graph return true for Graph.Features.ElementFeatures.supportsCustomIds() ()} then it should support filters as with: g.vertices(v) g.vertices(v.id()) g.vertices(v.id().toString()) If the graph return true for Graph.Features.ElementFeatures.supportsAnyIds() ()} then it should support filters as with: g.vertices(v) g.vertices(v.id()) If the graph return true for Graph.Features.ElementFeatures.supportsStringIds() ()} then it should support filters as with: g.vertices(v) g.vertices(v.id().toString()) g.vertices("id") If the graph return true for Graph.Features.ElementFeatures.supportsStringIds() ()} then it should support filters as with: g.vertices(v) g.vertices(v.id().toString()) g.vertices("id")

Parameters:

vertexIds - the ids of the vertices to get

Returns:

an Iterator of vertices that match the provided vertex ids