Oracle DBMS_GSM_POOLADMIN
Version 12.2.0.1

General Information
Library Note Morgan's Library Page Header
"I spent my entire adult life looking out for the well-being, the training, the equipping of the troops for whom I was responsible. I will not be lectured about what our military needs by a five-deferment draft dodger,"
~ Sen. Tammy Duckworth
Purpose Utilities supporting the Global Services Manager Pool Administration
AUTHID DEFINER
Constants
Name Data Type Value
Public Constants
cs_readwrite NUMBER 0
cs_readonly NUMBER 1
prv_key NUMBER 0
pub_key NUMBER 1
prk_enc_str NUMBER 2
Public Broker Configuration Status
undeployed (initial add state) NUMBER 0
deploy_ready (ready to deploy) NUMBER 1
broker_configured (ready to go) NUMBER 2
Public Move Chunk Errors
move_ok NUMBER 0
move_notarget (no target DB) NUMBER 1
move_nosrc (no source db) NUMBER 2
move_fail (general failure to move) NUMBER 3
Private Action Parameter Constants
logical NUMBER 1
physical NUMBER 2
Private Force Parameter Constants
force_off NUMBER 0
force_on NUMBER 1
Private gen_aq Notification Constants
gen_aq_off NUMBER 0
gen_aq_on NUMBER 1
Private Templates For Create/Modify Database SID, Files, Credentials, and Jobs Constants
sid_tmpl VARCHAR2(2) 'sh'
file_tmpl VARCHAR2(11) 'SHARD_FILE_'
cred_tmpl VARCHAR2(11) 'SHARD_CRED_'
job_tmpl VARCHAR2(10) 'SHARD_JOB_';
Data Types -----------------
-- Name list type
-----------------
TYPE name_list_type IS TABLE OF VARCHAR2(dbms_gsm_common.max_ident)
INDEX BY BINARY_INTEGER;

-----------------
--- chunk types
-----------------
TYPE chunk_list IS TABLE OF NUMBER INDEX BY BINARY_INTEGER;
TYPE shardid_list IS TABLE OF NUMBER INDEX BY BINARY_INTEGER ;
TYPE shard2chunk_map IS TABLE OF shard_t INDEX BY PLS_INTEGER;
Dependencies
ALL_SCHEDULER_EXTERNAL_DESTS DBMS_LOB MESSAGE_PARAM_LIST
BROKER_CONFIGS DBMS_LOCK NLS_DATABASE_PARAMETERS
CATALOG_REQUESTS DBMS_RANDOM NUMBER_LIST
CAT_ROLLBACK_TRIGGER DBMS_SCHEDULER PLITBLM
CAT_SEQUENCE DBMS_SESSION RAC_INSTANCE_T
CHUNKS DBMS_SYS_ERROR REGION
CHUNK_LOC DBMS_UTILITY REQUEST_DELETE_TRIGGER
CLOUD DBPARAMS_LIST SERVICE
CREDENTIAL DBPARAMS_T SERVICE_PREFERRED_AVAILABLE
CREDENTIAL_SEQUENCE DDLID$ SHARDGROUP_SEQUENCE
CS_CHUNK_ID DDL_REQUESTS SHARDSPACE_SEQUENCE
DATABASE DONE_TRIGGER SHARD_GROUP
DATABASE_POOL DRSET_SEQUENCE SHARD_LIST_T
DBA_SCHEDULER_EXTERNAL_DESTS DUAL SHARD_SPACE
DBA_SCHEDULER_JOB_RUN_DETAILS EXECASUSER SHARD_T
DBMS_ASSERT EXEC_SHARD_PLSQL SHARD_TS
DBMS_CREDENTIAL FILES SID_SEQUENCE
DBMS_GSM_ALERTS FILES_SEQUENCE TABLESPACE_SET
DBMS_GSM_CLOUDADMIN GSM_CHANGE_MESSAGE TABLE_FAMILY
DBMS_GSM_COMMON GSM_REQUESTS UTL_HTTP
DBMS_GSM_NOPRIV GV$SESSION UTL_LMS
DBMS_GSM_UTILITY INSTANCE_LIST VNCR
DBMS_GSM_UTILITY_LIB INT_DBNUM_SEQUENCE V_$PARAMETER2
DBMS_JOB MESSAGE_PARAM  
Documented No
Exceptions
Error Code Reason
ORA-03739 The specified database is not configured to be a catalog.
   
   
First Available 12cR1
Security Model Owned by SYS with EXECUTE granted to GGSYS, GSMADMIN_ROLE, GSM_POOLADMIN_ROLE
Source {ORACLE_HOME}/rdbms/admin/dbmsgwmpl.sql

Also see catgwmcat.sql
Subprograms
 
ADDBROKERCONFIG
Makes a database pool a Data Guard broker configuration dbms_gsm_pooladmin.addBrokerConfig(
db_unique_name          IN VARCHAR2,
database_pool_name      IN VARCHAR2 DEFAULT NULL,
database_connect_string IN VARCHAR2,
password                IN VARCHAR2 DEFAULT NULL,
region                  IN VARCHAR2 DEFAULT NULL,
num_standbys            IN NUMBER   DEFAULT 1,
instances               IN NUMBER   DEFAULT NULL,
encpassword             IN RAW      DEFAULT NULL);
TBD
 
