Oracle | DBMS_GSM

Oracle DBMS_GSM_POOLADMIN 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 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
cs_stbypref	NUMBER	2
cs_stbyonly	NUMBER	3
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; ----------------- --- Federated Database grant types ----------------- TYPE objgrant IS RECORD(object_type NUMBER, privname VARCHAR2(128), owner VARCHAR2(128), name VARCHAR2(128), colname VARCHAR2(128), wgo NUMBER); TYPE objgrant_table IS TABLE OF objgrant INDEX BY BINARY_INTEGER; TYPE sysgrant IS RECORD(privname VARCHAR2(128), wgo NUMBER); TYPE sysgrant_table IS TABLE OF sysgrant INDEX BY BINARY_INTEGER;

Dependencies SELECT name FROM dba_dependencies WHERE referenced_name = 'DBMS_GSM_POOLADMIN' UNION SELECT referenced_name FROM dba_dependencies WHERE name = 'DBMS_GSM_POOLADMIN' ORDER BY 1;

Returns 128 objects

Documented No

Exceptions

Error Code	Reason
ORA-03739	The specified database is not configured to be a catalog.
ORA-03745	`global service manager not running`
ORA-03794	CDB does not exist: <cdb_name_string>

First Available 12.1

Pragma SUPPLEMENTAL_LOG_DATA(default, UNSUPPORTED);

Security Model Owned by GSMADMIN_INTERNAL with EXECUTE granted to GGSYS, GSMADMIN_ROLE, GSM_POOLADMIN_ROLE

Source {ORACLE_HOME}/rdbms/admin/dbmsgwmpl.sql

Also see catgwmcat.sql

Subprograms

ADDBROKERCONFIG	GETINSTANCESTRING	REMOVERU
ADDCDB	GETMAXNAMELEN	REMOVESERVICE
ADDDATABASE	GETSERVICEDBPARAMS	REMOVESERVICEINTERNAL
ADDDATABASEDONE	GETSERVICELOCALPARAMS	REMOVESHARD
ADDDATABASEINTERNAL	GETSHARDCONNECTIONINFO	REMOVESHARDGROUP
ADDFILE	GETTASK	REMOVESHARDSPACE
ADDREMOTECRED	GET_KEY	REQUESTDELETE
ADDSERVICE	GSMPROCESSINGDEPLOY	REQUESTDONE
ADDSERVICETODBS	INITCROSSSHARDS	RESUMESERVICES
ADDSHARD	MAKEDBSPREFERRED	RETRIEVEFILE
ADDSHARDGROUP	MODIFYCATALOGDDL	SETDGPROPERTY
ADDSHARDSPACE	MODIFYCDB	SETRUNTIMESTATUS
ALTERTASK	MODIFYDATABASE	SETRUPARAM
AQTEST	MODIFYDATABASEDDLSTATE	SET_KEY
ASSIGNCHUNKLOCATIONSDG	MODIFYFILE	SPLITCHUNK
ASSIGNCHUNKLOCATIONSOGG	MODIFYREMOTECRED	STARTOBSERVER
BIC	MODIFYSERVICE	STARTRU
BIS	MODIFYSERVICECONFIG	STARTSERVICE
BIT/td>	MODIFYSERVICEONDB	STOPRU
CATROLLBACK	MODIFYSHARD	STOPSERVICE
CHANGESERVICESTATE	MODIFYSHARDGROUP	STRTOLIST
CHECKSYNC	MODIFYSHARDSPACE	STRTONUMLIST
CLONECOMPLETE	MODSHPUBLICDBLINK	SUSPENDSERVICES
CONFIRMMOVE	MOVECHUNK	SWITCHOVERRU
COPYRU	MOVECHUNKATOMIC	SYNCBROKERCONFIG
CREATEBACKUPSTOREDSCRIPTS	MOVEFAILED	SYNCDATABASE
CREATEGLOBALRESTOREPOINT	MOVERU	SYNCDDL
CREATERESTOREPOINTJOB	MOVESERVICETODB	SYNCKEYS
CREATESHARD	NOTIFYCOMPATIBLEUPDATE	SYNCRU
DEPLOY	PDB_FIXUP	SYNCSCHEMA
DEPLOY_ASYNC	RECOVERCHUNKS	UPDATECHUNKLOCATIONREMOTE
DEPLOY_INT	RECOVERSHARDDDL	UPDATECROSSSHARDOGGDBDOWN
DISABLESERVICE	REFRESHCOMPATIBLE	UPDATECROSSSHARDOGGDBUP
DUPTABLEDDLWAIT	REFRESHRUMETADATA	UPDATEDATABASESTATUS
ENABLESERVICE	RELOCATECHUNK	UPDATEMOVECHUNK
EXECSQLONSHARD	RELOCATESERVICE	UPDATEMOVESTATE
EXECUTEOGGPROCEDURE	REMOVEBROKERCONFIG	UPDATERUROLE
GENERICPROCEDUREDONE	REMOVECDB	VALIDATEALL
GETDBINFO	REMOVEDATABASE	VALIDATENETWORKAFTERADDSHARD
GETGLOBALRESTOREPOINTS	REMOVEFILE	VALIDATENETWORKAFTERSTARTGSM
GETGLOBALRESTOREPOINTSCN	REMOVEREMOTECRED	WRITEVALRESULTS
GETINFO	REMOVERESTOREPOINTJOB

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

