oracle.pg.rdbms

Interface OraclePgqlStatement

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

OraclePgqlPreparedStatement

All Known Implementing Classes:

OraclePgqlExecution

public interface OraclePgqlStatement
extends java.lang.AutoCloseable

This interface is used to execute a static PGQL query.

A typical usage is shown below.

 
 Oracle oracle = new Oracle(jdbcUrl,user,password);
 OraclePropertyGraph graph = OraclePropertyGraph.getInstance(oracle,graphName);

 OraclePgqlStatement ops = 
   OraclePgqlExecutionFactory.createStatement(graph);

 OraclePgqlResultSet oprs = ops.executeQuery(pgqlString, "USE_GT_TAB=T");

 OraclePgqlResultSetMetaData rsmd = oprs.getMetaData();
 Iterator<OraclePgqlResult> itr = oprs.getResults().iterator();
 while(itr.hasNext()) {
   OraclePgqlResult opr = itr.next();
   for (int i = 1; i <= rsmd.getColumnCount(); i++) {
     OraclePgqlColumnDescriptor.Type t = opr.getColumnType(i);
     switch (t) {
       case VERTEX:
         // process vertex
         break;
       case EDGE:
         // process edge
         break;
       case VALUE:
         // process value
         break;
     }
   }
 }

 oprs.close();
 ops.close();
 
 

Method Summary

Modifier and Type	Method and Description
void	close() Releases this OraclePgqlStatment's database and JDBC resources.
OraclePgqlResultSet	executeQuery(java.lang.String pgql, int timeout, int parallel, long queryID, int dynamicSampling, int maxResults, java.lang.String options) Translates this instance's PGQL statement into a SQL statement and executes the SQL against this instance's property graph.
OraclePgqlResultSet	executeQuery(java.lang.String pgql, java.lang.String options) Translates this instance's PGQL statement into a SQL statement and executes the SQL against this instance's property graph.
int	getFetchSize() Returns the the number of rows that should be fetched from the database when more rows are needed for a query result.
void	setFetchSize(int fetchSize) Sets the number of rows that should be fetched from the database when more rows are needed for a query result.
OraclePgqlSqlTrans	translateQuery(java.lang.String pgql, int parallel, int dynamicSampling, int maxResults, java.lang.String options) Translates this instance's PGQL statement into a SQL statement.
OraclePgqlSqlTrans	translateQuery(java.lang.String pgql, java.lang.String options) Translates this instance's PGQL statement into a SQL statement.

Method Detail

close

void close()
    throws java.sql.SQLException

Releases this OraclePgqlStatment's database and JDBC resources.

Closing this OraclePgqlStatement will close all OraclePgqlResultSets that were created from it.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.sql.SQLException

executeQuery

OraclePgqlResultSet executeQuery(java.lang.String pgql,
                                 int timeout,
                                 int parallel,
                                 long queryID,
                                 int dynamicSampling,
                                 int maxResults,
                                 java.lang.String options)
                          throws PgqlToSqlException,
                                 oracle.pgql.lang.PgqlException,
                                 java.sql.SQLException

Translates this instance's PGQL statement into a SQL statement and executes the SQL against this instance's property graph.

Supported query options are:

USE_GT_TAB=T Use the GRAPH_NAMEGT$ table instead of the GRAPH_NAMEGE$ table for evaluating edge traversals.

USE_RW=F Use CONNECT BY instead of recursive WITH for unbounded path traversals.

MAX_PATH_LEN=n Traverse at most n hops when evaluating unbounded path traversals.

EDGE_SET_PARTIAL=T Fetch properties for each start and end vertex found when reading edges from the query result.

Parameters:

pgql - the PGQL query to execute

timeout - the number of seconds for query execution to finish

parallel - the degree of parallelism to use for query execution

queryID - the query ID

dynamicSampling - the value for dynamic sampling

maxResults - the maximum number of rows returned

options - additional options used to influence query translation and execution

Returns:

a OraclePgqlResultSet object with the result of the provided PGQL query

Throws:

PgqlToSqlException

oracle.pgql.lang.PgqlException

java.sql.SQLException

executeQuery

OraclePgqlResultSet executeQuery(java.lang.String pgql,
                                 java.lang.String options)
                          throws PgqlToSqlException,
                                 oracle.pgql.lang.PgqlException,
                                 java.sql.SQLException

Translates this instance's PGQL statement into a SQL statement and executes the SQL against this instance's property graph.

Supported query options are:

USE_GT_TAB=T Use the GRAPH_NAMEGT$ table instead of the GRAPH_NAMEGE$ table for evaluating edge traversals.

USE_RW=F Use CONNECT BY instead of recursive WITH for unbounded path traversals.

MAX_PATH_LEN=n Traverse at most n hops when evaluating unbounded path traversals.

EDGE_SET_PARTIAL=T Fetch properties for each start and end vertex found when reading edges from the query result.

Parameters:

pgql - the PGQL query to execute

options - additional options used to influence query translation and execution

Returns:

a OraclePgqlResultSet object with the result of the provided PGQL query

Throws:

PgqlToSqlException

oracle.pgql.lang.PgqlException

java.sql.SQLException

getFetchSize

int getFetchSize()

Returns the the number of rows that should be fetched from the database when more rows are needed for a query result.

Returns:

the query fetch size

setFetchSize

void setFetchSize(int fetchSize)

Sets the number of rows that should be fetched from the database when more rows are needed for a query result.

Parameters:

fetchSize - the query fetch size

translateQuery

OraclePgqlSqlTrans translateQuery(java.lang.String pgql,
                                  int parallel,
                                  int dynamicSampling,
                                  int maxResults,
                                  java.lang.String options)
                           throws PgqlToSqlException,
                                  oracle.pgql.lang.PgqlException

Translates this instance's PGQL statement into a SQL statement.

Supported query options are:

USE_GT_TAB=T Use the GRAPH_NAMEGT$ table instead of the GRAPH_NAMEGE$ table for evaluating edge traversals.

USE_RW=F Use CONNECT BY instead of recursive WITH for unbounded path traversals.

MAX_PATH_LEN=n Traverse at most n hops when evaluating unbounded path traversals.

EDGE_SET_PARTIAL=T Fetch properties for each start and end vertex found when reading edges from the query result.

Parameters:

pgql - the PGQL query to translate

parallel - the degree of parallelism to use for query execution

dynamicSampling - the value for dynamic sampling

maxResults - the maximum number of rows returned

options - additional options used to influence query translation

Returns:

a OraclePgqlSqlTrans object with the SQL translation and column metadata for the provided PGQL query

Throws:

PgqlToSqlException

oracle.pgql.lang.PgqlException

translateQuery

OraclePgqlSqlTrans translateQuery(java.lang.String pgql,
                                  java.lang.String options)
                           throws PgqlToSqlException,
                                  oracle.pgql.lang.PgqlException

Translates this instance's PGQL statement into a SQL statement.

Supported query options are:

USE_GT_TAB=T Use the GRAPH_NAMEGT$ table instead of the GRAPH_NAMEGE$ table for evaluating edge traversals.

USE_RW=F Use CONNECT BY instead of recursive WITH for unbounded path traversals.

MAX_PATH_LEN=n Traverse at most n hops when evaluating unbounded path traversals.

EDGE_SET_PARTIAL=T Fetch properties for each start and end vertex found when reading edges from the query result.

Parameters:

pgql - the PGQL query to translate

options - additional options used to influence query translation

Returns:

a OraclePgqlSqlTrans object with the SQL translation and column metadata for the provided PGQL query

Throws:

PgqlToSqlException

oracle.pgql.lang.PgqlException