Oracle DBMS_GSM_COMMON
Version 12.2.0.1

General Information
Library Note Morgan's Library Page Header
Are you prepared for the release of Oracle Database 18c ... the first autonomous database? We are here at the Library. It is time for DBAs to stop fighting robots with their fingers and losing ... time to start using our intelligence and winning.
Purpose Global Service Manager Validation Utilities. The package header refers to it as "DBMS package for GWM fixed operations"
AUTHID DEFINER
Constants
Name Data Type Value
Set GSM Parameter Constants
add_gsms NUMBER 0
replace_all_gsms NUMBER 1
remove_gsms NUMBER 2
modify_gsms NUMBER 3
Set Region List Parameter Constants
add_regions NUMBER 0
remove_regions NUMBER 1
modify_regions NUMBER 2
Dependencies
DBMS_GSM_ALERTS EXECASUSER PARAM_VALUE_LIST_T
DBMS_GSM_CLOUDADMIN EXECUTEDDL PARAM_VALUE_T
DBMS_GSM_COMMON_LIB EXEC_SQL PLITBLM
DBMS_GSM_DBADMIN GSM_LIST_T RAC_INSTANCE_T
DBMS_GSM_FIXED GSM_T REGION
DBMS_GSM_POOLADMIN GV_$DATABASE REGION_LIST_T
DBMS_GSM_UTILITY INSTANCE_LIST REGION_T
DBMS_LOB LOCAL_CHUNKS UTL_RAW
DBMS_UTILITY LOCAL_CHUNK_TYPES V_$PARAMETER2
DBPARAMS_LIST MESSAGE_PARAM_LIST V_$VERSION
DBPARAMS_T    
Documented No
First Available 12.2.0.1
Security Model Owned by GSMADMIN_INTERNAL with EXECUTE granted to GGSYS, GSMADMIN_ROLE, GSM_POOLADMIN_ROLE, SYSDG,
Source {ORACLE_HOME}/rdbms/admin/dbmsgwmco.sql

See also catgwmcat.sql
Subprograms
 
CHECKDBCOMPAT (new 12.2)
Check that database level is compatible with GDS dbms_gsm_common.checkDBCompat RETURN BOOLEAN;
BEGIN
  IF gsmadmin_internal.dbms_gsm_common.checkDBCompat THEN
    dbms_output.put_line('This database is compatible');
  ELSE
    dbms_output.put_line('This database is not compatible');
  END IF;
END;
/
 
CHUNKLOWHIGH (new 12.2)
Undocumented dbms_gsm_common.chunkLowHigh(
chunk_counter IN  BINARY_INTEGER,
total_chunks  IN  BINARY_INTEGER,
chunk_low     OUT NUMBER,
chunk_high    OUT NUMBER);
TBD
 
CLOBTOTRACE (new 12.2)
Reformats a CLOB as a trace dbms_gsm_common.clobToTrace(phrase IN CLOB) RETURN VARCHAR2;
SQL> SELECT gsmadmin_internal.dbms_gsm_common.clobToTrace('This is a test of the emergency formatting system')
  2  FROM dual;

GSMADMIN_INTERNAL.DBMS_GSM_COMMON.CLOBTOTRACE('THISISATESTOFTHETRACEFORMATTINGSYSTEM')
------------------------------------------------------------------------------------------
This is a test of the trace formatting system
 
DBISDOWNGRADEABLE (new 12.2)
Returns TRUE if the database downgradeable: Otherwise FALSE dbms_gsm_common.DBisDowngradeable RETURN BOOLEAN;
BEGIN
  IF gsmadmin_internal.dbms_gsm_common.DBisDowngradeable THEN
    dbms_output.put_line('This database can be downgraded');
  ELSE
    dbms_output.put_line('This database can not be downgraded');
  END IF;
END;
/
 