ADDCDB

Adds a new CDB to a sharding configuration dbms_gsm_pooladmin.addCDB( db_unique_name IN VARCHAR2, database_connect_string IN VARCHAR2, 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, oracle_home IN VARCHAR2 DEFAULT NULL, dbid IN NUMBER DEFAULT 0, database_role IN VARCHAR2 DEFAULT NULL, rack IN VARCHAR2 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

Undocumented dbms_gsm_pooladmin.addFile( filename IN VARCHAR2, contents IN CLOB, poolname IN VARCHAR2 DEFAULT NULL);

TBD

ADDREMOTECRED

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, failover_restore IN VARCHAR2 DEFAULT dbms_gsm_common.failover_restore_none);

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

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, cdb IN VARCHAR2 DEFAULT NULL, is_cdb IN BOOLEAN DEFAULT FALSE, replace IN VARCHAR2 DEFAULT NULL, pdb_name IN VARCHAR2 DEFAULT NULL, pdb_id IN NUMBER DEFAULT 0);

TBD

ADDSHARDGROUP

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

ADDSHARDSPACE

Undocumented dbms_gsm_pooladmin.addShardSpace( shardspace_name IN VARCHAR2, chunks IN NUMBER DEFAULT NULL, protectmode IN NUMBER DEFAULT NULL);

TBD

ALTERTASK (new 23ai)

Undocumented dbms_gsm_pooladmin.alterTask( id_list IN name_list_type DEFAULT CAST(NULL AS name_list_type), chunk_list IN name_list_type DEFAULT CAST(NULL AS name_list_type), db_list IN name_list_type DEFAULT CAST(NULL AS name_list_type), ru_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

AQTEST

Undocumented dbms_gsm_pooladmin.aqTest( aq_num IN NUMBER, targets IN number_list, params IN VARCHAR2 DEFAULT NULL, update_table IN NUMBER);

TBD

ASSIGNCHUNKLOCATIONSDG

Undocumented dbms_gsm_pooladmin.assignChunkLocationsDG( chunk IN NUMBER, shgroup_id IN NUMBER);

TBD

ASSIGNCHUNKLOCATIONSOGG

Reassign a single chunk on GoldenGate dbms_gsm_pooladmin.assignChunkLocationsOGG( chk IN NUMBER, source_db IN NUMBER, target_db IN NUMBER);

TBD

BIC (new 23ai)

Clears a bit in passed number value dbms_gsm_pooladmin.bic( flag IN OUT NUMBER, bit IN NUMBER);

TBD

BIS (new 23ai)

Sets a bit in passed number value dbms_gsm_pooladmin.bis( flag IN OUT NUMBER, bit IN NUMBER); RAGMA SUPPLEMENTAL_LOG_DATA(BIS, READ_ONLY);

TBD

BIT (new 23ai)

Tests if bit is set in passed number value dbms_gsm_pooladmin.bit( flag IN NUMBER, bit IN NUMBER) RETURN BOOLEAN;

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

Undocumented dbms_gsm_pooladmin.checkSync(db_name IN VARCHAR2);

exec gsmadmin_internal.dbms_gsm_pooladmin.checkSync('PERRITO');

CLONECOMPLETE (new 23ai)

Update the catalog at the end of a cloning operation of the shards added with clone option dbms_gsm_pooladmin.cloneComplete(dbnum IN NUMBER);

TBD

CONFIRMMOVE

Undocumented dbms_gsm_pooladmin.confirmMove( source_db IN NUMBER, target_db IN NUMBER, chunk_id IN NUMBER);

TBD

COPYRU (new 23ai)

Undocumented dbms_gsm_pooladmin.copyRU( ru IN NUMBER, source IN VARCHAR2 DEFAULT NULL, target IN VARCHAR2, replace IN VARCHAR2 DEFAULT NULL, timeout IN NUMBER DEFAULT 0, verbose IN NUMBER DEFAULT 0, force IN NUMBER DEFAULT NULL, extended IN NUMBER DEFAULT NULL);

TBD

CREATEBACKUPSTOREDSCRIPTS

Undocumented dbms_gsm_pooladmin.createBackupsStoredScripts( backupLevel1Type IN BINARY_INTEGER, sdb_cat_dbid IN VARCHAR2, cookie OUT BINARY_INTEGER);

TBD

CREATEGLOBALRESTOREPOINT

SDB backup support dbms_gsm_pooladmin.createGlobalRestorePoint(name IN VARCHAR2 DEFAULT NULL);

TBD

CREATERESTOREPOINTJOB

SDB backup support dbms_gsm_pooladmin.createRestorePointJob(start_time IN VARCHAR2 DEFAULT NULL);

TBD

CREATESHARD

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

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);

           *

      ORA-03739: The specified database is not configured to be a catalog.

      ORA-01403: no data found

