oracle.pg.rdbms

Class OraclePropertyGraphUtils

java.lang.Object

oracle.pg.common.OracleConvertersUtilsBase

oracle.pg.common.OraclePropertyGraphUtilsBase

oracle.pg.rdbms.OraclePropertyGraphUtils

All Implemented Interfaces:

oracle.pg.common.messages.MesgConsts

public class OraclePropertyGraphUtils
extends OraclePropertyGraphUtilsBase

This class contains utility functions to help manage property graphs stored in an Oracle Database.

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
OraclePropertyGraphUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	checkSnapshotExist(java.lang.String szGraphName, java.lang.String tableOwner, java.sql.Connection conn, long lSnapshotID) This method returns TRUE if a particular snapshot exists for a given property graph
static boolean	checkSnapshotTableExist(java.lang.String szGraphName, java.lang.String tableOwner, java.sql.Connection conn) This method returns TRUE if a designated table for storing snapshots exists for a given property graph
static void	clearPropertyGraph(Oracle oracle, java.lang.String szGraphName) This method clears the contents from the underlying schema objects for the specified property graph.
static void	cloneGraph(java.sql.Connection conn, java.lang.String szOrgGraphName, java.lang.String szNewGraphName, int iDOP, int iNumSubPtns, java.lang.String szTBS, java.lang.String szOptions) This method makes a clone of a given graph.
static void	copyGraph(Oracle oracle, java.lang.String graphName, java.lang.String newGraphName) Copy the property graph (including its associated tables) to the specified graph name (if it is not empty).
static void	copyGraph(Oracle oracle, java.lang.String graphName, java.lang.String newGraphName, int dop) Copy the property graph (including its associated tables) to the specified graph name (if it is not empty).
static void	createSnapshotTable(java.lang.String szGraphName, java.lang.String tableOwner, java.sql.Connection conn, int dop, java.lang.String options, java.lang.String tablespace, boolean nologging) This method creates the snapshot table for storing in-memory graphs
static void	dropPropertyGraph(Oracle oracle, java.lang.String szGraphName) Drops the specified property graph (including its associated tables).
static void	dropPropertyGraphTables(Oracle oracle, java.lang.String szGraphName) Drops the underlying tables of specified property graph (including its associated tables).
static void	dropTable(java.sql.Connection conn, java.lang.String tableName) Drop the specified table
static void	dropTable(java.sql.Connection conn, java.lang.String owner, java.lang.String tableName) Drop the specified table
static boolean	existsGraph(Oracle conn, java.lang.String graphName) Checks if the specified property graph already exists in the database
static void	exportFlatFiles(OraclePropertyGraph pg, java.io.OutputStream osVertex, java.io.OutputStream osEdge, int dop, boolean append) This function exports a given property graph into two flat files: one for vertices and the other for edges.
static void	exportFlatFiles(OraclePropertyGraph pg, java.io.OutputStream osVertex, java.io.OutputStream osEdge, int dop, boolean append, boolean closeStreams) This function exports a given property graph into two flat files: one for vertices and the other for edges.
static void	exportFlatFiles(java.lang.String jdbcUrl, java.lang.String user, java.lang.String password, java.lang.String propertyGraphName, java.lang.String vertexFileName, java.lang.String edgeFileName) This function exports a given property graph into two flat files: one for vertices and the other for edges.
static javax.sql.DataSource	getDataSource(java.lang.String dsName) Gets a DataSource object from the given data source name
static java.util.List<java.lang.String>	getGraphNames(Oracle oracle) List all the names of the property graphs stored in the given database
static boolean	hasTable(java.sql.Connection conn, java.lang.String tableName, java.lang.String tableOwner) Verifies if the specified table exists in the given Oracle Database
static PropertyType	idTypeAsPropertyType(IdType type) Converts a IdType object into a PropertyType object
static void	quietlyCloseConnections(Oracle[] oracleArray, java.sql.Connection[] connections) Quietly close an array of Oracle objects handling connections to an Oracle Database.
static void	readBinaryInMemGraphSnapshot(java.lang.String szGraphName, java.lang.String tableOwner, java.sql.Connection conn, java.io.OutputStream[] os, long lSnapshotID, int dop) Reads an In-Memory Graph Snapshot (binary file) from the snapshot SS$ table and writes it into the given outputstream.
static void	renameGraph(Oracle oracle, java.lang.String graphName, java.lang.String newGraphName) Renames the property graph (including its associated tables) to the specified graph name (if it does not exists or is not empty).
static void	renameGraph(Oracle oracle, java.lang.String graphName, java.lang.String newGraphName, boolean nologging, java.lang.String szOptions) Renames the property graph (including its associated tables) to the specified graph name (if it does not exists or is not empty).
static void	storeBinaryInMemGraphSnapshot(java.lang.String szGraphName, java.lang.String tableOwner, java.sql.Connection conn, java.io.InputStream is, long lSnapshotID, int dop) Stores an In-Memory Graph Snapshot (binary file) into the snapshot SS$ table.
static void	storeBinaryInMemGraphSnapshot(java.lang.String szGraphName, java.lang.String tableOwner, java.sql.Connection conn, java.io.InputStream is, long lSnapshotID, long lTimestamp, int dop) Stores an In-Memory Graph Snapshot (binary file) into the snapshot SS$ table.
static void	validateEdgeFlatFileSyntax(java.io.InputStream is, boolean continueOnError, java.io.PrintStream psOutput) This method validates the syntax of given PG edge file
static void	validatePGFlatFiles(java.lang.String vertexFile, java.lang.String edgeFile, boolean continueOnError) This method validates the syntax of given PG vertex and edge file
static void	validateVertexFlatFileSyntax(java.io.InputStream is, boolean continueOnError, java.io.PrintStream psOutput) This method validates the syntax of given PG vertex file