ADDDATABASE
Adds a database to a region and a database pool dbms_gsm_pooladmin.addDatabase(
db_unique_name          IN VARCHAR2,
database_pool_name      IN VARCHAR2 DEFAULT NULL,
database_connect_string IN VARCHAR2,
password                IN VARCHAR2,
region                  IN VARCHAR2 DEFAULT NULL,
instances               IN NUMBER   DEFAULT NULL,
cpu                     IN NUMBER   DEFAULT NULL,
srlat                   IN NUMBER   DEFAULT NULL,
encpassword             IN RAW      DEFAULT NULL,
dbhost                  IN VARCHAR2 DEFAULT NULL,
agent_port              IN NUMBER   DEFAULT NULL,
db_sid                  IN VARCHAR2 DEFAULT NULL,
oracle_home             IN VARCHAR2 DEFAULT NULL,
dbid                    IN NUMBER   DEFAULT 0,
conversion_status       IN VARCHAR2 DEFAULT NULL);
TBD
 
ADDDATABASEDONE
Marks the end of "add database" processing dbms_gsm_pooladmin.addDatabaseDone(
db_unique_name     IN VARCHAR2,
database_pool_name IN VARCHAR2,
scan_address       IN VARCHAR2 DEFAULT NULL,
ons_port           IN NUMBER   DEFAULT NULL,
hostname           IN VARCHAR2 DEFAULT NULL,
db_vers            IN NUMBER   DEFAULT NULL,
db_type            IN CHAR     DEFAULT 'U');
TBD
 
ADDDATABASEINTERNAL
Adds a new database to a broker configuration dbms_gsm_pooladmin.addDatabaseInternal(
db_unique_name          IN VARCHAR2,
database_pool_name      IN VARCHAR2 DEFAULT NULL,
database_connect_string IN VARCHAR2,
password                IN VARCHAR2 DEFAULT NULL,
region                  IN VARCHAR2 DEFAULT NULL,
status                  IN CHAR,
db_num                  IN NUMBER   DEFAULT NULL,
scan_address            IN VARCHAR2 DEFAULT NULL,
ons_port                IN NUMBER   DEFAULT NULL,
hostname                IN VARCHAR2 DEFAULT NULL,
db_vers                 IN NUMBER   DEFAULT NULL,
prmdb_name              IN VARCHAR2 DEFAULT NULL,
db_type                 IN CHAR     DEFAULT 'U');
TBD
 
ADDFILE (new 12.2)
Undocumented dbms_gsm_pooladmin.addFile(
filename IN VARCHAR2,
contents IN CLOB,
poolname IN VARCHAR2 DEFAULT NULL);
TBD
 
ADDREMOTECRED (new 12.2)
Undocumented dbms_gsm_pooladmin.addRemoteCred(
credential_name IN VARCHAR2,
username        IN VARCHAR2,
password        IN VARCHAR2,
windows_domain  IN VARCHAR2 DEFAULT NULL,
poolname        IN VARCHAR2 DEFAULT NULL);
TBD
 
ADDSERVICE
Add a service to a database pool dbms_gsm_pooladmin.addservice(
database_pool_name        IN VARCHAR2 DEFAULT NULL,
service_name              IN VARCHAR2,
preferred_all             IN NUMBER   DEFAULT dbms_gsm_common.prefer_all_dbs,
preferred_dbs             IN name_list_type,
available_dbs             IN name_list_type,
svc_locality              IN NUMBER   DEFAULT dbms_gsm_common.service_anywhere,
region_failover           IN NUMBER   DEFAULT dbms_gsm_common.region_failover_off,
db_role                   IN NUMBER   DEFAULT dbms_gsm_common.db_role_none,
failover_primary          IN NUMBER   DEFAULT dbms_gsm_common.failover_primary_off,
rlb_goal                  IN NUMBER   DEFAULT dbms_gsm_common.rlb_goal_none,
clb_goal                  IN NUMBER   DEFAULT dbms_gsm_common.clb_goal_none,
ha_notification           IN NUMBER   DEFAULT dbms_gsm_common.ha_notification_on,
taf_policy                IN NUMBER   DEFAULT dbms_gsm_common.taf_none,
restart_policy            IN NUMBER   DEFAULT dbms_gsm_common.policy_automatic,
distr_trans               IN NUMBER   DEFAULT dbms_gsm_common.dtp_off,
lag                       IN NUMBER   DEFAULT dbms_gsm_common.any_lag,
max_lag                   IN NUMBER   DEFAULT 0,
failover_method           IN VARCHAR2 DEFAULT dbms_gsm_common.failover_none,
failover_type             IN VARCHAR2 DEFAULT dbms_gsm_common.failover_type_none,
failover_retries          IN NUMBER   DEFAULT NULL,
failover_delay            IN NUMBER   DEFAULT NULL,
edition                   IN VARCHAR2 DEFAULT NULL,
pdb                       IN VARCHAR2 DEFAULT NULL,
commit_outcome            IN NUMBER   DEFAULT NULL,
retention_timeout         IN NUMBER   DEFAULT NULL,
replay_initiation_timeout IN NUMBER   DEFAULT NULL,
session_state_consistency IN VARCHAR2 DEFAULT NULL,
sql_translation_profile   IN VARCHAR2 DEFAULT NULL,
table_family              IN VARCHAR2 DEFAULT NULL,
drain_timeout             IN NUMBER   DEFAULT NULL,
stop_option               IN VARCHAR2 DEFAULT NULL);
TBD
 
