oracle.pg.rdbms

Interface OraclePropertyGraphAnalytics

All Known Implementing Classes:

OraclePropertyGraph

public interface OraclePropertyGraphAnalytics

This interface defines analytical functions that are supported by OraclePropertyGraph

Method Summary

Methods

Modifier and Type	Method and Description
long	countTriangle(StringBuilder sbUndirWorkTab) This method returns the number of triangles that exist in this graph which is treated as undirected.
long	countTriangle(StringBuilder sbUndirWorkTab, int iNumSubPtns, int iDOP, String szTBS, String szOptions) This method returns the number of triangles that exist in this graph.
void	countTriangleCleanup(StringBuilder sbUndirBMTab, StringBuilder sbMapWorkTab, StringBuilder sbUndirAMTab, String szOptions) This method does cleanup work after running triangle calculations.
void	countTrianglePrep(StringBuilder sbUndirBMTab, StringBuilder sbMapWorkTab, StringBuilder sbUndirAMTab, String szOptions) This method does preparation work before running triangle calculations.
long	countTriangleRenum(StringBuilder sbUndirBMTab, StringBuilder sbMapWorkTab, StringBuilder sbUndirAMTab, int iNumSubPtns, int iDOP, String szTBS, String szOptions) This method returns the number of triangles that exist in this graph (treated as undirected).
long	estimateTriangleRenum(StringBuilder sbUndirBMTab, StringBuilder sbMapWorkTab, StringBuilder sbUndirAMTab, int iNumSubPtns, int iChunk, int iDOP, String szTBS, String szOptions) This method estimates the number of triangles that exist in this graph (treated as undirected).
void	findCluster(StringBuilder sbClusters, StringBuilder sbUndir, StringBuilder sbCluas, StringBuilder sbNewas, StringBuilder sbDelta, int iDOP, String szTBS, String szOptions) This method finds clusters in this property graph (treated as undirected).
void	findClusterCleanup(StringBuilder sbClusters, StringBuilder sbUndir, StringBuilder sbCluas, StringBuilder sbNewas, StringBuilder sbDelta, String szOptions) This method does cleanup work after running graph cluster detection.
void	findClusterPrep(StringBuilder sbClusters, StringBuilder sbUndir, StringBuilder sbCluas, StringBuilder sbNewas, StringBuilder sbDelta, String szOptions) This method does preparation work before running graph cluster detection.
long	pageRank(StringBuilder sbNodePR, StringBuilder sbNodeNextPR, StringBuilder sbEdgeTabDeg, StringBuilder sbDelta, float d, int iNumIterations, float convergence, int iDOP, String szTBS, String szOptions) This method calculates the page rank values of vertices in this graph.
void	pageRankCleanup(StringBuilder sbNodePR, StringBuilder sbNodeNextPR, StringBuilder sbEdgeTabDeg, StringBuilder sbDelta, String szOptions) This method does cleanup work before running page rank calculation.
void	pageRankPrep(StringBuilder sbNodePR, StringBuilder sbNodeNextPR, StringBuilder sbEdgeTabDeg, StringBuilder sbDelta, String szOptions) This method does preparation work before running page rank calculation.
String	shortestPath(Long lStart, Long lEnd, StringBuilder sbExpTab) This method returns a shortest path in a string format.
String	shortestPath(Long lStart, Long lEnd, StringBuilder sbExpTab, StringBuilder sbPathWeights, String szOptions) This method returns a shortest path in a string format.
String	shortestPath(Long lStart, Long lEnd, StringBuilder sbExpTab, String szEdgeTabName, StringBuilder sbPathWeights, String szOptions, Long lSCN) This method returns a shortest path in a string format.
String	shortestPath(OracleVertex vStart, OracleVertex vEnd, StringBuilder sbExpTab) This method returns a shortest path in a string format.
String	shortestPath(OracleVertex vStart, OracleVertex vEnd, StringBuilder sbExpTab, StringBuilder sbPathWeights, String szOptions) This method returns a shortest path in a string format.
void	shortestPathCleanup(StringBuilder sbExpTab, String szOptions) This method does clean up after running shortest path calculations.
void	shortestPathPrep(StringBuilder sbExpTab, String szOptions) This method does some preparation work before running one or multiple shortest path calculations.

Method Detail

countTriangle

long countTriangle(StringBuilder sbUndirWorkTab)
                   throws SQLException