Methods inherited from class oracle.pg.common.OraclePropertyGraphUtilsBase

castAsOracleConnection, compareFiles, compareValueObjects, exportEdgeFlatFile, exportEdges, exportFlatFiles, exportFlatFiles, exportFlatFiles, exportFlatFiles, exportVertexFlatFile, exportVertices, getDatatypeAsPropertyType, getPropertiesFromFile, getPropertyType, getPropertyValueAsStr, handleGZipInputStream, isDateValue, isNumericValue, listify, outputEdgeRecord, outputVertexRecord, outputVertexRecord, prepareConfigEdgePropertiesFromOPVFile, prepareConfigVertexPropertiesFromOPVFile, quietlyClose, quietlyClose, quietlyClose, quietlyClose, quietlyClose, quietlyCloseResultSet, quietlyCloseResultSetAndStmt, quietlyCloseResultSetAndStmt, quietlyCloseStmt, quietlyShutdown, saveInputStreamIntoFile, size, size, unescape, validateSources

Methods inherited from class oracle.pg.common.OracleConvertersUtilsBase

convertCSV2OPE, convertCSV2OPE, convertCSV2OPE, convertCSV2OPE, convertCSV2OPE, convertCSV2OPE, convertCSV2OPE, convertCSV2OPV, convertCSV2OPV, convertCSV2OPV, convertCSV2OPV, convertCSV2OPV, convertRDBMSTable2OPE, convertRDBMSTable2OPE, convertRDBMSTable2OPE, convertRDBMSTable2OPE, convertRDBMSTable2OPE, convertRDBMSTable2OPE, convertRDBMSTable2OPE, convertRDBMSTable2OPE, convertRDBMSTable2OPV, convertRDBMSTable2OPV, convertRDBMSTable2OPV, convertRDBMSTable2OPV

Methods inherited from class java.lang.Object

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

Constructor Detail

OraclePropertyGraphUtils

public OraclePropertyGraphUtils()

Method Detail

checkSnapshotExist

public static boolean checkSnapshotExist(java.lang.String szGraphName,
                                         java.lang.String tableOwner,
                                         java.sql.Connection conn,
                                         long lSnapshotID)
                                  throws java.sql.SQLException

This method returns TRUE if a particular snapshot exists for a given property graph

Parameters:

szGraphName - the graph name where to get the snapshot

tableOwner - the owner of the snapshot table

conn - an Oracle connection

lSnapshotID - the ID of the snapshot to write

Throws:

java.sql.SQLException

checkSnapshotTableExist

public static boolean checkSnapshotTableExist(java.lang.String szGraphName,
                                              java.lang.String tableOwner,
                                              java.sql.Connection conn)
                                       throws java.sql.SQLException

This method returns TRUE if a designated table for storing snapshots exists for a given property graph

Parameters:

szGraphName - the graph name where to get the snapshot

