Oracle OPG_APIS
Version 26ai

General Information
Library Note Morgan's Library Page Header
The best Oracle News for FY2026

Oracle Database 26ai will be available on generic Linux platforms in January and soon on AIX and Windows
Purpose Provides support for Graph Database Operations on property graphs in the Oracle Database.
Acronyms GE - Graph Edge
PG - Property Graph
PR - Page Rank
SP - Shortest Path
VT - Vertex
WKT - Well Known Text
AUTHID CURRENT_USER
Constants
Name Data Type Value
 Error Codes
ECODE_INVALID_NAME INTEGER -20900
ECODE_INVALID_NUM_PTNS INTEGER -20901
ECODE_INVALID_MARKER_TOO_LONG INTEGER -20902
ECODE_INVALID_ARGUMENT INTEGER -20903
ECODE_GET_LOCK INTEGER -20904
ECODE_RELEASE_LOCK INTEGER -20905
 Table Prefix
OPG_TMP_TAB_PREFIX VARCHAR2(200) 'opg_tmptab_'
Dependencies
DBMS_ASSERT OPG_LOG SDO_CS
DBMS_LOCK OPG_METRICS SDO_GEOMETRY
DBMS_STANDARD OPG_PATH SDO_POINT_TYPE
DBMS_STATS OPG_RANK SDO_UTIL
DBMS_UTILITY OPG_UTL T_VARCHAR2_ARRAY
OPG_GRAPHOP PLITBLM  
Documented Yes
First Available 19c
Pragmas PRAGMA SUPPLEMENTAL_LOG_DATA(default, NONE);
Security Model Owned by MDSYS with EXECUTE granted to PUBLIC
Source {ORACLE_HOME}/mdsys/admin/opgapih.sql
{ORACLE_HOME}/mdsys/admin/opgapih.plb
Subprograms
ADD_INDEX_METADATA_ORATEXT FIND_SP
ANALYZE_PG FIND_SP_CLEANUP
CF FIND_SP_PREP
CF_CLEANUP GET_BUILD_ID
CF_PREP GET_GEOMETRY_FROM_V_COL
CLEAR_PG GET_GEOMETRY_FROM_V_T_COLS
CLEAR_PG_INDICES GET_LATLONG_FROM_V_COL
CLONE_GRAPH GET_LATLONG_FROM_V_T_COLS
COUNT_TRIANGLE GET_LONGLAT_FROM_V_COL
COUNT_TRIANGLE_CLEANUP GET_LONGLAT_FROM_V_T_COLS
COUNT_TRIANGLE_PREP GET_LONG_LAT_GEOMETRY
COUNT_TRIANGLE_RENUM GET_OPG_VERSION
CREATE_EDGES_TEXT_IDX GET_SCN
CREATE_PG GET_VERSION
CREATE_PG_SNAPSHOT_TAB GET_WKTGEOMETRY_FROM_V_COL
CREATE_PG_TEXTIDX_TAB GET_WKTGEOMETRY_FROM_V_T_COLS
CREATE_STAT_TABLE GRANT_ACCESS
CREATE_SUB_GRAPH IMP_EDGE_TAB_STATS
CREATE_VERTICES_TEXT_IDX IMP_VERTEX_TAB_STATS
DELETE_INDEX_METADATA MIGRATE_PG_TO_CURRENT
DELETE_INDEX_METADATA_KEY PR
DROP_EDGES_TEXT_IDX PREPARE_TEXT_INDEX
DROP_PG PR_CLEANUP
DROP_PG_VIEW PR_PREP
DROP_VERTICES_TEXT_IDX RENAME_PG
ESTIMATE_TRIANGLE_RENUM REVOKE_ACCESS
EXP_EDGE_TAB_STATS SPARSIFY_GRAPH
EXP_VERTEX_TAB_STATS SPARSIFY_GRAPH_CLEANUP
FIND_CC_MAPPING_BASED SPARSIFY_GRAPH_PREP
FIND_CLUSTERS_CLEANUP TRUNCATE_AND_DROP_IGNORE
FIND_CLUSTERS_PREP VALIDATE_NAME
 