ADDSERVICETODBS
Add an existing service to additional preferred and/or available databases dbms_gsm_pooladmin.addServiceToDBS(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2,
preferred_dbs      IN name_list_type,
available_dbs      IN name_list_type);
TBD
 
ADDSHARD (new 12.2)
Undocumented dbms_gsm_pooladmin.addShard(
db_unique_name          IN VARCHAR2,
database_pool_name      IN VARCHAR2 DEFAULT NULL,
database_connect_string IN VARCHAR2,
password                IN VARCHAR2,
region                  IN VARCHAR2 DEFAULT NULL,
instances               IN NUMBER   DEFAULT NULL,
cpu                     IN NUMBER   DEFAULT NULL,
srlat                   IN NUMBER   DEFAULT NULL,
shardgroup_name         IN VARCHAR2 DEFAULT NULL,
encpassword             IN RAW      DEFAULT NULL,
shardspace_name         IN VARCHAR2 DEFAULT NULL,
deploy_as               IN NUMBER   DEFAULT NULL,
dbhost                  IN VARCHAR2 DEFAULT NULL,
agent_port              IN NUMBER   DEFAULT NULL,
db_sid                  IN VARCHAR2 DEFAULT NULL,
oracle_home             IN VARCHAR2 DEFAULT NULL,
dbid                    IN NUMBER   DEFAULT 0,
conversion_status       IN VARCHAR2 DEFAULT NULL,
rack                    IN VARCHAR2 DEFAULT NULL,
gg_service              IN VARCHAR2 DEFAULT NULL,
gg_password             IN VARCHAR2 DEFAULT NULL);
TBD
 
ADDSHARDGROUP (new 12.2)
Undocumented dbms_gsm_pooladmin.addShardGroup(
shardgroup_name IN VARCHAR2,
region_name     IN VARCHAR2 DEFAULT NULL,
shardspace_name IN VARCHAR2 DEFAULT NULL,
repfactor       IN NUMBER   DEFAULT NULL,
deploy_as       IN NUMBER   DEFAULT NULL);
TBD
 
ADDSHARDPACE (new 12.2)
Undocumented dbms_gsm_pooladmin.addShardSpace(
shardspace_name IN VARCHAR2,
chunks          IN NUMBER DEFAULT NULL,
protectmode     IN NUMBER DEFAULT NULL);
TBD
 
AQTEST (new 12.2)
Undocumented dbms_gsm_pooladmin.aqTest(
aq_num       IN NUMBER,
targets      IN number_list,
params       IN VARCHAR2 DEFAULT NULL,
update_table IN NUMBER);
TBD
 
ASSIGNCHUNKLOCATIONSOGG (new 12.2)
Reassign a single chunk on GoldenGate dbms_gsm_pooladmin.assignChunkLocationsOGG(
chk       IN NUMBER,
source_db IN NUMBER,
target_db IN NUMBER);
TBD
 
CATROLLBACK
Perform rollback operation on catalog when distributed change has failed on the target database(s) dbms_gsm_pooladmin.catRollBack(
change        IN gsm_change_message,
old_instances IN instance_list);
TDB
 
CHANGESERVICESTATE
Update service state, sends notification with new service state dbms_gsm_pooladmin.changeServiceState(
service_name     IN VARCHAR2,
pool_name        IN VARCHAR2,
db_name          IN VARCHAR2,
new_state        IN VARCHAR2,
gen_notification IN NUMBER DEFAULT 0);
TBD
 
CHECKSYNC (new 12.2)
Undocumented dbms_gsm_pooladmin.checkSync(db_name IN VARCHAR2);
exec gsmadmin_internal.dbms_gsm_pooladmin.checkSync('PERRITO');
 
CONFIRMMOVE (new 12.2)
Undocumented dbms_gsm_pooladmin.confirmMove(
source_db IN NUMBER,
target_db IN NUMBER,
chunk_id  IN NUMBER);
TBD
 