tableOwner - the owner of the snapshot table

conn - an Oracle connection

Throws:

java.sql.SQLException

clearPropertyGraph

public static void clearPropertyGraph(Oracle oracle,
                                      java.lang.String szGraphName)
                               throws java.sql.SQLException

This method clears the contents from the underlying schema objects for the specified property graph. This operation cannot be undone.

Throws:

java.sql.SQLException

cloneGraph

public static void cloneGraph(java.sql.Connection conn,
                              java.lang.String szOrgGraphName,
                              java.lang.String szNewGraphName,
                              int iDOP,
                              int iNumSubPtns,
                              java.lang.String szTBS,
                              java.lang.String szOptions)
                       throws java.sql.SQLException

This method makes a clone of a given graph.

Parameters:

conn - a JDBC connection to Oracle Database

szOrgGraphName - name of the original graph

szNewGraphName - name of the new graph

iDOP - degree of parallelism

iNumSubPtns - number of sub partitions to be used for the new graph. Has to be a positive integer (and a power of 2)

szTBS - name of the tablespace to be used for the new graph

szOptions - options to be passed on to the underlying PL/SQL API.

Throws:

java.sql.SQLException

copyGraph

public static void copyGraph(Oracle oracle,
                             java.lang.String graphName,
                             java.lang.String newGraphName)
                      throws java.io.IOException,
                             java.lang.Exception

Copy the property graph (including its associated tables) to the specified graph name (if it is not empty). This operation will not copy existing indices into the new graph.

Parameters:

oracle - an Oracle connection to the database where the property graph is stored.

graphName - the name of the property graph to be copied

newGraphName - the new name of the graph

Throws:

java.io.IOException

java.lang.Exception

copyGraph

public static void copyGraph(Oracle oracle,
                             java.lang.String graphName,
                             java.lang.String newGraphName,
                             int dop)
                      throws java.io.IOException,
                             java.lang.Exception

Copy the property graph (including its associated tables) to the specified graph name (if it is not empty). This operation will not copy existing indices into the new graph.

Parameters:

oracle - an Oracle connection to the database where the property graph is stored.

graphName - the name of the property graph to be copied

newGraphName - the new name of the graph

dop - the degree of parallelism to use when copying the data from one graph to the other

Throws:

java.io.IOException

java.lang.Exception

createSnapshotTable

public static void createSnapshotTable(java.lang.String szGraphName,
                                       java.lang.String tableOwner,
                                       java.sql.Connection conn,
                                       int dop,
                                       java.lang.String options,
                                       java.lang.String tablespace,
                                       boolean nologging)
                                throws java.sql.SQLException

This method creates the snapshot table for storing in-memory graphs

Throws:

java.sql.SQLException

dropPropertyGraph

public static void dropPropertyGraph(Oracle oracle,
                                     java.lang.String szGraphName)
                              throws java.sql.SQLException

Drops the specified property graph (including its associated tables). This operation cannot be undone. This method will drop the underlying schema objects for the specified property graph. It will also drop Lucene/SolrCloud index data, if any.

Parameters:

oracle - an Oracle connection to the database where the property graph is stored.

szGraphName - the name of the graph to drop.

Throws:

java.sql.SQLException

dropPropertyGraphTables

public static void dropPropertyGraphTables(Oracle oracle,
                                           java.lang.String szGraphName)
                                    throws java.sql.SQLException

Drops the underlying tables of specified property graph (including its associated tables). This operation cannot be undone. Note that this method does not drop Lucene or SolrCloud index data, if any. This method will drop the underlying schema objects for the specified property graph.

Parameters:

oracle - an Oracle connection to the database where the property graph is stored.

szGraphName - the name of the graph to drop.

Throws:

java.sql.SQLException

dropTable

public static void dropTable(java.sql.Connection conn,
                             java.lang.String tableName)
                      throws java.sql.SQLException

Drop the specified table

Parameters:

conn - a Connection to Oracle Database

tableName - the name of the table

Throws:

java.sql.SQLException

dropTable

public static void dropTable(java.sql.Connection conn,
                             java.lang.String owner,
                             java.lang.String tableName)
                      throws java.sql.SQLException

Drop the specified table

Parameters:

conn - a Connection to Oracle Database

tableName - the name of the table

Throws:

java.sql.SQLException

existsGraph