This method returns the number of triangles that exist in this graph which is treated as undirected. Note that an undirected graph will be created before counting the number of triangles.

Parameters:

sbUndirWorkTab - a place holder for the name of the undirected working table to be used for calculating triangles.

Throws:

SQLException

countTriangle

long countTriangle(StringBuilder sbUndirWorkTab,
                 int iNumSubPtns,
                 int iDOP,
                 String szTBS,
                 String szOptions)
                   throws SQLException

This method returns the number of triangles that exist in this graph. By default, the underlying logic will NOT create an undirected graph before counting the number of triangles. To change that behavior, one can add ",CREATE_UNDIRECTED=T," to the szOptions.

Parameters:

sbUndirWorkTab - a place holder for the name of the undirected working table to be used for calculating triangles. This argument is relevant when "CREATE_UNDIRECTED=T" option is set.

iNumSubPtns - has to be a positive integer and has to be power of two. This value represents the number of logical partitions chosen to do the calculation. Set the value to 1 to avoid using partitioned approach.

iDOP - degree of parallelism to be used

szTBS - tablespace. It can be NULL.

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

countTriangleCleanup

void countTriangleCleanup(StringBuilder sbUndirBMTab,
                        StringBuilder sbMapWorkTab,
                        StringBuilder sbUndirAMTab,
                        String szOptions)
                          throws SQLException

This method does cleanup work after running triangle calculations. Basically, all intermediate working tables will be truncated and dropped.

Parameters:

sbUndirBMTab - a place holder for the name of the undirected working table (before mapping) to be used for calculating triangles.

sbMapWorkTab - a place holder for the name of the map working table to be used for calculating triangles.

sbUndirAMTab - a place holder for the name of the undirected working table (after mapping) to be used for calculating triangles.

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

countTrianglePrep

void countTrianglePrep(StringBuilder sbUndirBMTab,
                     StringBuilder sbMapWorkTab,
                     StringBuilder sbUndirAMTab,
                     String szOptions)
                       throws SQLException

This method does preparation work before running triangle calculations.

Parameters:

sbUndirBMTab - a place holder for the name of the undirected working table (before mapping) to be used for calculating triangles.

sbMapWorkTab - a place holder for the name of the map working table to be used for calculating triangles. The map working table is for renumbering vertices.

sbUndirAMTab - a place holder for the name of the undirected working table (after mapping) to be used for calculating triangles.

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

countTriangleRenum

long countTriangleRenum(StringBuilder sbUndirBMTab,
                      StringBuilder sbMapWorkTab,
                      StringBuilder sbUndirAMTab,
                      int iNumSubPtns,
                      int iDOP,
                      String szTBS,
                      String szOptions)
                        throws SQLException

This method returns the number of triangles that exist in this graph (treated as undirected). A re-numbering of vertices will be carried out before the actual work of counting is performed.

Parameters:

sbUndirBMTab - a place holder for the name of the undirected working table (before mapping) to be used for calculating triangles.

sbMapWorkTab - a place holder for the name of the map working table to be used for calculating triangles.

sbUndirAMTab - a place holder for the name of the undirected working table (after mapping) to be used for calculating triangles.

iNumSubPtns - has to be a positive integer and has to be power of two. This value represents the number of logical partitions chosen to do the calculation. Set the value to 1 to avoid using partitioned approach.

iDOP - degree of parallelism to be used for creating a working table holding undirected graph data and for executing triangle counting query.

szTBS - tablespace. It can be NULL.

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

estimateTriangleRenum

long estimateTriangleRenum(StringBuilder sbUndirBMTab,
                         StringBuilder sbMapWorkTab,
                         StringBuilder sbUndirAMTab,
                         int iNumSubPtns,
                         int iChunk,
                         int iDOP,
                         String szTBS,
                         String szOptions)
                           throws SQLException

This method estimates the number of triangles that exist in this graph (treated as undirected). A re-numbering of vertices will be carried out before the actual work of counting is performed.

Parameters:

sbUndirBMTab - a place holder for the name of the undirected working table (before mapping) to be used for calculating triangles.

sbMapWorkTab - a place holder for the name of the map working table to be used for calculating triangles.

sbUndirAMTab - a place holder for the name of the undirected working table (after mapping) to be used for calculating triangles.

iNumSubPtns - has to be a positive integer and has to be power of two. This value represents the number of logical partitions chosen to do the calculation. As the number of logical partitions grows, the estimation will become faster (and less precise).