DEPLOY_ASYNC

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);

      

      PL/SQL procedure successfully completed.

DEPLOY_INT

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);

          
      *

      ORA-03739: The specified database is not configured to be a catalog.

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

DUPTABLEDDLWAIT

Wait for the create duplicated table DDL to complete for an alter duplicated table DDL dbms_gsm_pooladmin.duptableDDLWait( v_schema_name IN VARCHAR2, v_table_name IN VARCHAR2);

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

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

Updates metadata as needed and sends the AQ GoldenGate message to multiple shards. When the GSM is done executing the command, 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

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

GETDBINFO

Get database specific info stored on catalog for cross validation dbms_gsm_pooladmin.getDbInfo( db_unique_name IN VARCHAR2, minobj_number OUT NUMBER, maxobj_number OUT NUMBER, db_dbid OUT NUMBER);

DECLARE

       x NUMBER;

       y NUMBER;

       z NUMBER;

      BEGIN

        gsmadmin_internal.dbms_gsm_pooladmin.getDbInfo('ORABASE', x, y, z);

      END;

      /

      *

      ORA-45558: There are no database pools in this catalog.

GETGLOBALRESTOREPOINTS

SDB backup support dbms_gsm_pooladmin.getGlobalRestorePoints(grps OUT grp_list_t);

TBD

GETGLOBALRESTOREPOINTSCN

SDB backup support dbms_gsm_pooladmin.getGlobalRestorePointSCN( name IN VARCHAR2, scn OUT BINARY_INTEGER);

TBD

GETINFO (new 23ai overloads)

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

Overload 3 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 sharding_type OUT NUMBER);

TBD

Overload 4 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 sharding_type OUT NUMBER, replication_type OUT NUMBER);

TBD

GETINSTANCESTRING

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

GETMAXNAMELEN

For use by GDSCTL to validate inputs returns the width of name_list_type values dbms_gsm_common.max_ident) dbms_gsm_pooladmin.getMaxNameLen RETURN NUMBER;

SELECT gsmadmin_internal.dbms_gsm_pooladmin.getMaxNameLen;

      

      GETMAXNAMELEN

      -------------

                128

GETSERVICEDBPARAMS

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

Undocumented dbms_gsm_pooladmin.getShardConnectionInfo( chunks_lst IN chunk_list, access_type IN NUMBER, exclusion_list IN shardid_list) RETURN shard2chunk_map;

TBD

GETTASK (new 23ai)

Returns the gdsctl command pending in CATALOG_REQUESTS dbms_gsm_pooladmin.getTask(cat_seq IN NUMBER) RETURN VARCHAR2;

TBD

GET_KEY

Returns the value of a key by name dbms_gsm_pooladmin.get_key(key_type IN NUMBER) RETURN RAW;

TBD

GSMPROCESSINGDEPLOY

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;

      /

      *

      ORA-03745: global service manager not running

INITCROSSSHARDS

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);

      

      PL/SQL procedure successfully completed.

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

MODIFYCATALOGDDL

Undocumented dbms_gsm_pooladmin.modifyCatalogDDL( operation IN VARCHAR2, ddlnum IN NUMBER, ddltext IN VARCHAR2 DEFAULT NULL, ddlschema IN VARCHAR2 DEFAULT NULL);

TBD

MODIFYCDB