public static boolean existsGraph(Oracle conn,
                                  java.lang.String graphName)

Checks if the specified property graph already exists in the database

Parameters:

conn - a Oracle connection to the database

graphName - the name of the property graph

Throws:

java.io.IOException

exportFlatFiles

public static final void exportFlatFiles(OraclePropertyGraph pg,
                                         java.io.OutputStream osVertex,
                                         java.io.OutputStream osEdge,
                                         int dop,
                                         boolean append)
                                  throws java.io.IOException,
                                         java.io.FileNotFoundException

This function exports a given property graph into two flat files: one for vertices and the other for edges.

Parameters:

pg - the property graph that will be exported into flat files

osVertex - an OutputStream object for the vertex flat file

osEdge - an OutputStream object for the edge flat file

dop - the degree of parallelism used when writing the data into the flat files. This will use multiple threads to optimize writing performance.

append - if false, overwrite the existing flat files removing all existing data.

Throws:

java.io.IOException

java.io.FileNotFoundException

exportFlatFiles

public static void exportFlatFiles(OraclePropertyGraph pg,
                                   java.io.OutputStream osVertex,
                                   java.io.OutputStream osEdge,
                                   int dop,
                                   boolean append,
                                   boolean closeStreams)
                            throws java.io.IOException,
                                   java.io.FileNotFoundException

This function exports a given property graph into two flat files: one for vertices and the other for edges.

Parameters:

pg - the property graph that will be exported into flat files

osVertex - an OutputStream object for the vertex flat file

osEdge - an OutputStream object for the edge flat file

dop - the degree of parallelism used when writing the data into the flat files. This will use multiple threads to optimize writing performance.

append - if false, overwrite the existing flat files removing all existing data.

closeStreams - whether to close the OutputStreams or not

Throws:

java.io.IOException

java.io.FileNotFoundException

exportFlatFiles

public static void exportFlatFiles(java.lang.String jdbcUrl,
                                   java.lang.String user,
                                   java.lang.String password,
                                   java.lang.String propertyGraphName,
                                   java.lang.String vertexFileName,
                                   java.lang.String edgeFileName)
                            throws java.sql.SQLException,
                                   java.io.IOException,
                                   java.io.FileNotFoundException

This function exports a given property graph into two flat files: one for vertices and the other for edges.

Parameters:

jdbcUrl - JDBC URL that identifies an Oracle database

user - username of a database schema

password - password to authenticate

propertyGraphName - the name of the property graph to export

vertexFileName - the name of the vertex flat file e.g. graph.opv

edgeFileName - the name of the edge flat file e.g. graph.ope

Throws:

java.sql.SQLException

java.io.IOException

java.io.FileNotFoundException

getDataSource

public static javax.sql.DataSource getDataSource(java.lang.String dsName)
                                          throws java.sql.SQLException,
                                                 javax.naming.NamingException

Gets a DataSource object from the given data source name

Parameters:

dsName - the data source name

Throws:

java.sql.SQLException

javax.naming.NamingException

getGraphNames

public static java.util.List<java.lang.String> getGraphNames(Oracle oracle)

List all the names of the property graphs stored in the given database

Parameters:

oracle - an Oracle connection to the database where the property graph is stored.

Returns:

a list of Strings with the names of the property graphs in the database.

hasTable

public static boolean hasTable(java.sql.Connection conn,
                               java.lang.String tableName,
                               java.lang.String tableOwner)

Verifies if the specified table exists in the given Oracle Database

Parameters:

conn - a Connection to Oracle Database

tableName - the name of the table

tableOwner - the owner of the table

idTypeAsPropertyType

public static PropertyType idTypeAsPropertyType(IdType type)

Converts a IdType object into a PropertyType object

quietlyCloseConnections

public static void quietlyCloseConnections(Oracle[] oracleArray,
                                           java.sql.Connection[] connections)

Quietly close an array of Oracle objects handling connections to an Oracle Database.

Parameters:

oracleArray - the array of Oracle connections to be closed.

connections - the array of Connection objects obtained from the Oracle objects.

readBinaryInMemGraphSnapshot

public static void readBinaryInMemGraphSnapshot(java.lang.String szGraphName,
                                                java.lang.String tableOwner,
                                                java.sql.Connection conn,
                                                java.io.OutputStream[] os,
                                                long lSnapshotID,
                                                int dop)
                                         throws OraclePropertyGraphException,
                                                java.sql.SQLException