CREATESHARD (new 12.2)
Creates a new shard and adds it to a region and a database pool dbms_gsm_pooladmin.createShard(
region              IN  VARCHAR2 DEFAULT NULL,
shardspace_name     IN  VARCHAR2 DEFAULT NULL,
shardgroup_name     IN  VARCHAR2 DEFAULT NULL,
deploy_as           IN  NUMBER   DEFAULT NULL,
dest                IN  VARCHAR2,
cred                IN  VARCHAR2 DEFAULT NULL,
dbparam             IN  VARCHAR2 DEFAULT NULL,
dbtemplate          IN  VARCHAR2 DEFAULT NULL,
netparam            IN  VARCHAR2 DEFAULT NULL,
osaccount           IN  VARCHAR2 DEFAULT NULL,
ospassword          IN  VARCHAR2 DEFAULT NULL,
windows_domain      IN  VARCHAR2 DEFAULT NULL,
dbparamcontent      IN  CLOB     DEFAULT NULL,
dbtemplatecontent   IN  CLOB     DEFAULT NULL,
netparamcontent     IN  CLOB     DEFAULT NULL,
rack                IN  VARCHAR2 DEFAULT NULL,
gg_service          IN  VARCHAR2 DEFAULT NULL,
gg_password         IN  VARCHAR2 DEFAULT NULL,
syspassword         IN  VARCHAR2 DEFAULT NULL,
systempassword      IN  VARCHAR2 DEFAULT NULL,
serviceuserpassword IN  VARCHAR2 DEFAULT NULL,
new_dbname          OUT VARCHAR2);
TBD
 
DEPLOY (new 12.2)
Undocumented dbms_gsm_pooladmin.deploy(skip_move IN NUMBER DEFAULT dbms_gsm_common.isFalse);
exec gsmadmin_internal.dbms_gsm_pooladmin.deploy(gsmadmin_internal.dbms_gsm_common.isFalse);
BEGIN gsmadmin_internal.dbms_gsm_pooladmin.deploy(gsmadmin_internal.dbms_gsm_common.isFalse); END;
*
ERROR at line 1:
ORA-03739: The specified database is not configured to be a catalog.
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_NOPRIV", line 153
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 2708
ORA-06512: at "SYS.DBMS_SYS_ERROR", line 79
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 73
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 2695
ORA-06512: at line 1
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_NOPRIV", line 149
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 17650
ORA-01403: no data found
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_NOPRIV", line 55
ORA-01403: no data found
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 2683
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 2583
ORA-06512: at line 1
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_NOPRIV", line 47
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 15227
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 17663
ORA-06512: at line 1
 
DEPLOY_ASYNC (new 12.2)
Undocumented dbms_gsm_pooladmin.depoy_async(skip_move IN NUMBER DEFAULT dbms_gsm_common.isFalse);
exec gsmadmin_internal.dbms_gsm_pooladmin.deploy_async(gsmadmin_internal.dbms_gsm_common.isFalse);
 
DEPLOY_INT (new 12.2)
Undocumented dbms_gsm_pooladmin.deploy_int(
msg_id    IN NUMBER,
skip_move IN NUMBER DEFAULT dbms_gsm_common.isFalse);
exec gsmadmin_internal.dbms_gsm_pooladmin.deploy_int(1, gsmadmin_internal.dbms_gsm_common.isFalse);
BEGIN gsmadmin_internal.dbms_gsm_pooladmin.deploy_int(1, gsmadmin_internal.dbms_gsm_common.isFalse); END;
*
ERROR at line 1:
ORA-03739: The specified database is not configured to be a catalog.
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_NOPRIV", line 153
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 2708
ORA-06512: at "SYS.DBMS_SYS_ERROR", line 79
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 73
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 2695
ORA-06512: at line 1
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_NOPRIV", line 149
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 17650
ORA-01403: no data found
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_NOPRIV", line 55
ORA-01403: no data found
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 2683
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 2583
ORA-06512: at line 1
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_NOPRIV", line 47
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 15227
ORA-06512: at line 1
 
DISABLESERVICE
Disable a service in a database pool dbms_gsm_pooladmin.disableService(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2 DEFAULT NULL,
database_name      IN VARCHAR2 DEFAULT NULL);
TBD
 
ENABLESERVICE
Enables a service in a database pool dbms_gsm_pooladmin.enableService(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2 DEFAULT NULL,
database_name      IN VARCHAR2 DEFAULT NULL);
TBD
 
EXECSQLONSHARD (new 12.2)
Undocumented dbms_gsm_pooladmin.execSQLonShard(
shard_list    IN name_list_type DEFAULT CAST(NULL AS name_list_type),
primary_only  IN NUMBER         DEFAULT 0,
on_catalog    IN NUMBER         DEFAULT 0,
statement     IN VARCHAR2,
write_ddl_req IN NUMBER         DEFAULT dbms_gsm_common.isFalse);
TBD
 