Undocumented dbms_gsm_pooladmin.modifyCDB( 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, dest IN VARCHAR2 DEFAULT NULL, cred IN VARCHAR2 DEFAULT NULL, osaccount IN VARCHAR2 DEFAULT NULL, ospassword IN VARCHAR2 DEFAULT NULL, windows_domain IN VARCHAR2 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

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

Undocumented dbms_gsm_pooladmin.modifyFile( filename IN VARCHAR2, contents IN CLOB);

TBD

MODIFYREMOTECRED

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, failover_restore IN VARCHAR2 DEFAULT NULL);

exec gsmadmin_internal.dbms_gsm_pooladmin.modifyService(service_name => 'pdbdev', clb_goal => dbms_service.clb_goal_short);

          
      *

      ORA-45558: There are no database pools in this catalog.

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);

exec gsmadmin_internal.dbms_gsm_pooladmin.modifyServiceOnDB(service_name => 'pdbdev', database_name => 'ORABASE2');

          
      *

      ORA-45558: There are no database pools in this catalog.

MODIFYSHARD

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

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

Undocumented dbms_gsm_pooladmin.modifyShardSpace( shardspace_name IN VARCHAR2, chunks IN NUMBER DEFAULT NULL, protectmode IN NUMBER DEFAULT NULL);

TBD

MODSHPUBLICDBLINK (new 23ai)

Re-creates public multi-target dblinks as shards dbms_gsm_pooladmin.modshPubliCDBDBLlink(shared IN BOOLEAN);

TBD

MOVECHUNK

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

MOVECHUNKATOMIC

Undocumented dbms_gsm_pooladmin.moveChunkAtomic( 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, internalcall IN NUMBER DEFAULT dbms_gsm_common.isFalse, mmode IN NUMBER DEFAULT 1);

TBD

MOVEFAILED

Undocumented dbms_gsm_pooladmin.moveFailed( source_db IN NUMBER, chunk_id IN NUMBER, err_id IN NUMBER);

TBD

MOVERU (new 23ai)

Undocumented dbms_gsm_pooladmin.moveRU( ru IN NUMBER DEFAULT NULL, source IN VARCHAR2, target IN VARCHAR2 DEFAULT NULL, timeout IN NUMBER DEFAULT 0, verbose IN NUMBER DEFAULT 0, force IN NUMBER DEFAULT NULL, extended IN NUMBER DEFAULT NULL);

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

NOTIFYCOMPATIBLEUPDATE (new 23ai)

Sends an AQ notification to all shards about a new compatible or knclp_cap setting dbms_gsm_pooladmin.notifyCompatibleUpdate( db_number IN NUMBER, compatible IN VARCHAR2, knclp_cap IN NUMBER, spare1 IN NUMBER DEFAULT NULL, spare2 IN NUMBER DEFAULT NULL, spare3 IN VARCHAR2 DEFAULT NULL, spare4 IN RAW DEFAULT NULL);

TBD

PDB_FIXUP

Used to repair metadata related to PDB shards when upgrading from 18c to a newer release dbms_gsm_pooladmin.updateMoveState( chunk IN NUMBER, gsmreq_id IN NUMBER, state IN NUMBER DEFAULT 0, is_term IN NUMBER DEFAULT dbms_gsm_common.isFalse);

TBD

RECOVERCHUNKS

Recovers Chunk information after an unsuccessful move or split dbms_gsm_pooladmin.recoverChunks(database_name IN VARCHAR2);

TBD

RECOVERSHARDDDL

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

REFRESHCOMPATIBLE (new 23ai)

Connects to every shard and refreshes their compatible settings dbms_gsm_pooladmin.refreshCompatible;

TBD

REFRESHRUMETADATA (new 23ai)

Undocumented dbms_gsm_pooladmin.refreshRUMetadata;

TBD

RELOCATECHUNK (new 23ai)

Undocumented dbms_gsm_pooladmin.relocateChunk( chunks IN gsmadmin_internal.dbms_gsm_pooladmin.name_list_type, sourceru IN NUMBER, targetru IN NUMBER DEFAULT NULL, timeout IN NUMBER DEFAULT 0, verbose IN NUMBER DEFAULT 0);

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

REMOVECDB

Undocumented dbms_gsm_pooladmin.removeCDB( cdb_list IN name_list_type DEFAULT CAST(NULL AS name_list_type), force IN NUMBER DEFAULT NULL);