EXISTGSM (new 12.2)
Checks if a gsm_alias already in the _gsm parameter on a database dbms_gsm_common.existGSM(gsm_alias IN VARCHAR2) RETURN BOOLEAN;
BEGIN
  IF gsmadmin_internal.dbms_gsm_common.existGSM('ZZYZX') THEN
    dbms_output.put_line('Alias Exists');
  ELSE
    dbms_output.put_line('Alias Does Not Exist');
  END IF;
END;
/
 
GETDBPARAMETERNUM (new 12.2)
Undocumented dbms_gsm_common.getDBParameterNum(
pname IN VARCHAR2,
pno   IN BINARY_INTEGER)
RETURN BINARY_INTEGER;
SELECT gsmadmin_internal.dbms_gsm_common.getDBParameterNum('_db_num_gsm', 1)
FROM dual;
 
GETDBPARAMETERSTR (new 12.2)
Undocumented dbms_gsm_common.getDBParameterStr(
pname IN VARCHAR2,
pno   IN BINARY_INTEGER)
RETURN VARCHAR2;
SELECT gsmadmin_internal.dbms_gsm_common.getDBParameterStr('_shardgroup_name', 1)
FROM dual;
 
GETMSG (new 12.2)
Returns the message text given message number and parameters dbms_gsm_common.getMsg(
message_NUMBER IN  BINARY_INTEGER,
message_text   OUT VARCHAR2,
params         IN  message_param_list DEFAULT message_param_list());
TBD
 
GSM_LIST_TO_GSM_PARAMS (new 12.2)
Undocumented dbms_gsm_common.gsm_list_to_gsm_params(
gsm_list   IN  gsm_list_t,
gsm_params OUT param_value_list_t);
TBD
 
GSM_PARAMS_TO_GSM_LIST (new 12.2)
Undocumented dbms_gsm_common.gsm_params_to_gsm_list(gsm_list OUT gsm_list_t);
TBD
 
GWMFACTOR (new 12.2)
Factoring. Is GDS licensed? (currently requires enterprise edition) dbms_gsm_common.gwmFactor;
exec gsmadmin_internal.dbms_gsm_common.gwmFactor;
 
GWMSUBNET (new 12.2)
Get subnet string for this host (RAC only) dbms_gsm_common.gwmSubnet(subnet OUT VARCHAR2);
DECLARE
 outVal VARCHAR2(30);
BEGIN
  gsmadmin_internal.dbms_gsm_common.gwmSubnet(outVal);
  dbms_output.put_line(outVal);
END;
/
 
INST_LIST_TO_INST_STRING (new 12.2)
Converts an instance_list to string format dbms_gsm_common.inst_list_to_inst_string(instances IN instance_list)
RETURN VARCHAR2;
TBD
 
ISCDB (new 12.2)
Returns TRUE if the database is a CDB dbms_gsm_common.isCDB RETURN BOOLEAN;
BEGIN
  IF gsmadmin_internal.dbms_gsm_common.isCDB THEN
    dbms_output.put_line('The database is a CDB');
  ELSE
    dbms_output.put_line('The database is not a CDB');
  END IF;
END;
/
 
ISGWMTRACING (new 12.2)
Checks if GWM module tracing is enabled dbms_gsm_common.isGWMTracing RETURN BOOLEAN;
BEGIN
  IF gsmadmin_internal.dbms_gsm_common.isGWMTracing THEN
    dbms_output.put_line('The database is Tracing');
  ELSE
    dbms_output.put_line('The database is not Tracing');
  END IF;
END;
/
 
NUM2LINEAR (new 12.2)
Convert numbers to a linear key representation dbms_gsm_common.num2linear(x IN NUMBER) RETURN BLOB;
TBD
 
PARAMS_TO_DBPARAM_LIST (new 12.2)
Converts params string in NVP format to dbparams_list type dbms_gsm_common.params_to_dbparam_list(
params   IN  VARCHAR2,
dbname   OUT VARCHAR2,
dbparams OUT dbparams_list)
RETURN BOOLEAN;
TBD
 