EXECUTEOGGPROCEDURE (new 12.2)
Updates meta-data as needed, and then sends AQ ogg_multi_target (93). When the GSM is done executing the command it updates gsm_requests and calls genericProcedureDone dbms_gsm_pooladmin.executeOGGProcedure(
pool_name IN  VARCHAR2,
targets   IN  number_list,
payload   IN  VARCHAR2,
gsm_req#  OUT NUMBER);
TBD
 
GENERICPROCEDUREDONE (new 12.2)
Called after the GSM updates gsm_requests to say that it has completed executing command for AQ 92/93 dbms_gsm_pooladmin.genericProcedureDone(
sequence_id IN NUMBER,
change_id   IN NUMBER,
status      IN CHAR,
payload     IN VARCHAR2);
TBD
 
GETINFO (new 12.2)
Undocumented

Overload 1
dbms_gsm_pooladmin.getInfo(
pool_name       IN  VARCHAR2 DEFAULT NULL,
shardgroup_name IN  VARCHAR2 DEFAULT NULL,
cloud_name      OUT VARCHAR2,
use_sysdba      OUT NUMBER,
shardspace_name IN  VARCHAR2 DEFAULT NULL);
TBD
Overload 2 dbms_gsm_pooladmin.getInfo(
pool_name       IN  VARCHAR2 DEFAULT NULL,
shardgroup_name IN  VARCHAR2 DEFAULT NULL,
cloud_name      OUT VARCHAR2,
use_sysdba      OUT NUMBER,
shardspace_name IN  VARCHAR2 DEFAULT NULL,
CHARset         OUT VARCHAR2,
nCHARset        OUT VARCHAR2);
TBD
 
GETINSTANCESTRING (new 12.2)
Returns a list of preferred/available instances in string form dbms_gsm_pooladmin.getInstanceString(
service_name    IN  VARCHAR2,
pool_name       IN  VARCHAR2,
database_name   IN  VARCHAR2,
instance_string OUT VARCHAR2);
TBD
 
GETSERVICEDBPARAMS (new 12.2)
Converts DB paramters in name_list_type to a parameter string. Used primarily by GDSCTL/GSM to return parameter strings from database object types dbms_gsm_pooladmin.getServiceDBParams(dbparams IN dbparams_list)
RETURN VARCHAR2;
TBD
 
GETSERVICELOCALPARAMS
Converts DB local parameter list types to a parameter string. Used primarily by GDSCTL/GSM to return parameter strings from database object types dbms_gsm_pooladmin.getServiceLocalParams(
dbparams  IN dbparams_list,
instances IN instance_list)
RETURN VARCHAR2;
TBD
 
GETSHARDCONNECTIONINFO (new 12.2)
Undocumented dbms_gsm_pooladmin.getShardConnectionInfo(
chunks_lst     IN chunk_list,
access_type    IN NUMBER,
exclusion_list IN shardid_list)
RETURN shard2chunk_map;
TBD
 
GET_KEY
Returns the value of a key by name dbms_gsm_pooladmin.get_key(key_type IN NUMBER) RETURN RAW;
TBD
 
GSMPROCESSINGDEPLOY (new 12.2)
Undocumented dbms_gsm_pooladmin.gsmProcessingDeploy RETURN BOOLEAN;
BEGIN
  IF gsmadmin_internal.dbms_gsm_pooladmin.gsmProcessingDeploy THEN
    dbms_output.put_line('T');
  ELSE
    dbms_output.put_line('F');
  END IF;
END;
/
 
INITCROSSSHARDS (new 12.2)
Initial assignments of chunks to shards for a cross-shard query dbms_gsm_pooladmin.initCrossShards(reptype IN NUMBER);
exec gsmadmin_internal.dbms_gsm_pooladmin.initCrossShards(1);
 
MAKEDBSPREFERRED
Changes the specified databases to preferred databases for the service dbms_gsm_pooladmin.makeDBsPreferred(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2,
dbs                IN name_list_type,
force              IN NUMBER   DEFAULT NULL);
TBD
 
MODIFYDATABASE
Modifies the database database pool dbms_gsm_pooladmin.modifyDatabase(
db_unique_name          IN VARCHAR2,
database_pool_name      IN VARCHAR2 DEFAULT NULL,
database_connect_string IN VARCHAR2 DEFAULT NULL,
password                IN VARCHAR2 DEFAULT NULL,
region                  IN VARCHAR2 DEFAULT NULL,
scan                    IN VARCHAR2 DEFAULT NULL,
ons                     IN NUMBER   DEFAULT NULL,
cpu                     IN NUMBER   DEFAULT NULL,
srlat                   IN NUMBER   DEFAULT NULL,
encpassword             IN RAW      DEFAULT NULL);
TBD
 
MODIFYDATABASEDDLSTATE (new 12.2)
Updates DDL application results for a given Database dbms_gsm_pooladmin.modifyDatabaseDDLState(
db_unique_name IN VARCHAR2,
ddlid          IN NUMBER   DEFAULT NULL,
ddl_error      IN VARCHAR2 DEFAULT NULL,
deploy_flag    IN NUMBER   DEFAULT NULL);
TBD
 
MODIFYFILE (new 12.2)
Undocumented dbms_gsm_pooladmin.modifyFile(
filename IN VARCHAR2,
contents IN CLOB);
TBD
 
MODIFYREMOTECRED (new 12.2)
Undocumented dbms_gsm_pooladmin.modifyRemoteCred(
credential_name IN VARCHAR2,
username        IN VARCHAR2 DEFAULT NULL,
password        IN VARCHAR2 DEFAULT NULL,
windows_domain  IN VARCHAR2 DEFAULT NULL);
TBD
 
MODIFYSERVICE
Modifies service attributes

As you can see from the demo, at right, database_pool_name may DEFAULT to NULL but you must have one
dbms_gsm_pooladmin.modifyService(
database_pool_name        IN VARCHAR2 DEFAULT NULL,
service_name              IN VARCHAR2,
svc_locality              IN NUMBER   DEFAULT NULL,
region_failover           IN NUMBER   DEFAULT NULL,
db_role                   IN NUMBER   DEFAULT NULL,
failover_primary          IN NUMBER   DEFAULT NULL,
rlb_goal                  IN NUMBER   DEFAULT NULL,
clb_goal                  IN NUMBER   DEFAULT NULL,
ha_notification           IN NUMBER   DEFAULT NULL,
taf_policy                IN NUMBER   DEFAULT NULL,
restart_policy            IN NUMBER   DEFAULT NULL,
distr_trans               IN NUMBER   DEFAULT NULL,
lag                       IN NUMBER   DEFAULT NULL,
max_lag                   IN NUMBER   DEFAULT NULL,
failover_method           IN VARCHAR2 DEFAULT NULL,
failover_type             IN VARCHAR2 DEFAULT NULL,
failover_retries          IN NUMBER   DEFAULT NULL,
failover_delay            IN NUMBER   DEFAULT NULL,
edition                   IN VARCHAR2 DEFAULT NULL,
pdb                       IN VARCHAR2 DEFAULT NULL,
commit_outcome            IN NUMBER   DEFAULT NULL,
retention_timeout         IN NUMBER   DEFAULT NULL,
replay_initiation_timeout IN NUMBER   DEFAULT NULL,
session_state_consistency IN VARCHAR2 DEFAULT NULL,
sql_translation_profile   IN VARCHAR2 DEFAULT NULL,
force                     IN NUMBER   DEFAULT dbms_gsm_common.isFalse,
drain_timeout             IN NUMBER   DEFAULT NULL,
stop_option               IN VARCHAR2 DEFAULT NULL);
SQL> exec gsmadmin_internal.dbms_gsm_pooladmin.modifyService(service_name => 'pdbdev', clb_goal => dbms_service.clb_goal_short);
BEGIN gsmadmin_internal.dbms_gsm_pooladmin.modifyService(service_name=>'pdbdev', clb_goal=>dbms_service.clb_goal_short); END;
*
ERROR at line 1:
ORA-45558: There are no database pools in this catalog.
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 11406
ORA-06512: at "SYS.DBMS_SYS_ERROR", line 79
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 491
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 11148
ORA-06512: at line 1
 
MODIFYSERVICECONFIG
Changes the set of preferred and available databases for a service dbms_gsm_pooladmin.modifyServiceConfig(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2,
preferred_all      IN NUMBER,
preferred_dbs      IN name_list_type,
available_dbs      IN name_list_type,
force              IN NUMBER DEFAULT NULL);
TBD
 
MODIFYSERVICEONDB
Modifies the attributes of a service specific to a (RAC) database

As you can see from the demo, at right, database_pool_name may DEFAULT to NULL but you must have one
dbms_gsm_pooladmin.modifyServiceOnDB(
database_pool_name IN VARCHAR2       DEFAULT NULL,
service_name       IN VARCHAR2,
database_name      IN VARCHAR2,
params             IN VARCHAR2       DEFAULT NULL,
dbparam_names      IN name_list_type DEFAULT CAST(NULL AS name_list_type),
dbparam_values     IN name_list_type DEFAULT CAST(NULL AS name_list_type),
palist_op          IN CHAR           DEFAULT NULL,
preferred_list     IN name_list_type DEFAULT CAST(NULL AS name_list_type),
available_list     IN name_list_type DEFAULT CAST(NULL AS name_list_type),
force              IN NUMBER         DEFAULT dbms_gsm_common.isFalse);
SQL> exec gsmadmin_internal.dbms_gsm_pooladmin.modifyServiceOnDB(service_name => 'pdbdev', database_name => 'ORABASE2');
BEGIN gsmadmin_internal.dbms_gsm_pooladmin.modifyServiceOnDB(service_name => 'pdbdev', database_name o=> 'ORABASE2'); END;
*
ERROR at line 1:
ORA-45558: There are no database pools in this catalog.
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 12517
ORA-06512: at "SYS.DBMS_SYS_ERROR", line 79
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_UTILITY", line 491
ORA-06512: at "GSMADMIN_INTERNAL.DBMS_GSM_POOLADMIN", line 12248
ORA-06512: at line 1
 
MODIFYSHARD (new 12.2)
Undocumented dbms_gsm_pooladmin.modifyShard(
shardgroup_name IN VARCHAR2,
region_name     IN VARCHAR2 DEFAULT NULL,
shardspace_name IN VARCHAR2 DEFAULT NULL,
repfactor       IN NUMBER   DEFAULT NULL,
deploy_as       IN NUMBER   DEFAULT NULL);
TBD
 
MODIFYSHARDGROUP (new 12.2)
Undocumented dbms_gsm_pooladmin.modifyShardGroup(
shardgroup_name IN VARCHAR2,
region_name     IN VARCHAR2 DEFAULT NULL,
shardspace_name IN VARCHAR2 DEFAULT NULL,
repfactor       IN NUMBER   DEFAULT NULL,
deploy_as       IN NUMBER   DEFAULT NULL);
TBD
 
MODIFYSHARDSPACE (new 12.2)
Undocumented dbms_gsm_pooladmin.modifyShardSpace(
shardspace_name IN VARCHAR2,
chunks          IN NUMBER DEFAULT NULL,
protectmode     IN NUMBER DEFAULT NULL);
TBD
 
MOVECHUNK (new 12.2)
Undocumented dbms_gsm_pooladmin.moveChunk(
chunks  IN name_list_type,
source  IN VARCHAR2,
target  IN VARCHAR2 DEFAULT NULL,
timeout IN NUMBER   DEFAULT 0,
verbose IN NUMBER   DEFAULT 0,
copy    IN NUMBER   DEFAULT 0);
TBD
 
MOVEFAILED (new 12.2)
Undocumented dbms_gsm_pooladmin.moveFailed(
source_db IN NUMBER,
chunk_id  IN NUMBER,
err_id    IN NUMBER);
TBD
 
MOVESERVICETODB
Moves an existing service from one database to another dbms_gsm_pooladmin.moveServiceToDB(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2,
old_db             IN VARCHAR2,
new_db             IN VARCHAR2,
force              IN NUMBER DEFAULT NULL);
TBD
 
RECOVERSHARDDDL (new 12.2)
Recovers DDL on a given shard dbms_gsm_pooladmin.recoverShardDDL(
shard_name    IN VARCHAR2 DEFAULT NULL,
database_name IN VARCHAR2,
ddlaction     IN NUMBER   DEFAULT dbms_gsm_common.execddl_DEFAULT);
TBD
 
RELOCATESERVICE
Relocate a service from one database to another. This operation does not change the underlying configuration of the service dbms_gsm_pooladmin.relocateService(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2,
old_database_name  IN VARCHAR2,
new_database_name  IN VARCHAR2,
force              IN NUMBER DEFAULT NULL);
TBD
 
REMOVEBROKERCONFIG
Removes entire broker configuration (all databases and services) dbms_gsm_pooladmin.removeBrokerConfig(
database_pool_name  IN VARCHAR2,
action              IN NUMBER DEFAULT logical,
gen_aq_notification IN NUMBER DEFAULT gen_aq_on);
TBD
 
REMOVEDATABASE
Remove a database from a database pool dbms_gsm_pooladmin.removeDatabase(
db_unique_name      IN VARCHAR2,
database_pool_name  IN VARCHAR2 DEFAULT NULL,
action              IN NUMBER   DEFAULT logical,
force               IN NUMBER   DEFAULT NULL,
gen_aq_notification IN NUMBER   DEFAULT gen_aq_on,
ignore_missing      IN NUMBER   DEFAULT dbms_gsm_common.isFalse);
TBD
 
REMOVEFILE (new 12.2)
Undocumented dbms_gsm_pooladmin.removeFile(filename IN VARCHAR2);
TBD
 
REMOVEREMOTECRED (new 12.2)
Undocumented dbms_gsm_pooladmin.removeRemoteCred(credential_name IN VARCHAR2);
exec gsmadmin_internal.dbms_gsm_pooladmin.removeRemoteCred('UWRCred');
 
REMOVESERVICE
Remove a service from a database pool dbms_gsm_pooladmin.removeService(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2);
TBD
 
REMOVESERVICEINTERNAL
Remove a service from a database pool; called by GSM directly dbms_gsm_pooladmin.removeServiceInternal(
database_pool_name  IN VARCHAR2 DEFAULT NULL,
service_name        IN VARCHAR2,
CalledByGSM         IN NUMBER   DEFAULT 0,
gen_aq_notification IN NUMBER   DEFAULT gen_aq_on,
force               IN NUMBER   DEFAULT NULL);
TBD
 
REMOVESHARD (new 12.2)
Undocumented dbms_gsm_pooladmin.removeShard(
shard_list      IN name_list_type DEFAULT CAST(NULL AS name_list_type),
shardspace_list IN name_list_type DEFAULT CAST(NULL AS name_list_type),
shardgroup_list IN name_list_type DEFAULT CAST(NULL AS name_list_type),
force           IN NUMBER         DEFAULT NULL);
TBD
 
REMOVESHARDGROUP (new 12.2)
Undocumented dbms_gsm_pooladmin.removeShardGroup(shardgroup_name IN VARCHAR2);
TBD
 
REMOVESHARDSPACE (new 12.2)
Undocumented dbms_gsm_pooladmin.remoeShardSpace(shardspace_name IN VARCHAR2);
TBD
 
REQUESTDELETE (new 12.2)
Undocumented dbms_gsm_pooladmin.requestDelete(
request# IN NUMBER,
change   IN gsm_change_message,
status   IN CHAR);
TBD
 
REQUESTDONE
Perform completion actions when change request is done dbms_gsm_pooladmin.requestDone(
change IN gsm_change_message,
status IN CHAR);
TBD
 
RETRIEVEFILE (new 12.2)
Retrieves the contents of a file as a CLOB dbms_gsm_pooladmin.retrieveFile(
filename IN  VARCHAR2,
contents OUT CLOB);
TBD
 
SETRUNTIMESTATUS (new 12.2)
Sets runtime status for a database dbms_gsm_pooladmin.setRunTimeStatus(
source_db IN VARCHAR2,
db_flags  IN NUMBER );
TBD
 
SET_KEY
Sets PKI keys and flags dbms_gsm_pooladmin.set_key(
key_type  IN NUMBER,
key_value IN RAW);
TBD
 
SPLITCHUNK (new 12.2)
Undocumented dbms_gsm_pooladmin.splitChunk(
chunks      IN name_list_type,
shardspaces IN name_list_type);
TBD
 
STARTOBSERVER (new 12.2)
Undocumented dbms_gsm_pooladmin.startObserver(
database_name IN  VARCHAR2 ,
BC_ID         OUT NUMBER);
TBD
 
STARTSERVICE
Start a service in a database pool dbms_gsm_pooladmin.startService(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2 DEFAULT NULL,
database_name      IN VARCHAR2 DEFAULT NULL);
TBD
 
STOPSERVICE
Stop a service in a database pool dbms_gsm_pooladmin.stopService(
database_pool_name IN VARCHAR2 DEFAULT NULL,
service_name       IN VARCHAR2 DEFAULT NULL,
database_name      IN VARCHAR2 DEFAULT NULL,
force              IN NUMBER   DEFAULT NULL,
options            IN VARCHAR2 DEFAULT NULL);
TBD
 
STRTOLIST
Convert a VARCHAR2 string to name_list_type

This is an incredibly valuable find and should be part of every DBA and Developer's toolkit
dbms_gsm_pooladmin.strToList(lstring IN VARCHAR2)
RETURN name_list_type;
DECLARE
 retVal gsmadmin_internal.dbms_gsm_pooladmin.name_list_type;
BEGIN
  retVal := gsmadmin_internal.dbms_gsm_pooladmin.strToList('A,B,C');
  dbms_output.put_line(retVal(1));
  dbms_output.put_line(retVal(2));
  dbms_output.put_line(retVal(3));
END;
/
 
STRTONUMLIST (new 12.2)
Converts a VARCHAR2 string to a number_list

This is an incredibly valuable find and should be part of every DBA and Developer's toolkit
dbms_gsm_pooladmin.strToNumList(lstring IN VARCHAR2)
RETURN number_list;
DECLARE
 retVal gsmadmin_internal.number_list;
BEGIN
  retVal := gsmadmin_internal.dbms_gsm_pooladmin.strToNumList('0,1,2,3,4,5');
  dbms_output.put_line(retVal(1));
  dbms_output.put_line(retVal(2));
  dbms_output.put_line(retVal(3));
  dbms_output.put_line(retVal(4));
  dbms_output.put_line(retVal(5));
  dbms_output.put_line(retVal(6));
END;
/
 
SYNCBROKERCONFIG
Sync GSM's version of broker configuration with latest updates dbms_gsm_pooladmin.syncBrokerConfig(
database_pool_name IN VARCHAR2 DEFAULT NULL,
database_name      IN VARCHAR2 DEFAULT NULL);
TBD
 