Reads an In-Memory Graph Snapshot (binary file) from the snapshot SS$ table and writes it into the given outputstream.

Parameters:

szGraphName - the graph name where to get the snapshot

tableOwner - the owner of the snapshot table

conn - an Oracle connection

os - an array of OutputStream objects where the in-memory graph binary files will be written.

lSnapshotID - the ID of the snapshot to read

dop - the degree of parallelism to use when reading the snapshot

Throws:

OraclePropertyGraphException

java.sql.SQLException

OraclePropertyGraphException

renameGraph

public static void renameGraph(Oracle oracle,
                               java.lang.String graphName,
                               java.lang.String newGraphName)
                        throws java.io.IOException,
                               java.lang.Exception

Renames the property graph (including its associated tables) to the specified graph name (if it does not exists or is not empty). This operation will not take into account existing indices. Indices should be removed before calling this operation and re-executed using the new graph instance.

Parameters:

oracle - an Oracle connection to the database where the property graph is stored.

graphName - the name of the property graph to be renamed

newGraphName - the new name of the property graph.

Throws:

java.io.IOException

java.lang.Exception

renameGraph

public static void renameGraph(Oracle oracle,
                               java.lang.String graphName,
                               java.lang.String newGraphName,
                               boolean nologging,
                               java.lang.String szOptions)
                        throws java.io.IOException,
                               java.lang.Exception

Renames the property graph (including its associated tables) to the specified graph name (if it does not exists or is not empty). This operation will not take into account existing indices. Indices should be removed before calling this operation and re-executed using the new graph instance.

Parameters:

oracle - an Oracle connection to the database where the property graph is stored.

graphName - the name of the property graph to be renamed

newGraphName - the new name of the property graph.

nologging - if logging is enabled on the underlying PL/SQL API.

szOptions - options to be passed on to the underlying PL/SQL API.

Throws:

java.io.IOException

java.lang.Exception

storeBinaryInMemGraphSnapshot

public static void storeBinaryInMemGraphSnapshot(java.lang.String szGraphName,
                                                 java.lang.String tableOwner,
                                                 java.sql.Connection conn,
                                                 java.io.InputStream is,
                                                 long lSnapshotID,
                                                 int dop)
                                          throws OraclePropertyGraphException

Stores an In-Memory Graph Snapshot (binary file) into the snapshot SS$ table.

Parameters:

szGraphName - the graph name where to get the snapshot

tableOwner - the owner of the snapshot table

conn - an Oracle connection

is - an InputStream objects where the in-memory graph binary files will be read.

lSnapshotID - the ID of the snapshot to write

dop - the degree of parallelism to use when writing the snapshot

Throws:

OraclePropertyGraphException

java.sql.SQLException

OraclePropertyGraphException

storeBinaryInMemGraphSnapshot

public static void storeBinaryInMemGraphSnapshot(java.lang.String szGraphName,
                                                 java.lang.String tableOwner,
                                                 java.sql.Connection conn,
                                                 java.io.InputStream is,
                                                 long lSnapshotID,
                                                 long lTimestamp,
                                                 int dop)
                                          throws OraclePropertyGraphException

Stores an In-Memory Graph Snapshot (binary file) into the snapshot SS$ table.

Parameters:

szGraphName - the graph name where to get the snapshot

tableOwner - the owner of the snapshot table

conn - an Oracle connection

is - an InputStream objects where the in-memory graph binary files will be read.

lSnapshotID - the ID of the snapshot to write

dop - the degree of parallelism to use when writing the snapshot

Throws:

OraclePropertyGraphException

java.sql.SQLException

OraclePropertyGraphException

validateEdgeFlatFileSyntax

public static void validateEdgeFlatFileSyntax(java.io.InputStream is,
                                              boolean continueOnError,
                                              java.io.PrintStream psOutput)

This method validates the syntax of given PG edge file

validatePGFlatFiles

public static void validatePGFlatFiles(java.lang.String vertexFile,
                                       java.lang.String edgeFile,
                                       boolean continueOnError)

This method validates the syntax of given PG vertex and edge file

validateVertexFlatFileSyntax

public static void validateVertexFlatFileSyntax(java.io.InputStream is,
                                                boolean continueOnError,
                                                java.io.PrintStream psOutput)

This method validates the syntax of given PG vertex file