iChunk - an integer in the range of [0, iNumSubPtns*iNumSubPtns - 1]

iDOP - degree of parallelism to be used

szTBS - tablespace. It can be NULL.

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

findCluster

void findCluster(StringBuilder sbClusters,
               StringBuilder sbUndir,
               StringBuilder sbCluas,
               StringBuilder sbNewas,
               StringBuilder sbDelta,
               int iDOP,
               String szTBS,
               String szOptions)
                 throws SQLException

This method finds clusters in this property graph (treated as undirected).

Parameters:

sbClusters - a place holder for the name of the output table that holds cluster assignment for vertices

sbUndir - a place holder for the name of the working table that holds undirected graph

sbCluas - a place holder for the name of the working table that holds intermediate cluster assignment

sbNewas - a place holder for the name of the working table that holds updated cluster assignment

sbDelta - a place holder for the name of the working table that holds delta information

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

findClusterCleanup

void findClusterCleanup(StringBuilder sbClusters,
                      StringBuilder sbUndir,
                      StringBuilder sbCluas,
                      StringBuilder sbNewas,
                      StringBuilder sbDelta,
                      String szOptions)
                        throws SQLException

This method does cleanup work after running graph cluster detection. All the tables that hold intermediate data and the output cluster assignment will be dropped.

Parameters:

sbClusters - a place holder for the name of the output table that holds cluster assignment for vertices

sbUndir - a place holder for the name of the working table that holds undirected graph

sbCluas - a place holder for the name of the working table that holds intermediate cluster assignment

sbNewas - a place holder for the name of the working table that holds updated cluster assignment

sbDelta - a place holder for the name of the working table that holds delta information

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

findClusterPrep

void findClusterPrep(StringBuilder sbClusters,
                   StringBuilder sbUndir,
                   StringBuilder sbCluas,
                   StringBuilder sbNewas,
                   StringBuilder sbDelta,
                   String szOptions)
                     throws SQLException

This method does preparation work before running graph cluster detection.

Parameters:

sbClusters - a place holder for the name of the output table that holds cluster assignment for vertices

sbUndir - a place holder for the name of the working table that holds undirected graph

sbCluas - a place holder for the name of the working table that holds intermediate cluster assignment

sbNewas - a place holder for the name of the working table that holds updated cluster assignment

sbDelta - a place holder for the name of the working table that holds delta information

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

pageRank

long pageRank(StringBuilder sbNodePR,
            StringBuilder sbNodeNextPR,
            StringBuilder sbEdgeTabDeg,
            StringBuilder sbDelta,
            float d,
            int iNumIterations,
            float convergence,
            int iDOP,
            String szTBS,
            String szOptions)
              throws SQLException

This method calculates the page rank values of vertices in this graph.

Parameters:

sbNodePR - a place holder for the name of the working table that holds the page rank values of the vertices

sbNodeNextPR - a place holder for the name of the working table that holds the page rank values in the next iteration

sbEdgeTabDeg - a place holder for the name of the working table that holds edges and node degree information

sbDelta - a place holder for the name of the working table that holds information about some special vertices

d - damping factor, 0.85f is often used.

iNumIterations - number of iterations to perform PR calculations.

convergence - if positive, then continue PR calculations till sum of PR value changes is less than this convergence setting.

iDOP - degree of parallelism to be used for creating a working table holding undirected graph data and for executing triangle counting query.

szTBS - tablespace. It can be NULL.

szOptions - options to be used by the underlying PL/SQL API.

Returns:

the number of vertices of the table stored in sbNodePR. The PR values of vertices are stored in the working table sbNodePR

Throws:

SQLException

pageRankCleanup

void pageRankCleanup(StringBuilder sbNodePR,
                   StringBuilder sbNodeNextPR,
                   StringBuilder sbEdgeTabDeg,
                   StringBuilder sbDelta,
                   String szOptions)
                     throws SQLException

This method does cleanup work before running page rank calculation.

Parameters:

sbNodePR - a place holder for the name of the working table that holds the page rank values of the vertices

sbNodeNextPR - a place holder for the name of the working table that holds the page rank values in the next iteration

sbEdgeTabDeg - a place holder for the name of the working table that holds edges and node degree information

sbDelta - a place holder for the name of the working table that holds information about some special vertices

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

pageRankPrep

void pageRankPrep(StringBuilder sbNodePR,
                StringBuilder sbNodeNextPR,
                StringBuilder sbEdgeTabDeg,
                StringBuilder sbDelta,
                String szOptions)
                  throws SQLException