ADD_INDEX_METADATA_ORATEXT
Adds the metadata information from an Oracle Text index into the IT$ table opg_apis.add_index_metadata_oratext(
indexName    IN NVARCHAR2,
entityType   IN INT,
indexType    IN INT,
searchEngine IN INT,
strKey       IN NVARCHAR2,
prefOwner    IN NVARCHAR2,
datastore    IN NVARCHAR2,
filter       IN NVARCHAR2,
storage      IN NVARCHAR2,
wordlist     IN NVARCHAR2,
stoplist     IN NVARCHAR2,
lexer        IN NVARCHAR2,
options      IN NVARCHAR2,
graph_owner  IN NVARCHAR2,
graph_name   IN NVARCHAR2);
TBD
 
ANALYZE_PG
Gathers statistics for the VT$, GE$, IT$, and GT$ tables from a graph

Overload 1		 opg_apis.analyze_pg(
graph_name       IN VARCHAR2,
estimate_percent IN NUMBER,
method_opt       IN VARCHAR2,
degree           IN NUMBER,
cascade          IN BOOLEAN,
no_invalidate    IN BOOLEAN,
force            IN BOOLEAN DEFAULT FALSE);
TBD
Overload 2 opg_apis.analyze_pg(
graph_name       IN VARCHAR2,
estimate_percent IN NUMBER,
method_opt       IN VARCHAR2,
degree           IN NUMBER,
cascade          IN BOOLEAN,
no_invalidate    IN BOOLEAN,
force            IN BOOLEAN  DEFAULT FALSE,
options          IN VARCHAR2 DEFAULT 'GATHER');
TBD
Overload 3 opg_apis.analyze_pg(
graph_name       IN VARCHAR2,
degree           IN NUMBER,
cascade          IN BOOLEAN,
no_invalidate    IN BOOLEAN,
force            IN BOOLEAN  DEFAULT FALSE);
TBD
Overload 4 opg_apis.analyze_pg(
graph_name       IN VARCHAR2,
degree           IN NUMBER,
cascade          IN BOOLEAN,
no_invalidate    IN BOOLEAN,
force            IN BOOLEAN  DEFAULT FALSE,
options          IN VARCHAR2 DEFAULT 'GATHER');
TBD
 
CF
Runs collaborative filtering on a graph using matrix factorization opg_apis.cf(
edge_tab_name   IN     VARCHAR2,
edge_label      IN     VARCHAR2,
rating_property IN     VARCHAR2,
iterations      IN     INTEGER  DEFAULT 10,
min_error       IN     NUMBER   DEFAULT 0.001,
k               IN     INTEGER  DEFAULT 5,
learning_rate   IN     NUMBER   DEFAULT 0.0002,
decrease_rate   IN     NUMBER   DEFAULT 0.95,
regularization  IN     NUMBER   DEFAULT 0.02,
dop             IN     NUMBER   DEFAULT 8,
wt_l            IN OUT VARCHAR2,
wt_r            IN OUT VARCHAR2,
wt_l1           IN OUT VARCHAR2,
wt_r1           IN OUT VARCHAR2,
wt_i            IN OUT VARCHAR2,
wt_ld           IN OUT VARCHAR2,
wt_rd           IN OUT VARCHAR2,
tbs             IN     VARCHAR2 DEFAULT NULL,
options         IN     VARCHAR2 DEFAULT NULL);
TBD
 