DECLARE

       inList gsmadmin_internal.dbms_gsm_pooladmin.name_list_type;

      BEGIN

        inList(1) := 'ORCLCDB';

        
      gsmadmin_internal.dbms_gsm_pooladmin.removeCDB(inList, 0);

      END;

      /

      *

      ORA-03794: CDB does not exist: ORCLCDB

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

Undocumented dbms_gsm_pooladmin.removeFile(filename IN VARCHAR2);

TBD

REMOVEREMOTECRED

Undocumented dbms_gsm_pooladmin.removeRemoteCred(credential_name IN VARCHAR2);

exec gsmadmin_internal.dbms_gsm_pooladmin.removeRemoteCred('UWRCred');

           *

      ORA-02602: credential does not exist: UWRCred

REMOVERESTOREPOINTJOB (new 23ai)

Undocumented dbms_gsm_pooladmin.removeRestorePointJob;

TBD

REMOVERU (new 23ai)

Undocumented dbms_gsm_pooladmin.removeRU( ru IN NUMBER, timeout IN NUMBER DEFAULT 0, verbose IN NUMBER DEFAULT 0, force IN NUMBER DEFAULT 0);

TBD

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

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

Undocumented dbms_gsm_pooladmin.removeShardGroup(shardgroup_name IN VARCHAR2);

TBD

REMOVESHARDSPACE

Undocumented dbms_gsm_pooladmin.remoeShardSpace(shardspace_name IN VARCHAR2);

TBD

REQUESTDELETE

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

RESUMESERVICES (new 23ai)

Undocumented dbms_gsm_pooladmin.resumeServices( database_name IN VARCHAR2, verbose IN NUMBER) DEFAULT 0;

TBD

RETRIEVEFILE

Retrieves the contents of a file as a CLOB dbms_gsm_pooladmin.retrieveFile( filename IN VARCHAR2, contents OUT CLOB);

TBD

SETDGPROPERTY

Sets a DataGuard property value for a shardgroup, shardspace, shard, or broker config. dbms_gsm_pooladmin.setDGProperty( shardgroup_name IN VARCHAR2 DEFAULT NULL, shard_name IN VARCHAR2 DEFAULT NULL, broker_name IN VARCHAR2 DEFAULT NULL, shardspace_name IN VARCHAR2 DEFAULT NULL, prop_name IN VARCHAR2, prop_value IN VARCHAR2 DEFAULT NULL, prop_scope IN VARCHAR2 DEFAULT NULL, prop_reset IN NUMBER DEFAULT 0);

TBD

SETRUNTIMESTATUS

Sets runtime status for a database dbms_gsm_pooladmin.setRunTimeStatus( source_db IN VARCHAR2, db_flags IN NUMBER);

TBD

SETRUPARAM (new 23ai)

Sets a Replication Unit Parameter for a shard or RU dbms_gsm_pooladmin.setruparam( shard_name IN VARCHAR2 DEFAULT NULL, ru IN NUMBER DEFAULT NULL, param_name IN VARCHAR2, param_value IN VARCHAR2 DEFAULT NULL, param_reset IN NUMBER DEFAULT 0);

TBD

SET_KEY

Sets PKI keys and flags dbms_gsm_pooladmin.set_key( key_type IN NUMBER, key_value IN RAW);

TBD

SPLITCHUNK

Undocumented dbms_gsm_pooladmin.splitChunk( chunks IN name_list_type, shardspaces IN name_list_type);

TBD

STARTOBSERVER

Undocumented dbms_gsm_pooladmin.startObserver( database_name IN VARCHAR2, BC_ID OUT NUMBER);

TBD

STARTRU (new 23ai)

Undocumented dbms_gsm_pooladmin.startRU( ru IN NUMBER, dbname IN VARCHAR2 DEFAULT NULL, timeout IN NUMBER DEFAULT 0, verbose IN NUMBER DEFAULT 0, force IN NUMBER DEFAULT 0);

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

STOPRU (new 23ai)

Undocumented dbms_gsm_pooladmin.stopRU( ru IN NUMBER, dbname IN VARCHAR2 DEFAULT NULL, timeout IN NUMBER DEFAULT 0, verbose IN NUMBER DEFAULT 0, force IN NUMBER DEFAULT 0);

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;

      /

      A

      B

      C

      

      PL/SQL procedure successfully completed.

STRTONUMLIST

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;

      /

      0

      1

      2

      3

      4

      5

      

      PL/SQL procedure successfully completed.

SUSPENDSERVICES (new 23ai)

Undocumented dbms_gsm_pooladmin.suspendServices(database_name IN VARCHAR2);

TBD