This method does preparation work before running page rank calculation.

Parameters:

sbNodePR - a place holder for the name of the working table that holds the page rank values of the vertices

sbNodeNextPR - a place holder for the name of the working table that holds the page rank values in the next iteration

sbEdgeTabDeg - a place holder for the name of the working table that holds edges and node degree information

sbDelta - a place holder for the name of the working table that holds information about some special vertices

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

shortestPath

String shortestPath(Long lStart,
                  Long lEnd,
                  StringBuilder sbExpTab)
                    throws SQLException

This method returns a shortest path in a string format. The path is delimited by space. A NULL value will be returned if there is no path found.

Parameters:

lStart - start vertex integer ID

lEnd - destination vertex integer ID

sbExpTab - place holder of expansion table name

Throws:

SQLException

shortestPath

String shortestPath(Long lStart,
                  Long lEnd,
                  StringBuilder sbExpTab,
                  StringBuilder sbPathWeights,
                  String szOptions)
                    throws SQLException

This method returns a shortest path in a string format. The path is delimited by space. A NULL value will be returned if there is no path found.

Parameters:

lStart - start vertex integer ID

lEnd - destination vertex integer ID

sbExpTab - place holder of expansion table name

sbPathWeights - place holder of path weights of the shortest path. The first number represents the number of vertices on the shortest path, the second number represents the total weight and the rest numbers denote weights of edges along the shortest path. All these numbers are delimited by spaces.

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

Throws:

SQLException

shortestPath

String shortestPath(Long lStart,
                  Long lEnd,
                  StringBuilder sbExpTab,
                  String szEdgeTabName,
                  StringBuilder sbPathWeights,
                  String szOptions,
                  Long lSCN)
                    throws SQLException

This method returns a shortest path in a string format. The path is delimited by space. A NULL value will be returned if there is no path found.

Parameters:

lStart - start vertex integer ID

lEnd - destination vertex integer ID

szEdgeTabName - name of the edge table (or view). Note that one can create a view on top of existing edge table to filter out unwanted edges.

sbPathWeights - place holder of path weights of the shortest path. The first number represents the number of vertices on the shortest path, the second number represents the total weight and the rest numbers denote weights of edges along the shortest path. All these numbers are delimited by spaces.

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

lSCN - SCN for the edge table. It can be NULL.

Throws:

SQLException

shortestPath

String shortestPath(OracleVertex vStart,
                  OracleVertex vEnd,
                  StringBuilder sbExpTab)
                    throws SQLException

This method returns a shortest path in a string format. The path is delimited by space. A NULL value will be returned if there is no path found.

Parameters:

vStart - start vertex object

vEnd - destination vertex object

sbExpTab - place holder of expansion table name

Throws:

SQLException

shortestPath

String shortestPath(OracleVertex vStart,
                  OracleVertex vEnd,
                  StringBuilder sbExpTab,
                  StringBuilder sbPathWeights,
                  String szOptions)
                    throws SQLException

This method returns a shortest path in a string format. The path is delimited by space. A NULL value will be returned if there is no path found.

Parameters:

vStart - start vertex object

vEnd - destination vertex object

sbExpTab - place holder of expansion table name

sbPathWeights - place holder of path weights of the shortest path. The first number represents the number of vertices on the shortest path, the second number represents the total weight and the rest numbers denote weights of edges along the shortest path. All these numbers are delimited by spaces.

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

Throws:

SQLException

shortestPathCleanup

void shortestPathCleanup(StringBuilder sbExpTab,
                       String szOptions)
                         throws SQLException

This method does clean up after running shortest path calculations.

Parameters:

sbExpTab - a place holder for the name of the expansion table to be used for Bi-directional, Set Style, Dijkstra search.

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException

shortestPathPrep

void shortestPathPrep(StringBuilder sbExpTab,
                    String szOptions)
                      throws SQLException

This method does some preparation work before running one or multiple shortest path calculations. This method only needs to be invoked once unless a different expansion table is to be used to calculate shortest paths.

Parameters:

sbExpTab - a place holder for the name of the expansion table to be used for Bi-directional, Set Style, Dijkstra search. If sbExpTab is empty, an intermediate working table will be created and the table name will be returned in the sbExpTab object.

szOptions - options to be used by the underlying PL/SQL API.

Throws:

SQLException