CF_CLEANUP
Performs cleanup work after graph collaborative filtering is completed opg_apis.cf_cleanup(
edge_tab_name IN     VARCHAR2,
wt_l          IN OUT VARCHAR2,
wt_r          IN OUT VARCHAR2,
wt_l1         IN OUT VARCHAR2,
wt_r1         IN OUT VARCHAR2,
wt_i          IN OUT VARCHAR2,
wt_ld         IN OUT VARCHAR2,
wt_rd         IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
CF_PREP
Performs preparation work, including creating intermediate tables, for a later call to the OPG_APIS.CF opg_apis.cf_prep(
edge_tab_name IN     VARCHAR2,
wt_l          IN OUT VARCHAR2,
wt_r          IN OUT VARCHAR2,
wt_l1         IN OUT VARCHAR2,
wt_r1         IN OUT VARCHAR2,
wt_i          IN OUT VARCHAR2,
wt_ld         IN OUT VARCHAR2,
wt_rd         IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
CLEAR_PG
Clears all data from a property graph opg_apis.clear_pg(graph_name IN VARCHAR2);
TBD
 
CLEAR_PG_INDICES
Removes all text index metadata in the IT$ table of the property graph opg_apis.clear_pg_indices(graph_name IN VARCHAR2);
TBD
 
CLONE_GRAPH
Makes a clone of the original graph, giving the new graph a new name opg_apis.clone_graph(
orgGraph      IN VARCHAR2,
newGraph      IN VARCHAR2,
dop           IN INTEGER  DEFAULT 4,
num_hash_ptns IN INTEGER  DEFAULT 8,
tbs           IN VARCHAR2 DEFAULT NULL,
options       IN VARCHAR2 DEFAULT NULL);
TBD
 
COUNT_TRIANGLE
Performs triangle counting in a property graph opg_apis.count_triangle(
edge_tab_name IN VARCHAR2,
wt_und        IN VARCHAR2,
num_sub_ptns  IN INTEGER  DEFAULT 1,
dop           IN INTEGER  DEFAULT 1,
tbs           IN VARCHAR2 DEFAULT NULL,
options       IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
TBD
 
COUNT_TRIANGLE_CLEANUP
Cleans up and drops the temporary working tables used for triangle counting opg_apis.count_triangle_cleanup(
edge_tab_name IN     VARCHAR2,
wt_undBM      IN OUT VARCHAR2,
wt_rnmap      IN OUT VARCHAR2,
wt_undAM      IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
COUNT_TRIANGLE_PREP
Prepares for running triangle counting opg_apis.count_triangle_prep(
edge_tab_name IN     VARCHAR2,
wt_undBM      IN OUT VARCHAR2,
wt_rnmap      IN OUT VARCHAR2,
wt_undAM      IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
COUNT_TRIANGLE_RENUM
Performs triangle counting with the optimization of reNUMBERing the vertices by their degree opg_apis.count_triangle_renum(
edge_tab_name IN VARCHAR2,
wt_undBM      IN VARCHAR2,
wt_rnmap      IN VARCHAR2,
wt_undAM      IN VARCHAR2,
num_sub_ptns  IN INTEGER  DEFAULT 1,
dop           IN INTEGER  DEFAULT 1,
tbs           IN VARCHAR2 DEFAULT NULL,
options       IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
TBD
 
CREATE_EDGES_TEXT_IDX
Creates a text index on a property graph edge table opg_apis.create_edges_text_idx(
graph_owner IN VARCHAR2,
graph_name  IN VARCHAR2,
pref_owner  IN VARCHAR2 DEFAULT NULL,
datastore   IN VARCHAR2 DEFAULT NULL,
filter      IN VARCHAR2 DEFAULT NULL,
storage     IN VARCHAR2 DEFAULT NULL,
wordlist    IN VARCHAR2 DEFAULT NULL,
stoplist    IN VARCHAR2 DEFAULT NULL,
lexer       IN VARCHAR2 DEFAULT NULL,
dop         IN INTEGER  DEFAULT NULL,
options     IN VARCHAR2 DEFAULT NULL);
TBD
 
CREATE_PG
Creates the property graph schema tables required to store data about vertices, edges, text indexes, and snapshots

Overload 1		 opg_apis.create_pg(
graph_name    IN VARCHAR2,
dop           IN INTEGER  DEFAULT NULL,
num_hash_ptns IN INTEGER  DEFAULT 8,
tbs           IN VARCHAR2 DEFAULT NULL,
options       IN VARCHAR2 DEFAULT NULL);
TBD
Overload 2 opg_apis.create_pg(
graph_owner   IN VARCHAR2,
graph_name    IN VARCHAR2,
dop           IN INTEGER  DEFAULT NULL,
num_hash_ptns IN INTEGER  DEFAULT 8,
tbs           IN VARCHAR2 DEFAULT NULL,
tbs_set       IN VARCHAR2 DEFAULT NULL,
options       IN VARCHAR2 DEFAULT NULL);
TBD
Overload 3 opg_apis.create_pg(
graph_owner   IN VARCHAR2,
graph_name    IN VARCHAR2,
dop           IN INTEGER  DEFAULT NULL,
num_hash_ptns IN INTEGER  DEFAULT 8,
tbs           IN VARCHAR2 DEFAULT NULL,
options       IN VARCHAR2 DEFAULT NULL);
TBD
 
CREATE_PG_SNAPSHOT_TAB
Creates the property graph schema table (<graph_name>SS$) snapshot metadata

Overload 1		 opg_apis.create_pg_snapshot_tab(
graph_name IN VARCHAR2,
dop        IN INTEGER  DEFAULT NULL,
tbs        IN VARCHAR2 DEFAULT NULL,
options    IN VARCHAR2 DEFAULT NULL);
TBD
Overload 2 opg_apis.create_pg_snapshot_tab(
graph_owner IN VARCHAR2,
graph_name  IN VARCHAR2,
dop         IN INTEGER  DEFAULT NULL,
tbs         IN VARCHAR2 DEFAULT NULL,
options     IN VARCHAR2 DEFAULT NULL);
TBD
 
CREATE_PG_TEXTIDX_TAB
Creates the necessary property graph text index schema table (<graph_name>IT$) to store text index metadata

Overload 1		 opg_apis.create_pg_textidx_tab(
graph_name IN VARCHAR2,
dop        IN INTEGER  DEFAULT NULL,
tbs        IN VARCHAR2 DEFAULT NULL,
options    IN VARCHAR2 DEFAULT NULL);
TBD
Overload 2 opg_apis.create_pg_textidx_tab(
graph_owner IN VARCHAR2,
graph_name  IN VARCHAR2,
dop         IN INTEGER  DEFAULT NULL,
tbs         IN VARCHAR2 DEFAULT NULL,
options     IN VARCHAR2 DEFAULT NULL);
TBD
 
CREATE_STAT_TABLE
Creates a table to store property graph statistics opg_apis.create_stat_table(
stattab  IN VARCHAR2,
tblspace IN VARCHAR2 DEFAULT NULL);
TBD
 
CREATE_SUB_GRAPH
Creates a subgraph, which is an expansion from a given vertex opg_apis.create_sub_graph(
graph_owner  IN VARCHAR2,
orgGraph     IN VARCHAR2,
newGraph     IN VARCHAR2,
nSrc         IN NUMBER,
depth        IN INTEGER,
dop          IN INTEGER  DEFAULT 4,
nPQThreshold IN INTEGER  DEFAULT 10000,
tbs          IN VARCHAR2 DEFAULT NULL,
options      IN VARCHAR2 DEFAULT NULL);
TBD
 
CREATE_VERTICES_TEXT_IDX
Creates a text index on a property graph vertex table opg_apis.create_vertices_text_idx(
graph_owner IN VARCHAR2,
graph_name  IN VARCHAR2,
pref_owner  IN VARCHAR2 DEFAULT NULL,
datastore   IN VARCHAR2 DEFAULT NULL,
filter      IN VARCHAR2 DEFAULT NULL,
storage     IN VARCHAR2 DEFAULT NULL,
wordlist    IN VARCHAR2 DEFAULT NULL,
stoplist    IN VARCHAR2 DEFAULT NULL,
lexer       IN VARCHAR2 DEFAULT NULL,
dop         IN INTEGER  DEFAULT NULL,
options     IN VARCHAR2 DEFAULT NULL);
TBD
 
DELETE_INDEX_METADATA
Deletes metadata information of the given Text index from the IT$ table opg_apis.delete_index_metadata(
indexName   IN NVARCHAR2,
graph_owner IN NVARCHAR2,
graph_name  IN NVARCHAR2);
TBD
 
DELETE_INDEX_METADATA_KEY
Deletes metadata information of the given Text index from the IT$ table opg_apis.delete_index_metadata_key(
indexName   IN NVARCHAR2,
strKey      IN NVARCHAR2,
graph_owner IN NVARCHAR2,
graph_name  IN NVARCHAR2);
TBD
 
DROP_EDGES_TEXT_IDX
Drops a text index on a property graph edge table opg_apis.drop_edges_text_idx(
graph_owner IN VARCHAR2,
graph_name  IN VARCHAR2,
options     IN VARCHAR2 DEFAULT NULL);
TBD
 
DROP_PG (new 23ai overload)
Deletes a property graph

Overload 1		 opg_apis.drop_pg(graph_name IN VARCHAR2);
TBD
Overload 2 opg_apis.drop_pg(
graph_name IN VARCHAR2,
options    IN VARCHAR2);
TBD
Overload 3 opg_apis.drop_pg(
graph_owner IN VARCHAR2),
graph_name  IN VARCHAR2,
options     IN VARCHAR2);
TBD
 
DROP_PG_VIEW
Deletes the view definition of a property graph opg_apis.drop_pg_view(
graph_name IN VARCHAR2,
options    IN VARCHAR2);
TBD
 
DROP_VERTICES_TEXT_IDX
Drops a text index on a property graph vertex table opg_apis.drop_vertices_text_idx(
graph_owner IN VARCHAR2,
graph_name  IN VARCHAR2,
options     IN VARCHAR2 DEFAULT NULL);
TBD
 
ESTIMATE_TRIANGLE_RENUM
Estimates the number of triangles in a property graph opg_apis.estimate_triangle_renum(
edge_tab_name IN VARCHAR2,
wt_undBM      IN VARCHAR2,
wt_rnmap      IN VARCHAR2,
wt_undAM      IN VARCHAR2,
num_sub_ptns  IN INTEGER  DEFAULT 1,
chunk_id      IN INTEGER  DEFAULT 1,
dop           IN INTEGER  DEFAULT 1,
tbs           IN VARCHAR2 DEFAULT NULL,
options       IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
TBD
 
EXP_EDGE_TAB_STATS
Retrieves statistics for the edge table of a given property graph and stores them in the user-created statistics table opg_apis.exp_edge_tab_stats(
graph_name    IN VARCHAR2,
stattab       IN VARCHAR2,
statid        IN VARCHAR2 DEFAULT NULL,
cascade       IN BOOLEAN  DEFAULT TRUE,
statown       IN VARCHAR2 DEFAULT NULL,
stat_category IN VARCHAR2 DEFAULT 'OBJECT_STATS');
TBD
 
EXP_VERTEX_TAB_STATS
Retrieves statistics for the vertex table of a given property graph and stores them in the user-created statistics table opg_apis.exp_vertex_tab_stats(
graph_name    IN VARCHAR2,
stattab       IN VARCHAR2,
statid        IN VARCHAR2 DEFAULT NULL,
cascade       IN BOOLEAN  DEFAULT TRUE,
statown       IN VARCHAR2 DEFAULT NULL,
stat_category IN VARCHAR2 DEFAULT 'OBJECT_STATS'
TBD
 
FIND_CC_MAPPING_BASED
Finds connected components in a property graph and stores them in the wt_clusters table opg_apis.find_cc_mapping_based(
edge_tab_name IN     VARCHAR2,
wt_clusters   IN OUT VARCHAR2,
wt_undir      IN OUT VARCHAR2,
wt_cluas      IN OUT VARCHAR2,
wt_newas      IN OUT VARCHAR2,
wt_delta      IN OUT VARCHAR2,
dop           IN     INTEGER  DEFAULT 4,
rounds        IN     INTEGER  DEFAULT 0, -- continue until all components found
tbs           IN     VARCHAR2 DEFAULT NULL,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
FIND_CLUSTERS_CLEANUP
Cleans up after running weakly connected components (WCC) cluster detection opg_apis.find_clusters_cleanup(
edge_tab_name IN     VARCHAR2,
wt_clusters   IN OUT VARCHAR2,
wt_undir      IN OUT VARCHAR2,
wt_cluas      IN OUT VARCHAR2,
wt_newas      IN OUT VARCHAR2,
wt_delta      IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
FIND_CLUSTERS_PREP
Prepares for running weakly connected components (WCC) cluster detection opg_apis.find_clusters_prep(
edge_tab_name IN     VARCHAR2,
wt_clusters   IN OUT VARCHAR2,
wt_undir      IN OUT VARCHAR2,
wt_cluas      IN OUT VARCHAR2,
wt_newas      IN OUT VARCHAR2,
wt_delta      IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
FIND_SP
Finds the shortest path between given source vertex and destination vertex in the property graph opg_apis.find_sp(
edge_tab_name  IN  VARCHAR2,
source         IN  NUMBER,
dest           IN  NUMBER,
exp_tab        IN  VARCHAR2,
dop            IN  INTEGER,
stats_freq     IN  INTEGER  DEFAULT 20000,
path_output    OUT VARCHAR2,
weights_output OUT VARCHAR2,
options        IN  VARCHAR2 DEFAULT NULL,
scn            IN  NUMBER   DEFAULT NULL);
TBD
 
FIND_SP_CLEANUP
Cleans up after running one or more shortest path calculations opg_apis.find_sp_cleanup(
edge_tab_name IN     VARCHAR2,
exp_tab       IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
FIND_SP_PREP
Prepares for shortest path calculations opg_apis.find_sp_prep(
edge_tab_name IN     VARCHAR2,
exp_tab       IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
GET_BUILD_ID
Returns the build ID of the Oracle Spatial and Graph property graph support, in YYYYMMDD format

Note: The demo at right was run in 23.8		 opg_apis.get_build_id RETURN VARCHAR2;
SELECT opg_apis.get_build_id;

GET_BUILD_ID
-------------
20180710
 
GET_GEOMETRY_FROM_V_COL
Returns an SDO_GEOMETRY object constructed using spatial data and optionally an SRID value opg_apis.get_geometry_from_v_col(
v    IN NVARCHAR2,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DETERMINISTIC PARALLEL_ENABLE;
TBD
 
GET_GEOMETRY_FROM_V_T_COLS
Returns an SDO_GEOMETRY object constructed using spatial data, a type value, and optionally an SRID value opg_apis.get_geometry_from_v_t_cols(
v    IN NVARCHAR2,
t    IN INT,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DETERMINISTIC PARALLEL_ENABLE;
TBD
 
GET_LATLONG_FROM_V_COL
Returns an SDO_GEOMETRY object constructed using spatial data and optionally an SRID value opg_apis.get_latlong_from_v_col(
v    IN NVARCHAR2,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DETERMINISTIC PARALLEL_ENABLE;
TBD
 
GET_LATLONG_FROM_V_T_COLS
Returns an SDO_GEOMETRY object constructed using spatial data, a type value, and optionally an SRID value opg_apis.get_latlong_from_v_t_cols(
v    IN NVARCHAR2,
t    IN INT,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DETERMINISTIC PARALLEL_ENABLE;
TBD
 
GET_LONGLAT_FROM_V_COL
Returns an SDO_GEOMETRY object constructed using spatial data, a type value, and optionally anSRID value opg_apis.get_longlat_from_v_col(
v    IN NVARCHAR2,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DETERMINISTIC PARALLEL_ENABLE;
TBD
 
GET_LONGLAT_FROM_V_T_COLS
Returns an SDO_GEOMETRY object constructed using spatial data, a type value, and optionally an SRID value opg_apis.get_longlat_from_v_t_cols(
v    IN NVARCHAR2,
t    IN INT,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DETERMINISTIC PARALLEL_ENABLE;
TBD
 
GET_LONG_LAT_GEOMETRY
Returns an SDO_GEOMETRY object constructed using X and Y point coordinate values, and optionally an SRID value opg_apis.get_long_lat_geometry(
x    IN NUMBER,
y    IN NUMBER,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DETERMINISTIC PARALLEL_ENABLE;
TBD
 
GET_OPG_VERSION (new 23ai)
Undocumented opg_apis.get_opt_version;
SELECT opg_apis.get_opt_version;

GET_OPG_VERSION
----------------
23.3
 
GET_SCN
Returns the current System Change Number: The online documentation is incorrect. opg_apis.get_scn RETURN NUMBER
SELECT mdsys.opg_apis.get_scn;

   GET_SCN
----------
 111700386

SELECT mdsys.opg_apis.get_scn;

   GET_SCN
----------
 111700502
 
GET_VERSION
Returns the current version of the Oracle Spatial and Graph property graph support

Note: The demo at right was run in 23.8		 opg_apis.get_version RETURN VARCHAR2;
SELECT opg_apis.get_version;

GET_VERSION
------------
19.1.0.1 P1
 
GET_WKTGEOMETRY_FROM_V_COL
Returns an SDO_GEOMETRY object based on a geometry in WKT form and optionally an SRID opg_apis.get_wktgeometry_from_v_col(
v    IN NVARCHAR2,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DEGTERMINISTIC PARALLEL_ENABLE;
TBD
 
GET_WKTGEOMETRY_FROM_V_T_COLS
Returns an SDO_GEOMETRY object based on a geometry in WKT (well known text) form, a type value, and optionally an SRID opg_apis.get_wktgeometry_from_v_t_cols(
v    IN NVARCHAR2,
t    IN INT,
srid IN NUMBER DEFAULT 8307)
RETURN mdsys.sdo_geometry DETERMINISTIC PARALLEL_ENABLE;
TBD
 
GRANT_ACCESS
Grants access privileges on a property graph to another database user -- The privilege argument can contain a mix of 'R', 'S', 'I', 'D', or 'U' (Read, Select, Insert, Delete, and Update)

opg_apis.grant_access(
graph_owner IN VARCHAR2,
graph_name  IN VARCHAR2,
other_user  IN VARCHAR2,
privilege   IN VARCHAR2);
TBD
 
IMP_EDGE_TAB_STATS
Retrieves graph edge table (GE$) statistics from the user statistics table identified by stattab and stores them in the dictionary imported opg_apis.imp_edge_tab_stats(
graph_name    IN VARCHAR2,
stattab       IN VARCHAR2,
statid        IN VARCHAR2 DEFAULT NULL,
cascade       IN BOOLEAN  DEFAULT TRUE,
statown       IN VARCHAR2 DEFAULT NULL,
no_invalidate IN BOOLEAN  DEFAULT FALSE,
force         IN BOOLEAN  DEFAULT FALSE,
stat_category IN VARCHAR2 DEFAULT 'OBJECT_STATS');
TBD
 
IMP_VERTEX_TAB_STATS
Retrieves graph edge table (VT$) statistics from the user statistics table identified by stattab and stores them in the dictionary imported opg_apis.imp_vertex_tab_stats(
graph_name    IN VARCHAR2,
stattab       IN VARCHAR2,
statid        IN VARCHAR2 DEFAULT NULL,
cascade       IN BOOLEAN  DEFAULT TRUE,
statown       IN VARCHAR2 DEFAULT NULL,
no_invalidate IN BOOLEAN  DEFAULT FALSE,
force         IN BOOLEAN  DEFAULT FALSE,
stat_category IN VARCHAR2 DEFAULT 'OBJECT_STATS');
TBD
 
MIGRATE_PG_TO_CURRENT (new 23ai)
Undocumented

Overload 1		 opg_apis.migrate_pg_to_current(
graph_name    IN VARCHAR2,
dop           IN NUMBER,
num_hash_ptns IN NUMBER,
tbs           IN VARCHAR2,
options       IN VARCHAR2);
TBD
Overload 2 opg_apis.migrate_pg_to_current(
graph_owner   IN VARCHAR2,
graph_name    IN VARCHAR2,
dop           IN NUMBER,
num_hash_ptns IN NUMBER,
tbs           IN VARCHAR2,
tbs_set       IN VARCHAR2,
options       IN VARCHAR2);
TBD
Overload 3 opg_apis.migrate_pg_to_current(
graph_owner   IN VARCHAR2,
graph_name    IN VARCHAR2,
dop           IN NUMBER,
num_hash_ptns IN NUMBER,
tbs           IN VARCHAR2,
options       IN VARCHAR2);
TBD
 
PR
Prepares for page rank calculations opg_apis.pr(
edge_tab_name   IN     VARCHAR2,
d               IN     NUMBER  DEFAULT 0.85,
num_iterations  IN     NUMBER  DEFAULT 10,
convergence     IN     NUMBER  DEFAULT 0.1,
dop             IN     INTEGER DEFAULT 4,
wt_node_pr      IN OUT VARCHAR2,
wt_node_nextpr  IN OUT VARCHAR2,
wt_edge_tab_deg IN OUT VARCHAR2,
wt_delta        IN OUT VARCHAR2,
tablespace      IN     VARCHAR2 DEFAULT NULL,
options         IN     VARCHAR2 DEFAULT NULL,
num_vertices       OUT NUMBER);
TBD
 
PREPARE_TEXT_INDEX
Performs preparatory work needed before a text index can be created on any NVARCHAR2 columns opg_apis.prepare_text_index;
exec opg_apis.prepare_text_index;

PL/SQL procedure successfully completed.
 
PR_CLEANUP
Performs cleanup after performing page rank calculations opg_apis.pr_cleanup(
edge_tab_name   IN     VARCHAR2,
wt_node_pr      IN OUT VARCHAR2,
wt_node_nextpr  IN OUT VARCHAR2,
wt_edge_tab_deg IN OUT VARCHAR2,
wt_delta        IN OUT VARCHAR2,
options         IN     VARCHAR2 DEFAULT NULL);
TBD
 
PR_PREP
Prepares for page rank calculations opg_apis.pr_prep(
edge_tab_name   IN     VARCHAR2,
wt_node_pr      IN OUT VARCHAR2,
wt_node_nextpr  IN OUT VARCHAR2,
wt_edge_tab_deg IN OUT VARCHAR2,
wt_delta        IN OUT VARCHAR2,
options         IN     VARCHAR2 DEFAULT NULL);
TBD
 
RENAME_PG
Renames a property graph opg_apis.rename_pg(
graph_name     IN VARCHAR2,
new_graph_name IN VARCHAR2);
TBD
 
REVOKE_ACCESS
Revokes access to a property graph from another user opg_apis.revoke_access(
graph_owner IN VARCHAR2,
graph_name  IN VARCHAR2,
other_user  IN VARCHAR2,
privilege   IN VARCHAR2);
TBD
 
SPARSIFY_GRAPH
Performs sparsification (edge trimming) for a property graph edge table opg_apis.sparsify_graph(
edge_tab_name IN     VARCHAR2,
threshold     IN     NUMBER  DEFAULT 0.5,
min_keep      IN     INTEGER DEFAULT 1,
dop           IN     INTEGER DEFAULT 4,
wt_out_tab    IN OUT VARCHAR2,
wt_und_tab    IN OUT VARCHAR2,
wt_hsh_tab    IN OUT VARCHAR2,
wt_mch_tab    IN OUT VARCHAR2,
tbs           IN     VARCHAR2 DEFAULT NULL,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
SPARSIFY_GRAPH_CLEANUP
Cleans up after sparsification (edge trimming) for a property graph edge table opg_apis.sparsify_graph_cleanup(
edge_tab_name IN     VARCHAR2,
wt_out_tab    IN OUT VARCHAR2,
wt_und_tab    IN OUT VARCHAR2,
wt_hsh_tab    IN OUT VARCHAR2,
wt_mch_tab    IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
SPARSIFY_GRAPH_PREP
Prepares working table names that are necessary to run sparsification for a property graph edge table opg_apis.sparsify_graph_prep(
edge_tab_name IN     VARCHAR2,
wt_out_tab    IN OUT VARCHAR2,
wt_und_tab    IN OUT VARCHAR2,
wt_hsh_tab    IN OUT VARCHAR2,
wt_mch_tab    IN OUT VARCHAR2,
options       IN     VARCHAR2 DEFAULT NULL);
TBD
 
TRUNCATE_AND_DROP_IGNORE
Undocumented opg_apis.truncate_and_drop_ignore(
tname    IN VARCHAR2,
err_code IN NUMBER);
TBD
 
VALIDATE_NAME
Undocumented opg_apis.validate_name(s IN VARCHAR2) RETURN VARCHAR2;
TBD

Related Topics
Built-in Functions
Built-in Packages
Database Security
OPG_GRAPHOP
What's New In 21c
What's New In 26ai

Morgan's Library Page Footer
This site is maintained by Daniel Morgan. Last Updated: This site is protected by copyright and trademark laws under U.S. and International law. © 1998-2026 Daniel A. Morgan All Rights Reserved