SYNCDATABASE
Send database sync AQ message to GSM dbms_gsm_pooladmin.syncDatabase(
database_pool_name IN VARCHAR2 DEFAULT NULL,
database_name      IN VARCHAR2 DEFAULT NULL);
TBD
 
UPDATECROSSSHARDOGGDBDOWN (new 12.2)
Reassign chunks when an OGG shard goes down dbms_gsm_pooladmin.updateCrossShardOGGDBDown(db_num IN NUMBER);
TBD
 
UPDATECROSSSHARDOGGDBUP (new 12.2)
Reassign chunks when an OGG shard comes up dbms_gsm_pooladmin.updateCrossShardOGGDBUp(db_num IN NUMBER);
TBD
 
UPDATEDATABASESTATUS
Updates runtime status information for database dbms_gsm_pooladmin.updateDatabaseStatus(
db_unique_name     IN VARCHAR2,
database_pool_name IN VARCHAR2 DEFAULT NULL,
status             IN CHAR     DEFAULT NULL,
db_vers            IN NUMBER   DEFAULT NULL);
TBD
 
UPDATEMOVECHUNK (new 12.2)
Undocumented dbms_gsm_pooladmin.updateMoveChunk(
chunks  IN name_list_type DEFAULT CAST(NULL AS name_list_type),
db_list IN name_list_type DEFAULT CAST(NULL AS name_list_type),
verbose IN NUMBER         DEFAULT 0,
action  IN NUMBER         DEFAULT dbms_gsm_utility.restart_move);
TBD

Related Topics
Built-in Functions
Built-in Packages
DBMS_CREDENTIAL
DBMS_GSM_ALERTS
DBMS_GSM_CLOUDADMIN
DBMS_GSM_COMMON
DBMS_GSM_DBADMIN
DBMS_GSM_FIX
DBMS_GSM_FIXED
DBMS_GSM_UTILITY
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