REGION_PARAMS_TO_REGION_LIST (new 12.2)
Return a the regions parameters in the regions list type dbms_gsm_common.region_params_to_region_list(region_list OUT region_list_t);
TBD
 
REREGISTERDB (new 12.2)
Re-registers database with GSM listeners after some change dbms_gsm_common.reregisterDB;
exec gsmadmin_internal.dbms_gsm_common.reregisterDB;
 
RESETDBPARAMETER (new 12.2)
Resets a GSM parameter dbms_gsm_common.resetDBParameter(pname IN VARCHAR2);
TBD
 
SERVICECHANGE (new 12.2)
Signal a service change for registration dbms_gsm_common.serviceChange;
exec gsmadmin_internal.dbms_gsm_common.serviceChange;
 
SETDBPARAMETER (new 12.2)
Sets a GSM parameter in the database

Overload 1
dbms_gsm_common.setDBParameter(
pname  IN VARCHAR2,
pvalue IN VARCHAR2)
ACCESSIBLE BY (PACKAGE dbms_gsm_dbadmin,
               PACKAGE dbms_gsm_pooladmin,
               PACKAGE dbms_gsm_common,
               PACKAGE dbms_gsm_cloudadmin,
               PACKAGE ggsys.ggsharding);
TBD
Overload 2 dbms_gsm_common.setDBParameter(
pname   IN VARCHAR2,
pvalues IN region_list_t)
ACCESSIBLE BY (PACKAGE dbms_gsm_dbadmin,
               PACKAGE dbms_gsm_pooladmin,
               PACKAGE dbms_gsm_common,
               PACKAGE dbms_gsm_cloudadmin,
               PACKAGE ggsys.ggsharding);
TBD
Overload 3 dbms_gsm_common.setDBParameter(
pname   IN VARCHAR2,
pvalues IN param_value_list_t)
ACCESSIBLE BY (PACKAGE dbms_gsm_dbadmin,
               PACKAGE dbms_gsm_pooladmin,
               PACKAGE dbms_gsm_common,
               PACKAGE dbms_gsm_cloudadmin,
               PACKAGE ggsys.ggsharding);
TBD
 
SETGSMPARAMETER (new 12.2)
Changes the value of the _gsm parameter on a database dbms_gsm_common.setGSMParameter(
operation IN NUMBER,
gsms      IN gsm_list_t);
TBD
 
SETREGIONLISTPARAMETER (new 12.2)
Changes the value of the _gsm_region_list parameter on a database dbms_gsm_common.setRegionListParameter(
operation IN number,
regions   IN region_list_t);
TBD
 
UPDATECHUNKS (new 12.2)
Refresh RDBMS chunks cache dbms_gsm_common.updateChunks;
gsmadmin_internal.dbms_gsm_common.updateChunks;
 
VERIFYUET (new 12.2)
Undocumented dbms_gsm_common.verifyUET(
module IN BINARY_INTEGER,
test   IN BINARY_INTEGER,
stage  IN BINARY_INTEGER,
mesg   IN VARCHAR2);
TBD
 
WRITETOGWMTRACING (new 12.2)
Prints using the GWM tracing mechanism

Overload 1
dbms_gsm_common.writeToGWMTracing(phrase IN VARCHAR2);
exec gsmadmin_internal.dbms_gsm_common.writeToGWMTracing('Testing 1, 2, 3');
Overload 2 dbms_gsm_common.writeToGWMTracing(
phrase IN VARCHAR2,
gdsctl_id NUMBER);
exec gsmadmin_internal.dbms_gsm_common.writeToGWMTracing('Testing 1, 2, 3', 42);

Related Topics
Built-in Functions
Built-in Packages
DBMS_GSM_ALERTS
DBMS_GSM_CLOUDADMIN
DBMS_GSM_DBADMIN
DBMS_GSM_FIX
DBMS_GSM_FIXED
DBMS_GSM_XDB
What's New In 12cR1
What's New In 12cR2

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