SWITCHOVERRU (new 23ai)

Undocumented dbms_gsm_pooladmin.switchoverRU( ru IN NUMBER DEFAULT NULL, dbname IN VARCHAR2 DEFAULT NULL, rebalance IN NUMBER DEFAULT NULL, verbose IN NUMBER DEFAULT 0, timeout IN NUMBER DEFAULT 0);

TBD

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

SYNCDDL

Docs indicate that this is a renamed command but do not know the original name dbms_gsm_pooladmin.syncDDL( retrieve_only IN NUMBER DEFAULT 0, apply IN NUMBER DEFAULT 0, schemas IN name_list_type DEFAULT CAST(NULL AS name_list_type), restart IN NUMBER DEFAULT 0, skip_first IN NUMBER DEFAULT 0, deploy_wait IN NUMBER DEFAULT NULL);

TBD

SYNCKEYS (new 23ai)

Usually called when sync is done to send the shard keys to the shard or called from the shard via a DB link when the shard is executing a DDL and does not yet have the shard keys dbms_gsm_pooladmin.syncKeys( database_name IN VARCHAR2, shd_req_keys IN BOOLEAN DEFAULT FALSE, force IN BOOLEAN DEFAULT FALSE);

TBD

SYNCRU (new 23ai)

Undocumented dbms_gsm_pooladmin.syncRU( ru IN NUMBER, dbname IN VARCHAR2 DEFAULT NULL, timeout IN NUMBER DEFAULT 0, verbose IN NUMBER DEFAULT 0, force IN NUMBER DEFAULT 0);

TBD

SYNCSCHEMA

Called for federated database after adding existing databases. This procedure extracts DDLs from newly added shards; generates a 'common' schema and applies it on the catalog. dbms_gsm_pooladmin.syncSchema( retrieve_only IN NUMBER DEFAULT 0, apply IN NUMBER DEFAULT 0, schemas IN name_list_type DEFAULT CAST(NULL AS name_list_type), restart IN NUMBER DEFAULT 0, skip_first IN NUMBER DEFAULT 0);

TBD

UPDATECHUNKLOCATIONREMOTE

Undocumented dbms_gsm_pooladmin.updateChunkLocationRemote(chunk_id IN NUMBER);

exec gsmadmin_internal.dbms_gsm_pooladmin.updateChunkLocationRemote(128);

      *

      ORA-01403: no data found

UPDATECROSSSHARDOGGDBDOWN

Reassign chunks when an OGG shard goes down dbms_gsm_pooladmin.updateCrossShardOGGDBDown(db_num IN NUMBER);

TBD

UPDATECROSSSHARDOGGDBUP

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

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

UPDATEMOVESTATE

Undocumented dbms_gsm_pooladmin.updateMoveState( chunk IN NUMBER, gsmreq_id IN NUMBER, state IN NUMBER DEFAULT 0, is_term IN NUMBER DEFAULT dbms_gsm_common.isFalse);

TBD

UPDATERUROLE (new 23ai)

Reassign chunks when the SNR leader changes dbms_gsm_pooladmin.updateRURole( db_num NUMBER, ru_id NUMBER, term NUMBER, role NUMBER, getLock BOOLEAN DEFAULT TRUE);

TBD

VALIDATEALL (new 23ai)

Calls TNSPING and performs validation checks dbms_gsm_pooladmin.validateAll(session_id OUT VARCHAR2);

DECLARE

        outVal VARCHAR2(30);

      BEGIN

        gsmadmin_internal.dbms_gsm_pooladmin.validateAll(outVal);

        dbms_output.put_line(outVal);

      END;

      /

      *

      ORA-01403: no data found

VALIDATENETWORKAFTERADDSHARD (new 23ai)

Calls TNSPING and performs validation checks dbms_gsm_pooladminvalidateNetworkAfterAddShard( shard_name IN VARCHAR2, session_id OUT VARCHAR2);

TBD

VALIDATENETWORKAFTERSTARTGSM (new 23ai)

Calls TNSPING and performs validation checks dbms_gsm_pooladmin.ValidateNetworkAfterStrartGSM( gsm_name IN VARCHAR2, session_id OUT VARCHAR2);

TBD

WRITEVALRESULTS (new 23ai)

Called from GSMs to write validation results to the validate_vncr and validate_tnsping tables dbms_gsm_pooladmin.writeValResults( session_id IN VARCHAR2, gsm_name IN VARCHAR2, db_name IN VARCHAR2, results IN VARCHAR2, table_num IN NUMBER);

TBD