C Global Data Services Control Utility (GDSCTL) Command Reference
This appendix includes a complete reference of the Global Data Services utility (GDSCTL) commands for use with a Global Data Services or Oracle Sharding configuration.
add brokerconfig
Adds an Oracle Data Guard broker configuration to a Global Data Services pool.
Syntax
add brokerconfig -connect connect_identifier
[-pwd password]
[-gdspool gdspool_name]
[-region region_name]
[-savename]
[-force]Options
Table C-1 GDSCTL add brokerconfig Options
| Option | Description |
|---|---|
|
|
Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor for a database in the broker configuration. |
|
|
If specified, the existing GDS configuration is deleted. Deletes an existing, running SDB, and should only be used if you want to get rid of the entire SDB. |
|
|
The pool to which the databases of the Oracle Data Guard broker configuration are to be added. If the specified Global Data Services pool already contains databases or another configuration, GDSCTL returns an error. |
|
|
The password for the GSMUSER. If |
|
|
The Global Data Services region to which the databases belong. If you specify a region, then all the databases are added to that region. If you do not specify a region, then all databases are added with a region of UNASSIGNED. If the region is UNASSIGNED, then you must use the modify database command to change the region. |
|
|
Specify this option to store a net service name specified with the |
Usage Notes
-
You must connect to the Global Data Services catalog database as a user with the pool administrator privileges, the GSMUSER database account, using the connect command before running the
add brokerconfigcommand. You should use theCONNECTcommand to connect to the GSMUSER for the database that you are adding the broker configuration for. -
If a GDS pool already has databases or another configuration, an error is returned. If
-regionis specified, it defines only the region of primary database. If there is more than one region in catalog, GDS region property of standbys will be unassigned. The user will have to use modify database to specify GDS region.
Examples
Add the Oracle Data Guard broker configuration for the DB1 database to the Global Data Services pool MYREADERFARM and the WEST region.
GDSCTL> add brokerconfig -connect 192.168.1.1:1521:sid -region west -gdspool myreaderfarmExceptions or Error Codes
GDSCTL returns the errors listed below if you use this command incorrectly.
Table C-2 GDSCTL add brokerconfig Exceptions or Error Codes
| Exception | Description |
|---|---|
|
|
A pool can only contain one Data Guard broker configuration. If a Global Data Services pool already contains an Oracle Data Guard broker configuration, then GDSCTL returns error 44866 because a database must be added using Oracle Data Guard in this case. |
add cdb
Add a cdb to the shard catalog.
Syntax
add cdb -connect connect_identifier
[-pwd gsmrootuser_pwd]
[-savename]
[-cpu_threshold cpu]
[-disk_threshold disk]
[-rack rack_id]
[-force]
Options
Table C-3 GDSCTL add cdb Options
| Option | Description |
|---|---|
-connect connect_identifier |
Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor for the database being added as the shard. |
-pwd gsmrootuser_pwd |
Enter the GSMROOTUSER password. If not specified, the user is prompted for the password. |
-savename |
Store in the shard catalog a net service name specified with the |
-force |
If specified, the existing GDS and sharding configuration on the shard and in the shard catalog with information about this shard will be rewritten. |
-cpu_threshold cpu |
Specify the CPU Utilization percentage threshold. |
-disk_threshold disk |
Specify the average latency in milliseconds of a synchronous single-block read. |
-rack rack_id |
Specify an identifier of a rack (hardware cabinet), or another physical grouping of nodes with similar availability characteristics. If specified, GDS will enforce that databases that contain replicated data are not placed in the same rack. If this is not possible an error is raised. |
Usage Notes
ADD CDB adds metadata about a CDB to a sharding catalog. This command is only necessary if you intend to deploy a PDB as a shard with the -cdb option in the ADD SHARD command. CDBs can support multiple PDB shards from different sharded databases; however, this support is limited to only one PDB shard from a given sharded database for each CDB.
Examples
Adds a CDB called db11 to the shard catalog.
GDSCTL> add cdb -connect db11 -pwd gsmrootuser_pwdadd credential
Adds a credential which can be used by the remote scheduler agent to execute shard jobs.
Syntax
add credential -credential credential_name
-osaccount account_name
-ospassword password
[-windows_domain domain_name]Options
Table C-4 GDSCTL add credential Options
| Option | Description |
|---|---|
|
|
Specify the name of the credential to add. |
|
|
Specify the operating system account which will be used for remote jobs. |
|
|
Specify the corresponding password for the account. |
|
|
If a Windows account has been specified, specify the corresponding domain name for that account. |
Usage Notes
This command adds a credential which will be used to execute jobs on sharded hosts in response to administrative commands. The operating system account may be any valid account on the remote host which is in the OSDBA group; the account does not need to be enabled for interactive login unless it is used for other purposes. A specific non-interactive account may be created for use with the remote scheduler, if desired. The OS password must be a valid and current password for the specified account.
If the specified credential already exists, the command returns an error.
Examples
Add a credential named east_region_cred.
GDSCTL> add credential –credential east_region_cred –osaccount agent_user
–ospassword passwordadd database
Adds databases to a Global Data Services region and Global Data Services pool.
Syntax
add database -connect connect_identifier
[-region region_name]
[-gdspool gdspool_name]
[-pwd password]
[-savename]
[-cpu_threshold cpu]
[-disk_threshold disk]
Options
Table C-5 GDSCTL add database Options
| Option | Description |
|---|---|
|
|
Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor for the database being added. |
|
|
Specifies CPU Utilization percentage threshold. |
|
|
Specifies the average latency in milliseconds of a synchronous single-block read. |
|
|
The Global Data Services pool to which the database belongs. |
|
|
The password for the GSMUSER. If |
|
|
The Global Data Services region to which the database belongs. |
|
|
Specify this option to store a net service name specified with the |
Usage Notes
-
You must connect to the Global Data Services catalog database as a user with the pool administrator privileges, using the connect command before running this command.
-
If
-savenameis not specified, then GDSCTL replaces what you specify for the net service name with the full connection string before saving the configuration to the catalog. -
The default for GDSCTL is for
autovncrto be enabled for the catalog. Ifautovncrhas been disabled for the catalog, before configuring Global Data Services pools and adding databases to the Global Data Services configuration, the nodes where those databases run must be part of the valid node checking for registration (VNCR) list for database registration. Use the add invitednode (add invitedsubnet) command to define the valid nodes.
Example
Adds database DB1 to the WEST region and Global Data Services pool MYREADERFARM.
GDSCTL> add database -connect 127.0.0.1:1521:db1 -region west -gdspool
myreaderfarm
Adds a database using myalias instead of the IP address connection string.
GDSCTL> add database -connect myalias -gdspool myreaderfarmExceptions or Error Codes
GDSCTL returns the errors listed below if you use this command incorrectly.
Table C-6 GDSCTL add database Exceptions or Error Codes
| Exception | Description |
|---|---|
|
|
If a pool already contains an Oracle Data Guard broker configuration, then GDSCTL returns an error; you must add databases using Oracle Data Guard in this case. That is, if a pool contains an Oracle Data Guard broker configuration, then additional databases can only be added to the pool by adding them to that Data Guard broker configuration. |
|
|
If the database being added is part of a Oracle Data Guard broker configuration, then GDSCTL returns an error; you must use the add brokerconfig command in this case. |
add file
Adds the contents of a file to the catalog which can be used by subsequent GDSCTL commands.
Syntax
add file -file file_name
-source local_filenameOptions
Table C-7 GDSCTL add file Options
| Option | Description |
|---|---|
-file file_name |
Specify the name of the file object to add. |
-source local_filename |
Specify an operating system file name specifying a file local to the machine running GDSCTL. |
Usage Notes
This command creates a named file object in the catalog and associates the contents of an operating system file with that object by opening the file and storing its contents in the catalog. If the contents of the operating system file change, the MODIFY FILE command can be used to reload the contents into the catalog.
If the specified file object already exists, the command returns an error.
Examples
Add a file named east_region_db_params from the local source file /tmp/dbca_params.txt
GDSCTL> add file -file east_region_db_params -source /tmp/dbca_params.txtadd gdspool
Adds a Global Data Services pool to the Global Data Services framework.
Syntax
add gdspool -gdspool gdspool_name_list
[-users user_list]Options
Table C-8 GDSCTL add gdspool Options
| Option | Description |
|---|---|
|
|
A comma-delimited list of Global Data Services pool names. A Global Data Services pool must have a unique name within its GDS configuration. If you do not specify a name for the pool when you create it, then the name defaults to |
|
|
A comma-delimited list of users that are granted the pool administrator role. |
Usage Notes
-
A default GDS pool, DBPOOLORA, will be created automatically when a GDS catalog is created using create gdscatalog.
-
You must connect to the Global Data Services catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.
-
The default for GDSCTL is for
autovncrto be enabled for the catalog. Ifautovncrhas been disabled for the catalog, then before configuring Global Data Services pools and adding databases to the Global Data Services configuration, the nodes where those databases run must be part of the valid node checking for registration (VNCR) list for database registration. Use the add invitednode (add invitedsubnet) command to define the valid nodes.
Example
Add a Global Data Services pool named MYREADERFARM to the configuration:
GDSCTL> add gdspool -gdspool myreaderfarmadd gsm
Adds a global service manager to the Global Data Services framework.
Syntax
add gsm -gsm gsm_name
-catalog connect_id
[-pwd password]
[-wpwd password]
[-region region_name]
[-localons ons_port]
[-remoteons ons_port]
[-listener listener_port]
[-endpoint gmsendpoint]
[-remote_endpoint remote_endpoint]
[-trace_level level]Options
Table C-9 GDSCTL add gsm Options
| Option | Description |
|---|---|
|
|
Specify the connect identifier for the Global Data Services catalog database. If a network service name is specified, it must be resolvable by the local naming method to a connect descriptor that allows the global service manager being added to connect to the catalog database. |
|
|
Specifies the protocol address that the global services manager listens on for client connection requests. If you use this option, the value that you specify overrides the default endpoint. |
|
|
Specify the name of the global service manager that you want to add. If you do not specify a name, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm. |
|
|
Specify the listener port. The default port is 1522. |
|
|
Specify the local ONS port. If you do not specify this option, then GDSCTL uses the default ONS port (which is 6123 on most platforms). |
|
|
Specify the password for the |
|
|
Specify the region to which the global service manager belongs. The value for |
|
|
Specifies the protocol address that is used by the global service manager to receive database registration requests and communicate with other global service managers in the configuration. If you use this option, the value that you specify overrides the default endpoint. |
|
|
Specify the remote ONS port. If you do not specify this option, then GDSCTL uses the default ONS port (which is 6234 on most platforms). |
|
|
Specify the global service manager trace level (to be used as directed by Oracle Support Services). |
|
|
Specify a password to protect the global service manager wallet. If a wallet password is not specified, a system-generated password is used instead. Note that if a password is specified with this option, the wallet cannot be modified without supplying that password. |
Usage Notes
-
You must specify the Global Data Services catalog database when using this command.
-
You must run this command, locally, on the computer where you want to add the global service manager.
-
You must have operating system privileges on the computer where you want to add the global service manager to run this command.
-
When you run this command, GDSCTL connects to the Global Data Services catalog as the GSMCATUSER user and prompts you for the GSMCATUSER password.
Example
Add a global service manager named gsm1, specifying the location of the Global Data Services catalog database, DB1.
GDSCTL> add gsm -gsm gsm1 -catalog 127.0.0.1:1521:db1add invitednode (add invitedsubnet)
Adds host address or subnet information to the valid node checking for registration (VNCR) list in the catalog, before starting the first global service manager, by establishing a direct connection to the Global Data Services catalog database.
Syntax
add {invitednode | invitedsubnet}
[-group group_name]
[-catalog catalog_dbname [-user user_name/password]]
vncr_idOptions
Table C-10 GDSCTL add invitednode (add invtitedsubnet) Options
| Option | Description |
|---|---|
|
|
Specify the Global Data Services catalog database net alias or connect string. If you enter an invalid address or connect string, then GDSCTL uses the pre-established connection created with the connect command. |
|
|
Specify an alias which defines a group of invited nodes. This alias can be referenced in other commands related to invited nodes. |
|
|
Specify the user credentials for the Global Data Services administrator in the catalog database. If you do not specify a user or a password, then GDSCTL prompts you this information. |
|
|
Specify the list of nodes that can register with the global service manager. The list can include host names or CIDR notation for IPv4 and IPv6 addresses. The wildcard format (*) is supported for IPv4 addresses. The presence of a host name in the list results in the inclusion of all IP addresses mapped to the host name. The host name should be consistent with the public network interface. |
Usage Notes
-
You must connect to the Global Data Services catalog database as a user with the pool administrator privileges, using the connect command before running this command.
-
The default for GDSCTL is that
autovncris enabled for the catalog. Ifautovncrhas been disabled for the catalog, before configuring Global Data Services pools and adding databases to the Global Data Services configuration, then the nodes where those databases run must be part of the valid node checking for registration (VNCR) list for database registration. Use the add invitednode (add invitedsubnet) command to define the valid nodes. -
VNCR enables or denies access from specified IP addresses to Oracle services. See Oracle Database Net Services Administrator's Guide for more information about VNCR.
Examples
Add the netmask 255.255.255.248 to the catalog.
GDSCTL> add invitednode 255.255.255.248
Add the server east1.example.com to the catalog in the alias group EAST_SRV.
GDSCTL> add invitednode east1.example.com
Add the server east2.example.com to the catalog in the alias group EAST_SRV.
GDSCTL> add invitednode east2.example.comadd region
Adds a region to a Global Data Services framework or an Oracle Sharding configuration.
Syntax
add region -region region_list
[-buddy region_name]Options
Table C-11 GDSCTL add region Options
| Option | Description |
|---|---|
|
|
Specify the name of the buddy region. |
|
|
Specify a comma-delimited list of Global Data Services region names. A Global Data Services region should have a name that is unique within the corresponding Global Data Services configuration. If no name is specified at the first region creation time, the default name, oraregion, is given to the region. The region name can be up to 30 characters long and can be any valid identifier - an alphabetical character followed by zero or more alphanumeric ASCII characters or underscore (_). |
Usage Notes
-
When the Global Data Services catalog is created using the create gdscatalog command, the default REGIONORA region is created automatically.
-
You must connect to the Global Data Services catalog database as a user with the Global Data Services administrator privileges, using the command connect before running this command
Example
Add two Global Data Services regions, EAST and WEST to the current configuration:
GDSCTL> add region -region east,westadd service
Adds a global service to a Global Data Services pool.
Syntax
add service
[-gdspool gdspool_name]
-service service_name
(-preferred_all | (-preferred dbname_list [-available dbname_list]))
[-locality {ANYWHERE | LOCAL_ONLY [-region_failover]}]
[-role {PRIMARY | PHYSICAL_STANDBY [-failover_primary] |
LOGICAL_STANDBY | SNAPSHOT_STANDBY}]
[-lag {lag_value | ANY}]
[-notification {TRUE | FALSE}]
[-rlbgoal {SERVICE_TIME | THROUGHPUT}]
[-dtp {TRUE | FALSE}]
[-sql_translation_profile stp_name]
[-clbgoal {SHORT | LONG}]
[-tafpolicy {BASIC | NONE | PRECONNECT}]
[-policy policy]
[-failovertype {NONE | SESSION | SELECT | TRANSACTION | AUTO}]
[-failovermethod {NONE | BASIC}]
[-failoverretry failover_retries]
[-failoverdelay failover_delay]
[-edition edition_name]
[-commit_outcome {TRUE | FALSE}]
[-retention retention_seconds]
[-session_state {DYNAMIC | STATIC | AUTO}]
[-replay_init_time replay_init_time]
[-pdbname pdbname]
[-drain_timeout]
[-stop_option {NONE,IMMEDIATE, TRANSACTIONAL}]
[-failover_restore {NONE|LEVEL1|AUTO}]
[-table_family family]Options
Table C-12 GDSCTL add service Options
| Option | Description |
|---|---|
|
|
Specify a comma-delimited list of available databases on which the service runs if the preferred databases are not available. You cannot specify a list of available instances, only databases. You can use the modify service command with the The list of available databases must be mutually exclusive with the list of preferred databases. You cannot use this option with the |
|
|
Connection Load Balancing Goal. Use a value of The default value for this option, if not specified, is |
|
|
Enable Transaction Guard; when set to |
|
|
Set drain time in seconds. |
|
|
Indicates whether Distributed Transaction Processing should be enabled for this service. This service can either be a service in a policy-managed database or a preferred service on a single node in an administrator-managed database. |
|
|
Specify the initial session edition of the service. When an edition is specified for a service, all subsequent connections that specify the service use this edition as the initial session edition. However, if a session connection specifies a different edition, then the edition specified in the session connection is used for the initial session edition. GDSCTL does not validate the specified edition name. During connection, the connect user must have |
|
|
If you set the |
|
|
For Application Continuity and TAF, this parameter specifies the time delay (in seconds) between reconnect attempts for each incident at failover. |
|
|
TAF failover method (for backward compatibility only). If the failover type ( |
|
|
For Application Continuity and TAF, this parameter determines the number of attempts to connect after an incident. |
|
|
Specify the failover type. To enable Application Continuity for Java, set this parameter to |
|
|
Specify the name of the Global Data Services pool to which you want to add a service. If the pool name is not specified and there is only one |
|
|
Specify the lag for the service in seconds. You can use the keyword The default value for |
|
|
Specify the service region locality. If you do not specify this option, then GDSCTL uses the default value of |
|
|
Enable Fast Application Notification (FAN) for OCI connections. |
|
|
Specify the pluggable database name. |
|
|
Specify the management policy for the service. If you specify If you specify |
|
|
Specify a comma-delimited list of preferred databases on which the service runs. You cannot specify preferred instances, only databases. You can use the modify service command to specify instance-level preferences. The list of preferred databases must be mutually exclusive with the list of available databases. You cannot use this option with the |
|
|
Specifies that all the databases in the Global Data Services pool are preferred databases. Any databases you later add to the pool are configured as preferred databases for this service. You cannot use this option with the |
|
|
Indicates that the service is enabled for region failover. You can only use this option when you specify |
|
|
For Application Continuity, this parameter specifies the time (in seconds) after which replay cannot be initiated. The default value is 300 seconds. |
|
|
If commit_outcome is set to |
|
|
Run-time Load Balancing Goal (for the Load Balancing Advisory). Set this parameter to If you do not use this option, then the value defaults to |
|
|
Specify the database role that the database must be for this service to start on that database. This applies only to Global Data Services pools that contain an Oracle Data Guard broker configuration. See Also: Oracle Data Guard Concepts and Administration for more information about database roles |
|
|
Specify the name of the global service. The service name specified in the A global service name must be unique within a GDS pool and when qualified by domain, must also be unique within a GDS configuration. A global service cannot be created at a database if a local or global service with the same name already exists at that database. A global service name can contain alphanumeric characters, underscore (_), and period (.). The first character must be alphanumeric. The maximum length of a global service name is 64 characters. The maximum length of a domain qualified global service name is 250 characters. An Oracle Net connect descriptor used to connect to a global service must contain a domain qualified service name. |
|
|
For Application Continuity, this parameter specifies whether the session state that is not transactional is changed by the application. A setting of |
|
|
Use this option to specify a SQL translation profile for a service that you are adding after you have migrated applications from a non-Oracle database to an Oracle database. This option corresponds to the SQL translation profile parameter in the Notes:
See Also: Oracle Database SQL Translation and Migration Guide for more information about SQL translation |
|
|
Set the default stop option to |
|
|
Specifies the name of the table family as a property of the service. This parameter takes one of the table family values (root table schema.name) as shown in the If the schema name or the table name is case-sensitive, use two-level quotes (single quotes outside, double quotes inside) around the whole string, for example, '"TESTUSER1.Customers6"'. No quotes are needed if neither name is case sensitive. If this parameter is not specified, but there is currently only one table family, the service created with the |
|
|
TAF policy specification (for administrator-managed databases only). |
Usage Notes
Database-specific options cannot be set at this level. The modify service command must be used to set database-specific options.
One of -preferred_all or -preferred must be specified. If -preferred_all is specified, then all databases in the pool are preferred for this global service (databases inserted into the pool will also have this global service added).
In Oracle Sharding, note that when there is no table_family parameter specified, the service is not associated with any table family, and the value of the property is set to NULL. This is the case for user-defined and composite sharding, where there is always only one table family, and can also be the case when there is only one table family in system-managed sharding. When a table family is deleted (that is, the root table of the table family is dropped) the table_family property of the service is reset to NULL.
Examples
Add a service named sales_report to the Global Data Services pool MYREADERFARM with a value of ANYWHERE for the locality.
GDSCTL> add service -gdspool myreaderfarm -service sales_report -locality ANYWHERE
Add a service named daily_sales_rept to the Global Data Services pool MYDGPOOL with preferred instance set to DB1 and the available instances set to DB3 and DB4. The service should use the basic transaction failover policy.
GDSCTL> add service -gdspool mydgpool -s daily_sales_rept -preferred db1
-available db3,db4 -tafpolicy BASICIn a system-managed sharded database, the table family ID parameter is specified as a property of the service.
GDSCTL> add service –gdspool shdpool –table_family sales.customer -service sales –preferred_all -locality ANYWHERESee Also:
add shard
Add a shard to the shard catalog.
Syntax
add shard -connect connect_identifier
[-pwd password]
[-savename]
[-region region_name]
[-force]
[-cdb cdb_name]
[-cpu_threshold cpu]
[-disk_threshold disk]
[{-shardgroup shardgroup_name | -shardspace shardspace_name}]
[-deploy_as {PRIMARY | STANDBY | ACTIVE_STANDBY}]
[-rack rack_id]
[-replace old_db_name]
[-gg_service (http|https):ogg_host:sm_port/GGHOME_directory]
Options
Table C-13 GDSCTL add shard Options
| Option | Description |
|---|---|
-connect connect_identifier |
Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor for the database being added as the shard. |
-pwd password |
Enter the GSMUSER password. If not specified, the user is prompted for the password. |
-savename |
Store in the shard catalog a net service name specified with the |
-region region_name |
Specify the GDS region that this shard belongs to. This parameter is only valid for user-defined sharding. For other sharing methods it is specified per shardgroup. |
-force |
If specified, the existing GDS and sharding configuration on the shard and in the shard catalog with information about this shard will be rewritten. |
-cdb cdb_name |
If this parameter is used, the shard must be a PDB and the CDB must already exist in the catalog. |
-cpu_threshold cpu |
Specify the CPU Utilization percentage threshold. |
-disk_threshold disk |
Specify the average latency in milliseconds of a synchronous single-block read. |
{-shardgroup shardgroup_name | -shardspace shardspace_name} |
Specify the name of the shardgroup or shardspace that this shard is being added to. Use |
-deploy_as {PRIMARY | STANDBY | ACTIVE_STANDBY} |
Specify the role that is assigned to a shard added to the shardgroup after deployment. This parameter is only used with Data Guard replication. The specified role will be assigned to the shard database after deployment. The valid values are:
If the parameter is not specified, the default value is STANDBY |
-rack rack_id |
Specify an identifier of a rack (hardware cabinet), or another physical grouping of nodes with similar availability characteristics. If specified, GDS will enforce that databases that contain replicated data are not placed in the same rack. If this is not possible an error is raised. |
—replace old_db_name |
This parameter specifies db_unique_name of the old shard when replacing it. The existing parameters of the This parameter is not supported in an Oracle GoldenGate environment. |
-gg_service (http|https):ogg_host:sm_port/deployment |
This parameter is mandatory for Oracle GoldenGate replication and specifies the URI for the GoldenGate Admin Server that will manage the GoldenGate replication at this shard. The format will be as follows Example:
|
Usage Notes
Before running add shard, you must validate the shard by running the validateShard procedure as described in Using Oracle Sharding
-
The shard will become part of the sharded database after a
DEPLOYcommand is executed, except in the case of-replace. - Any databases added to a sharding configuration using
ADD SHARDmust not have ever been deployed as a shard in another configuration (unless-replaceis specified). Re-adding a previously deployed shard will cause theADD SHARDcommand to succeed, but the shard will be unable to successfully deploy and register with the shard director (GSM) when theDEPLOYcommand is eventually run. -
ADD SHARDonly registers the database (shard) with GDS. Replication is not configured on a newly added database and data from other databases is not distributed to it untilDEPLOYis run. -
With Data Guard replication, a shard can be added as a standby to a preexisting Data Guard configuration. There is no need to re-shard the data. It is expected that the shard being added is in a the correct state for configuration; the standbys should be cloned from the primary and have the same DBID. When you run
DEPLOY, the existing primary and standby databases are matched with each other, using the DBID to form a broker configuration. If the broker has not been configured, it is configured, otherwise it is validated that it has been configured correctly. Once the broker is configured, Data Guard does its work, and it should be able to perform catch-up on the standbys if needed before bringing them online. Note that the broker is not configured for a federated database. - The
-DEPLOY_ASoption cannot be used in conjunction with-SHARDGROUPfor system/composite sharding. -
See Working with Oracle GoldenGate Sharding in the Fusion Middleware Using the Oracle GoldenGate Microservices Architecture guide for more information about using Oracle GoldenGate with Oracle Sharding.
-
When using the- replace parameter, see Using Oracle Sharding for more information about its usage.
Note: Oracle GoldenGate replication support for Oracle Sharding High Availability is deprecated in Oracle Database 21c, and will be desupported in Oracle Database 22c.
Examples
Add the shard to shardgroup GROUP1 of the DB11 database.
GDSCTL> add shard –connect db11 –shardgroup group1Replace shard SH1 with database DB11.
GDSCTL> add shard –replace sh1 –connect db11add shardgroup
Add a shardgroup to a shardspace.
Syntax
add shardgroup -shardgroup shardgroup_name
[-region region_name]
[-shardspace shardspace_name]
[-deploy_as {PRIMARY | STANDBY | ACTIVE_STANDBY}]
[-repfactor number]Options
Table C-14 GDSCTL add shardgroup Options
| Option | Description |
|---|---|
|
|
Specify the name of the shardgroup. The name must be unique across all shardspaces. The shardgroup name can be up to 30 characters long and can be an alphabetical character followed by zero or more alphanumeric ASCII characters or an underscore (_). |
|
|
Specify the name of the region. If not specified, a default region will be used. |
|
|
Specify the name of the shardspace to which to add the shardgroup. |
|
|
Specify the role that is assigned to a shard added to the shardgroup after deployment. This parameter is only used with Data Guard replication. The valid values are: If the parameter is not specified, the default value is
|
|
|
Specify the replication factor - the number of replicas for each piece of data stored in this shardgroup. This parameter can only be used with Oracle GoldenGate replication and is mandatory unless the default value of replication factor was specified in |
Usage Notes
This command can only be used with system-managed or composite sharding, not user-defined sharding.
See Working with Oracle GoldenGate Sharding in the Fusion Middleware Using the Oracle GoldenGate Microservices Architecture guide for more information about using Oracle GoldenGate with Oracle Sharding.
Note: Oracle GoldenGate replication support for Oracle Sharding High Availability is deprecated in Oracle Database 21c, and will be desupported in Oracle Database 22c.Examples
Add the GROUP1 shardgroup in the WEST region within the GOLD shardspace.
GDSCTL> add shardgroup -shardgroup group1 -region west –shardspace goldadd shardspace
Add a shardspace to the shard catalog.
Syntax
add shardspace -shardspace shardspace_name
[-chunks number]
[-protectmode dg_protection_mode]Options
Table C-15 GDSCTL add shardspace Options
| Option | Description |
|---|---|
-shardspace shardspace_name |
Specify the name of the shardspace. The shardspace name can be up to 30 characters long and can be an alphabetical character followed by zero or more alphanumeric ASCII characters or an underscore (_). |
-chunks number |
Specify the number of unique chunks in the shardspace. The value of This parameter does not apply to user-defined sharding. All shardgroups in a shardspace have the same number of chunks. If this parameter is not specified, the default number of chunks is determined at the time of execution of the first |
-protectmode dg_protection_mode |
Specify the Data Guard protection mode: |
Usage Notes
The command is applicable to user-defined sharding, composite sharding that assumes multiple shardspaces, and system managed sharding when there are no other shardspaces present in the current configuration.
Examples
Add the GOLD shardspace with Data Guard MAXAVAILABILITY protection mode.
GDSCTL> add shardspace –shardspace gold –protectmode maxavailability
config
Displays the configuration data for all components defined for the configuration.
Syntax
config [-support]Options
Table C-16 GDSCTL config Options
| Option | Description |
|---|---|
-support |
If specified, GDSCTL output displays additional information for support purposes. |
Usage Notes
When using the command, it does not matter if the components (except for the catalog database) are started. The configuration data displayed is retrieved from the catalog database.
Example
Display the configuration data for all components defined for the configuration.
GDSCTL> configconfig backup
Configure Sharded Database (SDB) Backup
Syntax
config backup -rccatalog rc_connstr
[-target (PRIMARY|STANDBY)]
[(-destination (ALL|CATALOG| <shard_list>):<deviceconfig>:<channelconfig>)+]
[-frequency #level0_days|[#level0_days]:[#level1-days]]
[-incremental (DIFFERENTIAL|CUMULATIVE)]
[-retention #recovery_window_days]
[-cdb sc_cdb_connstr] [-catpwd password]
[-shard shard_list] [-async]Options
Table C-17 GDSCTL config backup Options
| Option | Description |
|---|---|
-rccatalog rc_connstr |
A connection string to the recovery catalog database. |
-target (PRIMARY|STANDBY) |
For shards in Data Guard configurations, database
backup can be done at the primary or the standby. The default is the
standby. The value for this option is either
PRIMARY or STANDBY.
|
-destination {ALL|CATALOG| shard_list:deviceconfig:channelconfig} |
Definition of device types and channels for target
databases. It consists of three components: shard-list, deviceconfig and
channelconfig.
|
-starttime ALL|CATALOG|shard_list:hh:mm |
Backup start time for individual shards and the
sharded database (SDB) catalog database. It must be a local time in
a day in the time zone where the target database is located and
specified in 24-hour format. The smallest unit for the time is
minute. For example, CATALOG:22:30 specifies that
the scheduled backup for the SDB catalog database should be started
at 10:30 PM. The default backup start time for a target database is
the midnight (00:00). Internally the start time is converted into a
UTC time before it’s passed to DBMS Scheduler to be set as the job
start time
|
-frequency #level0_days|#level0_days:#level1_days |
Backup repeat intervals for incremental level 0 and level 1 backups in days. The first number is the interval for incremental level 0 backups and the second is that for level 1 backups. If a single number is specified without a following comma, it defines the interval for level 0 backups. If a comma appears in the parameter, then the number to its left is the backup interval for level 0 backups and that to its right is the interval for level 1 backups, but both numbers are optional in this case. The default intervals for level 0 and level 1 backups are respectively 7 and 1 day. |
-incremental
DIFFERENTIAL|CUMULATIVE |
Incremental level 1 backup type to either
DIFFERENTIAL or CUMULATIVE.
The default is DIFFERENTIAL.
|
-retention #recovery_window_days |
A recovery window for backup files. It must be a positive integer and specified in days. The default is 30 days. |
-cdb sc_cdb_connstr |
Required if the SDB catalog database is a PDB. It specifies a connect string for the container database of the SDB catalog database. |
-catpwd
password |
Password for user GSMCATUSER. Prompted if not specified. This password only needs to be specified once for this command in an entire GDSCTL session. |
-shard shard_list |
shard_list specifies
a comma separated list of shard identifiers. They can be shard
space, shard group or shard names. If the same name is used for a
shard space, shard group or shard, shard space takes the highest
precedence followed by shard group and then shard. There are two
special words for this option: ALL and
CATALOG. ALL represents the
SDB catalog database and all the shards in the SDB while
CATALOG represents only the SDB catalog
database. The default is all shards.
|
-async |
When specified, all tasks to configure the backup for the shards will run in background. By default, the task will run in foreground. The task for the SDB catalog database will always run in foreground regardless of this flag setting. |
Examples
The following example configures a backup channel of DISK type for
the SDB catalog database, two parallel channels of DISK type for
each of the shards (shard spaces dbs1 and dbs2 are used in the shard list), the
backup retention window to 14 days, the level 0 and level 1 incremental backup
repeat intervals to 7 and 1 day and the backup start time to 12:00 AM, leaving the
incremental backup type to the default DIFFERENTIAL and the backup
target type to the default STANDBY.
GDSCTL> config backup -rccatalog rcadmin/rman@inst6 -destination
"CATALOG::configure channel device type disk format '/tmp/rman/backups/%d_%U'" -destination "dbs1,dbs2:configure device type disk parallelism 2:configure
channel 1 device type disk format '/tmp/rman/backups/1/%U';configure channel 2
device type disk format '/tmp/rman/backups/2/%U'" -starttime ALL:00:00 -
retention 14 -frequency 7:1 -catpwd gsm -cdb gsm_admin/gsm@instroot1;When CONFIG BACKUP is not provided with any parameters, it shows the
current backup configuration.
GDSCTL> config backup
Recovery catalog database user: rcadmin
Recovery catalog database connect descriptor: (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=den02qxr)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=cdb6_pdb1.regress.rdbms.dev.example.com)))
Catalog database root container user: gsm_admin
Catalog database root container connect descriptor: (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=den02qxr)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=v1908.regress.rdbms.dev.example.com)))
Backup retention policy in days: 14
Level 0 incremental backup repeat interval in minutes: 10080
Level 1 incremental backup repeat interval in minutes: 1440
Level 1 incremental backup type : DIFFERENTIAL
Backup target type: STANDBY
Backup destinations:
catalog::channel device type disk format '/tmp/rman/backups/%d_%u'
dbs1,dbs2:device type disk parallelism 2:channel 1 device type disk format '/tmp/rman/backups/1/%u';channel 2 device type disk format '/tmp/rman/backups/2/%u'
catalog::configure channel device type disk format '/tmp/rman/backups/%d_%u'
dbs1,dbs2:configure device type disk parallelism 2:configure channel 1 device type disk format '/tmp/rman/backups/1/%u';configure channel 2 device type disk format '/tmp/rman/backups/2/%u'
Backup start times:
all:00:00
config cdb
Displays properties of a specified CDB.
Syntax
config cdb [-cdb cdb_name]Options
Table C-18 GDSCTL config cdb Options
| Option | Description |
|---|---|
-cdb cdb_name |
Specify the name of the cdb. |
Examples
Display information about CDB called cdb1.
GDSCTL> config cdb -cdb cdb1
Name: tstsdbyb
Connection string: (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=cdb1host)(PORT=1521))
(CONNECT_DATA=(SERVICE_NAME=cdb1.example.com)))
SCAN address:
ONS remote port: 0
Disk Threshold, ms: 20
CPU Threshold, %: 75
Version: 18.0.0.0
Rack: config chunks
Displays properties of a specified chunk.
Syntax
config chunks [-support]
( [-shard shd] | [-shardgroup sh] | [-show_reshard] | [-cross_shard] )
( [-chunk chunk_id] | [-key key [-superkey superkey] ) Options
Table C-19 GDSCTL config chunks Options
| Option | Description |
|---|---|
-chunk chunk_id |
Specify a numeric chunk ID. |
-cross_shard |
Show cross-shard placement. |
-key key |
Sharding key |
-shard shd |
The name of the shard. |
-shardgroup sh |
The name of the shardgroup. |
-show_reshard |
Display information about ongoing chunk management operations. |
-superkey superkey |
Sharding super key. This is only needed for the composite sharding method. |
-support |
If specified, GDSCTL output displays additional information. |
Usage Notes
The config chunks command lists all of the database shards and the chunks that they contain. Some chunks are listed more than once if there are standbys that contain replicated chunks.
Examples
The output from config chunks is shown below.
GDSCTL> config chunks
Chunks
------------------------
Database From To
-------- ---- --
sh1a 1 10
sh1b 1 10config credential
Displays remote credentials currently available for shard jobs.
Syntax
config credential [-support] Options
Table C-20 GDSCTL config credential Options
| Option | Description |
|---|---|
-support |
If specified, GDSCTL output displays additional information. |
Usage Notes
This command displays all existing remote credentials that can be used to execute sharding jobs.
Examples
Display credentials.
GDSCTL> config credential
Name Username Windows domain
--------------- -------- --------------
CREDENTIAL_ONE OraUser
CREDENTIAL_TWO OraUser2 config database
Displays the static configuration data stored in the catalog for the specified database.
Syntax
config database [-support]
[-database db_name] Options
Table C-21 GDSCTL config database Options
| Syntax | Description |
|---|---|
|
|
Specify the name of a database. If you do not specify a database name, then GDSCTL displays the configuration data for all databases in the Global Data Services configuration. |
|
|
GDSCTL output displays additional support information. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command
Examples
Display the static configuration data stored in the catalog for all the databases in the Global Data Services configuration.
GDSCTL> config database
The gdsctl config database command returns information similar to the following:
Name Pool Status Region
---- ---- ------ ------
dbcat sales Ok east
dbcat1 sales Ok west
dbcat3 sales Ok westconfig file
Displays file objects currently available that can be specified in GDSCTL commands.
Syntax
config file [-support]
[-file file_name] Options
Table C-22 GDSCTL config file Options
| Option | Description |
|---|---|
-file file_name |
The name of the file object. |
-support |
If specified, GDSCTL output displays additional information. |
Usage Notes
If the specified file object does not exist, the command returns an error.
Example
Display the list of files defined in the catalog database.
GDSCTL> config file
Name
------
dbcfg1config gdspool
Displays the static configuration data that is stored in the catalog for the specified database pool.
Syntax
config gdspool [-support]
[-gdspool gdspool_name]Options
Table C-23 GDSCTL config gdspool Options
| Syntax | Description |
|---|---|
|
|
Specify the name of a database pool. If you do not specify a database pool name, then GDSCTL displays the configuration data for all database pools. |
|
|
GDSCTL output displays additional support information. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command
Example
Display the static configuration data stored in the catalog for all Global Data Services pools.
GDSCTL> config gdspool
The gdsctl config gdspool command returns output similar to the following:
Name Broker
---- ------
dbpoolora No
mkt No
sales No
marketing No
The following command shows the configuration detail of Global Data Services pool marketing.
GDSCTL> config gdspool -gdspool marketing
The above example returns output similar to the following:
GDS Pool administrators
------------------------
Databases
------------------------
dbcat2
dbcat1
dbcat3
Services
------------------------
sales_report
sales_analysis
sales_estimation
sales_peragent
sales_globalconfig gsm
Displays the static configuration data stored in the catalog for the specified global service manager.
Syntax
config gsm [-gsm gsm_name]
[-support]Options
Table C-24 GDSCTL config gsm Options
| Syntax | Description |
|---|---|
|
|
Specify the name of a global service manager. If you do not specify a global service manager name, then GDSCTL displays the static configuration data for all global service managers in the cloud. |
|
|
If specified, GDSCTL output displays additional information. |
Usage Notes
You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command
Example
Display the static configuration data stored in the catalog for the global service manager mygsm:
GDSCTL> config gsm -gsm mygsm
The gdsctl config gsm command returns output similar to the following:
Name: mygsm
Endpoint 1: (ADDRESS=(HOST=stcal.us.hq.com)(PORT=1523)(PROTOCOL=tcp))
Endpoint 2: (ADDRESS=(HOST=stcal.us.hq.com)(PORT=1523)(PROTOCOL=tcp))
Local ONS port: 6123
Remote ONS port: 6234
Region: east
Buddy
------------------------config region
Displays the static configuration data for the specified region.
Syntax
config region [-region region_name]
[-support]Options
Table C-25 GDSCTL config region Options
| Syntax | Description |
|---|---|
|
|
Specify the name of a global service manager. |
|
|
If specified, GDSCTL output displays additional information. |
Example
Displays the static configuration data for the specified region.
GDSCTL> config region -region east
Displays the following output:
Name Buddy
---- -----
east
config sdb
Displays the static configuration data stored in the catalog for the sharded database.
Syntax
config sdb [-support]
Options
Table C-26 GDSCTL config sdb Options
| Option | Description |
|---|---|
-support |
If specified, GDSCTL output displays additional information. |
Examples
The output for config sdb is similar to the following.
GDSCTL> config sdb GDS Pool administrators ------------------------ Replication Type ------------------------ Data Guard Shard type ------------------------ System-managed Shard spaces ------------------------ shardspaceora Services ------------------------ oltp_ro_srvc oltp_rw_srvc
config service
Displays the static configuration data stored in the Global Data Services catalog for the specified services that are located in a database pool.
Syntax
config service [-gdspool gdspool_name]
[-service service_name]
[-support]Options
Table C-27 GDSCTL config service Options
| Syntax | Description |
|---|---|
|
|
Specify the name of the database pool that contains the services. If the name is not specified, and there is only one |
|
|
Specify a comma-delimited list of service names. If you do not use this option, then GDSCTL displays the configuration data for all services in the specified database pool. |
|
|
If specified, GDSCTL output displays additional information. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command
Examples
Show all the services in the user's Global Data Services pool:
GDSCTL> config service
The gdsctl config service command returns information similar to the following:
Name Network name Pool Started Preferred all
---- ------- ---- ---- ------- --------- ---
sales_svc1 sales_svc1.sales.oradbcloud sales Yes Yes
sales_svc2 sales_svc2.sales.oradbcloud sales NO Yes
sales_svc3 sales_svc3.sales.oradbcloud sales Yes Yes
mkt_svc1 mkt_svc1.mkt.oradbcloud mkt NO Yes
Display the static configuration data stored in the Global Data Services catalog for sales:
GDSCTL> config service -service sales
Name: sales
Network name: sales.sdhdpool.oradbcloud
Pool: shdpool
Started: Yes
Preferred all: Yes
Locality: ANYWHERE
Region Failover: No
Role: NONE
Primary Failover: No
Lag: ANY
Runtime Balance: SERVICE_TIME
Connection Balance: LONG
Notification: Yes
TAF Policy: NONE
Policy: AUTOMATIC
DTP: No
Failover Method: NONE
Failover Type: NONE
Failover Retries:
Failover Delay:
Edition:
PDB:
Commit Outcome:
Retention Timeout:
Replay Initiation Timeout:
Session State Consistency:
SQL Translation Profile:
Stop option: NONE
Drain timeout:
Table Family: sales.customer
Supported services
------------------------
Database Preferred Status
-------- --------- ------
shdb Yes Enabled
shdc Yes Enabled
config shard
Displays properties of a specified shard.
Syntax
config shard -shard shard_name
[-support]Options
Table C-28 GDSCTL config shard Options
| Option | Description |
|---|---|
-shard shard_name |
Specify the name of the shard. |
-support |
GDSCTL output displays additional support information. |
Examples
GDSCTL> config shard
Name Shard Group Status State Region Availability
---- ----------- ------ ----- ------ ------------
den17b dbs1 Ok Deployed east ONLINE
den17c dbs2 Ok Deployed east READ ONLY The State column in the results can have the following values:
-
Created: Indicates that
add shardorcreate shardwas run, butdeployhas not yet been run for that shard. -
Replicated: Indicates that
deploywas run and the Data Guard broker configuration was created. No other metadata (chunks, for example) are on the shard and the shard has not yet registered with the shard director -
Sharded: Indicates that the database has successfully registered with the shard director. Creates chunk metadata for new shards, but does not start any automatic rebalancing. To manually get from Replicated to Sharded and beyond, run
GDSCTL sync -database <shard_name>. This is what is happening internally in this step. -
Deployed: Indicates that all DDL catchup is completed and the shard is ready for operations. At this point, any scheduled chunk moves are begun in the background. A shard can be Deployed without having been rebalanced because rebalancing is a background operation.
config shardgroup
Displays properties of a specified shardgroup.
Syntax
config shardgroup [-shardgroup shardgroup_name]
[-support]Options
Table C-29 GDSCTL config shardgroup Options
| Option | Description |
|---|---|
-shardgroup shardgroup_name |
Specify the name of the shardgroup. |
-support |
GDSCTL output displays additional support information. |
Examples
The config shardgroup command generates the following output.
GDSCTL> config shardgroup –shardgroup northeast
Shard Group Chunks Region Shard space
----------- ------ ------ -----------
dbs1 10 east shd1
dbs2 10 east shd1
By specifying a shardgroup, you get the following output.
GDSCTL> config shardgroup -shardgroup dbs1
Shard Group: dbs1
Chunks: 10
Replicas:
Region: east
Shard space: shd1
Shards
------------------------
Shard Chunks
----- ------
den17b 10 config shardspace
Displays properties of a specified shardspace.
Syntax
config shardspace [-shardspace shardspace_name]
[-support]Options
Table C-30 GDSCTL config shardspace Options
| Option | Description |
|---|---|
-shardspace shardspace_name |
Specify the name of the shardspace. Optional for system-managed sharding. |
-support |
GDSCTL output displays additional support information. |
Usage Notes
The output varies depending on whether the command is issued on a shardspace configured in a user-defined SDB.
Examples
The config shardspace command generates the following output
GDSCTL> config shardspace Shard space Chunks ----------- ------ shd1 10
When a shardspace is specified, the output is returned in the following format.
GDSCTL> config shardspace -shardspace silver
Shard Group Region Role
----------- ------ ----
dbs1 east Primary
dbs2 east Standby
PROTECTION_MODE Chunks
--------------- ------
MaxProtection 10 config table family
Displays information about all table families in the sharded database.
Syntax
config table familyExamples
The config table family command generates the following output
GDSCTL> config table family
Schema Name ID Shard Type
------ ----- ----- ----------
sales customer 1 System
hr department 25 Systemconfig vncr
Displays the static configuration data stored in the catalog for valid node checking for registration (VNCR).
Syntax
config vncr [-group group_name]
[-support]Options
Table C-31 GDSCTL config vncr Options
| Syntax | Description |
|---|---|
-group group_name |
A group alias that defines a group of VNCRs. The same alias can be used in multiple ADD calls. |
-support |
GDSCTL output displays additional support information. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command
Example
The config vncr command returns information similar to the following:
GDSCTL> config vncr
Name Group ID
---- --------
192.0.2.1 group_nameconfigure
Sets the GDSCTL parameters.
Syntax
configure [-gsmport port]
[-timeout seconds]
[-show]
[-driver {THIN | OCI}]
[-resolve {IP | HOSTNAME | QUAL_HOSTNAME}]
[-log {ALL|OFF|INFO|FINE|FINER|FINEST|SEVERE|WARNING}]
[-log_file log_file]
[-gsm gsm_name]
[-showtime ON|OFF]
[-verbose ON|OFF]
[-save_config]
[-gsmdebug (1|0)]
[-spool]
[-width]Options
Table C-32 GDSCTL configure Options
| Syntax | Description |
|---|---|
-driver THIN | OCI |
Oracle JDBC driver. |
-gsm gsm_name |
Set current global service manager. |
-gsmdebug (1|0) |
Global service manager debug mode. |
-gsmport port |
Default global service manager port. |
-log {ALL | OFF | INFO | FINE | FINER | FINEST | SEVERE | WARNING} |
Set the logging level. The default is |
-log_file log_file |
Set the location of the log file. The default is |
-resolve IP | HOSTNAME| QUAL_HOSTNAME |
Default host resolution for global service manager endpoint. |
-save_config |
Store configuration changes to GSM.ORA. |
-show |
Show the configuration. |
-showtime ON|OFF |
Print time stamps. |
-spool |
Enable spooling. Warning: prints security-sensitive information to log file. |
-timeout seconds |
Global service manager requests timeout in seconds. |
-verbose ON|OFF |
Enable or disable verbose output. The default value is ON. |
-width |
Console width in number of characters (default 80). |
Example
Set the mygsm driver to OCI:
configure -driver OCI mygsmconnect
Specifies the credentials to administer a global service management environment. Credentials must be specified to perform certain operations using GDSCTL.
Syntax
connect [user_name[/password]]@connect_identifierOptions
Table C-33 GDSCTL connect Options
| Syntax | Description |
|---|---|
connect_identifier |
Specify an Oracle Net connect descriptor or a net service name that maps to a connect descriptor (for example, a list of global service managers). |
password |
Specify the password for the specified user. If you do not specify a password, then you are prompted to enter a password. The password is obscured when entered. |
user_name |
Specify the name of the user to connect as. The user that you specify must have either the Global Data Services administrator or the pool administrator role. If you specify no user name, then you are prompted for a user name. |
Usage Notes
You must connect to the catalog database as a user with either the Global Data Services administrator or the pool administrator privileges, depending on which command you want to run after you connect
WARNING:
Specifying a password as a connect command option is a security risk. You can avoid this risk by omitting the password, and entering it only when the system prompts for it.
Examples
Connect as the gsmadmin user to the private cloud:
GDSCTL> connect gsmadmin@mycloud
Enter password:
Connect using a connect descriptor, without specifying a user name and password:
GDSCTL> connect (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=myhost)(PORT=1521)))
Enter username: create catalog
The create catalog command is deprecated. Use create gdscatalog or create shardcatalog instead. Creates a Global Data Services catalog for global service management in a specific database.
Syntax
create catalog -database db_name
[-user user_name[/password]
[-region region_name_list]
[-gdspool gdspool_name_list]
[-configname confname]
[-autovncr {ON | OFF}]
[-force]Options
Table C-34 GDSCTL create catalog Options
| Options | Description |
|---|---|
-autovncr {ON | OFF} |
This option enables ( See the Usage Notes below for important information about this option. |
-configname confname |
Specify the name of the GDS configuration. The default configuration name is The configuration name can be up to 32 bytes long and can contain an alphabetical character followed by zero or more alphanumeric ASCII characters, ‘_', or ‘#' and possibly separated by periods if there are multiple identifiers. |
-database db_name |
Specify the connect identifier for the database in which you want to create catalog. |
-force |
Rewrites existing global service manager configuration on catalog database. |
-gdspool gdspool_name_list |
Specify a comma-delimited list of database pool names. When you use this option, the specified database pools are created as part of the catalog creation. If you do not specify this option, then GDSCTL creates a default database pool named DBPOOLORA. |
-region region_name_list |
Specify a comma-delimited list of region names. This command creates each region and adds the regions to the catalog. If you do not specify a region, then a default region named REGIONORA is created. |
-user user_name[/password] |
Specify a user (and optionally, the password) that has the Global Data Services administrator privileges on the catalog database. If you do not use this option, then GDSCTL prompts you for the name and the password of a user with Global Data Services administrator privileges. If you specify a user name but not the password for the user, then GDSCTL prompts you for the password. |
Usage Notes
This command is deprecated in Oracle Database 12c Release 2. Use create gdscatalog or create shardcatalog for your specific environment.
The create catalog command generates a pair of PKI public and private keys and stores them in the catalog, along with a fixed string "GSM" that is encrypted with a private key. It uses the GSMCATUSER password.
You must have the Global Data Services administrator privileges on the computer where you want to create the Global Data Services catalog.
Auto VNCR is best used in environments with simple private networks where ease of configuration is the most important consideration. To have the highest level of control over which hosts may participate in a GDS configuration, disable Auto VNCR and explicitly add the IP addresses of each database host to the VNCR configuration.
When —autovncr is enabled, Oracle attempts to find the host name of the target database when it is validated during add shard or add database execution. This host is then automatically added to the VNCR list in the catalog as an invited node. This mechanism is not compatible with all network configurations and may not work in the following cases:
-
The catalog or global service manager host does not know how to translate the host name discovered on the target database host to an real IP address. This can happen if they have different names in the hosts file or DNS on the catalog or global service manager host, or if they just do not exist on those hosts.
-
The target database host has multiple public network addresses, and Oracle chooses an address that is different than the address used when the database registers with the global service manager. This can happen if the host has multiple network cards or has configured virtual network interfaces.
-
The database is running Oracle RAC, and other Oracle RAC instances run on a different subnet. This is not a recommended configuration for Oracle RAC. Refer to the Oracle RAC documentation for recommended configurations. With Oracle RAC, Oracle Database connects to a single database host to validate the target, and returns a subnet mask that includes the entire subnet that the host is on. If other instances are on a different subnet, they have no valid VNCR entry, and registration is rejected.
When —autoVNCR is not enabled, or, if any of the above cases apply, new hosts should be added manually using add invitednode (add invitedsubnet).
Example
Create a Global Data Services catalog for global service management in the database named DB1. Also create the regions EAST and WEST, and the database pool READERFARM.
GDSCTL> create catalog -database db1 -region west,east -gdspool readerfarmcreate gdscatalog
Creates a Global Data Services catalog for global service management in a specific database.
Syntax
create gdscatalog -database db_name
[-user user_name[/password]
[-region region_name_list]
[-gdspool gdspool_name_list]
[-configname confname]
[-autovncr {ON | OFF}]
[-force]Options
Table C-35 GDSCTL create gdscatalog Options
| Syntax | Description |
|---|---|
-autovncr {ON | OFF} |
This option enables ( See the Usage Notes below for important information about this option. |
-configname confname |
Specify the name of the GDS configuration. The default configuration name is The configuration name can be up to 32 bytes long and can contain an alphabetical character followed by zero or more alphanumeric ASCII characters, ‘_', or ‘#' and possibly separated by periods if there are multiple identifiers. |
-database db_name |
Specify the connect identifier for the database in which you want to create catalog. |
-force |
Rewrites existing global service manager configuration on catalog database. |
-gdspool gdspool_name_list |
Specify a comma-delimited list of database pool names. When you use this option, the specified database pools are created as part of the catalog creation. If you do not specify this option, then GDSCTL creates a default database pool named DBPOOLORA. |
-region region_name_list |
Specify a comma-delimited list of region names. This command creates each region and adds the regions to the catalog. If you do not specify a region, then a default region named REGIONORA is created. |
-user user_name[/password] |
Specify a user (and optionally, the password) that has the Global Data Services administrator privileges on the catalog database. If you do not use this option, then GDSCTL prompts you for the name and the password of a user with Global Data Services administrator privileges. If you specify a user name but not the password for the user, then GDSCTL prompts you for the password. |
Usage Notes
The create gdscatalog command generates a pair of PKI public and private keys and stores them in the catalog, along with a fixed string "GSM" that is encrypted with a private key. It uses the GSMCATUSER password.
You must have the Global Data Services administrator privileges on the computer where you want to create the Global Data Services catalog.
Auto VNCR is best used in environments with simple private networks where ease of configuration is the most important consideration. To have the highest level of control over which hosts can participate in a GDS configuration, disable Auto VNCR and explicitly add the IP addresses of each database host to the VNCR configuration.
When —autovncr is enabled, Oracle attempts to find the host name of the target database when it is validated during add shard or add database execution. This host is then automatically added to the VNCR list in the catalog as an invited node. This mechanism is not compatible with all network configurations and may not work in the following cases:
-
The catalog or global service manager host does not know how to translate the host name discovered on the target database host to an real IP address. This can happen if they have different names in the hosts file or DNS on the catalog or global service manager host, or if they just do not exist on those hosts.
-
The target database host has multiple public network addresses, and Oracle chooses an address that is different than the address used when the database registers with the global service manager. This can happen if the host has multiple network cards or has configured virtual network interfaces.
-
The database is running Oracle RAC, and other Oracle RAC instances run on a different subnet. This is not a recommended configuration for Oracle RAC. Refer to the Oracle RAC documentation for recommended configurations. With Oracle RAC, Oracle Database connects to a single database host to validate the target, and returns a subnet mask that includes the entire subnet that the host is on. If other instances are on a different subnet, they have no valid VNCR entry, and registration is rejected.
When —autoVNCR is not enabled, or, if any of the above cases apply, new hosts should be added manually using add invitednode (add invitedsubnet).
Example
Create a Global Data Services catalog for global service management in the database named DB1. Also create the regions EAST and WEST, and the database pool READERFARM.
GDSCTL> create gdscatalog -database db1 -region west,east -gdspool readerfarmcreate shard
Create a new shard and add it to a shardspace or shardgroup.
Syntax
create shard [{-shardgroup shardgroup_name | –shardspace shardspace_name}]
[-region region_name]
[-deploy_as {primary | standby | active_standby}]
[-rack rack_id]
[-gg_service (http|https):ogg_host:sm_port/deployment
-gg_password gg_user_password]
-destination destination_name
{-credential credential_name |
-osaccount account_name
-ospassword password
[-windows_domain domain_name]}
[-dbparam db_parameter_file |
-dbparamfile db_parameter_file]
[-dbtemplate db_template_file |
-dbtemplatefile db_template_file]
[-netparam net_parameter_file |
-netparamfile net_parameter_file]
[-serviceuserpassword pwd]
[-sys_password]
[-system_password]
Options
Table C-36 GDSCTL create shard Options
| Option | Description |
|---|---|
-credential credential_name |
The name of the credential object. |
-dbparam db_parameter_file |
Specify a file object containing Database Configuration Assistant (DBCA) parameters to use during database creation on the remote machine. |
-dbparamfile db_parameter_file |
Specify an operating system file name containing Database Configuration Assistant (DBCA) parameters to use during database creation on the remote machine. GDSCTL uses this to open a local file on the machine on which it is running. |
-dbtemplate db_template_file |
Specify a file object containing Database Configuration Assistant (DBCA) database template information to use during database creation on the remote machine. |
-dbtemplatefile db_template_file |
Specify an operating system file name containing Database Configuration Assistant (DBCA) database template information to use during database creation on the remote machine. GDSCTL uses this to open a local file on the machine on which it is running. |
-deploy_as {PRIMARY | STANDBY | ACTIVE_STANDBY} |
Specify the role that is assigned to a shard added to the shardgroup after deployment. This parameter is only used with Data Guard replication. The specified role will be assigned to the shard database after deployment. The valid values are:
If the parameter is not specified, the default value is STANDBY |
-destination destination_name |
The name of the remote executable agent through which the database will be created as listed in the |
-gg_password gg_user_password |
Specifies the password for the user account that will be created on the shard database that the Oracle GoldenGate replication processes will use. This parameter is mandatory for Oracle GoldenGate replication. |
-gg_service hostname:port/GGHOME_directory |
This parameter is mandatory for Oracle GoldenGate replication and specifies the URI for the GoldenGate Admin Server that will manage the GoldenGate replication at this shard. The format will be as follows Example:
|
-netparam net_parameter_file |
Specify a file object containing Net Configuration Assistant (NETCA) parameters to use during network listener setup on the remote machine. |
-netparamfile net_parameter_file |
Specify an operating system file name containing Net Configuration Assistant (NETCA) parameters to use during network listener setup on the remote machine. GDSCTL uses this to open a local file on the machine on which it is running. |
-osaccount account_name |
Specify the operating system account which will be used for remote jobs |
-ospassword password |
Specify the corresponding password for the account name specified in the |
-rack rack_id |
Specify an identifier of a rack (hardware cabinet), or another physical grouping of nodes with similar availability characteristics. If specified, GDS will enforce that databases that contain replicated data are not placed in the same rack. If this is not possible an error is raised. |
-region region_name |
Specify the GDS region database, catalog, shard, shardgroup, or shard director (global service manager) that this shard belongs to. This parameter is only valid for user-defined sharding. For other sharing methods it is specified per shardgroup. |
-serviceuserpassword pwd |
The password for the operating system account under which Windows RDBMS and TNSLSNR services run. |
{-shardgroup shardgroup_name | -shardspace shardspace_name} |
Specify the name of the shardgroup or shardspace that this shard is being added to. Use |
-sys_password |
SYS account password. |
-system_password |
SYSTEM account password. |
-windows_domain domain_name |
Specify a corresponding domain name for an account if a Windows account has been specified in the |
Usage Notes
CREATE SHARD causes a new database to be created using DBCA and NETCA.
CREATE SHARD only registers the database with GDS. The database is not created and replication is not configured on a newly create database, and data from other databases is not distributed to it until DEPLOY is executed.
The —DEPLOY_AS option can only be specified if a shard is being added to a shardspace. If a shard is being added to a shardgroup, its role will determined by the role of the shardgroup. The role is assigned when the shard gets deployed.
If the —CREDENTIAL option is specified, the credential name must have previously been created with the ADD CREDENTIAL command. If —CREDENTIAL is not specified, then OSACCOUNT and OSPASSWORD (and optionally WINDOWS_DOMAIN) must be specified.
The value for DBPARAM, DBTEMPLATE, or NETPARAM must be the name of a file object as previously specified in the ADD FILE command. The file content specified by the -netparam or -netparamfile parameter in CREATE SHARD is a NETCA response file. Examples can be found in $ORACLE_HOME/assistants/netca. By default, port 1521 is used with a listener name of LISTENER_shard_name. These values can be changed by modifying a sample response file and specifying it using the -netparam or -netparamfile parameters. The file content specified by the -dbtemplate or -dbtemplatefile parameter in CREATE SHARD is a DBCA template file. Examples of template files can be found in $ORACLE_HOME/assistants/dbca/templates. If not specified, the General_Purpose.dbc file located in the above directory on the shard destination host will be used. The format of the file contents specified in the -dbparam or -dbparamfile command is a space-delimited list of DBCA command line parameters and values on one or more lines. For example, the following is an example of a valid parameter file: -gdbName shard1.example.com -initParams sort_area_size=200000. For a complete list of possible DBCA parameters, run dbca -help -createDatabase.
See Working with Oracle GoldenGate Sharding in the Fusion Middleware Using the Oracle GoldenGate Microservices Architecture guide for more information about using Oracle GoldenGate with Oracle Sharding.
Note: Oracle GoldenGate replication support for Oracle Sharding High Availability is deprecated in Oracle Database 21c, and will be desupported in Oracle Database 22c.
Example
Create a shard.
GDSCTL> create shard –shardgroup group1 –destination dbdest –credential group1_cred
–dbparam group1_db_paramscreate restorepoint
Create Global Restore Points.
Syntax
create restorepoint [-name restore_point_name]Options
Table C-37 GDSCTL create restorepoint Options
| Syntax | Description |
|---|---|
-name restore_point_name |
The name of the global restore point to create in the sharded database. If it is not provided, a name is generated for the restore point. |
Examples
The example below creates a global restore point in the sharded database with
name GRP_MANUAL_1.
GGDSCTL> CREATE RESTOREPOINT -NAME GRP_MANUAL_1create shardcatalog
Creates a shard catalog for the sharded database.
Syntax
create shardcatalog -database connect_identifier
[-user username[/password]]
[-region region_name_list]
[-configname config_name]
[-autovncr {ON | OFF}]
[-force]
[-sdb sdb_name]
[-shardspace shardspace_name_list]
[-agent_password password]
[-repl DG | OGG}] [-repfactor number] [-sharding {system | composite | user}] [-chunks number]
[-protectmode dg_protection_mode]
[-agent_port port]
[-for_federated_database]Options
Table C-38 GDSCTL create shardcatalog options
| Command Option | Description |
|---|---|
-agent_password
password |
Specify the password to be used for remote scheduler agent registration with the catalog database. |
-agent_port port |
Port number for XDB to use. If NULL and no current value is set, then it will default to 8080. Execute on catalog as well. |
-autovncr
{ON|OFF} |
This option enables
( See the Usage Notes below for important information about this option. |
-chunks number |
Specify the default number of
unique chunks in a shardspace. The value of
This parameter does not apply to
user-defined sharding or a federated database.
It will apply to all
shardspaces created for composite sharding if the
number of chunks is not specified in the
All shardgroups in a shardspace
have the same number of chunks. If this parameter
is not specified, the default number of chunks is
determined at the time of execution of the first
|
-configname config_name |
Specify the name of the GDS
configuration. This name is used as the virtual
DB_DOMAIN of the sharded database. The default
configuration name is
The configuration name can be up to 32 bytes long and can contain an alphabetical character followed by zero or more alphanumeric ASCII characters, ‘_', or ‘#' and possibly separated by periods if there are multiple identifiers. |
-database connect_identifier |
Specify the connect identifier for the database in which you want to create the catalog. |
-for_federated_database |
Create a catalog for a federated database. |
-force |
Before creating the new catalog, delete an existing shard or GDS catalog on this database. |
-protectmode dg_protection_mode |
Specify the Data Guard protection
mode: |
-region region_name_list |
Specify a comma-delimited list of region names. This command creates each region and adds the regions to the catalog. If you do not specify a region, then a default region named REGIONORA is created. |
-repl
DG|OGG |
Specify the technology used to
replicate data in the sharded database. Only one
value can be specified for this parameter:
|
-repfactor number |
Specify the default replication factor (the number of replicas for each piece of data stored in a shardgroup). This parameter can only be used with Oracle GoldenGate replication and system-managed or composite sharding, and this parameter is mandatory in this cases. It does not apply to user-defined sharding or a federated database since there are no shardgroups in this case. The default replication factor
specified by this parameter can be overridden for
a particular shardgroup by specifying the
replication factor in the corresponding
|
-sdb sdb_name |
Specify the virtual DB_UNIQUE_NAME for the sharded database. The default name is ORASDB. The sharded database (SDB) name can be up to 30 characters long and can be an alphabetical character followed by zero or more alphanumeric ASCII characters or an underscore (_). |
-sharding
{system | composite | user} |
Specify the sharding type:
|
-shardspace shardspace_name_list |
Specify a comma-delimited list of shardspace names. This option creates specified shardspaces and adds them to the catalog. If you do not specify a shardspace, then a default shardspace named SHARDSPACEORA is created. |
—user username[/password] |
Specify a user (and optionally, the password) that has the administrator privileges on the catalog database. If you do not use this option, then GDSCTL prompts you for the name and the password of a user with administrator privileges. If you specify a user name but not the password for the user, then GDSCTL prompts you for the password. |
Usage Notes
The create
shardcatalog command creates a GDS
catalog specifically designed for a sharded
database (SDB). This command cannot be used to
create a conventional GDS catalog. Execution of
this command is the first step required to create
an SDB. The command is executed by the user with
the GDS administrator or SYSDBA privileges.
Keep the following points in mind
when using create
shardcatalog:
-
Only a single sharded database can be created using a shard catalog. A shard catalog cannot be used for a regular GDS configuration.
-
Any arbitrary password can be specified for remote agent registration. If one is stipulated and an agent registration password already exists, it will be overridden with the new password. In order to successfully execute the
GDSCTL CREATE SHARDcommand, an agent password must be set usingCREATE SHARDCATALOGorMODIFY CATALOG. -
CHUNKSdefines the default number of unique chunks in a shardspace. It is applied to all shardspaces created for composite sharding if the number of chunks is not specified in theADD SHARDSPACEcommand. -
This command creates each region and adds the regions to the catalog. If you do not specify a region, then a default region named
REGIONORAis created. -
The default replication factor specified by
REPFACTORcan be overridden for a particular shardgroup by specifying the replication factor in the correspondingADD SHARDGROUPcommand. For automatically created default shardgroups the parameter cannot be overridden. A non-default shardgroup must be created to customize the replication factor. -
The
SHARDSPACEoption creates specified shardspaces and adds them to the catalog. If you do not specify a shardspace, then a default shardspace namedSHARDSPACEORAis created. -
For Data Guard replication the
PROTECTMODEparameter applies to any shardspace created without specification of protection mode in theADD SHARDSPACEcommand. -
The
FOR_FEDERATED_DATABASEoption is mutually exclusive with theSHARDINGoption. -
Auto VNCR is best used in environments with simple private networks where ease of configuration is the most important consideration. To have the highest level of control over which hosts may participate in a GDS configuration, disable Auto VNCR and explicitly add the IP addresses of each database host to the VNCR configuration.
When
-autovncris enabled, Oracle attempts to find the host name of the target shard when it is validated duringadd shardexecution. This host is then automatically added to the VNCR list in the catalog as an invited node. This mechanism is not compatible with all network configurations and may not work in the following cases:-
The catalog or global service manager host does not know how to translate the host name discovered on the target shard host to an real IP address. This can happen if they have different names in the hosts file or DNS on the catalog or global service manager host, or if they just do not exist on those hosts.
-
The target shard host has multiple public network addresses, and Oracle chooses an address that is different than the address used when the shard registers with the global service manager. This can happen if the host has multiple network cards or has configured virtual network interfaces.
-
The shard is running Oracle RAC, and other Oracle RAC instances run on a different subnet. This is not a recommended configuration for Oracle RAC. Refer to the Oracle RAC documentation for recommended configurations. With Oracle RAC, Oracle Database connects to a single shard host to validate the target, and returns a subnet mask that includes the entire subnet that the host is on. If other instances are on a different subnet, they have no valid VNCR entry, and registration is rejected.
-
See Working with Oracle GoldenGate Sharding in the Fusion Middleware Using the Oracle GoldenGate Microservices Architecture guide for more information about using Oracle GoldenGate with Oracle Sharding.
When
—autoVNCRis not enabled, or, if any of the above cases apply, new hosts should be added manually using add invitednode (add invitedsubnet). -
Note: Oracle GoldenGate replication support for Oracle Sharding High Availability is deprecated in Oracle Database 21c, and will be desupported in Oracle Database 22c.
Examples
The following example creates a shard catalog on the mydb database.
GDSCTL> CREATE SHARDCATALOG –DATABASE mydbdatabases
Displays the status of all databases.
Syntax
{status database | databases} [-gsm gsm_name]
[-database db_name]
[-gdspool gdspool_name]
[-raw|-support|-verbose] Options
Table C-39 GDSCTL databases Options
| Option | Description |
|---|---|
-database db_name |
Specify the name of the database on which you want to start the service. If you do not specify this option, then GDSCTL starts the services on all preferred databases. |
-gdspool gdspool_name |
Specify the name of the database pool in which the services you want to start are located. If not specified and there is only one |
-gsm gsm_name |
Specify the name of a global service manager to check. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL |
-raw |
If specified, GDSCTL output is presented in a raw non-parsed format. |
-support |
If specified, GDSCTL output displays additional information. |
-verbose |
Enable verbose mode. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command.
Example
Display the status of all databases:
GDSCTL> databases
The databases command returns output similar to the following:
Database: "dbcat1" Registered: Y State: Ok ONS: N. Role: PRIMARY Instances: 1
Region: east
Service: "sales_svc2" Globally started: N Started: N
Scan: Y Enabled: Y Preferred: Y
Service: "sales_svc1" Globally started: Y Started: Y
Scan: N Enabled: Y Preferred: Y
Registered instances:
sales%11
Database: "dbcat2" Registered: Y State: Ok ONS: N. Role: PRIMARY Instances: 1
Region: east
Service: "sales_svc2" Globally started: N Started: N
Scan: Y Enabled: Y Preferred: Y
Service: "sales_svc1" Globally started: Y Started: Y
Scan: N Enabled: Y Preferred: Y
Registered instances:
sales%1delete backup
Deletes sharded database (SDB) backups identified with specific tags from the recovery repository.
Syntax
delete backup [-tag tag_list] [-obsolete] [-catpwd password]
[-shard shard_list] [-async]
Options
Table C-40 GDSCTL delete backup Options
| Option | Description |
|---|---|
tag tag_list |
A comma separated list of tags. The backups identified by these tags will be deleted. |
-obsolete |
If specified, all obsoleted backups are deleted. |
-catpwd
password |
Password for user GSMCATUSER. Prompted if not specified. It needs to be specified once for the entire GDSCTL session. |
-shard shard_list |
shard_list specifies
a comma separated list of shard identifiers. They can be shard
space, shard group or shard names. The default is no
shards.
|
-async |
When specified, all tasks to configure the backup for the shards will run in background. By default, the task will run in foreground. The task for the SDB catalog database will always run in foreground regardless of this flag setting. |
Examples
The following example deletes backups with tag
odb_200414205057124_0400 from shard
v1908d_cdb2_pdb1:
GDSCTL> delete backup -shard v1908d_cdb2_pdb1 -tag ODB_200414205057124_0400 -catpwd gsm
This will delete identified backups, would you like to continue [No]?y
Deleting backups for database "v1908d_cdb2_pdb1" ...
allocated channel: ORA_DISK_1
channel ORA_DISK_1: SID=231 device type=DISK
allocated channel: ORA_DISK_2
channel ORA_DISK_2: SID=467 device type=DISK
deleted backup piece
backup piece handle=/tmp/rman/backups/2/2hutl9e9 RECID=13 STAMP=1037739466
Deleted 1 objects
deleted backup piece
backup piece handle=/tmp/rman/backups/1/2iutl9ed RECID=14 STAMP=1037739469
Deleted 1 objects
Recovery Manager complete.
delete catalog
Deletes the specified catalog.
Syntax
delete catalog [-connect [user/[password]@]conn_str] [-force]
Options
Table C-41 GDSCTL delete catalog Options
| Syntax | Description |
|---|---|
-connect |
Specify an Oracle Net connect descriptor or a net service name that maps to a connect descriptor for the database (or shard). If you do not use this option, then GDSCTL deletes the Global Data Services catalog that is used by the global service manager associated with the current session. |
-force |
Silently remove GDS metadata. No warnings are shown. |
Usage Notes
You must have the Global Data Services administrator privileges on the computer where the database resides from which you want to delete the Global Data Services catalog
If -connect is not specified, the catalog that belongs to currently connected database (if any) is deleted.
Example
Delete the Global Data Services catalog located in the database named DB1.
GDSCTL> delete catalog -connect db1
deploy
Deploys the sharded database.
Syntax
deploy [-no_rebalance]Options
Table C-42 GDSCTL deploy Options
| Option | Description |
|---|---|
-no_rebalance |
Skip automatic chunk migration during incremental deploy. |
Usage Notes
This command is executed after one or more shards have been added to the shard catalog. As the result of the command execution, a certain range of data is associated with a newly added database. If a database is part of a Data Guard Broker configuration, a role (primary or standby) is assigned to it. Then replication and/or migration of data to from other databases to newly deployed databases are initiated.
-
Deploy runs almost entirely in parallel, and mostly in the background, and will not deploy any shards which do not have all their counterparts in other shardgroups. All undeployed shards that can be deployed are deployed as the result of execution of this command.
-
Before configuring replication, this command cross-checks parameters of all databases included into the replication configuration. An error is returned if the cross-check finds inconsistency or ambiguity, for example, no primary shardgroup in a shardspace with Data Guard replication.
-
If a
CREATE SHARDcommand had previously been issued, these new shards will be created during deployment and added to the shard catalog. If a shard needs to be created,DEPLOYruns a job for each database which requires a remote credential (see add credential and create shard). This credential must be valid at the time of deployment. -
The
NO_REBALANCEoption allows to skip automatic rebalancing of chunks across shards during incrementalDEPLOY. Use the move chunk command to perform manual chunk migration.
Examples
Deploy the sharded database.
GDSCTL> deploy
disable backup
Disable Sharded Database (SDB) Backup Jobs.
Syntax
disable backup [-catpwd password] [-shard shard_list]Options
Table C-43 GDSCTL disable backup Options
| Syntax | Description |
|---|---|
-catpwd password |
Password for user GSMCATUSER. Prompted if not specified. It needs to be specified once for the entire GDSCTL session. |
-shard shard_list |
shard-list is a comma separated list of shard identifiers. They can be shard space, shard group or shard names. The default is all shards |
disable service
Disables specified global services.
Syntax
disable service [-gdspool gdspool_name]
[-service service_name_list]
[-database db_name |[-override -connect conn_str [-pwd password]]]Options
Table C-44 GDSCTL disable service Options
| Syntax | Description |
|---|---|
-connect conn_str |
An Oracle Net connect descriptor or net service name that resolves to a connect descriptor for the database (or shard). |
-database db_name |
Specify the name of the database on which to the service is located. If you do not specify this option, then the service is disabled, globally. |
-gdspool gdspool_name |
Specify the database pool in which the services are located. If not specified and there is only one |
-override |
Skip the GDS catalog (used when the GDS catalog is not available). |
-pwd |
The GSMUSER password. |
-service service_name_list |
Specify a comma-delimited list of global service names. If you do not use |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command
A running service cannot be disabled. If -override is specified, the command is executed without going to the GDS catalog. Use this option when the GDS catalog is unavailable. It is not recommended for use under normal operation.
Example
Disable and stop the service G_SALES_REPORT on all databases in the database pool READERFARM.
GDSCTL> disable service -gdspool readerfarm -service g_sales_report -database db1
See Also:
enable backup
Enable Sharded Database (SDB) Backup Jobs.
Syntax
enable backup [-catpwd password] [-shard shard_list]Options
Table C-45 GDSCTL enable backup Options
| Syntax | Description |
|---|---|
-catpwd password |
Password for user GSMCATUSER. Prompted if not specified. It needs to be specified once for the entire GDSCTL session. |
-shard shard_list |
shard_list is a comma separated list of shard identifiers. They can be shard space, shard group or shard names. The default is all shards |
Usage Notes
All backup jobs are initially
disabled. They can be enabled by running the enable database command. They
should be run after SDB backup has been configured with command CONFIG
BACKUP. An error is reported if this command is run before SDB backup is
configured.
enable service
Enables the specified global services.
Syntax
enable service [-gdspool gdspool_name] [-service service_name_list] [-database db_name|[-override -connect conn_str [-pwd password]]]
Options
Table C-46 GDSCTL enable service Options
| Syntax | Description |
|---|---|
-connect conn_str |
An Oracle Net connect descriptor or net service name that resolves to a connect descriptor for the database (or shard). |
-database db_name |
Specify the name of the database on which the service is located. If you do not specify this option, then the service is enabled globally. |
-gdspool gdspool_name |
Specify the GDS pool in which the services are located. If not specified and there is only one gdspool with access granted to the user, it is used as the default gdspool. |
-override |
Skip the GDS catalog (used when the GDS catalog is not available). |
-pwd |
The GSMUSER password. |
-service service_name |
Specify a comma-delimited list of global service names. If you do not use |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command
ENABLE SERVICE will start the global service if it is preferred_all or cardinality is not reached.
If -override is specified, the command is executed without going to the GDS catalog. Use this option when the GDS catalog is unavailable. It is not recommended for use under normal operation.
Example
Enable the service G_SALES_REPORT on the database DB1 in the database pool READERFARM.
GDSCTL> enable service -gdspool readerfarm -service g_sales_report -database db1
See Also:
export catalog
Saves the current catalog configuration to a local file.
Syntax
export catalog [-force] sourceOptions
Table C-47 GDSCTL export catalog Options
| Syntax | Description |
|---|---|
-force |
If not specified, export will be cancelled if there are ongoing GDS operations. |
source |
Name of a file on the same computer where the command is being executed. The configuration will be saved to this file. If the file already exists, it will be overwritten without a prompt. If the file is not writable (for example the path does not exist), you will get an error. |
Usage Notes
You must connect to the catalog database as a user with GDS Administrator privileges before running this command.
It is recommended that you validate the catalog, using the validate catalog command before exporting it.
Example
Save the catalog backup to your home directory.
GDSCTL> export catalog /home/user/cat-201307.backup
help
Provides a list of the GDSCTL commands supported in the current release. When followed by a command name, it returns the help page associated with the command.
Syntax
help [gdsctl_command]Options
Table C-48 GDSCTL help Options
| Option | Description |
|---|---|
|
|
Enter any GDSCTL command name to return a help page with syntax, options, usage notes and examples. |
import catalog
Restores the catalog configuration from the specified file, created using export catalog command.
Syntax
import catalog [-database catalog_db_name]
[-catpwd gsmcatusrpwd]
[-user gsmadminname[/password]]
sourceOptions
Table C-49 GDSCTL import catalog Options
| Syntax | Description |
|---|---|
-catpwd gsmcatusrpwd |
GSMCATUSER password. |
—database catalog_db_name |
The connect identifier for the database in which to create catalog. |
source |
Name of a file on the same computer where the command is being executed. The configuration will be restored from this file. If the file is not readable, you will get an error. |
-user gsmadminname[/password] |
Credentials of the user that has the GDS administrator privileges on the catalog database. |
Usage Notes
If -database is not specified, the GDS catalog that the current global service manager is associated with will be used. The -catpwd option should be specified in case you need to perform cleanup of databases in the existing catalog that are not found in imported file.
When restoring to a new catalog database, catalog must be created first, using the create gdscatalog command.
You must connect to the catalog database as a user with GDS Administrator privileges before running this command.
The import procedure can be considered finished only when there are no pending requests after import. Use the config command to get the list of pending requests.
Example
Load the catalog backup from your home directory.
GDSCTL> import catalog /home/user/cat-201307.backup
list backup
List Sharded Database (SDB) Backups
Syntax
list backup [-restorepoint restorepoint] [-controlfile]
[-summary] [-catpwd password] [-shard shard_list]
Options
Table C-50 GDSCTL list backup Options
| Option | Description |
|---|---|
-restorepoint
restorepoint |
An SDB global restore point. If specified, only backups that are usable to restore the specified shards to the specific restore point are listed. Otherwise, all backups for the specified shards are listed. |
-controlfile |
If specified, only backups usable to restore database control files to a specific restore point are listed. |
-summary |
If specified, the backups are listed in summary format. |
-catpwd
password |
Password for user GSMCATUSER. Prompted if not specified. This password only needs to be specified once for this command in an entire GDSCTL session. |
-shard shard_list |
shard_list specifies
a comma separated list of shard identifiers. They can be shard
space, shard group or shard names. The default is no
shards.
|
Examples
The following example shows how to list the backups of control files from the SDB catalog database in summary.
GDSCTL> list backup -shard catalog -controlfile -summary -catpwd gsm
Listing backups for database "v1908" ...
List of Backups
===============
Key TY LV S Device Type Completion Time #Pieces #Copies Compressed Tag
------- -- -- - ----------- --------------- ------- ------- ---------- ---
1366 B F A DISK 13-APR-20 1 1 NO TAG20200413T234608
1851 B F A DISK 14-APR-20 1 1 NO TAG20200414T000333
1996 B F A DISK 14-APR-20 1 1 NO TAG20200414T001446
2057 B F A DISK 14-APR-20 1 1 NO TAG20200414T001519
2151 B F A DISK 14-APR-20 1 1 NO TAG20200414T012934
3205 B F A DISK 14-APR-20 1 1 NO TAG20200414T202822
Recovery Manager complete.
The next example shows the use of the command to list the backups from
shard v1908b_cdb2_pdb1 recoverable to restore point
backup_before_db_maintenance.
GGDSCTL> list backup -shard v1908b_cdb2_pdb1 -restorepoint BACKUP_BEFORE_DB_MAINTENANCE
"GSMCATUSER" password:
Listing backups for database "v1908b_cdb2_pdb1" ...
List of Backup Sets
===================
BS Key Type LV Size Device Type Elapsed Time Completion Time
------- ---- -- ---------- ----------- ------------ ---------------
2998 Incr 0 265.53M DISK 00:00:06 14-APR-20
BP Key: 3009 Status: AVAILABLE Compressed: NO Tag: BACKUP_BEFORE_DB_MAINTENANCE
Piece Name: /tmp/rman/backups/2/0sutl6oa
List of Datafiles in backup set 2998
File LV Type Ckp SCN Ckp Time Abs Fuz SCN Sparse Name
---- -- ---- ---------- --------- ----------- ------ ----
11 0 Incr 2678401 14-APR-20 NO /ade/b/3998875997/oracle/dbs/cdb2_pdb1_db.f
BS Key Type LV Size Device Type Elapsed Time Completion Time
------- ---- -- ---------- ----------- ------------ ---------------
2999 Incr 0 191.61M DISK 00:00:04 14-APR-20
BP Key: 3010 Status: AVAILABLE Compressed: NO Tag: BACKUP_BEFORE_DB_MAINTENANCE
Piece Name: /tmp/rman/backups/1/0tutl6oh
List of Datafiles in backup set 2999
File LV Type Ckp SCN Ckp Time Abs Fuz SCN Sparse Name
---- -- ---- ---------- --------- ----------- ------ ----
12 0 Incr 2678425 14-APR-20 NO /ade/b/3998875997/oracle/dbs/cdb2_pdb1_ax.f
13 0 Incr 2678425 14-APR-20 NO /ade/b/3998875997/oracle/dbs/cdb2_pdb1_xdb.f
Recovery Manager complete.
list restorepoint
List Global Restore Points.
Syntax
list restorepoint [-start_time t1] [-end_time t2] [-start_scn_ s1] [-end_scn s2]Options
Table C-51 GDSCTL list restorepoint Options
| Syntax | Description |
|---|---|
-start_time time1 |
If specified, the command lists restore points that were created at or after this time. It must be specified in the format “YYYY-MM-DD HH:MM:SS[.FFF] where .FFF is a fraction of a second in the precision of milliseconds. |
-end_time time2 |
If specified, the command lists restore points that were created at or before this time. Refer to the option “start_time” above for its format. |
-start_scn scn1 |
If specified, the command lists restore points with SCNs equal to or greater than this SCN. |
-end_scn scn2 |
If specified, the command lists restore points with SCNs equal to or less than this SCN. |
Examples
The example below lists the available restore points in the sharded database (SDB) with the SCN between 2600000 and 2700000.
GDSCTL> list restorepoint -start_scn 2600000 -end_scn 2700000
Name SCN Create Time
GRP_200726222838427_0400 2601938 2020-07-26 22:28:39.0
GRP_200726232837677_0400 2613192 2020-07-26 23:28:38.0
GRP_200727002838026_0400 2624200 2020-07-27 00:28:38.0
GRP_200727012838351_0400 2634360 2020-07-27 01:28:38.0
GRP_200727022837961_0400 2645399 2020-07-27 02:28:38.0
GRP_200727032838402_0400 2654898 2020-07-27 03:28:39.0
GRP_200727042837648_0400 2664398 2020-07-27 04:28:38.0
GRP_200727052837932_0400 2673905 2020-07-27 05:28:38.0
GRP_200727062838321_0400 2683840 2020-07-27 06:28:38.0
modify catalog
Modifies the properties of the GDS catalog or shard catalog.
Syntax
modify catalog [-autovncr {ON | OFF}]
[-oldpwd oldpassword -newpwd newpassword]
[-pwd password -newkeys]
[-agent_password password]
[-agent_port port]
[-region region]
[-recover]Options
Table C-52 GDSCTL modify catalog Options
| Syntax | Description |
|---|---|
-agent_password password |
Specify the agent registration password in the catalog for the remote Scheduler agent. |
-agent_port port |
Port number for XDB to use. If it is NULL and no current value is set, then it will default to 8080. Execute on catalog as well. |
-autovncr {ON | OFF} |
This option enables ( |
-newkeys |
Generates a new PKI key pair. |
-newpwd newpassword |
Used along with |
-oldpwd oldpassword |
Used along with |
-pwd password |
Provides the |
-recover |
Perform catalog recovery to the last consistent state. |
-region region |
Region that the database, catalog, shard, shardgroup, or global service manager belongs to. |
Usage Notes
To use this command, there must be a least one global service manager running and a connection with the catalog database must have already been established (see the connect command).
You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.
Auto VNCR is best used in environments with simple private networks where ease of configuration is the most important consideration. To have the highest level of control over which hosts may participate in a GDS configuration, disable Auto VNCR and explicitly add the IP address(es) of each database host to the VNCR configuration.
The GSMCATUSER password should be updated regularly for security reasons. Use the following command to perform this operation.
modify catalog -oldpwd oldpassword -newpwd newpasswordThis command fetches the encrypted private key and encryption string, decrypts them using the old password, re-encrypts them with the new password and stores them again.
If the GSMCATUSER password is changed, you must execute MODIFY CATALOG to update catalog security scheme, with -newpwd and -oldpwd specified.
The PKI keys must be updated regularly, which is done using modify catalog -oldpwd oldpassword -newkeys. This command generates a new PKI key pair and replaces the corresponding fields in the database.
If you decide to replace the PKI keys, or just after the patchset upgrade from Oracle Database 12c Release 1 (12.1) on the catalog database, run this command:
modify catalog -pwd ** -newkeys
An arbitrary password can be stipulated for remote agent registration. If an agent registration password already exists, it will be overridden with the new password. In order to successfully execute the GDSCTL CREATE SHARD command, an agent password must be set using the CREATE SHARDCATALOG or MODIFY CATALOG command.
Examples
Turn off autovncr mode for the catalog database.
connect gsmadmin@mycloud
GDSCTL> modify catalog -autovcnr offSpecify the remote Scheduler agent registration password.
connect gsmadmin@mycloud
GDSCTL> modify catalog –agent_password mypassUpdate catalog security scheme.
GDSCTL> modify catalog -autovncr OFF -oldpwd opwd -newpwd npwd -pwd pwd -newkeysmodify cdb
Modify cdb attributes.
Syntax
modify cdb -shard cdbname_list
[-connect connect_identifier]
[-pwd gsmrootuser_pwd]
[-scan scan_address [-ons port]]
[-savename]
Options
Table C-53 GDSCTL modify cdb Options
| Option | Description |
|---|---|
-shard cdbname_list |
Specify a comma-delimited list of cdb names. |
-connect connect_identifier |
Specify an Oracle Net connect descriptor or a net service name that maps to a connect descriptor for the database that is being modified. |
-ons port |
Specify the ONS port. |
-pwd gsmrootuser_pwd |
Specify the password for GSMROOTUSER. |
-savename |
Specify this option to store a net service name specified with the |
-scan scan_address |
Specify the SCAN address for a cluster. |
Usage Notes
Some parameters are not supported after the CDB contains shards or contains shards that have been deployed.
Examples
Change a password on a CDB.
GDSCTL> modify cdb -shard cdb1 -pwd new_gsmrootuser_passwordmodify credential
Modifies an existing credential which will be used by the remote Scheduler agent to execute shard jobs.
Syntax
modify credential -credential credential_name -osaccount account_name -ospassword password [-windows_domain domain_name]
Options
Table C-54 GDSCTL modify credential Options
| Option | Description |
|---|---|
-credential credential_name |
Specify the name of the credential to modify. |
-osaccount account_name |
Specify the operating system account which will be used for remote jobs. |
-ospassword password |
Specify the corresponding password for the account. |
-windows_domain domain_name |
If a Windows account has been specified, specify the corresponding domain name for that account. |
Usage Notes
This command modifies credentials which will be used to execute jobs on sharded hosts in response to administrative commands.
If the specified credential does not exist, the command returns an error.
Examples
Modify a credential named east_region_cred.
GDSCTL> modify credential –credential east_region_cred –osaccount agent_user
–ospassword newpassmodify database
Modifies the configuration parameters of the databases in a GDS pool, such as region, connect identifier, global service manager password, SCAN address, and ONS port.
Syntax
modify database -database db_name_list
[-gdspool gdspool_name]
[-shard shard_name]
[-deploy_as PRIMARY|STANDBY]
[-region region_name]
[-pwd password]
[-connect connect_identifier]
[-scan scan_address]
[-ons port]]
[-savename]
[-cpu_threshold cpu]
[-disk_threshold disk]
[-rack rack_id]
[-NETPARAM net_parameter_file | -NETPARAMFILE net_parameter_file]
[-DBPARAM db_parameter | -DBPARAMFILE db_parameter_file]
[-DBTEMPLATE db_template | -DBTEMPLATEFILE db_template_file] Options
Table C-55 GDSCTL modify database Options
| Option | Description |
|---|---|
-connect connect_identifier |
Specify an Oracle Net connect descriptor or a net service name that maps to a connect descriptor for the database that is being modified. |
-cpu_threshold cpu |
Specifies CPU Utilization percentage threshold. |
-database dbname_list |
Specify a comma-delimited list of database names. |
-disk_threshold disk |
Specifies the average latency in milliseconds of a synchronous single-block read. |
-gdspool gdspool_name |
Specify the database pool to which the databases belong. |
-ons port |
Specify the ONS port. |
-pwd password |
Specify the password for the GSMUSER. |
-region region_name |
Specify the region to which the databases belong. |
-savename |
Specify this option to store a net service name specified with the |
-scan scan_address |
Specify the SCAN address for a cluster. |
Usage Notes
You can multiple databases if the region property is specified.
For all parameters except for the GDS region, first the appropriate changes must be done by the database administrator and then the modify database command must be run to update the modified parameters in the GDS catalog. Alternatively, you can use the sync database (synchronize database)command for this purpose.
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command
Example
Change the region of databases DB1 and DB3 to EAST.
GDSCTL> modify database -database db1,db3 -region east
modify file
Updates the contents of a file in the catalog which can be used by subsequent GDSCTL commands.
Syntax
modify file -file file_name -source local_filename
Options
Table C-56 GDSCTL modify file Options
| Option | Description |
|---|---|
-file file_name |
Specify the name of the file object to update. |
-source local_filename |
Specify an operating system file name specifying a file local to the machine running GDSCTL. |
Usage Notes
This command updates a named file object in the catalog by reloading the contents of an operating system file into the catalog.
Examples
Update a file named east_region_db_params with content from the local source file /tmp/dbca_params.txt
GDSCTL> modify file -file east_region_db_params -source /tmp/dbca_params.txtmodify gdspool
Modifies the configuration parameters of GDS pools.
Syntax
modify gdspool -gdspool gdspool_name_list
[-removeuser user_name | -adduser user_name]Options
Table C-57 GDSCTL modify gdspool Options
| Option | Description |
|---|---|
-adduser user_name |
Specify the user to add to the list of GDS pool administrators. This option grants the pool administrator role to the specified user. |
-gdspool database_pool_list |
Specify a comma-delimited list of GDS pool names. |
-removeuser user_name |
Specify the user to remove from the list of GDS pool administrators. This option revokes the pool administrator role from the specified user. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command
Example
Add PETER to the list of database pool administrators for the pool MYREADERFARM:
GDSCTL> modify gdspool -gdspool myreaderfarm -adduser petermodify gsm
Modifies the configuration parameters of the global service manager. The changes take effect after the global service manager is restarted.
Syntax
modify gsm -gsm gsm_name
[-catalog connect_id [-pwd password]]
[-region region_name]
[-localons ons_port]
[-remoteons ons_port]
[-endpoint gmsendpoint [-remote_endpoint remote_endpoint]]
[-listener listener_port]
[-wpwd wallet_password]Options
Table C-58 GDSCTL modify gsm Options
| Option | Description |
|---|---|
-catalog |
Specify the connect identifier for the Global Data Services catalog database. If a network service name is specified, it must be resolvable by the local naming method to a connect descriptor that allows the global service manager being modified to connect to the catalog database. |
-endpoint gsmendpoint |
Specify the protocol address that the global services manager listens on for client connection requests. If you use this option, the value you specify overrides the default endpoint. |
-gsm gsm_name |
Enter the name of the global service manager that you want to modify. If you do not specify a name, then the current global service manager name for the session (specified with the set gsm command) is used. |
-listener listener_port |
Specify the new listener port. |
-localons ons_port |
Specify the new local ONS port. |
-pwd password |
Specify the password for the |
-region region_name |
Specify the region to which the global service manager belongs. |
-remote_endpoint remote_endpoint |
Specify the protocol address that is used by the global service manager to receive database registration requests and communicate with other global service managers in the configuration. If you use this option, the value you specify overrides the default endpoint. |
-remoteons ons_port |
Specify the new remote ONS port. |
-wpwd |
Specify the password for the global service manager wallet. |
Usage Notes
-
You must run this command locally on the computer where you want to modify the global service manager.
-
This command can be run only by the operating system user who started the global service manager.
-
When you run this command, GDSCTL connects to the Global Data Services catalog as the GSMCATUSER user and prompts you for the GSMCATUSER password.
Example
Modify the global service manager named gsm1 so that it is in the EAST region.
GDSCTL> modify gsm -gsm gsm1 -region eastmodify region
Modifies the configuration parameters for a region.
Syntax
modify region -region region_name_list
[-buddy region_name]
[-weights weight]Options
Table C-59 GDSCTL modify region Options
| Option | Description |
|---|---|
-buddy |
Specify the name of the buddy region |
-region region_list |
Specify a comma-delimited list of region names |
-weights weight |
Used for static RLB distribution. format: name = value,..,name = value |
Usage Notes
You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.
To clear buddy region or weight, call MODIFY REGION and specify empty quotes as the value. If WEIGHTS is specified, dynamic load balancing is replaced by static (not recommended).
Example
Modify two regions, EAST and WEST, as follows:
GDSCTL> modify region -region west -buddy eastmodify service
Modifies the service attributes.
Syntax
To add more preferred or available databases to a global service:
modify service [-gdspool gdspool_name]
-service service_name
{-preferred db_name_list | -available db_name_list}
To modify the attributes of a global service:
modify service [-gdspool gdspool_name]
-service service_name
[-locality {ANYWHERE | LOCAL_ONLY}]
[-region_failover]
[-role {PRIMARY | PHYSICAL_STANDBY [-failover_primary] |
LOGICAL_STANDBY | SNAPSHOT_STANDBY}]
[-lag {lag_value | ANY}]
[-notification {TRUE | FALSE}]
[-rlbgoal {SERVICE_TIME | THROUGHPUT}]
[-clbgoal {SHORT | LONG}]
[-tafpolicy {BASIC | NONE | PRECONNECT}]
[-policy policy]
[-failovertype {NONE | SESSION | SELECT | TRANSACTION}]
[-failovermethod {NONE | BASIC}]
[-dtp {TRUE | FALSE}]
[-sql_translation_profile stp_name]
[-failoverretry failover_retries]
[-failoverdelay failover_delay]
[-edition edition_name]
[-commit_outcome {TRUE | FALSE}]
[-retention retention_seconds]
[-session_state {DYNAMIC | STATIC}]
[-replay_init_time replay_init_time]]
[-table_family family]
To move a global service from one database to another database:
modify service [-gdspool gdspool_name]
-service service_name
-old_db db_name
-new_db db_name
[-force]To change an available database to a preferred database for a service:
MODIFY SERVICE [-gdspool gdspool_name]
-service service_name
-available db_name_list
-preferredTo change databases between preferred and available status:
modify service [-gdspool gdspool_name]
-service service_name
{-preferred_all |
{-modifyconfig -preferred db_name_list [-available db_name_list]}}To modify properties for a global service that are specific to an Oracle RAC database:
modify service [-gdspool gdspool_name] -service service_name -database db_name [-server_pool server_pool_name | {-add_instances|-modify_instances} -preferred inst_list -available inst_list | -drop_instances inst_list -cardinality {UNIFORM | SINGLETON}
Options
Table C-60 GDSCTL modify service Options
| Option | Description |
|---|---|
-add_instances [-preferred comma-delimited-list] [-available comma-delimited-list] |
Provides a list of preferred and available instances for the given service on the given database. The provided list over-rides existing assigned instances, if any. Using the –preferred and –available options is optional, but at least one of these must be provided. |
-available db_name_list |
Specify a comma-delimited list of available databases on which the service runs, if the preferred databases are not available. The list of available instances must be mutually exclusive with the list of preferred instances. If you attempt to add a preferred or available database to a service that was configured with |
-cardinality {UNIFORM | SINGLETON} |
Specify the cardinality option for a service running on a policy-managed Oracle RAC database. Services with cardinality set to |
-clbgoal {SHORT | LONG} |
For connection load balancing goal: set to The default value for this option is |
-commit_outcome {TRUE | FALSE} |
Enable Transaction Guard; when set to |
-database db_name |
Specify the name of the database on which you want to modify the service. When
|
-dtp {TRUE | FALSE} |
Indicates whether Distributed Transaction Processing should be enabled for this service. This ensures that the service is offered at exactly one instance at a time for XA affinity. |
-drop_instances inst_list |
Provide a list of instances to be removed from the existing assigned instances for a given service on a given database. The provided list of instances will be removed from the existing assigned list. |
-edition edition_name |
Specify the initial session edition of the service. When an edition is specified for a service, all subsequent connections that specify the service use this edition as the initial session edition. However, if a session connection specifies a different edition, then the edition specified in the session connection is used for the initial session edition. GDSCTL does not validate the specified edition name. During connection, the connect user must have |
-failover_primary |
If you set the |
-failoverdelay failover_delay |
For Application Continuity and TAF, the time delay (in seconds) between reconnect attempts for each incident at failover. |
-failovermethod {NONE | BASIC} |
TAF failover method (for backward compatibility only). If |
-failoverretry failover_retries |
For Application Continuity and TAF, the number of attempts to connect after an incident. |
-failovertype {NONE | SESSION | SELECT | TRANSACTION} |
Specify the failover type. To enable Application Continuity for Java, set this parameter to |
-force |
If you use this option, then all sessions are disconnected when the service is moved, requiring the sessions using the service to reconnect (potentially to a different instance). If you do not use this option, then the sessions that are connected to a database using this service stay connected, but all new sessions cannot be established to the service. |
-gdspool gdspool_name |
Specify the name of the database pool to which the service belongs. If not specified and there is only one |
-lag {lag_value | ANY} |
Specify the lag for the service in seconds. You can use the keyword The default value for the |
-locality {ANYWHERE | LOCAL_ONLY} |
The service region locality. If you do not use this option, then the default value of |
-modifyconfig |
Use this option to indicate that you are changing the current list of preferred and available databases for the service. If you use this option, then any databases that are not specified in either the preferred or available list, but were previously assigned, are removed from the list of databases on which the service can run. |
-modify_instances [-preferred comma-delimited-list] [-available comma-delimited-list] |
The provided If you specify an instance in the If you specify in Any instances already in the stored list that are not in the provided list remain unchanged in the stored list. Note that an instance cannot be both preferred and available, it can be in one mode only.
|
-new_db database_name |
Specify the name of the new database on which the service runs. If you attempt to move a service that was configured with |
-notification {TRUE | FALSE} |
Enable Fast Application Notification (FAN) for OCI connections. |
-old_db database_name |
Specify the name of the old database on which the service runs. If you attempt to move a service that was configured with |
-policy {AUTOMATIC | MANUAL} |
Specify the management policy for the service. If you specify If you specify |
-pdbname pdb_name |
Specify the pluggable database name. |
-preferred db_name_list |
Specify a comma-delimited list of preferred databases on which the service runs. When changing a database from available to preferred, you do not specify a value for the The list of preferred instances must be mutually exclusive with the list of available instances. If you attempt to add a preferred or available database to a service that was configured with |
-preferred_all |
Specifies that all the databases in the database pool are preferred databases. Any new databases added to the pool are configured as preferred databases for this service. This option cannot be used with the |
-region_failover |
Indicates that the service is enabled for region failover. You can only use this option when you specify |
-replay_init_time replay_init_time |
For Application Continuity, this parameter specifies the time (in seconds) after which replay is not initiated. Default value is 300 seconds. |
-retention retention_seconds |
For Transaction Guard ( |
-rlbgoal {SERVICE_TIME | THROUGHPUT} |
Run-time Load Balancing Goal. Set this parameter to If you do not use this option, then the value defaults to |
-role {[PRIMARY] | [PHYSICAL_STANDBY] [-failover_primary] | [LOGICAL_STANDBY] | [SNAPSHOT_STANDBY]} |
Specify the database role that the database must be for this service to start on that database. This applies only to database pools that contain an Oracle Data Guard broker configuration. See Also: Oracle Data Guard Concepts and Administration for more information about database roles |
-server_pool server_pool_name |
Specify the name of the Oracle RAC server pool in the GDS pool database to which the service belongs (for a policy-managed Oracle RAC database). |
-service service_name |
Specify the name of the global service. |
-session_state {DYNAMIC | STATIC} |
For Application Continuity, this parameter specifies whether the session state that is not transactional is changed by the application. A value of |
-sql_translation_profile stp_name |
Use this option to specify a SQL translation profile for a service that you are adding after you have migrated applications from a non-Oracle database to an Oracle database. This option corresponds to the SQL translation profile parameter in the Notes:
See Also: Oracle Database SQL Translation and Migration Guide for more information about SQL translation |
|
|
Specifies the table family name as a property of the service. This parameter takes one of the table family values (root table schema.name) as shown in the If the schema name or the table name is case-sensitive, use two-level quotes (single quotes outside, double quotes inside) around the whole string, for example, '"TESTUSER1.Customers6"'. No quotes are needed if neither name is case sensitive. |
-tafpolicy {BASIC | NONE } |
TAF policy specification (for administrator-managed databases only). |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the connect command before running this command.
Use this command to:
-
Add databases to the preferred or available lists for the service
-
Move a service from one database to another database
-
Change an available database to a preferred database or a preferred database to an available database
-
Modify the high availability attributes of the service
If you want to temporarily move a service from one database to a different database, then use the relocate service command.
Examples
Add the database DB3 as a preferred database for the service G_SALES_REPORT in the database pool MYREADERFARM.
GDSCTL> modify service -gdspool myreaderfarm -service g_sales_report -preferred db3
Modify the service G_DAILY_SALES_REPT in the database pool MYREADERFARM to change the run-time load balancing goal to THROUGHPUT.
GDSCTL> modify service -gdspool myreaderfarm -service g_daily_sales_rept
-rlbgoal THROUGHPUT
Move the service G_SALES_REPORT in the database pool MYREADERFARM from the database DB1 to DB4.
GDSCTL> modify service -gdspool myreaderfarm -service g_sales_report
-old_db db1 -new_db db4
Upgrade the DB3 database from an available database to a preferred database for the service G_SALES_REPORT in the database pool READFARM.
GDSCTL> modify service -gdspool readfarm -service g_sales_report
-available db3 -preferred
Assume the service G_SALES_REPORT currently has the databases DB1 and DB2 assigned as preferred databases, and the database DB3 assigned as an available database. Exchange the preferred and available databases DB1 and DB3, and remove the DB2 database for the service SALES_REPORT in the database pool READFARM.
GDSCTL> modify service -gdspool readfarm -service g_sales_report -modifyconfig
-available db3 -preferred db1
Modify the properties of the service G_SALES_REPORT in the database pool READFARM to specify that it should run only in the server pool named SALESPOOL for the policy-managed Oracle RAC database DB1.
GDSCTL> modify service -gdspool readfarm -service g_sales_report -database db1
-server_pool salespool
Supply the preferred and available instances for the given service on the given database.
GDSCTL> modify service –gdspool mypool –service mysvc –database mydb –add_instances
–preferred inst1,inst2 –available inst3,inst4In a system-managed sharded database, the table family ID parameter is specified as a property of the service.
GDSCTL> modify service –GDSPOOL shdpool –table_family sales.customer -service salesSee Also:
modify shard
Modify shard attributes.
Syntax
modify shard -shard shname_list
[-region region_name]
[-connect connect_identifier]
[-pwd password]
[-scan scan_address [-ons port]]
[-savename]
[-cpu_threshold cpu]
[-disk_threshold disk]
[-destination destination_name]
[-credential credential_name |
[[-osaccount account_name]
[-ospassword password]
[-windows_domain domain_name]]]
Options
Table C-61 GDSCTL modify shard Options
| Option | Description |
|---|---|
-connect connect_identifier |
Specify an Oracle Net connect descriptor or a net service name that maps to a connect descriptor for the database that is being modified. |
-cpu_threshold cpu |
Specifies CPU Utilization percentage threshold. |
-credential credential_name |
Specify the credential to use on the remote machine which specifies the user name and password under which database creation will occur. |
-destination destination_name |
Specify the name of the remote executable agent through which the database will be created. |
-disk_threshold disk |
Specifies the average latency in milliseconds of a synchronous single-block read. |
-ons port |
Specify the ONS port. |
-osaccount account_name |
Specify the operating system account which will be used for remote jobs. |
-ospassword password |
Specify the corresponding password for the account specified in |
-pwd password |
Specify the password for the GSMUSER. |
-region region_name |
Specify the region to which the databases belong. |
-savename |
Specify this option to store a net service name specified with the |
-scan scan_address |
Specify the SCAN address for a cluster. |
-shard shname_list |
Specify a comma-delimited list of shard names. |
-windows_domain domain_name |
Specify the corresponding domain name if a Windows account has been specified in |
Usage Notes
The REGION parameter cannot be modified for a shard that belongs to a shardgroup. The modification has to be done at the shardgroup level.
The DESTINATION and CREDENTIAL parameters are only modifiable when the shard has not yet been deployed, since these parameters only have meaning for the deployment process and are no longer referenced once deployment has completed successfully.
Examples
GDSCTL> modify shard -shard shard1 -ons 23222modify shardgroup
Modify shardgroup attributes.
Syntax
modify shardgroup -shardgroup shardgroup_name
[-region region_name]
[-shardspace shardspace_name]
[-repfactor number]
[-deploy_as {PRIMARY | STANDBY | ACTIVE_STANDBY}] Options
Table C-62 GDSCTL modify shardgroup Options
| Option | Description |
|---|---|
-shardgroup shardgroup_name |
Specify the name of the shardgroup to be modified. |
-region region_name |
Specify the region the shardgroup resides in. |
-shardspace shardspace_name |
Specify the shardspace this shardgroup belongs to. |
-repfactor number |
Specify the number of replicas for each piece of data stored in this shardgroup. |
-deploy_as {PRIMARY | STANDBY | ACTIVE_STANDBY} |
Specify the initial role for a newly deployed database: |
Usage Notes
All shardgroup attributes, except for DEPLOY_AS, can only be modified when the shardgroup does not contain any deployed shards. DEPLOY_AS can be modified at any time because it does not affect shards that were already added to the shardgroup.
Examples
Modify the GROUP1 shardgroup to have a replication factor of 3.
GDSCTL> modify SHARDGROUP –SHARDGROUP group1 –REPFACTOR 3 modify shardspace
Modify shardspace parameters.
Syntax
modify shardspace –shardspace shardspace_name [-chunks number] [-protectmode dg_protection_mode]
Options
Table C-63 GDSCTL modify shardspace Options
| Option | Description |
|---|---|
-shardspace shardspace_name |
Specify the name of the shardspace to be modified. |
-chunks number |
Specify the number of chunks in the shardspace. |
-protectmode dg_protection_mode |
Specify the Data Guard Protection mode: |
Usage Notes
The number of chunks can only be modified if a shardspace does not contain deployed shards.
Examples
Modify the GOLD shardspace to have 6000 chunks.
GDSCTL> modify shardspace –shardspace gold –chunks 6000
move chunk
Moves a listed set of chunks from one shard to another shard or multiple shards.
Syntax
move chunk -chunk {chunk_id_list | ALL}
-source shard_name
[-target shard_name]
[-timeout]
[-verbose]Options
Table C-64 GDSCTL move chunk Options
| Option | Description |
|---|---|
-chunk {chunk_id_list | ALL} |
Specify a comma-separated list of chunk IDs. If |
-source shard_name |
Specify the name of the source shard. |
-target shard_name |
Specify the name of the target shard. |
-timeout |
Specify a connection retention time-out for the interval between when FAN is sent to the clients and a chunk going into read-only mode or down. |
-verbose |
Enable verbose output mode. |
Usage Notes
This command can only be used with the system-managed sharding method.
Chunks cannot be moved between shards that belong to different shardgroups.
If -chunk ALL is specified without the -target option, all of the chunks are removed from the source shard and distributed to all of the remaining shards in a round-robin manner.
Examples
Move chunks 3 and 4 from SALE1 to SALE3.
GDSCTL> move chunk -chunk 3,4 –source sale1 –target sale3
Move all chunks from sale1 and distribute evenly among the remaining shards.
GDSCTL> move chunk -chunk ALL -source sale1recover shard
Executes all DDL statements on the specified shard (database), starting from the one that was previously executed with errors. The command is intended to perform all skipped DDL changes after database administrator fixes shard issues.
Syntax
recover shard -gdspool pool
-shard shard_name
[-skip_first|-ignore_first]
[-full]Options
Table C-65 GDSCTL recover shard Options
| Option | Description |
|---|---|
-full |
Full recovery mode. |
-gdspool pool |
Specify the GDS pool. If not specified and there is only one GDS pool with access granted to user, it will be used by default. |
-ignore_first |
Make first failed DDL statement obsolete. |
-shard shard_name |
The name of the shard. |
-skip_first |
Skip the first failed DDL statement. |
Usage Notes
Use SKIP_FIRST to skip first DDL. This is typically required after manual fix done by database administrator. For example, if CREATE TABLE statement fails because of a lack of space, the database administrator fixes the issue and re-executes CREATE TABLE. To avoid ORA-39151 (table exists) in RECOVER SHARD the database administrator must specify -SKIP_FIRST.
Use IGNORE_FIRST to mark the first DDL as obsolete. This is required when the wrong DDL statement was specified and failed on all shards. In this case, you need to mark it down as obsolete. FULL mode performs a complete recovery, including DDL operations, failed chunk migration, tablespace sets reconstruction, and database parameters.
Examples
Recover shard shd1.
GDSCTL> recover shard -shard shd1
relocate service
Stops a service on one database and starts the service on a different database.
Syntax
relocate service [-gdspool gdspool_name]
-service service_name
-old_db db_name
-new_db db_name
[-force]
[-override [-oldpwd oldpassword] [-newpwd newpassword]]Options
Table C-66 GDSCTL relocate service Options
| Option | Description |
|---|---|
-force |
If you use this option, then all sessions are disconnected when the service is moved, requiring the sessions using the service to reconnect (potentially to a different instance). If you do not use this option, then the sessions that are connected to a database using this service stay connected, but new sessions cannot be established to the service. |
-gdspool gdspool_name |
Specify the name of the database pool where the service is located. If not specified and there is only one |
-new_db db_name |
Specify the name of the database to which you want to move the service. |
-newpwd newpassword |
Specify the password for the GSMUSER in the database to which the service is being relocated (the target database). |
-old_db db_name |
Specify the name of the database where the service is currently located. |
-oldpwd oldpassword |
Specify the password for the GSMUSER in the source database, or the database where the service is currently located. |
-override |
This option causes the command to execute without updating the global service manager catalog. You can use this option when the catalog database is unavailable. During normal operation, you should not use this option. |
-service service_name |
Specify the name of the global service you are relocating. |
Usage Notes
Unlike using the modify service command to change the location of a service, this command does not change the underlying configuration. This command temporarily relocates a service to run on another database.
If -force is not specified, then the global service must have been started on the old database and not running on the new database prior to command execution. If -force is not specified, then sessions already connected to this global service stay connected, but new sessions cannot be established.
If -override is specified the command will be executed without going to the GDS catalog. Use this option when the GDS catalog is unavailable. It is not recommended for use under normal operation.
If you attempt to use this command on a service that was previously configured with the -preferred_all option, then GDSCTL returns an error.
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command
Example
Relocate the service SALES_REPORT in the READFARM database pool from the DB2 database to the DB3 database.
GDSCTL> relocate service -gdspool readfarm -service sales_report -old_db db1
-new_db db3remove brokerconfig
Removes an Oracle Data Guard broker configuration from a GDS pool.
Syntax
remove brokerconfig [-gdspool gdspool_name]Options
Table C-67 GDSCTL remove brokerconfig Options
| Syntax | Description |
|---|---|
-gdspool gdspool_name |
Specify the GDS pool from which you want to remove the Oracle Data Guard broker configuration (not required, however, if not specified and there is only one GDS pool with access granted to the user, and it is used by default). |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command.
If a GDS pool does not contain a Data Guard Broker configuration, an error is returned.
Example
Remove the Oracle Data Guard broker configuration from the database pool MYDGPOOL.
GDSCTL> remove brokerconfig -gdspool myreaderfarmremove cdb
Removes one or more CDBs from the shard catalog, but does not destroy it.
Syntax
remove cdb -cdb {cdb_name_list | ALL}
[-force] Options
Table C-68 GDSCTL remove cdb Options
| Option | Description |
|---|---|
-cdb {cdb_name_list | ALL} |
Specify a comma-delimited list of CDB names to remove, or specify |
-force |
Remove one or more specified CDBs, even if they are inaccessible and/or contain PDB shards which may contain chunks. It might result in a lower number of replicas or total unavailability for a certain range of data. WARNING: No chunks are moved before removing the CDB which may result in data loss. WARNING: Forced removal of a CDB will also cause the removal of all CDBs that are replicas of the CDB being forcibly removed. |
Examples
Remove the cdb named cdb1.
GDSCTL> remove cdb -cdb cdb1
remove credential
Removes an existing credential.
Syntax
remove credential -credential credential_name
Options
Table C-69 GDSCTL remove credential Options
| Option | Description |
|---|---|
-credential credential_name |
Specify the name of the credential to remove. |
Usage Notes
This command removes an existing credential. When the credential is removed, the catalog may no longer be able to execute jobs on sharded hosts in response to administrative commands.
If the specified credential does not exist, the command returns an error.
Examples
Remove a credential named east_region_cred.
GDSCTL> remove credential –credential east_region_credremove database
Removes databases from a GDS pool.
Syntax
remove database [-gdspool gdspool_name]
{-all | -database db_name_list}
[-force]Options
Table C-70 GDSCTL remove database Options
| Option | Description |
|---|---|
-all |
Removes all databases in the database pool. |
-database db_name_list |
Specify a comma-delimited list of database names that you want to remove from the database pool. You cannot specify a database that was added through an Oracle Data Guard broker configuration; you must use Oracle Data Guard to remove these databases. |
-gdspool gdspool_name |
Specify the GDS pool name. If not specified, and there is only one GDS pool with access granted to the user, it will be used by default. |
-force |
Removes the database from the catalog even if the database is not available. Using this option can result in global services not being removed from the database. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command.
If a pool already contains a Data Guard Broker configuration, an error is returned because a database must be removed through DGMGRL in this case.
With Oracle Sharding, only an undeployed database can be removed. If a database is offline or inaccessible, it has to be first undeployed with the -force option and then removed with the -force option.
Example
Remove the database DB1 from the global service management configuration.
GDSCTL> remove database -database db1 -gdspool pool1remove file
Removes an existing file object from the catalog.
Syntax
remove file -file file_nameOptions
Table C-71 GDSCTL remove file Options
| Option | Description |
|---|---|
-file file_name |
Specify the name of the file object to remove from the catalog. |
Usage Notes
If the specified file object does not exist, the command returns an error.
Examples
Remove a file named east_region_db_params.
GDSCTL> remove file -file east_region_db_paramsremove gdspool
Removes a GDS pool from the current configuration.
Syntax
remove gdspool -gdspool gdspool_name_listOptions
Table C-72 GDSCTL remove gdspool Options
| Option | Description |
|---|---|
-gdspool gdspool_name_list |
Specify a comma-delimited list of GDS pool names. |
Usage Notes
You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the command connect before running this command.
Example
Remove the GDS pools tempreaders and myfarm from the Global Data Services framework.
GDSCTL> remove gdspool -gdspool tempreaders,myfarmremove gsm
Removes a global service manager from the configuration.
Syntax
remove gsm [-gsm gsm_name]Options
Table C-73 GDSCTL remove gsm Options
| Syntax | Description |
|---|---|
-gsm gsm_name |
Specify the name of the global service manager that you want to remove. If the name is not specified, then the current global service manager is removed. |
Usage Notes
The removal of a global service manager requires at least one global service manager to be running to perform cleanup of Global Data Services databases. If there is only one global service manager in the Global Data Services configuration, then it has to be running to be removed.
You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the command connect before running this command.
Example
Remove the global service manager named gsm5 from the configuration.
GDSCTL> remove gsm -gsm gsm5remove invitednode (remove invitedsubnet)
Remove host address information from the valid node checking for registration (VNCR) list in the Global Data Services catalog. This command removes either the specified invitednode or all invitednodes that correspond to an alias.
Syntax
remove invitednode {[-group group_name]|vncr_id}Options
Table C-74 GDSCTL remove invitednode (remove invitedsubnet) Options
| Option | Description |
|---|---|
-group group_name |
Specify an alias which defines a group of VNCRs. This alias can be referenced in other commands related to invited nodes. |
vncr_id |
The host address information, which can be an IPv4 or IPv6 address, a host name, a netmask, or other identifier for a server. The host address information cannot contain any spaces. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command
Examples
Remove the invitednode 198.51.100.22 from the catalog.
GDSCTL> remove invitednode 198.51.100.22
Remove the VNCR alias group EAST_SRV from the catalog.
GDSCTL> remove invitednode -group east_srvremove region
Removes the specified regions from the global service management framework.
Syntax
remove region -region region_listOptions
Table C-75 GDSCTL remove region Options
| Option | Description |
|---|---|
-region region_list |
Specify a comma-delimited list of region names |
Usage Notes
You must connect to the catalog database as a user with the Global Data Services administrator privileges, using the connect command before running this command.
Example
Remove the region named SOUTH from the configuration.
GDSCTL> remove region -region southremove service
Removes a service from a database pool.
Syntax
remove service [-gdspool gdspool_name]
-service service_name
Options
Table C-76 GDSCTL remove service Options
| Option | Description |
|---|---|
-gdspool gdspool_name |
Specify the name of the GDS pool from which you want to remove the service. If not specified and there is only one |
-service service_name |
Specify the name of the service that you want to remove. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command
Example
Remove the service sales_report from the database pool MYREADERFARM.
GDSCTL> remove service -gdspool myreaderfarm -service sales_reportSee Also:
remove shard
Removes one or more shards from the sharded database.
Syntax
remove shard {-shard {shard_name_list | ALL} |
-shardspace shardspace_list |
-shardgroup shardgroup_list}
[-force] Options
Table C-77 GDSCTL remove shard Options
| Option | Description |
|---|---|
-shard {shard_name_list | ALL} |
Specify a comma-delimited list of shard names to remove, or specify |
-shardspace shardspace_list |
Specify a comma-delimited list of names of shardspaces from which to remove all shards. |
-shardgroupshardgroup_list |
Specify a comma-delimited list of names of shardgroups from which to remove all shards. |
-force |
Remove one or more specified shards, even if they are inaccessible and/or contain chunks. It might result in a lower number of replicas or total unavailability for a certain range of data. WARNING: No chunks are moved before removing the shard which may result in data loss. WARNING: Forced removal of a shard will also cause the removal of all shards that are replicas of the shard being forcibly removed. |
Examples
Remove the shards from shardgroup GROUP1.
GDSCTL> remove shard –shardgroup group1
remove shardgroup
Removes a shardgroup from the shard catalog.
Syntax
remove shardgroup -shardgroup shardgroup_nameOptions
Table C-78 GDSCTL remove shardgroup Options
| Option | Description |
|---|---|
-shardgroupshardgroup_name |
Specify the name of the shardgroup to be removed. |
Usage Notes
Only a shardgroup that does not contain any shards can be removed.
Examples
Remove the GROUP1 shardgroup.
GDSCTL> remove shardgroup –shardgroup group1
remove shardspace
Removes a shardspace from the shard catalog.
Syntax
remove shardspace -shardspace shardspace_nameOptions
Table C-79 GDSCTL remove shardspace Options
| Option | Description |
|---|---|
-shardspace shardspace_name |
Specify the name of the shardspace to be removed. |
Usage Notes
Only a shardspace that does not contain any shards or shardgroups can be removed.
Examples
Remove the GOLD shardspace.
GDSCTL> remove shardspace –shardspace gold
restore backup
The restore backup command is used to restore a sharded database to a specific global restore point.
Syntax
restore backup [-restorepoint restore_point_name] [-controlfile] [-catpwd password]
[-shard shard_list] [-async]Options
Table C-80 GDSCTL restore backup Options
| Option | Description |
|---|---|
-restorepoint restore_point_name |
An sharded database global restore point that the specified list of shards will be restored to. |
-controlfile |
If specified, it will restore the database control files to the specified restore point for the specified list of shards. |
-catpwd
password |
Password for user GSMCATUSER. Prompted if not specified. This password only needs to be specified once for this command in an entire GDSCTL session. |
-shard shard_list |
shard_list specifies
a comma separated list of shard identifiers. They can be shard
space, shard group or shard names. The default is no
shards.
|
-async |
When specified, all tasks to configure the backup for the shards will run in background. By default, the task will run in foreground. The task for the SDB catalog database will always run in foreground regardless of this flag setting. |
Examples
The following example restores the control files of shard
v1908c_cdb2_pdb1 to restore point
backup_before_db_maintenance. The database must be in
NOMOUNT state. This command alters the database to
MOUNT state after it has restored the control file..
GDSCTL> restore backup -shard v1908c_cdb2_pdb1 -restorepoint BACKUP_BEFORE_DB_MAINTENANCE –controlfile –catpwd gsm
executing command: SET until clause
Starting restore at 14-APR-20
allocated channel: ORA_DISK_1
channel ORA_DISK_1: SID=441 device type=DISK
allocated channel: ORA_DISK_2
channel ORA_DISK_2: SID=202 device type=DISK
channel ORA_DISK_1: starting datafile backup set restore
channel ORA_DISK_1: restoring control file
channel ORA_DISK_1: reading from backup piece /ade/b/3998875997/oracle/dbs3/V1908C/autobackup/2020_04_14/o1_mf_s_1037736781_h9dndfrd_.bkp
channel ORA_DISK_1: piece handle=/ade/b/3998875997/oracle/dbs3/V1908C/autobackup/2020_04_14/o1_mf_s_1037736781_h9dndfrd_.bkp tag=TAG20200414T201301
channel ORA_DISK_1: restored backup piece 1
channel ORA_DISK_1: restore complete, elapsed time: 00:00:01
output file name=/ade/b/3998875997/oracle/dbs/ct_cf1.f
Finished restore at 14-APR-20
released channel: ORA_DISK_1
released channel: ORA_DISK_2
The next example restores the shard v1908c_cdb2_pdb1 to
a restore point backup_before_db_maintenance.
GDSCTL> restore backup -shard v1908c_cdb2_pdb1 -restorepoint BACKUP_BEFORE_DB_MAINTENANCE -catpwd gsm
executing command: SET until clause
Starting restore at 14-APR-20
starting full resync of recovery catalog
full resync complete
allocated channel: ORA_DISK_1
channel ORA_DISK_1: SID=460 device type=DISK
channel ORA_DISK_1: starting datafile backup set restore
channel ORA_DISK_1: specifying datafile(s) to restore from backup set
...
channel ORA_DISK_1: restored backup piece 1
channel ORA_DISK_1: restore complete, elapsed time: 00:00:03
Finished restore at 14-APR-20
Starting recover at 14-APR-20
current log archived
using channel ORA_DISK_1
Creating automatic instance, with SID='yhox'
...
executing Memory Script
...
Oracle instance shut down
Removing automatic instance
Automatic instance removed
auxiliary instance file /ade/b/3998875997/oracle/dbs/V1908/datafile/o1_mf_sysext_h9dx66s0_.dbf deleted
auxiliary instance file /ade/b/3998875997/oracle/dbs/V1908/datafile/o1_mf_sysaux_h9dx66rp_.dbf deleted
auxiliary instance file /ade/b/3998875997/oracle/dbs/V1908/controlfile/o1_mf_h9dx5klq_.ctl deleted
Finished recover at 14-APR-20
run backup
Run Sharded Database (SDB) Backup Jobs.
Syntax
run backup [-tag tag] [-catpwd password] [-shard shard_list] [-async]Options
Table C-81 GDSCTL run backup Options
| Syntax | Description |
|---|---|
-tag
tag |
A name for the backup. If not provided, a unique tag is automatically generated for the backup. The size limit for tag is 30. |
-catpwd password |
Password for user GSMCATUSER. Prompted if not specified. It needs to be specified once for the entire GDSCTL session. |
-shard shard_list |
shard_list is a comma separated list of shard identifiers. They can be shard space, shard group or shard names. The default is no shards |
-async |
When specified, all tasks to configure the backup for the shards will run in background. By default, the task will run in foreground. |
Examples
In the following example, a backup for the shards in shard space
dbs1 is created before a shard maintenance.
GDSCTL> run backup -tag backup_before_db_maintenance -shard dbs1 -catpwd gsm
Running on-demand backup for database "v1908b_cdb2_pdb1" ...
executing global script: full_backup_cdb
...
Starting Control File and SPFILE Autobackup at 14-APR-20
piece handle=/ade/b/3998875997/oracle/dbs3/V1908C/autobackup/2020_04_14/o1_mf_s_1037736781_h9dndfrd_.bkp comment=NONE
Finished Control File and SPFILE Autobackup at 14-APR-20
Recovery Manager complete.
services
Retrieves information about the services that are registered with the specified global service manager.
Syntax
[status service | services] [-gsm gsm_name]
[-service service_name]
[-raw | -verbose | -support]Options
Table C-82 GDSCTL services Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of a global service manager. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL |
-raw |
If specified, GDSCTL output is presented in a raw, non-parsed format. |
-service service_name |
Specify a fully qualified service name. If the service name is not specified, then the information about all the services registered with the global service manager is retrieved. |
-support |
If specified, GDSCTL output displays additional information. |
-verbose |
Enables verbose output mode. |
Usage Notes
You must run this command on the host where the global service manager for which you want to retrieve service information resides.
You must have the privileges of the user who started the global service manager to run this command.
If -service is not specified, then information for all global services is displayed.
Example
Display information about the services registered with global service manager mygsm:
GDSCTL> services -gsm mygsm
The gdsctl services command returns output similar to the following:
GDSCTL>services -gsm mygsm Service "localsvc.dbpoolora.oradbcloud" has 2 instance(s). Affinity: LOCALPREF Instance "dbpoolora%1", name: "gdscat", db: "gdscat", region: "regionora", status: ready. Instance "dbpoolora%11", name: "gdscat2", db: "gdscat2", region: "regionora", status: ready. Service "sales_report1.dbpoolora.oradbcloud" has 2 instance(s). Affinity: LOCALONLY Instance "dbpoolora%1", name: "gdscat", db: "gdscat", region: "regionora", status: ready. Instance "dbpoolora%11", name: "gdscat2", db: "gdscat2", region: "regionora", status: ready. Service "sales_report2.dbpoolora.oradbcloud" has 2 instance(s). Affinity: ANYWHERE Instance "dbpoolora%1", name: "gdscat", db: "gdscat", region: "regionora", status: ready. Instance "dbpoolora%11", name: "gdscat2", db: "gdscat2", region: "regionora", status: ready.
Note:
Affinity values can be LOCALONLY when the service locality is defined as local_only, LOCALPREF when the service locality is defined as local_only with the region_failover option enabled, and ANYWHERE when the service locality is defined as anywhere.
Display the status of mthly_report service:
GDSCTL>services -service mthly_report.sales.oradbcloud
Returns output similar to the following:
Service "mthly_report.sales.oradbcloud" has 1 instance(s). Affinity:
ANYWHERE
Instance "sales%1", name: "debug", db: "debug", region: "eastcoast",
status: ready.set gsm
Sets the global service manager for the current session.
This command establishes to which global service manager the successive commands apply. The specified global service manager name is resolved in the gsm.ora configuration file.
Syntax
set gsm -gsm gsm_nameOptions
Table C-83 GDSCTL set gsm Options
| Syntax | Description |
|---|---|
-gsm gsm_name |
Specify the name of the global service manager to work with in the current session. If you do not specify a specific global service manager, then GDSCTL uses the default global service manager name of |
Usage Notes
You must run this command on the host where the global service manager that you want to set for the current session resides.
You must have the privileges of the user who started the global service manager to run this command.
Example
Set the global service manager for the current session to gsm1.
GDSCTL> set gsm -gsm gsm1set inbound_connect_level
Sets the INBOUND_CONNECT_LEVEL listener parameter.
Syntax
set inbound_connect_level [-gsm gsm_name]
timeout_valueOptions
Table C-84 GDSCTL set inbound_connect_level Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of the global service manager that you want to start. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm). |
timeout_value |
Specify in seconds the connection timeout value. |
Usage Notes
-
You must run this command on the host where the global service manager for which you want to set the
INBOUND_CONNECT_LEVELlistener parameter resides -
You must have the privileges of the user who started the global service manager to run this command
Example
Set the INBOUND_CONNECT_LEVEL listener parameter for mygsm to time out in 60 seconds:
GDSCLTL> set inbound_connect_level -gsm mygsm 60
set inbound_connect_timeout
Sets the INBOUND_CONNECT_TIMEOUT listener parameter.
Syntax
set inbound_connect_timeout timeout_value
[-gsm gsm_name]
[-save_config | -config_only]Options
Table C-85 GDSCTL set inbound_connect_timeout Options
| Option | Description |
|---|---|
-config_only |
Update GSM.ORA only, without trying to connect to a running global service manager instance. |
-gsm gsm_name |
Specify the name of the global service manager that you want to start. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm). |
-save_config |
Store configuration changes to GSM.ORA. |
timeout_value |
Specify in seconds the connection timeout value. |
Usage Notes
-
You must run this command on the host where the global service manager for which you want to set the
INBOUND_CONNECT_TIMEOUTlistener parameter resides -
You must have the privileges of the user who started the global service manager to run this command
-
By default, parameter values changes remain in effect until the global service manager is shut down.
Example
Set the INBOUND_CONNECT_TIMEOUT listener parameter for mygsm to time out in 60 seconds:
GDSCLTL> set inbound_connect_timeout -gsm mygsm 60
set log_level
Sets the log level for the listener associated with a specific global service manager.
Syntax
set log_level [-gsm gsm_name] log_level
Options
Table C-86 GDSCTL set log_level Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of the global service manager. |
log_level |
Specify the level of detail to write to the log. Valid values are ON or OFF. |
Usage Notes
-
You must run this command on the host where the global service manager for which you want to set the listener log level resides
-
You must have the privileges of the user who started the global service manager to run this command
Example
Set logging on for global service manager mygsm:
GDSCTL> set log_level -gsm mygsm ON
set log_status
Sets the LOG_STATUS listener parameter.
Syntax
set log_status ON|OFF
[-gsm gsm_name]
[-save_config | -config_only]Options
Table C-87 GDSCTL set log_status Options
| Option | Description |
|---|---|
ON|OFF |
Turns listener logging on or off. |
-config_only |
Update GSM.ORA only, without trying to connect to a running global service manager instance. |
-gsm gsm_name |
Specify the name of the global service manager that you want to start. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm). |
-save_config |
Store configuration changes to GSM.ORA. |
Usage Notes
-
You must run this command on the host where the global service manager for which you want to set the
LOG_STATUSlistener parameter resides -
You must have the privileges of the user who started the global service manager to run this command
-
By default, parameter values changes remain in effect until the global service manager is shut down.
Example
Set the LOG_STATUS listener parameter to ON.
GDSCLTL> set log_status on -save_config
set outbound_connect_level
Sets the timeout value for the outbound connections for the listener associated with a specific global service manager.
Syntax
set outbound_connect_level [-gsm gsm_name]
timeout_valueOptions
Table C-88 GDSCTL set outbound_connect_level Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of the global service manager |
timeout_value |
Specify the connection timeout value |
Usage Notes
-
You must run this command on the host where the global service manager for which you want to set the timeout value of outbound connections for the listener resides.
-
You must have the privileges of the user who started the global service manager to run this command.
Example
Set timeout value for all outbound connections:
GDSCTL> set outbound_connect_level 60
set outbound_connect_timeout
Sets the OUTBOUND_CONNECT_TIMEOUT listener parameter.
Syntax
set outbound_connect_timeout timeout_value
[-gsm gsm_name]
[-save_config | -config_only]Options
Table C-89 GDSCTL set outbound_connect_timeout Options
| Option | Description |
|---|---|
timeout_value |
Specify in seconds the connection timeout value. |
-config_only |
Update GSM.ORA only, without trying to connect to a running global service manager instance. |
-gsm gsm_name |
Specify the name of the global service manager that you want to start. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm). |
-save_config |
Store configuration changes to GSM.ORA. |
Usage Notes
-
You must run this command on the host where the global service manager for which you want to set the
OUTBOUND_CONNECT_TIMEOUTlistener parameter resides -
You must have the privileges of the user who started the global service manager to run this command
-
By default, parameter values changes remain in effect until the global service manager is shut down.
Example
Set the OUTBOUND_CONNECT_TIMEOUT listener parameter for mygsm to time out in 60 seconds:
GDSCLTL> set outbound_connect_timeout -gsm mygsm 60
set trace_level
Sets the trace level for the listener associated with the specified global service manager.
Syntax
set trace_level [-gsmgsm_name]trace_level
Options
Table C-90 GDSCTL set trace_level Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of the global service manager. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL |
trace_level |
Specify the trace level for the global service manager listener. Valid values are
|
Usage Notes
-
You must run this command on the host where the global service manager for which you want to set the listener trace level resides.
-
You must have the privileges of the user who started the global service manager to run this command.
Example
Set the trace level for all listeners associated with mygsm to ADMIN
GDSCTL> set trace_level -gsm mygsm ADMIN
set trc_level
Sets the TRC_LEVEL listener parameter.
Syntax
set trc_level trace_level
[-gsm gsm_name]
[-save_config | -config_only]Options
Table C-91 GDSCTL set trc_level Options
| Option | Description |
|---|---|
trace_level |
Specify the trace level for the global service manager listener. Valid values are USER provides traces to identify user-induced error conditions ADMIN provides traces to identify installation-specific problems SUPPORT provides trace with troubleshooting information for Oracle Support Services OFF provides no tracing |
-config_only |
Update GSM.ORA only, without trying to connect to a running global service manager instance. |
-gsm gsm_name |
Specify the name of the global service manager that you want to start. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm). |
-save_config |
Store configuration changes to GSM.ORA. |
Usage Notes
-
You must run this command on the host where the global service manager for which you want to set the
LOG_STATUSlistener parameter resides -
You must have the privileges of the user who started the global service manager to run this command
-
By default, parameter values changes remain in effect until the global service manager is shut down.
Example
Set the TRC_LEVEL listener parameter to SUPPORT.
GDSCLTL> set trc_level support
show ddl
Shows DDL statements execution status.
Syntax
show ddl {[-ddl ddl_id] [-count cnt] | [-failed_only]}
[-support]Options
Table C-92 GDSCTL show ddl Options
| Option | Description |
|---|---|
-count cnt |
The maximum number of entries to display. |
-ddl ddl_id |
DDL numeric identifier. |
-failed_only |
Use this option to display only errored out statements. |
-support |
If specified, GDSCTL output displays additional support information. |
Usage Notes
If -DDL and -COUNT are both unspecified, the command returns only the last 10 DDL statements.
If -DDL is specified but -COUNT is not, the command returns detailed information about the DDL statement. The -COUNT option defines the maximum number of DDLs to display.
Examples
GDSCTL> show ddl -count 20Note:
Theshow dll command output might be truncated. You can run SELECT ddl_text FROM gsmadmin_internal.ddl_requests on the catalog to see the full text of the statements.
split chunk
Splits each of the specified chunks into two chunks with an equal number of records. After the split, the chunks remain in the same shard.
Syntax
split chunk -chunk chunk_id_list
[-shardspace shard_space_list]Options
Table C-93 GDSCTL split chunk Options
| Option | Description |
|---|---|
-chunk chunk_id_list |
Specify a comma-separated list of numeric chunk identifiers. |
-shardspace shard_space_list |
Specify a list of shardspace names in which to split the specified chunks. |
Usage Notes
This command can only be used with system-managed sharding. For user-defined sharding, ALTER TABLE is used to split a partition of the root (parent) table.
Merging of chunks is not supported.
Examples
Split chunks 3, 4, and 5.
GDSCTL> split chunk -chunk 3,4,5sql
Executes a SQL statement or a PL/SQL stored procedure against a sharded database.
Syntax
sql "sql_statement"Options
Table C-94 GDSCTL sql Options
| Option | Description |
|---|---|
sql_statement |
Enter the SQL statement or PL/SQL stored procedure to be executed. Do not include a semi-colon (;) after the SQL statement to be executed. |
Usage Notes
This command can only be executed against a sharded GDS pool. The statements are executed in the GDS catalog database and are then broadcast to all shards in the pool. Since there can be only one sharded pool in a GDS configuration, all SQL statements executed on the catalog database are applied to this pool, if it exists.
Database objects created by this command in the catalog database are used as a schema of the sharded database and are not intended to store user data. The only exception is tables duplicated on all shards (reference tables) – they are populated with data in the catalog database.
SELECT statements are not allowed as the parameter.
The SQL statement or PL/SQL stored procedure to be executed must be enclosed in double quotation marks.
If the string that GDSCTL passes to PL/SQL contains a filename, then the filename must be enclosed in single quotation marks.
Do not include a semi-colon (;) after the SQL statement to be executed.
Examples
Using the gdsctl sql command.
GDSCTL> sql “CREATE TABLESPACE SET ts1 IN SHARDGROUP sgr1"start gsm
Starts a specific global service manager.
Syntax
start gsm [-gsm gsm_name]Options
Table C-95 GDSCTL start gsm Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of the global service manager that you want to start. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm). |
Usage Notes
-
You must run GDSCTL on the same host where the global service manager you want to start is located.
-
You must have operating system privileges on the computer where you want to start the global service manager to run this command.
Example
Start the global service manager gsm1 on the local host.
GDSCTL> start gsm -gsm gsm1start observer
Starts specific services.
Syntax
start observer -database db_name
[-timeout seconds]Options
Table C-96 GDSCTL start observer Options
| Option | Description |
|---|---|
-database db_name |
The name of the database. |
-timeout seconds |
The global service manager requests timeout in seconds. |
Usage Notes
TIMEOUT (default 15) represents the time between when the shard director/global service manager receives requests and starts the observer. See Using Oracle Sharding for the automatic rules for choosing the right region for the shard director (global service manager) server to start the observer. If shard director servers are not running in this region, the observer is not started.
Example
GDSCTL> start observer -database mydbstart service
Starts specific services.
Syntax
start service [-gdspool gdspool_name]
-service service_name
[{-database db_name |
-override [-pwd password] -connect connect_identifier}]Options
Table C-97 GDSCTL start service Options
| Option | Description |
|---|---|
-database db_name |
Specify the name of the database on which you want to start the service. If you do not specify this option, then GDSCTL starts the services on all preferred databases. |
-connect connect_identifier |
Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor. |
-gdspool gdspool_name |
Specify the name of the database pool in which the services that you want to start are located. If not specified and there is only one |
-override |
This option causes the command to run without updating the global service manager catalog. You can use this option when the catalog database is unavailable. During normal operation, you should not use this option. |
-pwd password |
Specify the password of the GSMUSER in the specified database. |
-service service_name |
Specify a comma-delimited list of global service names. If you do not use this option, then GDSCTL starts all the services in the database pool. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command.
Before starting services which run on administrator-managed databases, they must be modified for those databases to stipulate which instances should run the service. Please refer to the -modify_instances parameter of the modify service command.
Example
Start the service SALES_REPORT, located in the READERFARM database pool.
GDSCTL> start service -gdspool readerfarm -service sales_reportstatus
Displays the running status and runtime information for the global service manager.
Syntax
status [-gsm gsm_name] [-raw|-verbose|-support] Options
Table C-98 GDSCTL status Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of a global service manager to check. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL |
-raw |
If specified, GDSCTL output is presented in a raw non-parsed format. |
-support |
If specified, GDSCTL output displays additional information. |
-verbose |
Enable verbose mode. |
Example
GDSCTL> statusThe command returns output similar to the following.
Alias MYGSM
Version 12.1.0.0.2
Start Date 03-JUL-2012 16:48:54
Trace Level support
Listener Log File /u01/ORACLE/mygsm/alert/log.xml
Listener Trace File /u01/ORACLE/mygsm/trace/ora_14816_47568108067776.trc
Endpoint summary (ADDRESS=(HOST=mymv.us.hq.com)(PORT=1523)(PROTOCOL=tcp))
GSMOCI Version 0.1.8
Mastership Y
Connected to GDS catalog Y
Process Id 14818
Number of reconnections 0
Pending tasks. Total 0
Tasks in process. Total 0
Regional Mastership TRUE
Total messages published 28599
Time Zone -07:00
Orphaned Buddy Regions:
None
GDS region regionorastatus backup
View the detailed state on the scheduled backup jobs in the specified shards.
Syntax
status backup [-start_time t1] [-end_time t2] [-catpwd password] [-shard shard_list]
Options
Table C-99 GDSCTL status backup Options
| Option | Description |
|---|---|
-start_time time1 |
The command lists run details of the automated backup jobs that started on or after this time. It must be specified in the format YYYY-MM-DD HH:MM:SS[.FFF] where .FFF is a fraction of a second in the precision of milliseconds. |
-end_timetime2 |
If specified, only backups usable to restore database control files to a specific restore point are listed.. |
-catpwd
password |
Password for user GSMCATUSER. Prompted if not specified. This password only needs to be specified once for this command in an entire GDSCTL session. |
-shard shard_list |
shard_list specifies
a comma separated list of shard identifiers. They can be shard
space, shard group or shard names. The default is all
shards.
|
Examples
The following example shows the job state and all job run details from the sharded
database (SDB) catalog and the primary shard rdbmsb_cdb2_pdb1.
GDSCTL> status backup -catpwd -shard catalog,rdbmsb_cdb2_pdb1;
"GSMCATUSER" password:***
Retrieving scheduler backup job status for database "rdbms" ...
Jobs:
Incremental Level 0 backup job is enabled
Job schedule start time: 2020-07-27 00:00:00.000 -0400
Job repeat interval: freq=daily;interval=1
Incremental Level 1 backup job is enabled
Job schedule start time: 2020-07-27 00:00:00.000 -0400
Job repeat interval: freq=minutely;interval=60
Global restore point create job is enabled
Job schedule start time: 2020-07-27 23:59:55.960 -0400
Job repeat interval: freq=hourly
Run Details:
Incremental Level 1 backup job status: SUCCEEDED
Job run actual start time: 2020-07-26 14:00:00.177 -0400
Job run slave process ID: 9023
Incremental Level 1 backup job status: SUCCEEDED
Job run actual start time: 2020-07-26 22:00:01.305 -0400
Job run slave process ID: 59526
…
Global restore point create job status: SUCCEEDED
Job run actual start time: 2020-07-27 15:28:37.603 -0400
Job run slave process ID: 44227
…
Global restore point create job status: SUCCEEDED
Job run actual start time: 2020-07-27 17:28:38.251 -0400
Job run slave process ID: 57611
Retrieving scheduler backup job status for database "rdbmsb_cdb2_pdb1" ...
Jobs:
Incremental Level 0 backup job is enabled
Job schedule start time: 2020-07-28 00:00:00.000 -0400
Job repeat interval: freq=daily;interval=1
Incremental Level 1 backup job is enabled
Job schedule start time: 2020-07-28 00:00:00.000 -0400
Job repeat interval: freq=minutely;interval=60
Run Details:
Incremental Level 1 backup job status: SUCCEEDED
Job run actual start time: 2020-07-26 14:00:00.485 -0400
Job run slave process ID: 9056
…
Incremental Level 1 backup job status: SUCCEEDED
Job run actual start time: 2020-07-27 14:33:42.702 -0400
Job run slave process ID: 9056
Incremental Level 0 backup job status: SUCCEEDED
Job run actual start time: 2020-07-27 00:00:01.469 -0400
Job run slave process ID: 75176
status database
Displays the runtime status of databases, such as registration information, services, and so on.
Syntax
{status database | databases} [-gsm gsm_name]
[-database db_name]
[-gdspool gdspool_name]
[-raw | -support | -verbose] Options
Table C-100 GDSCTL status database Options
| Option | Description |
|---|---|
-database db_name |
Specify the name of the database on which to check status |
-gdspool gdspool_name |
Specify the name of the database pool. If not specified and there is only one gdspool with access granted to the user, it is used as the default gdspool. |
-gsm gsm_name |
Specify the name of a global service manager to check. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL |
-raw |
If specified, GDSCTL output is presented in a raw, non-parsed format. |
-support |
If specified, GDSCTL output displays additional support information. |
-verbose |
Enable verbose output mode. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command.
This command requires a locally started global service manager. If -gsm is not specified for STATUS DATABASE, then the currently connected global service manager name is used by default.
Example
Display the status of all databases:
GDSCTL> status database
The gdsctl status database command returns output similar to the following:
Database: "dbcat1" Registered: Y State: Ok ONS: N. Role: PRIMARY Instances: 1
Region: east
Service: "sales_svc2" Globally started: N Started: N
Scan: Y Enabled: Y Preferred: Y
Service: "sales_svc1" Globally started: Y Started: Y
Scan: N Enabled: Y Preferred: Y
Registered instances:
sales%11
Database: "dbcat2" Registered: Y State: Ok ONS: N. Role: PRIMARY Instances: 1
Region: east
Service: "sales_svc2" Globally started: N Started: N
Scan: Y Enabled: Y Preferred: Y
Service: "sales_svc1" Globally started: Y Started: Y
Scan: N Enabled: Y Preferred: Y
Registered instances:
sales%1status gsm
Displays the status of a specific global service manager.
Syntax
status (gsm)? [-gsm gsm_name]
[-raw | -verbose | -support]Options
Table C-101 GDSCTL status gsm Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of a global service manager to check. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL |
-raw |
If specified, GDSCTL output is presented in a raw, non-parsed format. |
-support |
If specified, GDSCTL output displays additional support information. |
-verbose |
Enable verbose output mode. |
Usage Notes
You must run GDSCTL on the same host where the global service manager for which you want to display the status is located.
You must have operating system privileges on the computer where you want to display the global service manager status to run this command.
Example
Display status of mygsm:
GDSCTL> status gsm -gsm mygsm
The gdsctl status gsm command returns output similar to the following:
Alias MYGSM
Version 12.1.0.0.2
Start Date 03-JUL-2012 16:48:54
Trace Level support
Listener Log File /u01/ORACLE/mygsm/alert/log.xml
Listener Trace File /u01/ORACLE/mygsm/trace/ora_14816_47568108067776.trc
Endpoint summary (ADDRESS=(HOST=mymv.us.hq.com)(PORT=1523)(PROTOCOL=tcp))
GSMOCI Version 0.1.8
Mastership Y
Connected to GDS catalog Y
Process Id 14818
Number of reconnections 0
Pending tasks. Total 0
Tasks in process. Total 0
Regional Mastership TRUE
Total messages published 28599
Time Zone -07:00
Orphaned Buddy Regions:
None
GDS region regionorastatus service
Displays the status of a specific service.
Syntax
{status service | services} [-gsm gsm_name]
[-service service_name]
[{-raw|-verbose|-support}]Options
Table C-102 GDSCTL status service Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of a global service manager. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the GDSCTL |
-raw |
Used by oracle internal components. |
-service service_name |
Specify a comma-delimited list of global service names. If you do not specify any services, then GDSCTL displays the status of all services in the database pool. |
-support |
Display more detailed information concerning load balancing. |
-verbose |
Display extra information related to load balancing. |
Usage Notes
Example
Display the status of service sales_report1.sales.oradbcloud:
GDSCTL> status service -service sales_report1.sales.oradbcloud
The gdsctl status service command returns output similar to the following:
Service "sales_report1.sales.oradbcloud" has 3 instance(s). Affinity: ANYWHERE
Instance "sales%1", name: "dbcat2", db: "dbcat2", region: "east",
status: ready.
Instance "sales%11", name: "dbcat1", db: "dbcat1", region: "west",
status: ready.
Instance "sales%31", name: "dbcat3", db: "dbcat3", region: "east",
status: ready.stop gsm
Stops a specific global service manager.
Syntax
stop gsm [-gsm gsm_name]Options
Table C-103 GDSCTL stop gsm Options
| Option | Description |
|---|---|
-gsm gsm_name |
Specify the name of a global service manager you want to stop. If you do not specify a specific global service manager, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm). |
Usage Notes
-
You must run GDSCTL on the same host where the global service manager that you want to stop is located.
-
You must have operating system privileges on the computer where you want to start the global service manager to run this command.
Example
Stop the global service manager gsm1 on the local host.
GDSCTL> stop gsm -gsm gsm1stop service
Stops the specified global services.
Syntax
stop service [-gdspool gdspool_name]
[-service service_name_list]
[{-database db_name |
-override -connect connect_identifier [-pwd password]}]
[-force]
[-drain_timeout time]
[-stop_option {NONE|IMMEDIATE|TRANSACTIONAL}]Options
Table C-104 GDSCTL stop service Options
| Option | Description |
|---|---|
-connect connect_identifier |
Specify an Oracle Net connect descriptor or net service name that resolves to a connect descriptor for the database (or shard). |
-database db_name |
Specify the name of the database on which you want to stop the service. If you do not specify this option, then GDSCTL stops the services on all databases on which the service is currently running. |
—drain_timeout |
Set drain time in seconds. |
-force |
If you use this option, then GDSCTL disconnects all sessions when the service is stopped, requiring the sessions using the service to reconnect (potentially to a different instance). If you do not use this option, then the sessions that are connected to a database using this service remain connected, but new sessions cannot be established to the service. |
-gdspool gdspool_name |
Specify the name of the GDS pool in which the service that you want to stop is located. If not specified and there is only one GDS pool with access granted to user, that GDS pool is used as the default GDS pool. |
-override |
This option causes the command to execute without updating the global service manager catalog. You can use this option when the catalog database is unavailable. During normal operation, you should not use this option. |
-pwd password |
Specify the password of the GSMUSER in the specified database. |
-service service_name |
Specify a comma-delimited list of global service names you want to stop. If you do not use this option, then GDSCTL stops all the services in the database pool. |
—stop_option |
Set the default stop option to |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command.
If -service is not specified, all global services of GDS pool are stopped.
If -database is not specified, the global services are stopped on all of the databases.
If -force is specified, all sessions are disconnected, requiring the session using the global service to reconnect (potentially to another instance). If -force is not specified, then sessions already connected to this global service stay connected, but new sessions cannot be established to the global service.
If -override is specified, the command is executed without connecting to the GDS catalog. Use this option when the GDS catalog is unavailable. It is not recommended for use under normal operation.
Example
Stop the service SALES_REPORT, on all databases in the database pool READERFARM.
GDSCTL> stop service -gdspool readerfarm -service sales_report
See Also:
sync brokerconfig (synchronize brokerconfig)
Synchronizes the Oracle Data Guard broker configuration in the global service manager with the configuration in the database pool. The synchronize brokerconfig command has the same options and usage.
Syntax
sync[hronize] brokerconfig [-gdspool gdspool_name]
[-database db_name]Options
Table C-105 GDSCTL sync brokerconfig Options
| Option | Description |
|---|---|
-database db_name |
Specify the name of a database in the database pool to use as a referential database, from which the configuration is queried. If you do not use this option, then GDSCTL uses the primary database as the referential database. If a primary database does not exist in the Oracle Data Guard broker configuration, then GDSCTL uses a random database from the pool as the referential database. |
-gdspool gdspool_name |
Specify the database pool to which the Oracle Data Guard broker configuration belongs. If not specified and there is only one If the specified database pool does not contain an Oracle Data Guard broker configuration, then GDSCTL returns an error. |
Usage Notes
You must connect to the catalog database as a user with the pool administrator privileges, using the command connect before running this command.
Example
Synchronize the Oracle Data Guard broker configuration in the database pool MYREADERFARM with the configuration stored in the Global Data Services catalog.
GDSCTL> sync brokerconfig -gdspool myreaderfarmsync database (synchronize database)
Synchronizes attributes of global services and GDS related parameters of a GDS pool database with the contents of the GDS catalog. The synchronize database command has the same options and usage.
Syntax
sync[hronize] database [-gdspool gdspool_name]
[-database database_name]Options
Table C-106 GDSCTL sync database Options
| Option | Description |
|---|---|
-database database_name |
Specify the name of a database in the database pool to use as a referential database, from which the configuration is queried. |
-gdspool gdspool_name |
Specify the GDS pool to which the database belongs. If not specified and there is only one GDS pool with access granted to user, it is used as the default GDS pool. |
Usage Notes
-
If database has no GDS region assigned, an error is returned.
-
If a GDS pool is specified and the database option is not specified, then each database in the pool is synchronized.
Example
Synchronize a database in the default database pool with the database mydb.
GDSCTL> sync database -database mydbsync schema (synchronize schema)
Allows common shared schemas across the existing databases to be retrieved. The command compares the schemas on all of the databases and retrieves those that are common.
Syntax
sync[hronize] schema [-schema schemalist [-retrieve_only] [-restart [-force]] | -apply [-skip_first] | -show [[-ddl ddlnum] [-count n] | [-failed_only]]]Options
Table C-107 GDSCTL sync
schema Options
| Option | Description |
|---|---|
-apply |
Specifies that the previously retrieved DDLs should be run in the catalog. |
-count n |
Specifies the maximum number of entries to show. |
-ddl ddlnum |
Specifies the DDL numeric identifier. |
-failed_only |
Shows only errored out statements. |
-force |
Forces sync without user confirmation. |
-restart |
Sync from the beginning, erasing schemas synced earlier. |
-retrieve_only |
Specifies that the DDLs of the common schemas should be retrieved only from the databases and stored in the catalog but not applied. |
-schema schemalist |
Specifies that only the listed schemas will be
retrieved. Specify |
-show |
Shows DDL statements and their execution status. |
-skip_first |
Specifies that the first failed DDL statement is skipped. |
Usage Notes
This command is used only when the catalog is created for a federated database, which can be created by using option-for_federated_database
of the create shardcatalog command. This option is mutually exclusive
with –sharding parameter. The rest of the steps are similar to sharded
database environment setup with user-defined sharding [create
shardcatalog, add gsm, add shardspace,
add shard, deploy]. After deployment is complete, the sync
schema command can be run to import specified schemas from shards to the
catalog.
sync ddl command combines two operations:
–schema parameter, which is list of schemas to import from shards.
Note that all can be supplied to the -schema parameter
to retrieve all non-Oracle schemas common to all shards and which do not exist on the
catalog.This operation can be split into two steps using -retrieve_only
and -apply options. The option -retrieve_only will
retrieve schemas from the shards and generate the required DDL statements to be applied,
but it does not execute these statements. To execute them at a later point, the
-apply option is used. If, for some reason, a DDL execution fails,
subsequent statements will not be executed as there could be dependencies on the failed
DDL. When –apply is run again after fixing the issue, it will start
from the first failed DDL statement and continue execution.
-show is for examining DDL
statements and their execution status.
Example
GDSCTL> sync schema -schema myschemaGDSCTL> sync schema -schema foo,barGDSCTL> sync schema -schema foo,"Bar"GDSCTL> sync schema -schema allvalidate backup
The validate backup command provides sharded database (SDB) backup validation.
Syntax
validate backup [-restorepoint restore_point_name] [-controlfile] [-header]
[-catpwd password] [-shard shard_list] [-async]Options
Table C-108 GDSCTL validate backup Options
| Option | Description |
|---|---|
-restorepoint restore_point_name |
A restore point to verify the backups against. |
-controlfile |
If specified, only backups usable to restore database control files to a specific restore point are validated. |
-header |
If specified, it will only validate the backup file headers to determine whether the files on the media correspond to the metadata in the RMAN repository. |
-catpwd
password |
Password for user GSMCATUSER. Prompted if not specified. This password only needs to be specified once for this command in an entire GDSCTL session. |
-shard shard_list |
shard_list
specifies a comma separated list of shard identifiers. They can be
shard space, shard group or shard names. The default is all
shards.
|
-async |
When specified, all tasks to configure the backup for the shards will run in background. By default, the task will run in foreground. The task for the SDB catalog database will always run in foreground regardless of this flag setting. |
Examples
The sharded database catalog (SC) database must be open, but the shard databases can
be either mounted or open. If the backup validation is for database control files,
the shards can be started nomount.The following example svalidates the backups of
the control files from the SDB catalog database recoverable to restore point
backup_before_db_maintenance.
GDSCTL> validate backup -shard catalog -controlfile -restorepoint BACKUP_BEFORE_DB_MAINTENANCE
Validating backups for database "v1908" ...
executing command: SET until clause
Starting restore at 14-APR-20
allocated channel: ORA_DISK_1
channel ORA_DISK_1: SID=201 device type=DISK
channel ORA_DISK_1: starting validation of datafile backup set
channel ORA_DISK_1: reading from backup piece /ade/b/3998875997/oracle/dbs/V1908/autobackup/2020_04_14/o1_mf_s_1037669374_h9blkyc8_.bkp
channel ORA_DISK_1: piece handle=/ade/b/3998875997/oracle/dbs/V1908/autobackup/2020_04_14/o1_mf_s_1037669374_h9blkyc8_.bkp tag=TAG20200414T012934
channel ORA_DISK_1: restored backup piece 1
channel ORA_DISK_1: validation complete, elapsed time: 00:00:01
Finished restore at 14-APR-20
Recovery Manager complete.The next example validates the headers of the backups from shard
v1908b_cdb2_pdb1 recoverable to restore point
backup_before_db_maintenance.
GGDSCTL> validate backup -shard v1908b_cdb2_pdb1 -restorepoint BACKUP_BEFORE_DB_MAINTENANCE -header
Validating backups for database "v1908b_cdb2_pdb1" ...
executing command: SET until clause
Starting restore at 14-APR-20
allocated channel: ORA_DISK_1
channel ORA_DISK_1: SID=468 device type=DISK
allocated channel: ORA_DISK_2
channel ORA_DISK_2: SID=236 device type=DISK
List of Backup Sets
===================
BS Key Type LV Size Device Type Elapsed Time Completion Time
------- ---- -- ---------- ----------- ------------ ---------------
2998 Incr 0 265.53M DISK 00:00:06 14-APR-20
BP Key: 3009 Status: AVAILABLE Compressed: NO Tag: BACKUP_BEFORE_DB_MAINTENANCE
Piece Name: /tmp/rman/backups/2/0sutl6oa
List of Datafiles in backup set 2998
Container ID: 3, PDB Name: CDB2_PDB1
File LV Type Ckp SCN Ckp Time Abs Fuz SCN Sparse Name
---- -- ---- ---------- --------- ----------- ------ ----
11 0 Incr 2678401 14-APR-20 NO /ade/b/3998875997/oracle/dbs/cdb2_pdb1_db.f
BS Key Type LV Size Device Type Elapsed Time Completion Time
------- ---- -- ---------- ----------- ------------ ---------------
2999 Incr 0 191.61M DISK 00:00:04 14-APR-20
BP Key: 3010 Status: AVAILABLE Compressed: NO Tag: BACKUP_BEFORE_DB_MAINTENANCE
Piece Name: /tmp/rman/backups/1/0tutl6oh
List of Datafiles in backup set 2999
Container ID: 3, PDB Name: CDB2_PDB1
File LV Type Ckp SCN Ckp Time Abs Fuz SCN Sparse Name
---- -- ---- ---------- --------- ----------- ------ ----
12 0 Incr 2678425 14-APR-20 NO /ade/b/3998875997/oracle/dbs/cdb2_pdb1_ax.f
13 0 Incr 2678425 14-APR-20 NO /ade/b/3998875997/oracle/dbs/cdb2_pdb1_xdb.f
validation succeeded for backup piece
Finished restore at 14-APR-20
Recovery Manager complete.
validate catalog
Cross checks the Global Data Services catalog, global service manager run-time status, and pool databases, and reports inconsistencies and errors.
Syntax
validate [catalog]
[-gsm gsm_name]
[ {-config | -database db_name} ]
[-catpwd cpwd]
[-dbpwd dpwd]
Options
Table C-109 GDSCTL validate catalog Options
| Option | Description |
|---|---|
-catpwd cpwd |
Provides the GSMCATUSER password, otherwise it is read from the local wallet file by default. |
-config |
Indicates that the validation should be performed on the Global Data Services catalog configuration only. |
-database db_name |
Indicates the name of the database for which the cross-check validation should be performed. |
-dbpwd dpwd |
Provides the pool database password directly if there is only one database in the pool, or if multiple databases in the pool share the same password. |
-gsm gsm_name |
Specify the global service manager name. If the name is not specified, then GDSCTL uses the current global service manager name for the session (specified with the command set gsm). |
Usage Notes
Because the execution of this command involves accessing all databases in a Global Data Services configuration, the GSMCATUSER password is required run it. The password is stored in the wallet of any global service manager that is part of the Global Data Services configuration. Therefore, if you run the command from the ORACLE_HOME of any of the global service managers, the password is automatically extracted from the wallet and does not have to be provided. Otherwise, you must provide the GSMCATUSER password using the -catpwd command option. Alternatively, if all databases in the Global Data Services configuration have the same GSMUSER password, you can specify the password instead of the GSMCATUSER password by using the -dbpwd option.
Example
Validate the catalog:
GDSCTL> validate
The output should be similar to the following:
Validation results:
VLD2: Region "regionora" does not have buddy region
VLD11: GDS pool "marketing" does not contain any databases
VLD12: GDS pool "marketing" does not contain any global services
VLD11: GDS pool "sales" does not contain any databases
VLD12: GDS pool "sales" does not contain any global services
VLD11: GDS pool "mkt" does not contain any databases
VLD12: GDS pool "mkt" does not contain any global servicesvalidate
Cross checks the GDS catalog, global service manager run-time status, and databases from the GDS pool and reports any inconsistencies and errors.
Syntax
validate [catalog] [-gsm gsm]
[-config | -database db_name [-dbpwd sipwd]]
[-catpwd cpwd]Options
Table C-110 GDSCTL validate Options
| Option | Description |
|---|---|
-catpwd cpwd |
GSMCATUSER password. |
-config |
If specified, performs validation of GDS catalog configuration only. |
-database db_name |
Performs cross-check validation of the specified database. |
-dbpwd sipwd |
GSMUSER password. |
-gsm gsm |
Global service manager name |
Usage Notes
If no options are specified, cross-checks are performed on the GDS catalog, database, and local global service manager.
Example
GDSCTL> validate catalog -catpwd cpwd -dbpwd sipwd