
Reference
This chapter describes the parameters for the packaged procedures that are supplied with the symmetric replication facility. Any possible exceptions raised by these procedures are also described. The procedures are listed alphabetically within each package. The package variables used with replication are described at the end of this chapter
.
DBMS_DEFER.CALL
Purpose
To build a deferred call to a remote procedure. For additional information, refer to page 11 - 4.
Syntax
The parameters for the CALL procedure are described in Table 12 - 1, and the exceptions are listed in Table 12 - 2. The syntax for this procedure is shown below:
DBMS_DEFER.CALL( schema_name IN VARCHAR2,
package_name IN VARCHAR2,
proc_name IN VARCHAR2,
arg_count IN NATURAL
[, nodes IN node_list_t]
[, group_name IN VARCHAR2 :=''])
Parameter
| Description
|
schema_name
| The name of the schema in which the stored procedure is located.
|
package_name
| The name of the package containing the stored procedure. The stored procedure must be part of a package. Deferred calls to standalone procedures are not supported.
|
proc_name
| The name of the remote procedure to which you want to defer a call.
|
arg_count
| The number of parameters for the procedure. You must have one call to DBMS_DEFER.datatype_ARG for each of these parameters.
|
nodes
| A PL/SQL table of fully qualified database names to which you want to propagate the deferred call. The table is indexed starting at position one and ending when a NULL entry is found, or the NO_DATA_FOUND exception is raised. The data in the table is case insensitive. This argument is optional.
|
group_name
| Reserved for internal use.
|
Table 12 - 1. Parameters for CALL
Exception
| Description
|
ORA-23304 (malformedcall)
| The previous call was not correctly formed.
|
ORA-23319
| Parameter value is not appropriate.
|
ORA-23352
| The destination list (specified by NODES or by a previous DBMS_DEFER.TRANSACTION call) contains duplicates.
|
Table 12 - 2. Exceptions for CALL
DBMS_DEFER.COMMIT_WORK
Purpose
To perform a transaction commit after checking for well formed deferred remote procedure calls.
Syntax
The parameter for the COMMIT_WORK procedure is described in Table 12 - 3, and the exception is listed in Table 12 - 4. The syntax for this procedure is as follows:
DBMS_DEFER.COMMIT_WORK(commit_work_comment IN VARCHAR2)
Parameter
| Description
|
commit_work_
comment
| Up to 50 bytes to describe the transaction in the DEF$_CALL table.
|
Table 12 - 3. Parameter for COMMIT_WORK
Exception
| Description
|
ORA-23304 (malformedcall)
| The transaction was not correctly formed or terminated.
|
Table 12 - 4. Exception for COMMIT_WORK
DBMS_DEFER.datatype_ARG
Purpose
To provide the data that is to be passed to a deferred remote procedure call. For additional information, refer to page 11 - 5.
Syntax
Depending upon the type of the data that you need to pass to the procedure, you need to call one of the following procedures in the DBMS_DEFER package for each argument to the procedure:
DBMS_DEFER.NUMBER_ARG(arg IN NUMBER);
DBMS_DEFER.DATE_ARG(arg IN DATE);
DBMS_DEFER.VARCHAR2_ARG(arg IN VARCHAR2);
DBMS_DEFER.CHAR_ARG(arg IN CHAR);
DBMS_DEFER.ROWID_ARG(arg IN ROWID);
DBMS_DEFER.RAW_ARG(arg IN RAW);
Parameter
| Description
|
arg
| The value of the parameter that you want to pass to the remote procedure to which you previously deferred a call.
|
Exception
| Description
|
ORA-23323
| The argument value is too long.
|
Table 12 - 6. Exception for VARCHAR2/CHAR/RAW_ARG
DBMS_DEFER.TRANSACTION
Purpose
To indicate the start of a new deferred transaction. If you omit this call, Oracle considers your first call to DBMS_DEFER.CALL to be the start of a new transaction. For additional information, refer to page 11 - 4.
Syntax
The parameter for the TRANSACTION procedure is described in Table 12 - 7, and the exceptions are listed in Table 12 - 8. The syntax for this procedure is as follows:
DBMS_DEFER.TRANSACTION
DBMS_DEFER.TRANSACTION( nodes IN node_list_t)
Note: The transaction procedure is overloaded. The behavior of the version without a parameter is similar to that of the version with a parameter, except that the former uses the nodes in the DefDefaultDest view instead of having a nodes parameter.
Parameter
| Description
|
nodes
| A PL/SQL table of fully qualified database names to which you want to propagate the deferred calls of the transaction. The table is indexed starting at position one until a NULL entry is found, or the NO_DATA_FOUND exception is raised. The data in the table is case insensitive.
|
Table 12 - 7. Parameter for TRANSACTION
Exception
| Description
|
ORA-23304 (malformedcall)
| The previous transaction was not correctly formed or terminated.
|
ORA-23319
| Parameter value is not appropriate.
|
ORA-23352
| Raised by DBMS_DEFER.CALL if the node list contains duplicates.
|
Table 12 - 8. Exceptions for TRANSACTION
DBMS_DEFER_QUERY.GET_ARG_TYPE
Purpose
To determine the type of an argument in a deferred call. For additional information, refer to page 7 - 2.
Syntax
The parameters for the GET_ARG_TYPE function are described in Table 12 - 9, the exception is listed in Table 12 - 10, and the possible return values are described in Table 12 - 11. The syntax for this procedure is shown below:
DBMS_DEFER_QUERY.GET_ARG_TYPE(
callno IN NUMBER,
deferred_tran_db IN VARCHAR2,
arg_no IN NUMBER,
deferred_tran_id IN VARCHAR2)
RETURN NUMBER
Parameter
| Description
|
callno
| The ID number from the DefCall view of the deferred remote procedure call.
|
deferred_tran_db
| Fully qualified database name that originated the transaction. This is also stored in the DefCall view.
|
arg_no
| The numerical position of the argument to the call whose type you want to determine. The first argument to a procedure is in position one.
|
deferred_tran_id
| The identifier of the deferred transaction.
|
Table 12 - 9. Parameters for GET_ARG_TYPE
Exception
| Description
|
NO_DATA_FOUND
| The input parameters do not correspond to a parameter of a deferred call.
|
Table 12 - 10. Exception for GET_ARG_TYPE
Return Value
| Corresponding Datatype
|
1
| VARCHAR2
|
2
| NUMBER
|
11
| ROWID
|
12
| DATE
|
23
| RAW
|
96
| CHAR
|
Table 12 - 11. Return Values for GET_ARG_TYPE
DBMS_DEFER_QUERY.GET_datatype_ARG
Purpose
To determine the value of an argument in a deferred call. For additional information, refer to page 7 - 3.
Syntax
Depending upon the type of the argument value that you want to retrieve, the syntax for the appropriate function is as follows. The parameters for these functions are described in Table 12 - 12, and the exceptions are listed in Table 12 - 13. Each of these functions returns the value of the specified argument.
For arguments of type NUMBER:
DBMS_DEFER_QUERY.GET_NUMBER_ARG
(callno IN NUMBER,
deferred_tran_db IN VARCHAR2,
arg_no IN NUMBER,
deferred_tran_id IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER
For arguments of type VARCHAR2:
DBMS_DEFER_QUERY.GET_VARCHAR2_ARG
(callno IN NUMBER,
deferred_tran_db IN VARCHAR2,
arg_no IN NUMBER,
deferred_tran_id IN VARCHAR2 DEFAULT NULL)
RETURN VARCHAR2
For arguments of type CHAR:
DBMS_DEFER_QUERY.GET_CHAR_ARG
(callno IN NUMBER,
deferred_tran_db IN VARCHAR2,
arg_no IN NUMBER,
deferred_tran_id IN VARCHAR2 DEFAULT NULL)
RETURN CHAR
For arguments of type DATE:
DBMS_DEFER_QUERY.GET_DATE_ARG
(callno IN NUMBER,
deferred_tran_db IN VARCHAR2,
arg_no IN NUMBER,
deferred_tran_id IN VARCHAR2 DEFAULT NULL)
RETURN DATE
For arguments of type RAW:
DBMS_DEFER_QUERY.GET_RAW_ARG
(callno IN NUMBER,
deferred_tran_db IN VARCHAR2,
arg_no IN NUMBER,
deferred_tran_id IN VARCHAR2 DEFAULT NULL)
RETURN RAW
For arguments of type ROWID:
DBMS_DEFER_QUERY.GET_ROWID_ARG
(callno IN NUMBER,
deferred_tran_db IN VARCHAR2,
arg_no IN NUMBER,
deferred_tran_id IN VARCHAR2 DEFAULT NULL)
RETURN ROWID
Parameter
| Description
|
callno
| The ID number from the DefCall view of the deferred remote procedure call.
|
deferred_tran_db
| Fully qualified database name that originated the transaction. This is also stored in the DefCall view.
|
arg_no
| The numerical position of the argument to the call whose value you want to determine. The first argument to a procedure is in position one.
|
deferred_tran_id
| Default NULL. The identifier of the deferred transaction. Defaults to the last transaction identifier passed to GET_ARG_TYPE.
|
Table 12 - 12. Parameters for GET_NUMBER/VARCHAR2/CHAR/DATE/RAW/ROWID_ARG
Exception
| Description
|
NO_DATA_FOUND
| The input parameters do not correspond to a parameter of a deferred call.
|
bad_param_type
| The argument in this position is not of the specified type.
|
Table 12 - 13. Exceptions for GET_NUMBER/VARCHAR2/CHAR/DATE/RAW/ROWID_ARG
DBMS_DEFER_SYS.ADD_DEFAULT_DEST
Purpose
To add a destination database to the DefDefaultDest view. For additional information, refer to page 11 - 5.
Syntax
The parameter for the ADD_DEFAULT_DEST procedure is described in Table 12 - 14, and the exception is listed in Table 12 - 15. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.ADD_DEFAULT_DEST( dblink IN VARCHAR2)
Parameter
| Description
|
dblink
| The fully qualified database name of the node that you want to add to the DefDefaultDest view.
|
Table 12 - 14. Parameter for ADD_DEFAULT_DEST
Exception
| Description
|
ORA-23352
| The DBLINK that you specified is already in the default list.
|
Table 12 - 15. Exception for ADD_DEFAULT_DEST
DBMS_DEFER_SYS.COPY
Purpose
To create a copy of a deferred transaction with a new destination. For additional information, refer to page 11 - 6.
Syntax
The parameters for the COPY procedure are described in Table 12 - 16. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.COPY
(deferred_tran_id IN VARCHAR2,
deferred_tran_db IN VARCHAR2,
destination_list IN dbms_defer.node_list_t,
destination_count IN BINARY_INTEGER)
Parameter
| Description
|
deferred_tran_id
| The ID number from the DefTran view of the deferred transaction that you want to copy.
|
deferred_tran_db
| The fully qualified database name from the DefTran view of the database in which the transaction that you want to copy originated.
|
destination_list
| A PL/SQL table of fully qualified database names to which you want to propagate the deferred calls of the copied transaction. The table is indexed starting at position one and the data in the table is case insensitive.
|
destination_count
| The number of entries in the DESTINATION_LIST table.
|
Table 12 - 16. Parameters for COPY
DBMS_DEFER_SYS.DELETE_DEFAULT_DEST
Purpose
To remove a destination database from the DefDefaultDest view. For additional information, refer to page 11 - 6.
Syntax
The parameter for the DELETE_DEFAULT_DEST procedure is described in Table 12 - 17. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.DELETE_DEFAULT_DEST(dblink IN VARCHAR2);
Parameter
| Description
|
dblink
| The fully qualified database name of the node that you want to delete from the DefDefaultDest view. If Oracle does not find this dblink in the view, no action is taken.
|
Table 12 - 17. Parameter for DELETE_DEFAULT_DEST
DBMS_DEFER_SYS.DELETE_ERROR
Purpose
To delete a transaction from the DefError view. If there are not other DefTranDest or DefError entries for the transaction, the transaction is deleted from the DefTran and DefCall views as well. For additional information, refer to page 7 - 5.
Syntax
The parameters for the DELETE_ERROR procedure are described in Table 12 - 18. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.DELETE_ERROR( deferred_tran_id IN VARCHAR2,
deferred_tran_db IN VARCHAR2,
destination IN VARCHAR2)
Parameter
| Description
|
deferred_tran_id
| The ID number from the DefError view of the deferred transaction that you want to remove from the DefError view. If this parameter is null, all transactions meeting the requirements of the other parameters are removed.
|
deferred_tran_db
| The fully qualified database name from the DefError view of the database in which the transaction that you want to remove from the DefError view originated. If this parameter is null, transactions meeting the requirements of the other parameters are removed.
|
destination
| The fully qualified database name from the DefError view of the database to which the transaction was originally queued. If this parameter is null, all transactions meeting the requirements of the other parameters are removed from the DefError view.
|
Table 12 - 18. Parameters for DELETE_ERROR
Exception
Transaction ID and/or node not found.
DBMS_DEFER_SYS.DELETE_TRAN
Purpose
To delete a transaction from the DefTranDest view. If there are not other DefTranDest or DefError entries for the transaction, the transaction is deleted from the DefTran and DefCall views as well. For additional information, refer to page 7 - 5.
Syntax
The parameters for the DELETE_TRAN procedure are described in Table 12 - 19. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.DELETE_TRAN( deferred_tran_id IN VARCHAR2,
deferred_tran_db IN VARCHAR2,
destination IN VARCHAR2)
Parameter
| Description
|
deferred_tran_id
| The ID number from the DefTran view of the deferred transaction that you want to delete. If this parameter is null, all transactions meeting the requirements of the other parameters are deleted.
|
deferred_tran_db
| The fully qualified database name from the DefTran view of the database in which the transaction that you want to delete originated. If this parameter is null, transactions meeting the requirements of the other parameters are deleted.
|
destination
| The fully qualified database name from the DefTranDest view of the database to which the transaction was originally queued. If this parameter is null, all transactions meeting the requirements of the other parameters are deleted.
|
Table 12 - 19. Parameters for DELETE_TRAN
Exception
Transaction ID and/or node not found.
DBMS_DEFER_SYS.DISABLED
Purpose
To determine if propagation of the deferred transaction queue from the current site to a given site is enabled. The DISABLED function returns TRUE if the deferred remote procedure call (RPC) queue is disabled for the given destination. For additional information, refer to page 4 - 32.
Syntax
The parameter for the DISABLED function is described in Table 12 - 20, the return values are described in Table 12 - 21, and the exception is listed in Table 12 - 22. The syntax for this function is shown below:
DBMS_DEFER_SYS.DISABLED(destination IN VARCHAR2)
RETURN BOOLEAN
Parameter
| Description
|
destination
| The fully qualified database name of the node whose propagation status you want to check.
|
Table 12 - 20. Parameter for DISABLED
Value
| Description
|
TRUE
| Propagation to this site from the current site is disabled.
|
FALSE
| Propagation to this site from the current site is enabled.
|
Exception
| Description
|
NO_DATA_FOUND
| DESTINATION does not appear in the DefSchedule view.
|
Table 12 - 22. Exception for DISABLED
DBMS_DEFER_SYS.EXECUTE
Purpose
To force a deferred remote procedure call queue at your current master or snapshot site to be pushed to another master site. For additional information, refer to page 4 - 31.
Syntax
The parameters for the EXECUTE procedure are shown in Table 12 - 23. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.EXECUTE(
destination IN VARCHAR2,
stop_on_error IN BOOLEAN := FALSE,
transaction_count IN BINARY_INTEGER := 0,
execution_seconds IN BINARY_INTEGER := 0,
execute_as_user IN BOOLEAN := FALSE,
delay_seconds IN NATURAL := 0,
batch_size IN NATURAL := 0)
Parameter
| Description
|
destination
| The fully qualified database name of the master site to which you are forwarding changes.
|
stop_on_error
| The default, FALSE, indicates that execution should continue even if errors, such as conflicts are encountered. Set this to TRUE if you want to stop execution when the first error is encountered.
|
transaction_count
| Execution stops after TRANSACTION_COUNT (number of transactions) or EXECUTION_SECONDS (number of seconds) has occurred. By default, (TRANSACTION_COUNT = 0 and EXECUTION_SECONDS = 0) transactions are executed until there are no more in the queue.
|
execution_seconds
|
|
execute_as_user
| The default, FALSE, indicates that a deferred call is authenticated at the remote system using the authentication context of the user who originally queued the deferred call (as indicated in the ORIGIN_USER column of the DefTran view). Set this to TRUE if you want the execution of a deferred call to be authenticated at the remote system using the authentication context of the session user.
|
delay_seconds
| The routine will sleep for this many seconds (default is 0), before returning when it finds no deferred calls queued for the destination. A non-zero value can reduce execution overhead compared to calling DBMS_DEFER_SYS.EXECUTE from a tight loop.
|
batch_size
| Indicates that a COMMIT should occur when the total number of deferred calls executed exceeds this number, and a complete transaction has been executed. If this argument is 0 (the default), a COMMIT occurs after each deferred transaction. For transactions originating at a master site, bundling transactions in this manner does not affect how errors are resolved, or how errors are logged in the DefError view.
For snapshot sites in a multi-master environment, you should always set this parameter to 0. Otherwise, the transactions are bundled before they are forwarded to other master sites, making conflict resolution more difficult.
|
Table 12 - 23. Parameters for EXECUTE
DBMS_DEFER_SYS.EXECUTE_ERROR
Purpose
To re-execute a deferred transaction that did not initially complete successfully. This procedure raises an ORA-24275 error when illegal combinations of NULL and non-NULL parameters are used. For additional information, refer to page 7 - 4.
Syntax
The parameters for the EXECUTE_ERROR procedure are described in Table 12 - 24. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.EXECUTE_ERROR( deferred_tran_id IN VARCHAR2,
deferred_tran_db IN VARCHAR2,
destination IN VARCHAR2)
Parameter
| Description
|
deferred_tran_id
| The ID number from the DefError view of the deferred transaction that you want to re-execute. If this parameter is null, all transactions queued for DESTINATION that originated from the DEFERRED_TRAN_DB are re-executed.
|
deferred_tran_db
| The fully qualified database name from the DefError view of the database in which the transaction that you want to re-execute originated. If both the DEFERRED_TRAN_ID and DEFERRED_TRAN_DB are null, all transactions originating from any site that were queued for the DESTINATION database that were not successfully executed are re-executed.
|
destination
| The fully qualified database name from the DefError view of the database to which the transaction was originally queued. This parameter must not be null.
|
Table 12 - 24. Parameters for EXECUTE_ERROR
Exception
EXECUTE_ERROR raises the last exception that it encountered before execution stopped as a result of the exception.
DBMS_DEFER_SYS.SCHEDULE_EXECUTION
Purpose
To establish communication between a master or snapshot site and another master site. For additional information, refer to page 4 - 30.
Syntax
The parameters for the SCHEDULE_EXECUTION procedure are described in Table 12 - 25. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.SCHEDULE_EXECUTION(
dblink IN VARCHAR2,
interval IN VARCHAR2,
next_date IN DATE,
reset IN BOOLEAN default FALSE,
stop_on_error IN BOOLEAN := NULL,
transaction_count IN BINARY_INTEGER := NULL,
execution_seconds IN BINARY_INTEGER := NULL,
execute_as_user IN BOOLEAN := NULL,
delay_seconds IN NATURAL := NULL,
batch_size IN NATURAL := NULL)
Parameter
| Description
|
dblink
| Fully qualified pathname to master database site at which you want to schedule periodic execution of deferred remote procedure calls.
|
interval
| Allows you to provide a function that is used to calculate the next time to apply any changes. This value is stored in the INTERVAL field of the DefSchedule view and is used to calculate the NEXT_DATE field of this view. If you use the default value for this parameter, NULL, the value of this field remains unchanged. If the field had no previous value, it is created with a value of null. If you do not supply a value for this field, you must supply a value for NEXT_DATE.
|
next_date
| Allows you to specify a given time to apply any outstanding changes to the given master site. This value is stored in the NEXT_DATE field of the DefSchedule view. If you use the default value for this parameter, NULL, the value of this field remains unchanged. If this field had no previous value, it is created with a value of null. If you do not supply a value for this field, you must supply a value for INTERVAL.
|
| Scheduling a communication interval between master sites is very similar to scheduling a refresh interval for snapshots, as described .
|
reset
| Set to TRUE to reset LAST_TXN_COUNT, LST_ERROR, and LAST_MSG to NULL.
|
stop_on_error
transaction_count
execution_seconds
execute_as_user
delay_seconds
batch_size
| These parameters are passed to the DBMS_DEFER_SYS.EXECUTE call that is scheduled for execution by this call. See Table 12 - 23 for more information on how these parameters are used by EXECUTE.
|
|
|
|
|
|
|
|
|
|
|
Table 12 - 25. Parameters for SCHEDULE_EXECUTION
DBMS_DEFER_SYS.SET_DISABLED
Purpose
To disable or enable propagation of the deferred transaction queue from the current site to a given destination site. If the disabled parameter is TRUE, the procedure disables propagation to the given destination and future invocations of DBMS_DEFER_SYS.EXECUTE do not push the deferred remote procedure call (RPC) queue. SET_DISABLED affects neither a session already pushing the queue to the given destination nor sessions appending to the queue with DBMS_DEFER. If the disable parameter is FALSE, the procedure enables propagation to the given destination and, although this does not push the queue, it permits future invocations to DBMS_DEFER_SYS.EXECUTE to push the queue to the given destination. Whether the disabled parameter is TRUE or FALSE, a COMMIT is required for the setting to take effect in other sessions.
Syntax
The parameters for the SET_DISABLED procedure are described in Table 12 - 26 and the exception is listed in Table 12 - 27. The syntax for this procedure is shown below:
DBMS_DEFER_SYS.SET_DISABLED(destination IN VARCHAR2,
disabled IN BOOLEAN := TRUE)
Parameter
| Description
|
destination
| The fully qualified database name of the node whose propagation status you want to change.
|
disabled
| By default, this parameter disables propagation of the deferred transaction queue from your current site to the given destination. Set this parameter to FALSE to enable propagation.
|
Table 12 - 26. Parameters for SET_DISABLED
Exception
| Description
|
NO_DATA_FOUND
| No entry was found in the DefSchedule view for the given DESTINATION.
|
Table 12 - 27. Exception for SET_DISABLED
DBMS_DEFER_SYS.UNSCHEDULE_EXECUTION
Purpose
To stop automatic communication from a snapshot or master site to another master site. For additional information, refer to page 4 - 32.
Syntax
The parameter for the UNSCHEDULE_EXECUTION procedure is described in Table 12 - 28, and the exception is listed in Table 12 - 29. The complete syntax for this procedure is shown below:
DBMS_DEFER_SYS.UNSCHEDULE_EXECUTION(
dblink IN VARCHAR2 NOT NULL)
Parameter
| Description
|
dblink
| Fully qualified pathname to master database site at which you want to unschedule periodic execution of deferred remote procedure calls.
|
Table 12 - 28. Parameter for UNSCHEDULE_EXECUTION
Exception
| Description
|
NO_DATA_FOUND
| No entry was found in the DefSchedule view for the given DBLINK.
|
Table 12 - 29. Exception for UNSCHEDULE_EXECUTION
DBMS_JOB.BROKEN
Purpose
To mark a job as broken or not broken. You can mark only jobs you own as broken. For additional information, refer to page 10 - 10.
Syntax
The syntax for the procedure DBMS_JOB.BROKEN is shown below. Table 12 - 30 describes the procedure's parameters.
DBMS_JOB.BROKEN( job IN BINARY_INTEGER,
broken IN BOOLEAN,
next_date IN DATE DEFAULT SYSDATE)
Parameter
| Description
|
job
| The identifier that was assigned to the job when you created it.
|
broken
| Indicates the state of the job.
|
| TRUE indicates that the job is broken and should not be executed. FALSE indicates that the job is not broken and should be executed at its normal execution interval, starting with NEXT_DATE.
|
next_date
| The date at which the job will be run next. The default value is SYSDATE.
|
Table 12 - 30. Parameters for DBMS_JOB.BROKEN
DBMS_JOB.CHANGE
Purpose
To alter any of the user-definable parameters associated with a job that has been submitted to the job queue. For additional information, refer to page 10 - 9.
Attention: When you change a job's definition using the WHAT parameter in the procedure CHANGE, Oracle records your current environment. This becomes the new environment for the job.
Syntax
The syntax for the procedure DBMS_JOB.CHANGE is shown below. Table 12 - 31 describes the procedure's parameters.
DBMS_JOB.CHANGE( job IN BINARY_INTEGER,
what IN VARCHAR2,
next_date IN DATE,
interval IN VARCHAR2)
Parameter
| Description
|
job
| The identifier that was assigned to the job when you created it.
|
what
| The PL/SQL code you want to have executed. Specify NULL to leave the current value unchanged.
|
| For more information about defining a job, see "Job Definitions" .
|
next_date
| The next date when the job will be run. Specify NULL to leave the current value unchanged.
|
interval
| The date function that calculates the next time to execute the job. INTERVAL must evaluate to a future point in time or NULL. Specify NULL to leave the current value unchanged.
|
| For more information on how to specify an execution interval, see page 10 - 7.
|
Table 12 - 31. Parameters for DBMS_JOB.CHANGE
DBMS_JOB.INTERVAL
Purpose
To alter the execution interval of a job. For additional information, refer to page 10 - 9.
Syntax
The syntax for the procedure DBMS_JOB.INTERVAL is shown below. Table 12 - 32 describes the procedure's parameters.
DBMS_JOB.INTERVAL( job IN BINARY_INTEGER,
interval IN VARCHAR2)
Parameter
| Description
|
job
| The identifier that was assigned to the job when you created it.
|
interval
| The date function that calculates the next time to execute the job. INTERVAL must evaluate to a future point in time or NULL.
|
| For more information on how to specify an execution interval, see page 10 - 7.
|
Table 12 - 32. Parameters for DBMS_JOB.INTERVAL
DBMS_JOB.NEXT_DATE
Purpose
To alter the date that a job will be next executed by Oracle. For additional information, refer to page 10 - 9.
Syntax
The syntax for the procedure DBMS_JOB.NEXT_DATE is shown below. Table 12 - 33 describes the procedure's parameters.
DBMS_JOB.NEXT_DATE( job IN BINARY_INTEGER,
next_date IN DATE)
Parameter
| Description
|
job
| The identifier that was assigned to the job when you created it.
|
next_date
| The next date when the job will be run.
|
Table 12 - 33. Parameters for DBMS_JOB.NEXT_DATE
DBMS_JOB.REMOVE
Purpose
To remove a job from the job queue. For additional information, refer to page 10 - 9.
Syntax
The syntax for the procedure DBMS_JOB.REMOVE is shown below. Table 12 - 34 describes the procedure's parameter.
DBMS_JOB.REMOVE(job IN BINARY_INTEGER)
Parameter
| Description
|
job
| The identifier that was assigned to the job when you created it.
|
Table 12 - 34. Parameter for DBMS_JOB.REMOVE
DBMS_JOB.RUN
Purpose
To force a job to be executed immediately, even if the job is marked as broken. You can run only jobs that you own. For additional information, refer to page 10 - 11.
Syntax
The syntax for the procedure DBMS_JOB.RUN is shown below. Table 12 - 35 describes the procedure's parameter.
DBMS_JOB.RUN( job IN BINARY_INTEGER)
Parameter
| Description
|
job
| The identifier that was assigned to the job when you created it. When the job is run, Oracle recomputes the next execution date.
|
Table 12 - 35. Parameter for DBMS_JOB.RUN
DBMS_JOB.SUBMIT
Purpose
To submit a new job to the job queue. For additional information, refer to page 10 - 5.
Syntax
The syntax for the procedure DBMS_JOB.SUBMIT is shown below. Table 12 - 36 describes the procedure's parameters.
DBMS_JOB.SUBMIT( job OUT BINARY_INTEGER,
what IN VARCHAR2,
next_date IN DATE DEFAULT SYSDATE,
interval IN VARCHAR2 DEFAULT 'null',
no_parse IN BOOLEAN DEFAULT FALSE)
Parameter
| Description
|
job
(out parameter)
| The identifier assigned to the job you created. You must use the job number whenever you want to alter or remove the job.
|
| For more information about job numbers, see "Job Numbers" .
|
what
| is the PL/SQL code you want to have executed. In the job definition, use two single quotation marks around strings. Always include a semicolon at the end of the job definition.
|
| For more information about defining a job, see "Job Definitions" .
|
next_date
| is the next date when the job will be run. The default value is SYSDATE.
|
interval
| is the date function that calculates the next time to execute the job. The default value is NULL. INTERVAL must evaluate to a future point in time or NULL.
|
| For more information on how to specify an execution interval, see page 10 - 7.
|
no_parse
| is a flag. The default value is FALSE.
|
| If NO_PARSE is set to FALSE (the default), Oracle parses the procedure associated with the job. If NO_PARSE is set to TRUE, Oracle parses the procedure associated with the job the first time that the job is executed. If, for example, you want to submit a job before you have created the tables associated with the job, set NO_PARSE to TRUE.
|
Table 12 - 36. Parameters for DBMS_JOB.SUBMIT
DBMS_JOB.WHAT
Purpose
To alter the definition of a job in the job queue. For additional information, refer to page 10 - 9.
Attention: When you execute procedure WHAT, Oracle records your current environment. This becomes the new environment for the job.
Syntax
The syntax for the procedure DBMS_JOB.WHAT is shown below. Table 12 - 37 describes the procedure's parameters.
DBMS_JOB.WHAT( job IN BINARY_INTEGER,
what IN VARCHAR2)
Parameter
| Description
|
job
| The identifier that was assigned to the job when you created it.
|
what
| The PL/SQL code you want to have executed. In the job definition, use two single quotation marks around strings. Always include a semicolon at the end of the job definition.
|
Table 12 - 37. Parameters for DBMS_JOB.WHAT
DBMS_OFFLINE_OG.BEGIN_INSTANTIATION
Purpose
To start offline instantiation of a replicated object group. You must call this procedure from the master definition site. For additional information, refer to page 4 - 19.
Syntax
The parameters for the BEGIN_INSTANTIATION procedure are described in Table 12 - 38, and the exceptions are listed in Table 12 - 39. The syntax for this procedure is shown below.
DBMS_OFFLINE_OG.BEGIN_INSTANTIATION( gname IN VARCHAR2,
new_site IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the object group that you want to replicate to the new site.
|
new_site
| The fully qualified database name of the new site to which you want to replicate the object group.
|
Table 12 - 38. Parameters for BEGIN_INSTANTIATION
Exception
| Description
|
23430
badargument
| Null or empty string for object group or new master site name.
|
nonmasterdef
| This procedure must be called from the master definition site.
|
23432
sitealreadyexists
| Given site is already a master site for this object group.
|
23431
wrongstate
| Status of master definition site must be QUIESCED.
|
missingrepgroup
| GNAME does not exist as a replicated object group.
|
Table 12 - 39. Exceptions for BEGIN_INSTANTIATION
DBMS_OFFLINE_OG.BEGIN_LOAD
Purpose
To disable triggers while data is imported to new master site as part of offline instantiation. You must call this procedure from the new master site. For additional information, refer to page 4 - 20.
Syntax
The parameters for the BEGIN_LOAD procedure are described in Table 12 - 40, and the exceptions are listed in Table 12 - 41. The syntax for this procedure is shown below.
DBMS_OFFLINE_OG.BEGIN_LOAD( gname IN VARCHAR2,
new_site IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the object group whose members you are importing.
|
new_site
| The fully qualified database name of the new site at which you will be importing the object group members.
|
Table 12 - 40. Parameters for BEGIN_LOAD
Exception
| Description
|
23430
badargument
| Null or empty string for object group or new master site name.
|
wrongsite
| This procedure must be called from the new master site.
|
23434
unknownsite
| Given site is not recognized by object group.
|
23431
wrongstate
| Status of the new master site must be QUIESCED.
|
missingrepgroup
| GNAME does not exist as a replicated object group.
|
Table 12 - 41. Exceptions for BEGIN_LOAD
DBMS_OFFLINE_OG.END_INSTANTIATION
Purpose
To complete offline instantiation of a replicated object group. You must call this procedure from the master definition site. For additional information, refer to page 4 - 20.
Syntax
The parameters for the END_INSTANTIATION procedure are described in Table 12 - 42, and the exceptions are listed in Table 12 - 43. The syntax for this procedure is shown below.
DBMS_OFFLINE_OG.BEGIN_INSTANTIATION( gname IN VARCHAR2,
new_site IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the object group that you are replicating to the new site.
|
new_site
| The fully qualified database name of the new site to which you are replicating the object group.
|
Table 12 - 42. Parameters for END_INSTANTIATION
Exception
| Description
|
23430
badargument
| Null or empty string for object group or new master site name.
|
nonmasterdef
| This procedure must be called from the master definition site.
|
23434
unknownsite
| Given site is not recognized by object group.
|
23431
wrongstate
| Status of master definition site must be QUIESCED.
|
missingrepgroup
| GNAME does not exist as a replicated object group.
|
Table 12 - 43. Exceptions for END_INSTANTIATION
DBMS_OFFLINE_OG.END_LOAD
Purpose
To re-enable triggers after importing data to new master site as part of offline instantiation. You must call this procedure from the new master site. For additional information, refer to page 4 - 20.
Syntax
The parameters for the END_LOAD procedure are described in Table 12 - 44, and the exceptions are listed in Table 12 - 45. The syntax for this procedure is shown below.
DBMS_OFFLINE_OG.END_LOAD( gname IN VARCHAR2,
new_site IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the object group whose members you have finished importing.
|
new_site
| The fully qualified database name of the new site at which you have imported the object group members.
|
Table 12 - 44. Parameters for END_LOAD
Exception
| Description
|
23430
badargument
| Null or empty string for object group or new master site name.
|
wrongsite
| This procedure must be called from the new master site.
|
23434
unknownsite
| Given site is not recognized by object group.
|
23431
wrongstate
| Status of the new master site must be QUIESCED.
|
missingrepgroup
| GNAME does not exist as a replicated object group.
|
Table 12 - 45. Exceptions for END_LOAD
DBMS_OFFLINE_OG.RESUME_SUBSET_OF_MASTERS
Purpose
To resume replication activity at all existing sites except the new site during offline instantiation of a replicated object group. You must call this procedure from the master definition site. For additional information, refer to page 4 - 19.
Syntax
The parameters for the RESUME_SUBSET_OF_MASTERS procedure are described in Table 12 - 46, and the exceptions are listed in Table 12 - 47. The syntax for this procedure is shown below.
DBMS_OFFLINE_OG.RESUME_SUBSET_OF_MASTERS(
gname IN VARCHAR2,
new_site IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the object group that you are replicating to the new site.
|
new_site
| The fully qualified database name of the new site to which you are replicating the object group.
|
Table 12 - 46. Parameters for RESUME_SUBSET_OF_MASTERS
Exception
| Description
|
23430
badargument
| Null or empty string for object group or new master site name.
|
nonmasterdef
| This procedure must be called from the master definition site.
|
23434
unknownsite
| Given site is not recognized by object group.
|
23431
wrongstate
| Status of master definition site must be QUIESCED.
|
missingrepgroup
| GNAME does not exist as a replicated object group.
|
Table 12 - 47. Exceptions for RESUME_SUBSET_OF_MASTERS
DBMS_OFFLINE_SNAPSHOT.BEGIN_LOAD
Purpose
To prepare a snapshot site for import of a new snapshot as part
of offline instantiation. You must call this procedure from the
snapshot site for the new snapshot. For additional information,
refer to page 5 - 11.
Syntax
The parameters for the BEGIN_LOAD procedure are described in Table 12 - 48, and the exceptions are listed in Table 12 - 49. The syntax for this procedure is shown below.
DBMS_OFFLINE_SNAPSHOT.BEGIN_LOAD(
gname IN VARCHAR2,
sname IN VARCHAR2,
master_site IN VARCHAR2,
snapshot_oname IN VARCHAR2,
storage_c IN VARCHAR2 := '',
comment IN VARCHAR2 :='')
Parameter
| Description
|
gname
| The name of the object group for the snapshot that you are creating using offline instantiation.
|
sname
| The name of the schema for the new snapshot.
|
master_site
| The fully qualified database name of the snapshot's master site.
|
snapshot_oname
| The name of the temporary snapshot created at the master site.
|
storage_c
| The storage options to use when creating the new snapshot at the snapshot site.
|
comment
| User comment.
|
Table 12 - 48. Parameters for BEGIN_LOAD
Exception
| Description
|
23430
badargument
| Null or empty string for object group, schema, master site, or snapshot name.
|
missingrepgroup
| GNAME does not exist as a replicated object group.
|
missingremotesnap
| Could not locate given snapshot at given master site.
|
snaptabmismatch
| Base table name at snapshot site and master site must be identical.
|
missingschema
| The given schema does not exist.
|
Table 12 - 49. Exceptions for BEGIN_LOAD
DBMS_OFFLINE_SNAPSHOT.END_LOAD
Purpose
To complete offline instantiation of a snapshot. You must call this procedure from the snapshot site for the new snapshot. For additional information, refer to page 5 - 11.
Syntax
The parameters for the END_LOAD procedure are described in Table 12 - 50, and the exceptions are listed in Table 12 - 51. The syntax for this procedure is shown below.
DBMS_OFFLINE_SNAPSHOT.END_LOAD(
gname IN VARCHAR2,
sname IN VARCHAR2,
snapshot_oname IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the object group for the snapshot that you are creating using offline instantiation.
|
sname
| The name of the schema for the new snapshot.
|
snapshot_oname
| The name of the snapshot.
|
Table 12 - 50. Parameters for END_LOAD
Exception
| Description
|
23430
badargument
| Null or empty string for object group, schema, or snapshot name.
|
missingrepgroup
| GNAME does not exist as a replicated object group.
|
nonsnapshot
| This procedure must be called from the snapshot site.
|
Table 12 - 51. Exceptions for END_LOAD
DBMS_RECTIFIER_DIFF.DIFFERENCES
Purpose
To determine the differences between two tables. For additional information, refer to page 7 - 15.
Syntax
The parameters for the DIFFERENCES procedure are described in Table 12 - 52, and the exceptions are listed in Table 12 - 53. The syntax for this procedure is shown below.
DBMS_RECTIFIER_DIFF.DIFFERENCES(
sname1 IN VARCHAR2,
oname1 IN VARCHAR2,
reference_site IN VARCHAR2 := '',
sname2 IN VARCHAR2,
oname2 IN VARCHAR2,
comparison_site IN VARCHAR2 := '',
where_clause IN VARCHAR2 := '',
column_list IN VARCHAR2 := '', |
array_columns IN dbms_utility.name_array
missing_rows_sname IN VARCHAR2,
missing_rows_oname1 IN VARCHAR2,
missing_rows_oname2 IN VARCHAR2,
missing_rows_site IN VARCHAR2 := '',
max_missing IN INTEGER,
commit_rows IN INTEGER := 500)
Parameter
| Description
|
sname1
| The name of the schema at REFERENCE_SITE.
|
oname1
| The name of the table at REFERENCE_SITE.
|
reference_site
| The name of the reference database site. The default, NULL, indicates the current site.
|
sname2
| The name of the schema at COMPARISON_SITE.
|
oname2
| The name of the table at COMPARISON_SITE.
|
comparison_site
| The name of the comparison database site. The default, NULL, indicates the current site.
|
where_clause
| Only rows satisfying this restriction are selected for comparison. The default, NULL or '', indicates that all rows should be compared.
|
column_list
| A comma-separated list of one or more column names in the table that you want to have compared. You must not have any white space before or after the comma. The default, NULL or '', indicates that all columns be compared. The column list must include the primary key (or its SET_COLUMNS equivalent).
|
array_columns
| A PL/SQL table of column names that you want compared for the two tables. Indexing begins at 1, and the final element of the array must be NULL. If position 1 is NULL, all columns are used.
|
missing_rows_sname
| The name of the schema in which the missing rows tables are located.
|
missing_rows_oname1
| The name of the table at MISSING_ROWS_SITE that stores information about the rows in the table at REFERENCE site missing from the table at COMPARISON site and the rows at COMPARISON site missing from the table at REFERENCE site.
|
missing_rows_oname2
| The name of the table at MISSING_ROWS_SITE that stores about the missing rows. This table has three columns: the rowid of the row in the MISSING_ROWS_ONAME1 table, the name of the site at which the row is present, and the name of the site from which the row is absent.
|
missing_rows_site
| The name of the site where the MISSING_ROWS_ONAME1 and MISSING_ROWS_ONAME2 tables are located. The default, NULL or '', indicates that the tables are located at the current site.
|
max_missing
| The maximum number of rows that should be inserted into the MISSING_ROWS_ONAME1 table. Once this number is reached, the routine returns normally, even if more differences exist.
|
commit_rows
| The maximum number of rows to insert into MISSING_ROWS_ONAME1 before a COMMIT occurs. By default, a COMMIT occurs after 500 inserts. An empty string ('') or NULL indicates that a COMMIT should only be issued after all rows have been inserted.
|
Table 12 - 52. Parameters for DBMS_RECTIFIER_DIFF.DIFFERENCES
Exception
| Description
|
23365
nosuchsite
| Database site could not be found.
|
23366
badnumber
| COMMIT_ROWS parameter less than 1.
|
23367
missingprimarykey
| Column list must include primary key (or SET_COLUMNS equivalent).
|
23368
badname
| NULL or empty string for table or schema name.
|
23369
cannotbenull
| Parameter cannot be NULL.
|
23370
notshapeequivalent
| Tables being compared are not shape equivalent. Shape refers to the number of columns, their column names, and the column data types.
|
23371
unknowncolumn
| Column does not exist.
|
23372
unsupportedtype
| Type not supported.
|
commfailure
| Remote site is inaccessible.
|
missingobject
| Table does not exist.
|
Table 12 - 53. Exceptions for DBMS_RECTIFIER_DIFF.DIFFERENCES
Restrictions
The error ORA-00001: Unique constraint (XXXX.XXXXX) violated is issued when there are any unique or primary key constraints on the MISSING_ROWS_DATA table.
RECTIFIER_DIFF.DIFFERENCES can only be invoked against release 7.3 sites or higher.
DBMS_RECTIFIER_DIFF.RECTIFY
Purpose
To resolve the differences between two tables. For additional information, refer to page 7 - 15.
Syntax
The parameters for the RECTIFY procedure are described in Table 12 - 54, and the exceptions are listed in Table 12 - 55. The syntax for this procedure is shown below.
DBMS_RECTIFIER_DIFF.RECTIFY(
sname1 IN VARCHAR2,
oname1 IN VARCHAR2,
reference_site IN VARCHAR2 := '',
sname2 IN VARCHAR2,
oname2 IN VARCHAR2,
comparison_site IN VARCHAR2 := '',
column_list IN VARCHAR2 := '', |
array_columns IN dbms_utility.name_array
missing_rows_sname IN VARCHAR2,
missing_rows_oname1 IN VARCHAR2,
missing_rows_oname2 IN VARCHAR2,
missing_rows_site IN VARCHAR2 := '',
commit_rows IN INTEGER := 500)
Parameter
| Description
|
sname1
| The name of the schema at REFERENCE_SITE.
|
oname1
| The name of the table at REFERENCE_SITE.
|
reference_site
| The name of the reference database site. The default, NULL, indicates the current site.
|
sname2
| The name of the schema at COMPARISON_SITE.
|
oname2
| The name of the table at COMPARISON_SITE.
|
comparison_site
| The name of the comparison database site. The default, NULL, indicates the current site.
|
column_list
| A comma-separated list of one or more column names being compared for the two tables. You must not have any white space before or after the comma. The default, NULL, indicates that all columns be compared.
|
array_columns
| A PL/SQL table of column names being compared for the two tables. Indexing begins at 1, and the final element of the array must be NULL. If position 1 is NULL, all columns are used.
|
missing_rows_sname
| The name of the schema in which the missing rows tables are located.
|
missing_rows_oname1
| The name of the table at MISSING_ROWS_SITE that stores information about the rows in the table at REFERENCE site missing from the table at COMPARISON site and the rows at COMPARISON site missing from the table at REFERENCE site.
|
missing_rows_oname2
| The name of the table at MISSING_ROWS_SITE that stores about the missing rows. This table has three columns: the rowid of the row in the MISSING_ROWS_ONAME1 table, the name of the site at which the row is present, and the name of the site from which the row is absent.
|
missing_rows_site
| The name of the site where the MISSING_ROWS_ONAME1 and MISSING_ROWS_ONAME2 tables are located. The default, NULL, indicates that the tables are located at the current site.
|
commit_rows
| The maximum number of rows to insert to or delete from the reference or comparison table before a COMMIT occurs. By default, a COMMIT occurs after 500 inserts or 500 deletes. An empty string ('') or NULL indicates that a COMMIT should only be issued after all rows for a single table have been inserted or deleted.
|
Table 12 - 54. Parameters for DBMS_RECTIFIER_DIFF.RECTIFY
Exception
| Description
|
23365
nosuchsite
| Database site could not be found.
|
23366
badnumber
| COMMIT_ROWS parameter less than 1.
|
23368
badname
| NULL or empty string for table or schema name.
|
commfailure
| Remote site is inaccessible.
|
missingobject
| Table does not exist.
|
Table 12 - 55. Exceptions for DBMS_RECTIFIER_DIFF.RECTIFY
DBMS_REFRESH.ADD
Purpose
To add snapshots to a refresh group. For additional information, refer to page 3 - 13.
Syntax
The parameters for the ADD procedure are described in Table 12 - 56. The syntax for this procedure is shown below.
DBMS_REFRESH.ADD( name IN VARCHAR2,
list IN VARCHAR2,
lax IN BOOLEAN DEFAULT FALSE)
parameter
| description
|
name
| Name of the refresh group to which you want to add members.
|
list
| Comma-separated list of snapshots that you want to add to the refresh group. (Synonyms are not supported.) Alternatively, you can supply a PL/SQL table of type DBMS_UTILITY.UNCL_ARRAY, where each element is the name of a snapshot.
|
lax
| A snapshot can belong to only one refresh group at a time. If you are moving a snapshot from one group to another, you must set the LAX flag to TRUE to succeed. Oracle then automatically removes the snapshot from the other refresh group and updates its refresh interval to be that of its new group. Otherwise, the call to ADD generates an error message.
|
Table 12 - 56. Parameters for DBMS_REFRESH.ADD
DBMS_REFRESH.CHANGE
Purpose
To change the refresh interval for a snapshot group. For additional information, refer to page 3 - 14.
Syntax
The parameters for the CHANGE procedure are described in Table 12 - 57. The syntax for this procedure is shown below:
DBMS_REFRESH.CHANGE(
name IN VARCHAR2,
next_date IN DATE DEFAULT NULL,
interval IN VARCHAR2 DEFAULT NULL,
implicit_destroy IN BOOLEAN DEFAULT NULL,
rollback_segment IN VARCHAR2 DEFAULT NULL,
push_deferred_rpc IN BOOLEAN DEFAULT NULL,
refresh_after_errors IN BOOLEAN DEFAULT NULL)
parameter
| description
|
name
| Name of the refresh group for which you want to alter the refresh interval.
|
next_date
| Next date that you want a refresh to occur. By default, this date remains unchanged.
|
interval
| Function used to calculate the next time to refresh the snapshots in the group. This interval is evaluated immediately before the refresh. Thus, you should select an interval that is greater than the time it takes to perform a refresh. By default, the interval remains unchanged.
|
implicit_destroy
| Allows you to reset the value of the IMPLICIT_DESTROY flag. If this flag is set, Oracle automatically deletes the group if it no longer contains any members. By default, this flag remains unchanged.
|
rollback_seg
| Allows you to change the rollback segment used. By default, the rollback segment remains unchanged. To reset this parameter to use the default rollback segment, specify 'null', including the quotes. Specifying null, without quotes, indicates that you do not want to change the rollback segment currently being used.
|
push_deferred_rpc
| Used by updatable snapshots only. Set this parameter to TRUE if you want to push changes from the snapshot to its associated master before refreshing the snapshot. Otherwise, these changes may appear to be temporarily lost. By default, this flag remains unchanged
|
refresh_after_
errors
| Used by updatable snapshots only. Set this parameter to TRUE if you want the refresh to proceed even if there are outstanding conflicts logged in the DefError view for the snapshot's master. By default, this flag remains unchanged
|
Table 12 - 57. Parameters for DBMS_REFRESH.CHANGE
DBMS_REFRESH.DESTROY
Purpose
To remove all of the snapshots from a refresh group and delete the refresh group. For additional information, refer to page 3 - 14.
Syntax
The parameter for the DESTROY procedure is described in Table 12 - 58. The syntax for this procedure is shown below:
DBMS_REFRESH.destroy( name IN VARCHAR2)
parameter
| description
|
name
| Name of the refresh group that you want to destroy.
|
Table 12 - 58. Parameter for DBMS_REFRESH.DESTROY
DBMS_REFRESH.MAKE
Purpose
To specify the members of a refresh group and the time interval used to determine when the members of this group should be refreshed. For additional information, refer to page 3 - 13.
Syntax
The parameters for the MAKE procedure are described in Table 12 - 59. The syntax for this procedure is shown below:
DBMS_REFRESH.MAKE(
name IN VARCHAR2,
list IN VARCHAR2, |
IN DBMS_UTILITY.UNCL_ARRAY,
next_date IN DATE,
interval IN VARCHAR2,
implicit_destroy IN BOOLEAN DEFAULT FALSE,
lax IN BOOLEAN DEFAULT FALSE,
job IN BINARY INTEGER DEFAULT 0,
rollback_seg IN VARCHAR2 DEFAULT NULL,
push_deferred_rpc IN BOOLEAN DEFAULT TRUE,
refresh_after_errors IN BOOLEAN DEFAULT FALSE)
parameter
| description
|
name
| Unique name used to identify the refresh group. Refresh groups must follow the same naming conventions as tables.
|
list
| Comma-separated list of snapshots that you want to refresh. (Synonyms are not supported.) These snapshots can be located in different schemas and have different master tables; however, all of the listed snapshots must be in your current database.
Instead of a comma separated list, you can supply a PL/SQL table of names of snapshots that you want to refresh using the datatype DBMS_UTILITY.UNCL_ARRAY. If the table contains the names of N snapshots, the first snapshot should be in position 1 and the N + 1 position should be set to null.
|
next_date
| Next date that you want a refresh to occur.
|
interval
| Function used to calculate the next time to refresh the snapshots in the group. This field is used with the NEXT_DATE value. For example, if you specify NEXT_DAY(SYSDATE+1, ''MONDAY'') as your interval, and your NEXT_DATE evaluates to Monday, Oracle will refresh the snapshots every Monday. This interval is evaluated immediately before the refresh. Thus, you should select an interval that is greater than the time it takes to perform a refresh. For more information on how to specify a refresh interval, see page 3 - 16.
|
implicit_destroy
| Set this argument to TRUE if you want to automatically delete the refresh group when it no longer contains any members. This flag is only checked when you call the SUBTRACT procedure. That is, setting this flag still allows you to create an empty refresh group.
|
lax
| A snapshot can belong to only one refresh group at a time. If you are moving a snapshot from an existing group to a new refresh group, you must set the LAX flag to TRUE to succeed. Oracle then automatically removes the snapshot from the other refresh group and updates its refresh interval to be that of its new group. Otherwise, the call to MAKE generates an error message.
|
job
| This parameter is needed by the Import utility. Use the default value, 0.
|
rollback_seg
| Name of the rollback segment to use while refreshing snapshots. The default, null, uses the default rollback segment.
|
push_deferred_rpc
| Used by updatable snapshots only. Use the default value, TRUE, if you want to push changes from the snapshot to its associated master before refreshing the snapshot. Otherwise, these changes may appear to be temporarily lost.
|
refresh_after_errors
| Used by updatable snapshots only. Set this parameter to TRUE if you want the refresh to proceed even if there are outstanding conflicts logged in the DefError view for the snapshot's master.
|
Table 12 - 59. Parameters for DBMS_REFRESH.MAKE
DBMS_REFRESH.REFRESH
Purpose
To manually refresh a refresh group. For additional information, refer to page 3 - 19.
Syntax
The parameter for the REFRESH procedure is described in Table 12 - 60. The syntax for this procedure is shown below:
DBMS_REFRESH.REFRESH( name IN VARCHAR2)
parameter
| description
|
name
| Name of the refresh group that you want to refresh manually.
|
Table 12 - 60. Parameters for DBMS_REFRESH.REFRESH
DBMS_REFRESH.SUBTRACT
Purpose
To remove snapshots from a refresh group. For additional information, refer to page 3 - 14.
Syntax
The parameters for the SUBTRACT procedure are described in Table 12 - 61. The syntax for this procedure is shown below:
DBMS_REFRESH.SUBTRACT( name IN VARCHAR2,
list IN VARCHAR2, |
IN DBMS_UTILITY.UNCL_ARRAY,
lax IN BOOLEAN DEFAULT FALSE)
parameter
| description
|
name
| Name of the refresh group from which you want to remove members.
|
list
| Comma-separated list of snapshots that you want to remove from the refresh group. (Synonyms are not supported.) Alternatively, you can supply a PL/SQL table of type DBMS_UTILITY.UNCL_ARRAY, where each element is the name of a snapshot.
|
lax
| Set this parameter to FALSE if you want Oracle to generate an error message if the snapshot you are attempting to remove is not a member of the refresh group.
|
Table 12 - 61. Parameters for DBMS_REFRESH.SUBTRACT
DBMS_REPCAT.ADD_GROUPED_COLUMN
Purpose
To add members to an existing column group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 23.
Syntax
The parameters for the ADD_GROUPED_COLUMN procedure are described in Table 12 - 62, and the exceptions are listed in Table 12 - 63. The syntax for this procedure is shown below:
DBMS_REPCAT.ADD_GROUPED_COLUMN(
sname, IN VARCHAR2,
oname, IN VARCHAR2,
column_group IN VARCHAR2,
list_of_column_names IN VARCHAR2,
IN DBMS_REPCAT.VARCHAR2S)
Parameter
| Description
|
sname
| The schema in which the replicated table is located.
|
oname
| The name of the replicated table with which the column group is located.
|
column_group
| The name of the column group to which you are adding members.
|
list_of_column_names
| The names of the columns that you are adding to the designated column group. This can either be a comma-separated list or a PL/SQL table of column names. The PL/SQL table must be of type dbms_repcat.varchar2s. Use the single value `*' to create a column group that contains all of the columns in your table.
|
Table 12 - 62. Parameters for ADD_GROUPED_COLUMN
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingobject
| The given table does not exist.
|
missinggroup
| The given column group does not exist.
|
missingcolumn
| A given column does not exist in the designated table.
|
duplicatecolumn
| The given column is already a member of another column group.
|
missingschema
| The given schema does not exist
|
Table 12 - 63. Exceptions for ADD_GROUPED_COLUMN
DBMS_REPCAT.ADD_MASTER_DATABASE
Purpose
To add another master site to your replicated environment. This procedure regenerates all the triggers and their associated packages at existing master sites. You must call this procedure from the master definition site. For additional information, refer to page 4 - 17.
Syntax
The parameters for the ADD_MASTER_DATABASE procedure are described in Table 12 - 64, and the exceptions are listed in Table 12 - 65. The syntax for this procedure is shown below:
DBMS_REPCAT.ADD_MASTER_DATABASE(
gname IN VARCHAR2,
master IN VARCHAR2,
use_existing_objects IN BOOLEAN := TRUE,
copy_rows IN BOOLEAN := TRUE,
comment IN VARCHAR2 := '',
propagation_mode IN VARCHAR2 := 'ASYNCHRONOUS')
Parameter
| Description
|
gname
| The name of the object group being replicated. This object group must already exist at the master definition site.
|
master
| The fully qualified database name of the new master database.
|
use_existing_objects
| Indicate TRUE if you want to reuse any objects of the same type and shape that already exist in the schema at the new master site. See page 4 - 15 for more information on how these changes are applied.
|
copy_rows
| Indicate TRUE if you want the initial contents of a table at the new master site to match the contents of the table at the master definition site.
|
comment
| This comment is added to the MASTER_COMMENT field of the RepSite view.
|
propagation_mode
| Method of forwarding changes to and receiving changes from new master database. Accepted values are synchronous and asynchronous.
|
Table 12 - 64. Parameters for ADD_MASTER_DATABASE
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
notquiesced
| The replicated object group has not been suspended.
|
missingrepgroup
| The object group does not exist at the given database site.
|
missingobject
| A member of the replicated object group does not exist at the master definition site with a database status of VALID. If a package, package body, procedure, or function is invalid, Oracle recompiles the object once, in an attempt to make it valid.
|
commfailure
| The new master is not accessible.
|
typefailure
| An incorrect propagation mode was specified.
|
notcompat
| Compatibility mode must be 7.3.0.0 or greater to use synchronous propagation.
|
repcompatnum
| The GNAME is not an existing database schema at the remote master site and the remote master site is a pre-release 7.3 site.
|
duplrepgrp
| The master site already exists.
|
Table 12 - 65. Exceptions for ADD_MASTER_DATABASE
DBMS_REPCAT.ADD_PRIORITY_datatype
Purpose
To add a member to a priority group. You must call this procedure from the master definition site. The procedure that you must call is determined by the datatype of your "priority" column. You must call this procedure once for each of the possible values of the "priority" column.
The available procedures are listed below:
For additional information, refer to page 6 - 29.
Syntax
The parameters for the ADD_PRIORITY_VARCHAR2 procedure are described in Table 12 - 66, and the exceptions are listed in Table 12 - 67. The syntax for the ADD_PRIORITY_VARCHAR2 procedure is shown below. (The syntax for the remaining ADD_PRIORITY_datatype procedures is identical, except for the datatype of the value.)
DBMS_REPCAT.ADD_PRIORITY_VARCHAR2(
gname IN VARCHAR2,
pgroup IN VARCHAR2,
value IN VARCHAR2,
priority IN NUMBER)
Parameter
| Description
|
gname
| The replicated object group for which you are creating a priority group.
|
pgroup
| The name of the priority group that you are creating.
|
value
| The value of the priority group member. This would be one of the possible values of the associated "priority" column of a table using this priority group.
|
priority
| The priority of this value. The higher the number, the higher the priority.
|
Table 12 - 66. Parameters for ADD_PRIORITY_datatype
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
duplicatevalue
| The given value already exists in the priority group.
|
duplicatepriority
| The given priority already exists in the priority group.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingprioritygroup
| The given priority group does not exist.
|
paramtype
| The given value has the incorrect datatype for the priority group.
|
Table 12 - 67. Exceptions for ADD_PRIORITY_datatype
DBMS_REPCAT.ADD_SITE_PRIORITY_SITE
Purpose
To add a new site to a site priority group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 34.
Syntax
The parameters for the ADD_SITE_PRIORITY_SITE procedure are described in Table 12 - 68, and the exceptions are listed in Table 12 - 69. The syntax for this procedure is shown below:
DBMS_REPCAT.ADD_SITE_PRIORITY_SITE(
gname IN VARCHAR2,
name IN VARCHAR2
site IN VARCHAR2,
priority IN NUMBER)
Parameter
| Description
|
gname
| The replicated object group for which you are adding a site to a group.
|
pgroup
| The name of the site priority group to which you are adding a member.
|
site
| The global database name of the site that you are adding.
|
priority
| The priority level of the site that you are adding. A higher number indicates a higher priority level.
|
Table 12 - 68. Parameters for ADD_SITE_PRIORITY_SITE
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingpriority
| The given site priority group does not exist.
|
duplicatepriority
| The given priority level already exists for another site in the group.
|
Table 12 - 69. Exceptions for ADD_SITE_PRIORITY_SITE
DBMS_REPCAT.ADD_conflicttype_RESOLUTION
Purpose
To designate a method for resolving an update, delete, or uniqueness conflict. You must call these procedures from the master definition site. The procedure that you need to call is determined by the type of conflict that the routine is used to resolve.
Conflict Type
| Procedure Name
|
update
| ADD_UPDATE_RESOLUTION
|
uniqueness
| ADD_UNIQUE_RESOLUTION
|
delete
| ADD_DELETE_RESOLUTION
|
For additional information, refer to page 6 - 25.
Syntax
The parameters for the ADD_UPDATE_RESOLUTION procedure are described in Table 12 - 70, and the exceptions are listed in Table 12 - 71. The syntax for this procedure is shown below:
DBMS_REPCAT.ADD_UPDATE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
column_group IN VARCHAR2,
sequence_no IN NUMBER,
method IN VARCHAR2,
parameter_column_name IN VARCHAR2,
priority_group IN VARCHAR2 := NULL,
function_name IN VARCHAR2 := NULL,
comment IN VARCHAR2 := NULL)
The parameters for the ADD_DELETE_RESOLUTION procedure are described in Table 12 - 70, and the exceptions are listed in Table 12 - 71. The syntax for this procedure is shown below:
DBMS_REPCAT.ADD_DELETE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
sequence_no IN NUMBER,
parameter_column_name IN VARCHAR2,
function_name IN VARCHAR2 := NULL,
comment IN VARCHAR2 := NULL)
The parameters for the ADD_UNIQUE_RESOLUTION procedure are described in Table 12 - 70, and the exceptions are listed in Table 12 - 71. The syntax for this procedure is shown below:
DBMS_REPCAT.ADD_UNIQUE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
constraint_name IN VARCHAR2,
sequence_no IN NUMBER,
method IN VARCHAR2,
parameter_column_name IN VARCHAR2,
function_name IN VARCHAR2 := NULL,
comment IN VARCHAR2 := NULL)
Parameter
| Description
|
sname
| The name of the schema containing the table to be replicated.
|
oname
| The name of the table for which you are adding a conflict resolution routine.
|
column_group
| The name of the column group for which you are adding a conflict resolution routine. Column groups are required for update conflict resolution routines only.
|
constraint_name
| The name of the unique constraint or unique index for which you are adding a conflict resolution routine. Use the name of the unique index if it differs from the name of the associated unique constraint. Constraint names are required for uniqueness conflict resolution routines only.
|
sequence_no
| The order in which the designated conflict resolution methods should be applied.
|
method
| The type of conflict resolution routine that you want to create. This can be the name of one of the standard routines provided with symmetric replication, or, if you have written your own routine, you should choose USER FUNCTION, and provide the name of your routine as the FUNCTION_NAME argument. The methods supported in this release are: MINIMUM, MAXIMUM, LATEST TIMESTAMP, EARLIEST TIMESTAMP, ADDITIVE, AVERAGE, PRIORITY GROUP, SITE PRIORITY, OVERWRITE, and DISCARD (for update conflicts) and APPEND SITE NAME, APPEND SEQUENCE NUMBER, and DISCARD (for uniqueness conflicts). There are no standard methods for delete conflicts, so this argument is not used.
|
parameter_column_name
| The name of the columns used to resolve the conflict. The standard methods operate on a single column. For example, if you are using the LATEST TIMESTAMP method for a column group, you should pass the name of the column containing the timestamp value as this argument. If your are using a USER FUNCTION, you can resolve the conflict using any number of columns. This argument accepts either a comma separated list of column names, or a PL/SQL table of type dbms_repcat.varchar2s. The single value `*' indicates that you want to use all of the columns in the table (or column group, for update conflicts) to resolve the conflict. If you specify `*', the columns will be passed to your function in alphabetical order.
|
priority_group
| If you are using the PRIORITY GROUP or SITE PRIORITY update conflict resolution method, you must supply the name of the priority group that you have created. Instructions for creating a priority group are included . If you are using a different method, you can use the default value for this argument, NULL. This argument is applicable to update conflicts only.
|
function_name
| If you selected the USER FUNCTION method, or if you are adding a delete conflict resolution routine, you must supply the name of the conflict resolution routine that you have written. If you are using one of the standard methods, you can use the default value for this argument, NULL.
|
comment
| This user comment is added to the RepResolution view.
|
Table 12 - 70. Parameters for ADD_UPDATE/DELETE_RESOLUTION
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingobject
| The given object does not exist as a table in the given schema using row-level replication.
|
missingschema
| The given schema does not exist.
|
missingcolumn
| The column that you specified as part of the PARAMETER_COLUMN_NAME argument does not exist.
|
missingprioritygroup
| The priority group that you specified does not exist for the table.
|
invalidmethod
| The resolution method that you specified is not recognized.
|
invalidparameter
| The number of columns that you specified for the PARAMETER_COLUMN_NAME argument is invalid. (The standard routines take only one column name.)
|
missingfunction
| The user function that you specified does not exist.
|
missingconstraint
| The constraint that you specified for a uniqueness conflict does not exist.
|
typefailure
| The datatype of one of the values that you specified for the PARAMETER_COLUMN_NAME argument is not one of the types supported for the given method.
|
Table 12 - 71. Exceptions for ADD_UPDATE/DELETE_RESOLUTION
DBMS_REPCAT.ALTER_MASTER_PROPAGATION
Purpose
To alter the propagation method for a given object group at a given master site. This object group must be quiesced. You must call this procedure from the master definition site. If the master appears in the dblink_list or dblink_table, ALTER_MASTER_PROPAGATION ignores that database link. There is no way to change the propagation mode from a master to itself. For additional information, refer to page 4 - 34.
Syntax
The parameters for the ALTER_MASTER_PROPAGATION procedure are described in Table 12 - 72, and the exceptions are listed in Table 12 - 73. The syntax for this procedure is shown below:
DBMS_REPCAT.ALTER_MASTER_PROPAGATION(
gname IN VARCHAR2,
master IN VARCHAR2,
dblink_list IN VARCHAR2, |
dblink_table IN dbms_utility.dblink_array,
propagation_mode IN VARCHAR2,
comment IN VARCHAR2 := '')
Parameter
| Description
|
gname
| The name of the object group that you want to alter.
|
master
| The name of the master site at which to alter the object group.
|
dblink_list
| A comma-separated list of database links for which to alter propagation. If null, all masters except the master site being altered will be used by default.
|
dblink_table
| A PL/SQL table, indexed from position 1, of database links for which to alter propagation.
|
propagation_mode
| Determines the manner in which changes from the given master site are propagated to the sites identified by the list of database links. Appropriate values are SYNCHRONOUS and ASYNCHRONOUS.
|
comment
| This comment is added to the RepProp view.
|
Table 12 - 72. Parameters for ALTER_MASTER_PROPAGATION
Exception
| Description
|
nonmasterdef
| The local site is not the master definition site.
|
notquiesced
| The local site is not quiesced.
|
typefailure
| The propagation mode specified was not recognized.
|
nonmaster
| The list of database links includes a site that is not a master site.
|
Table 12 - 73. Exceptions for ALTER_MASTER_PROPAGATION
DBMS_REPCAT.ALTER_MASTER_REPOBJECT
Purpose
To alter an object in your replicated environment. You must call this procedure from the master definition site. For additional information, refer to page 4 - 45.
Syntax
The parameters for the ALTER_MASTER_REPOBJECT procedure are described in Table 12 - 74, and the exceptions are listed in Table 12 - 75. The syntax for this procedure is shown below:
DBMS_REPCAT.ALTER_MASTER_REPOBJECT(
sname IN VARCHAR2,
oname IN VARCHAR2,
type IN VARCHAR2,
ddl_text IN VARCHAR2,
comment IN VARCHAR2 := '',
retry IN BOOLEAN := FALSE)
Note: If the DDL is supplied without specifying a schema, the default schema is the replication administrator's schema. Be sure to specify the schema if it is other than the replication administrator's schema.
Parameter
| Description
|
sname
| The schema containing the object that you want to alter.
|
oname
| The name of the object that you want to alter.
|
type
| The type of the object that you are altering. The types supported are: TABLE, INDEX, SYNONYM, TRIGGER, VIEW, PROCEDURE, FUNCTION, PACKAGE, and PACKAGE BODY.
|
ddl_text
| The DDL text that you want used to alter the object. Oracle does not parse this DDL before applying it; therefore, you must ensure that your DDL text provides the appropriate schema and object name for the object being altered.
|
comment
| If not null, this comment will be added to the COMMENT field of the RepObject view.
|
retry
| If retry is TRUE, ALTER_MASTER_REPOBJECT alters the object only at masters whose object status is not VALID.
|
Table 12 - 74. Parameters for ALTER_MASTER_REPOBJECT
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
notquiesced
| The associated object group has not been suspended.
|
missingobject
| The object identified by SNAME and ONAME does not exist.
|
typefailure
| The given type parameter is not supported.
|
ddlfailure
| DDL at the master definition site did not succeed.
|
commfailure
| At least one master site is not accessible.
|
Table 12 - 75. Exceptions for ALTER_MASTER_REPOBJECT
DBMS_REPCAT.ALTER_PRIORITY
Purpose
To alter the priority level associated with a given priority group member. You must call this procedure from the master definition site. For additional information, refer to page 6 - 31.
Syntax
The parameters for the ALTER_PRIORITY procedure are described in Table 12 - 76, and the exceptions are listed in Table 12 - 77. The syntax for this procedure is shown below:
DBMS_REPCAT.ALTER_PRIORITY(
gname IN VARCHAR2,
pgroup IN VARCHAR2,
old_priority IN NUMBER,
new_priority IN NUMBER)
Parameter
| Description
|
gname
| The replicated object group with which the priority group is associated.
|
pgroup
| The name of the priority group containing the priority that you want to alter.
|
old_priority
| The current priority level of the priority group member.
|
new_priority
| The new priority level that you want assigned to the priority group member.
|
Table 12 - 76. Parameters for ALTER_PRIORITY
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
duplicatepriority
| The new priority level already exists in the priority group.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingvalue
| The value was not registered by a call to DBMS_REPCAT.ADD_PRIORITY_datatype.
|
Table 12 - 77. Exceptions for ALTER_PRIORITY
DBMS_REPCAT.ALTER_PRIORITY_datatype
Purpose
To alter the value of a member to a priority group. You must call this procedure from the master definition site. The procedure that you must call is determined by the datatype of your "priority" column. The available procedures are listed below.
For additional information, refer to page 6 - 30.
Syntax
The parameters for the ALTER_PRIORITY_VARCHAR2 procedure are described in Table 12 - 78, and the exceptions are listed in Table 12 - 79. The syntax for this procedure is shown below. (The syntax for the remaining ALTER_PRIORITY_datatype procedures is identical, except for the datatype of the old and new values.)
DBMS_REPCAT.ALTER_PRIORITY_VARCHAR2(
gname IN VARCHAR2,
pgroup IN VARCHAR2,
old_value IN VARCHAR2,
new_value IN VARCHAR2)
Parameter
| Description
|
gname
| The replicated object group with which the priority group is associated.
|
pgroup
| The name of the priority group containing the value that you want to alter.
|
old_value
| The current value of the priority group member.
|
new_value
| The new value that you want assigned to the priority group member.
|
Table 12 - 78. Parameters for ALTER_PRIORITY_VARCHAR2
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
duplicatevalue
| The new value already exists in the priority group.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingprioritygroup
| The given priority group does not exist.
|
missingvalue
| The old value does not already exist.
|
paramtype
| The new value has the incorrect datatype for the priority group.
|
Table 12 - 79. Exceptions for ALTER_PRIORITY_VARCHAR2
DBMS_REPCAT.ALTER_SITE_PRIORITY
Purpose
To alter the priority level associated with a given site. You must call this procedure from the master definition site. For additional information, refer to page 6 - 35.
Syntax
The parameters for the ALTER_SITE_PRIORITY procedure are described in Table 12 - 80, and the exceptions are listed in Table 12 - 81. The syntax for this procedure is shown below:
DBMS_REPCAT.ALTER_SITE_PRIORITY( gname IN VARCHAR2,
name IN VARCHAR2
old_priority IN NUMBER,
new_priority IN NUMBER)
Parameter
| Description
|
gname
| The replicated object group with which the site priority group is associated.
|
name
| The name of the site priority group whose member you are altering.
|
old_priority
| The current priority level of the site whose priority level you want to change.
|
new_priority
| The new priority level for the site. A higher number indicates a higher priority level.
|
Table 12 - 80. Parameters for ALTER_SITE_PRIORITY
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingpriority
| The old priority level is not associated with any group members.
|
duplicatepriority
| The new priority level already exists for another site in the group.
|
missingvalue
| The old value does not already exist.
|
paramtype
| The new value has the incorrect datatype for the priority group.
|
Table 12 - 81. Exceptions for ALTER_SITE_PRIORITY
DBMS_REPCAT.ALTER_SITE_PRIORITY_SITE
Purpose
To alter the site associated with a given priority level. You must call this procedure from the master definition site. For additional information, refer to page 6 - 35.
Syntax
The parameters for the ALTER_SITE_PRIORITY_SITE procedure are described in Table 12 - 82, and the exceptions are listed in Table 12 - 83. The syntax for this procedure is shown below:
DBMS_REPCAT.ALTER_SITE_PRIORITY_SITE( gname IN VARCHAR2,
name IN VARCHAR2
old_site IN VARCHAR2,
new_site IN VARCHAR2)
Parameter
| Description
|
gname
| The replicated object group with which the site priority group is associated.
|
name
| The name of the site priority group whose member you are altering.
|
old_site
| The current global database name of the site whose name you want to change.
|
new_site
| The new global database name that you want to associate with the current priority level.
|
Table 12 - 82. Parameters for ALTER_SITE_PRIORITY_SITE
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingpriority
| The given site priority group does not exist
|
missingvalue
| The old site is not a group member.
|
duplicatesite
| The new site already exists in the group with a different priority level.
|
Table 12 - 83. Exceptions for ALTER_SITE_PRIORITY_SITE
DBMS_REPCAT.ALTER_SNAPSHOT_PROPAGATION
Purpose
To alter the propagation method for a given object group at the current snapshot site. This procedure pushes the deferred transaction queue at the snapshot site, locks the snapshot base tables, and regenerates any triggers and their associated packages. You must call this procedure from the snapshot site. For additional information, refer to page 5 - 21.
Syntax
The parameters for the ALTER_SNAPSHOT_PROPAGATION procedure are described in Table 12 - 84, and the exceptions are listed in Table 12 - 85. The syntax for this procedure is shown below:
DBMS_REPCAT.ALTER_SNAPSHOT_PROPAGATION(
gname IN VARCHAR2,
propagation_mode IN VARCHAR2,
comment IN VARCHAR2 := ''
execute_as_user IN BOOLEAN := FALSE)
Parameter
| Description
|
gname
| The name of the object group that you want to alter.
|
propagation_mode
| Determines the manner in which changes from the current snapshot site are propagated to its associated master site. Appropriate values are SYNCHRONOUS and ASYNCHRONOUS.
|
comment
| This comment is added to the RepProp view.
|
execute_as_user
| The default, FALSE, indicates that a deferred call is authenticated at the remote system using the authentication context of the user who originally queued the deferred call (as indicated in the ORIGIN_USER column of the DefTran view). Set this to TRUE if you want the execution of a deferred call to be authenticated at the remote system using the authentication context of the session user.
|
Table 12 - 84. Parameters for ALTER_SNAPSHOT_PROPAGATION
Exception
| Description
|
notcompat
| Only databases operating in 7.3.0 or later mode can use this procedure.
|
missingrepgroup
| The given replicated object group does not exist.
|
typefailure
| The propagation mode was specified incorrectly.
|
Table 12 - 85. Exceptions for ALTER_SNAPSHOT_PROPAGATION
DBMS_REPCAT.CANCEL_STATISTICS
Purpose
To stop collecting statistics about the successful resolution of update, uniqueness, and delete conflicts for a table. For additional information, refer to page 7 - 9.
Syntax
The parameters for the CANCEL_STATISTICS procedure are described in Table 12 - 86, and the exceptions are listed in Table 12 - 87. The syntax for this procedure is shown below:
DBMS_REPCAT.CANCEL_STATISTICS( sname IN VARCHAR2,
oname IN VARCHAR2)
Parameter
| Description
|
sname
| The name of the schema in which the table is located.
|
oname
| The name of the table for which you do not want to gather conflict resolution statistics.
|
Table 12 - 86. Parameters for CANCEL_STATISTICS
Exception
| Description
|
missingschema
| The given schema does not exist.
|
missingobject
| The given table does not exist.
|
statnotreg
| The given table is not currently registered to collect statistics.
|
Table 12 - 87. Exceptions for CANCEL_STATISTICS
DBMS_REPCAT.COMMENT_ON_COLUMN_GROUP
Purpose
To update the comment field in the RepColumn_Group view for a column group. This comment is not added at all master sites until the next call to DBMS_REPCAT.GENERATE_REPLICATION_SUPPORT. For additional information, refer to page 7 - 18.
Syntax
The parameters for the COMMENT_ON_COLUMN_GROUP procedure are described in Table 12 - 88, and the exceptions are listed in Table 12 - 89. The syntax for this procedure is shown below:
DBMS_REPCAT.COMMENT_ON_COLUMN_GROUP(
sname IN VARCHAR2,
oname IN VARCHAR2,
column_group IN VARCHAR2,
comment IN VARCHAR2)
Parameter
| Description
|
sname
| The name of the schema in which the object is located.
|
oname
| The name of the replicated table with which the column group is associated.
|
column_group
| The name of the column group.
|
comment
| The text of the updated comment that you want included in the GROUP_COMMENT field of the RepColumn_Group view.
|
Table 12 - 88. Parameters for COMMENT_ON_COLUMN_GROUP
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missinggroup
| The given column group does not exist.
|
Table 12 - 89. Exceptions for COMMENT_ON_COLUMN_GROUP
DBMS_REPCAT.COMMENT_ON_PRIORITY_GROUP/
DBMS_REPCAT.COMMENT_ON_SITE_PRIORITY
Purpose
To update the comment field in the RepPriority_Group view for a priority group. This comment is not added at all master sites until the next call to DBMS_REPCAT.GENERATE_REPLICATION_SUPPORT. For additional information, refer to page 7 - 18.
To update the comment field in the RepPriority_Group view for a site priority group, call the COMMENT_ON_SITE_PRIORITY procedure in the DBMS_REPCAT package. (This procedure is a wrapper for the COMMENT_ON_COLUMN_GROUP procedure and is provided as a convenience only.) This procedure must be issued at the master definition site.
Syntax
The parameters for the COMMENT_ON_PRIORITY_GROUP and COMMENT_ON_SITE_PRIORITY procedures are described in Table 12 - 90, and the exceptions are listed in Table 12 - 91.
The syntax for the COMMENT_ON_PRIORITY_GROUP procedure is shown below:
DBMS_REPCAT.COMMENT_ON_PRIORITY_GROUP(
gname IN VARCHAR2,
pgroup IN VARCHAR2,
comment IN VARCHAR2)
The syntax for the COMMENT_ON_SITE_PRIORITY procedure is shown below:
DBMS_REPCAT.COMMENT_ON_SITE_PRIORITY(
gname IN VARCHAR2,
name IN VARCHAR2,
comment IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the replicated object group.
|
pgroup/name
| The name of the priority or site priority group.
|
comment
| The text of the updated comment that you want included in the PRIORITY_COMMENT field of the RepPriority_Group view.
|
Table 12 - 90. Parameters for COMMENT_ON_PRIORITY_GROUP and COMMENT_ON_SITE_PRIORITY
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingprioritygroup
| The given priority group does not exist.
|
missingpriority
| The given site priority group does not exist.
|
Table 12 - 91. Exceptions for COMMENT_ON_PRIORITY_GROUP and COMMENT_ON_SITE_PRIORITY
DBMS_REPCAT.COMMENT_ON_REPGROUP
Purpose
To update the comment field in the RepGroup view for a replicated object group. For additional information, refer to page 7 - 18. This procedure must be issued at the master definition site.
Syntax
The parameters for the COMMENT_ON_REPGROUP procedure are described in Table 12 - 92, and the exceptions are listed in Table 12 - 93. The syntax for this procedure is shown below:
DBMS_REPCAT.COMMENT_ON_REPGROUP( gname IN VARCHAR2,
comment IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the object group that you want to comment on.
|
comment
| The updated comment to include in the GROUP_COMMENT field of the RepGroup view.
|
Table 12 - 92. Parameters for COMMENT_ON_REPGROUP
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
commfailure
| At least one master site is not accessible.
|
missingobjectgroup
| The object group does not exist.
|
Table 12 - 93. Exceptions for COMMENT_ON_REPGROUP Procedure
DBMS_REPCAT.COMMENT_ON_REPSITES
Purpose
To update the comment field in the RepSite view for a replicated site. For additional information, refer to page 7 - 18. This procedure must be issued at the master definition site.
Syntax
The parameters for the COMMENT_ON_REPGROUP procedure are described in Table 12 - 94, and the exceptions are listed in Table 12 - 95. The syntax for this procedure is shown below:
DBMS_REPCAT.COMMENT_ON_REPSITES(
gname IN VARCHAR2,
master IN VARCHAR,
comment IN VARCHAR2)
Parameter
| Description
|
gname
| The name of the object group. This avoids confusion if a database is a master site in more than one replicated environment.
|
master
| The fully qualified database name of the master site that you want to comment on.
|
comment
| The text of the updated comment that you want to include in the MASTER_COMMENT field of the RepSites view.
|
Table 12 - 94. Parameters for COMMENT_ON_REPSITES
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
Table 12 - 95. Exceptions for COMMENT_ON_REPSITES
DBMS_REPCAT.COMMENT_ON_REPOBJECT
Purpose
To update the comment field in the RepObject view for a replicated object. For additional information, refer to page 7 - 18. This procedure must be issued at the master definition site.
Syntax
The parameters for the COMMENT_ON_REPOBJECT procedure are described in Table 12 - 96, and the exceptions are listed in Table 12 - 97. The syntax for this procedure is shown below:
DBMS_REPCAT.COMMENT_ON_REPOBJECT( sname IN VARCHAR2,
oname IN VARCHAR2,
type IN VARCHAR2,
comment IN VARCHAR2)
Parameter
| Description
|
sname
| The name of the schema in which the object is located.
|
oname
| The name of the object that you want to comment on.
|
type
| The type of the object.
|
comment
| The text of the updated comment that you want to include in the OBJECT_COMMENT field of the RepObject view.
|
Table 12 - 96. Parameters for COMMENT_ON_REPOBJECT
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missingobject
| The given object does not exist.
|
typefailure
| The given type parameter is not supported.
|
commfailure
| At least one master site is not accessible.
|
Table 12 - 97. Exceptions for COMMENT_ON_REPOBJECT
DBMS_REPCAT.COMMENT_ON_conflicttype_RESOLUTION
Purpose
To update the comment field in the RepResolution view for a conflict resolution routine. The procedure that you need to call is determined by the type of conflict that the routine is used to resolve. These procedures must be issued at the master definition site.
Conflict Type
| Procedure Name
|
update
| COMMENT_ON_UPDATE_RESOLUTION
|
uniqueness
| COMMENT_ON_UNIQUE_RESOLUTION
|
delete
| COMMENT_ON_DELETE_RESOLUTION
|
The comment is not added at all master sites until the next call to DBMS_REPCAT.GENERATE_REPLICATION_SUPPORT. For additional information, refer to page 7 - 18.
Syntax
The parameters for the COMMENT_ON_conflicttype_RESOLUTION procedures are described in Table 12 - 98, and the exceptions are listed in Table 12 - 99.
The syntax for the COMMENT_ON_UPDATE_RESOLUTION procedure is shown below:
DBMS_REPCAT.COMMENT_ON_UPDATE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
column_group IN VARCHAR2,
sequence_no IN NUMBER,
comment IN VARCHAR2)
The syntax for the COMMENT_ON_UNIQUE_RESOLUTION procedure is shown below:
DBMS_REPCAT.COMMENT_ON_UNIQUE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
constraint_name IN VARCHAR2,
sequence_no IN NUMBER,
comment IN VARCHAR2)
The syntax for the COMMENT_ON_DELETE_RESOLUTION procedure is shown below:
DBMS_REPCAT.COMMENT_ON_DELETE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
sequence_no IN NUMBER,
comment IN VARCHAR2)
Parameter
| Description
|
sname
| The name of the schema.
|
oname
| The name of the replicated table with which the conflict resolution routine is associated.
|
column_group
| The name of the column group with which the update conflict resolution routine is associated.
|
constraint_name
| The name of the Unique constraint with which the uniqueness conflict resolution routine is associated.
|
sequence_no
| The sequence number of the conflict resolution procedure.
|
comment
| The text of the updated comment that you want included in the RESOLUTION_COMMENT field of the RepResolution view.
|
Table 12 - 98. Parameters for COMMENT_ON_UPDATE/UNIQUE/DELETE_RESOLUTION
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missingobject
| The given procedure does not exist.
|
missingresolution
| SEQUENCE_NO or COLUMN_GROUP is not registered.
|
Table 12 - 99. Exceptions for COMMENT_ON_UPDATE/UNIQUE/DELETE_RESOLUTION
DBMS_REPCAT.CREATE_MASTER_REPGROUP
Purpose
To create a new, empty, quiesced master replication object group. For additional information, refer to page 4 - 13.
Syntax
The parameters for the CREATE_MASTER_REPGROUP procedure are described in Table 12 - 100, and the exceptions are listed in Table 12 - 101. The syntax for this procedure is shown below:
DBMS_REPCAT.CREATE_MASTER_REPGROUP(
gname IN VARCHAR2,
group_comment IN VARCHAR2 := '',
master_comment IN VARCHAR2 := '')
Parameter
| Description
|
gname
| The name of the object group that you want to create.
|
group_comment
| This comment is added to the RepCat view.
|
master_comment
| This comment is added to the RepGroup view.
|
Table 12 - 100. Parameters for CREATE_MASTER_REPGROUP
Exception
| Description
|
duplicaterepgroup
| The object group already exists.
|
ddlfailure
| There is a problem creating the rep$what_am_i package or package body.
|
norepopt
| The advanced replication option is not installed.
|
notcompat
| The GNAME is not a schema name, and the master definition site is pre-release 7.3.
|
missingrepgrp
| The object group name was not specified.
|
Table 12 - 101. Exceptions for CREATE_MASTER_REPGROUP
DBMS_REPCAT.CREATE_MASTER_REPOBJECT
Purpose
To indicate that an object is a replicated object. For additional information, refer to page 4 - 14.
Syntax
The parameters for the CREATE_MASTER_REPOBJECT procedure are shown in Table 12 - 102, and the exceptions are listed in Table 12 - 103. The syntax for this procedure is shown below:
DBMS_REPCAT.CREATE_MASTER_REPOBJECT(
sname IN VARCHAR2,
oname IN VARCHAR2,
type IN VARCHAR2,
use_existing_object IN BOOLEAN := TRUE,
ddl_text IN VARCHAR2 := NULL,
comment IN VARCHAR2 := '',
retry IN BOOLEAN := FALSE
copy_rows IN BOOLEAN := TRUE,
gname IN VARCHAR2 := '')
Note: If the DDL is supplied without specifying a schema, the default schema is the replication administrator's schema. Be sure to specify the schema if it is other than the replication administrator's schema.
Parameter
| Description
|
sname
| The name of the schema in which the object that you want to replicate is located.
|
oname
| The name of the object that you are replicating. If DDL_TEXT is NULL, this object must already exist in the given schema. To ensure uniqueness, table names should be a maximum of 27 bytes long, and packages should be no more than 24 bytes.
|
type
| The type of the object that you are replicating. The types supported are: TABLE, INDEX, SYNONYM, TRIGGER,VIEW, PROCEDURE, FUNCTION, PACKAGE, and PACKAGE BODY.
|
use_existing_object
| Indicate TRUE if you want to reuse any objects of the same type and shape at the current master sites. See Table 12 - 104 for more information on how these changes are applied.
|
ddl_text
| If the object does not already exist at the master definition site, you must supply the DDL text necessary to create this object. PL/SQL packages, package bodies, procedures, and functions must have a trailing semicolon. SQL statements do not end with a trailing semicolon. Oracle does not parse this DDL before applying it; therefore, you must ensure that your DDL text provides the appropriate schema and object name for the object being created.
|
comment
| This comment will be added to the OBJECT_COMMENT field of the RepObject view.
|
retry
| Indicate TRUE if you want Oracle to reattempt to create an object that it was previously unable to create. Use RETRY if the error was transient or has since been rectified; for example, if you previously had insufficient resources. If RETRY is TRUE, Oracle creates the object only at master sites whose object status is not VALID.
|
copy_rows
| Indicate TRUE if you want the initial contents of a newly replicated object to match the contents of the object at the master definition site. See Table 12 - 104 for more information.
|
gname
| The name of the object group in which you want to create the replicated object. The schema name is used as the default object group name is none is specified.
|
Table 12 - 102. Parameters for CREATE_MASTER_REPOBJECT
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
notquiesced
| The replicated object group has not been suspended.
|
duplicateobject
| The given object already exists in the replicated object group and retry is FALSE, or if a name conflict occurs.
|
missingobject
| The object identified by SNAME and ONAME does not exist and appropriate DDL has not been provided.
|
typefailure
| Objects of the given type cannot be replicated
|
ddlfailure
| DDL at the master definition site did not succeed.
|
commfailure
| At least one master site is not accessible.
|
Table 12 - 103. Exceptions for CREATE_MASTER_REPOBJECT
Object Already Exists?
| COPY_ROWS
| USE_EXISTING_OBJECT
| Result
|
yes
| TRUE
| TRUE
| duplicateobject message if objects do not match. For tables, use data from master definition site.
|
yes
| FALSE
| TRUE
| duplicateobject message if objects do not match. For tables, Admin must ensure contents are identical.
|
yes
| TRUE/FALSE
| FALSE
| duplicateobject message
|
no
| TRUE
| TRUE/FALSE
| Object is created. Tables populated using data from master definition site.
|
no
| FALSE
| TRUE/FALSE
| Object is created. Admin must populate tables and ensure consistency of tables at all sites.
|
Table 12 - 104. Object Creation at Master Sites
DBMS_REPCAT.CREATE_SNAPSHOT_REPGROUP
Purpose
To create a new, empty, snapshot replication object group in your local database. For additional information, refer to page 5 - 6.
Syntax
The parameters for the CREATE_SNAPSHOT_REPGROUP procedure are described in Table 12 - 105, and the procedures are listed in Table 12 - 106. The syntax for this procedure is shown below:
DBMS_REPCAT.CREATE_SNAPSHOT_REPGROUP(
gname IN VARCHAR2,
master IN VARCHAR2,
comment IN VARCHAR2 := '',
propagation_mode IN VARCHAR2 := 'ASYNCHRONOUS')
Parameter
| Description
|
gname
| The name of the replicated object group. This object group must exist at the given master site.
|
master
| The fully qualified database name of the database in the replicated environment to use as the master.
|
comment
| This comment is added to the GROUP_COMMENT field of the RepCat view.
|
propagation_mode
| The method of propagation for all updatable snapshots in the object group. Acceptable values are SYNCHRONOUS and ASYNCHRONOUS.
|
Table 12 - 105. Parameters for CREATE_SNAPSHOT_REPGROUP
Exception
| Description
|
duplicaterepgroup
| The object group already exists at the invocation site.
|
nonmaster
| The given database is not a master site.
|
commfailure
| The given database is not accessible.
|
norepopt
| The advanced replication option is not installed.
|
typefailure
| The propagation mode was specified incorrectly.
|
notcompatible
| Propagation mode must be ASYNCHRONOUS for pre-release 7.3 sites.
|
Table 12 - 106. Exceptions for CREATE_SNAPSHOT_REPGROUP
DBMS_REPCAT.CREATE_SNAPSHOT_REPOBJECT
Purpose
To add a replicated object to your snapshot site. For additional information, refer to page 5 - 7.
Syntax
The parameters for the CREATE_SNAPSHOT_REPOBJECT procedure are shown in Table 12 - 107, and the exceptions are listed in Table 12 - 108. The syntax for this procedure is shown below:
DBMS_REPCAT.CREATE_SNAPSHOT_REPOBJECT(
sname IN VARCHAR2,
oname IN VARCHAR2,
type IN VARCHAR2,
ddl_text IN VARCHAR2 := NULL,
comment IN VARCHAR2 := '',
gname IN VARCHAR2 := ''
gen_obj_owner IN VARCHAR2 := '')
Note: If the DDL is supplied without specifying a schema, the default schema is the replication administrator's schema. Be sure to specify the schema if it is other than the replication administrator's schema.
Parameter
| Description
|
sname
| The name of the schema in which the object is located.
|
oname
| The name of the object that you want to add to the replicated snapshot object group. ONAME must exist at the associated master site.
|
type
| The type of the object that you are replicating. The types supported for snapshot sites are: PACKAGE, PACKAGE BODY, PROCEDURE, FUNCTION, SNAPSHOT, SYNONYM, and VIEW.
|
ddl_text
| For objects of type SNAPSHOT, the DDL text needed to create the object; for other types, use the default, NULL. If a snapshot with the same name already exists, Oracle ignores the DDL and registers the existing snapshot as a replicated object. If the master table for a snapshot does not exist in the replicated object group of the master site designated for this schema, Oracle raises a missingobject error.
|
comment
| This comment is added to the OBJECT_COMMENT field of the RepObject view.
|
gname
| The name of the replicated object group to which you are adding an object. The schema name is used as the default group name if none is specified.
|
gen_obj_owner
| The name of the user you want to assign as owner of the transaction.
|
Table 12 - 107. Parameters for CREATE_SNAPSHOT_REPOBJECT
Exception
| Description
|
nonsnapshot
| The invocation site is not a snapshot site.
|
nonmaster
| The master is no longer a master site.
|
missingobject
| The given object does not exist in the master's replicated object group.
|
duplicateobject
| The given object already exists with a different shape.
|
typefailure
| The type is not an allowable type.
|
ddlfailure
| The DDL did not succeed.
|
commfailure
| The master site is not accessible.
|
missingschema
| The schema does not exist as a database schema.
|
Table 12 - 108. Exceptions for CREATE_SNAPSHOT_REPOBJECT
DBMS_REPCAT.DEFINE_COLUMN_GROUP
Purpose
To create an empty column group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 24.
Syntax
The parameters for the DEFINE_COLUMN_GROUP procedure are described in Table 12 - 109, and the exceptions are listed in Table 12 - 110. The syntax for this procedure is shown below:
DBMS_REPCAT.DEFINE_COLUMN_GROUP(
sname IN VARCHAR2,
oname IN VARCHAR2,
column_group IN VARCHAR2,
comment IN VARCHAR2 := NULL)
Parameter
| Description
|
sname
| The schema in which the replicated table is located.
|
oname
| The name of the replicated table for which you are creating a column group.
|
column_group
| The name of the column group that you want to create.
|
comment
| This user text is displayed in the RepColumnGroup view.
|
Table 12 - 109. Parameters for DEFINE_COLUMN_GROUP
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingobject
| The given table does not exist.
|
duplicategroup
| The given column group already exists for the table.
|
Table 12 - 110. Exceptions for DEFINE_COLUMN_GROUP
DBMS_REPCAT.DEFINE_PRIORITY_GROUP
Purpose
To create a new priority group for a replicated object group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 29.
Syntax
The parameters for the DEFINE_PRIORITY_GROUP procedure are described in Table 12 - 111, and the exceptions are listed in Table 12 - 112. The syntax for this procedure is shown below:
DBMS_REPCAT.DEFINE_PRIORITY_GROUP(
gname IN VARCHAR2,
pgroup IN VARCHAR2,
datatype IN VARCHAR2,
fixed_length IN INTEGER := NULL,
comment IN VARCHAR2 := NULL)
Parameter
| Description
|
gname
| The replicated object group for which you are creating a priority group.
|
pgroup
| The name of the priority group that you are creating.
|
datatype
| The datatype of the priority group members. The datatypes supported are: CHAR, VARCHAR2, NUMBER, DATE, and RAW.
|
fixed_length
| You must provide a column length for the CHAR datatype. All other types can use the default, NULL.
|
comment
| This user comment is added to the RepPriority view.
|
Table 12 - 111. Parameters for DEFINE_PRIORITY_GROUP
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
duplicateprioritygroup
| The given priority group already exists in the replicated object group.
|
typefailure
| The given datatype is not supported.
|
Table 12 - 112. Exceptions for DEFINE_PRIORITY_GROUP
DBMS_REPCAT.DEFINE_SITE_PRIORITY
Purpose
To create a new site priority group for a replicated object group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 34.
Syntax
The parameters for the DEFINE_SITE_PRIORITY procedure are described in Table 12 - 113, and the exceptions are listed in Table 12 - 114. The syntax for this procedure is shown below:
DBMS_REPCAT.DEFINE_SITE_PRIORITY(
gname IN VARCHAR2,
name IN VARCHAR2,
comment IN VARCHAR2 := NULL)
Parameter
| Description
|
gname
| The replicated object group for which you are creating a site priority group.
|
name
| The name of the site priority group that you are creating.
|
comment
| This user comment is added to the RepPriority view.
|
Table 12 - 113. Parameters for DEFINE_SITE_PRIORITY
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
duplicateprioritygroup
| The given site priority group already exists in the replicated object group.
|
Table 12 - 114. Exceptions for DEFINE_SITE_PRIORITY
DBMS_REPCAT.DO_DEFERRED_REPCAT_ADMIN
Purpose
To execute the local outstanding deferred administrative procedures for the given replicated object group at the current master site, or (with assistance from job queues) for all master sites. For additional information, refer to page 7 - 10.
Note: DO_DEFERRED_REPCAT_ADMIN executes only those administrative requests submitted by the connected user that called DO_DEFERRED_REPCAT_ADMIN. Requests submitted by other users are ignored.
Syntax
The parameters for the DO_DEFERRED_REPCAT_ADMIN procedure are described in Table 12 - 115, and the exceptions are listed in Table 12 - 116. The syntax for this procedure is shown below:
DBMS_REPCAT.DO_DEFERRED_REPCAT_ADMIN(
gname IN VARCHAR2,
all_sites IN BOOLEAN := FALSE)
Parameter
| Description
|
gname
| The name of the replicated object group.
|
all_sites
| If ALL_SITES is TRUE, use a job to execute the local administrative procedures at each master.
|
Table 12 - 115. Parameters for DO_DEFERRED_REPCAT_ADMIN
Exception
| Description
|
nonmaster
| The invocation site is not a master site.
|
commfailure
| At least one master site is not accessible and all_sites is TRUE.
|
Table 12 - 116. Exceptions for DO_DEFERRED_REPCAT_ADMIN
DBMS_REPCAT.DROP_COLUMN_GROUP
Purpose
To drop a column group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 24.
Syntax
The parameters for the DROP_COLUMN_GROUP procedure are described in Table 12 - 117, and the exceptions are listed in Table 12 - 118. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_COLUMN_GROUP( sname IN VARCHAR2,
oname IN VARCHAR2,
column_group IN VARCHAR2)
Parameter
| Description
|
sname
| The schema in which the replicated table is located.
|
oname
| The name of the replicated table whose column group you are dropping.
|
column_group
| The name of the column group that you want to drop.
|
Table 12 - 117. Parameters for DROP_COLUMN_GROUP
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
referenced
| The given column group is being used in conflict detection and resolution.
|
missingobject
| The given table does not exist.
|
missinggroup
| The given column group does not exist.
|
missingschema
| The given schema does not exist.
|
Table 12 - 118. Exceptions for DROP_COLUMN_GROUP
DBMS_REPCAT.DROP_GROUPED_COLUMN
Purpose
To remove members from a column group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 23.
Syntax
The parameters for the DROP_GROUPED_COLUMN procedure are described in Table 12 - 119, and the exceptions are listed in Table 12 - 120. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_GROUPED_COLUMN(
sname IN VARCHAR2,
oname IN VARCHAR2,
column_group IN VARCHAR2,
list_of_column_names IN VARCHAR2)
Parameter
| Description
|
sname
| The schema in which the replicated table is located.
|
oname
| The name of the replicated table in which the column group is located.
|
column_group
| The name of the column group from which you are removing members.
|
list_of_column_names
| The names of the columns that you are removing from the designated column group. This can either be a comma-separated list or a PL/SQL table of column names. The PL/SQL table must be of type dbms_repcat.varchar2s.
|
Table 12 - 119. Parameters for DROP_GROUPED_COLUMN
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingobject
| The given table does not exist.
|
missinggroup
| The given column group does not exist.
|
missingschema
| The given schema does not exist.
|
Table 12 - 120. Exceptions for DROP_GROUPED_COLUMN
DBMS_REPCAT.DROP_MASTER_REPGROUP
Purpose
To drop a replicated object group from your current site. To drop the replicated object group from all master sites, including the master definition site, you can call this procedure at the master definition site, and set the final argument to TRUE. For additional information, refer to page 4 - 49.
Syntax
The parameters for the DROP_MASTER_REPGROUP procedure are described in Table 12 - 121, and the exceptions are listed in Table 12 - 122. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_MASTER_REPGROUP(
gname IN VARCHAR2,
drop_contents IN BOOLEAN := FALSE,
all_sites IN BOOLEAN := FALSE)
Parameter
| Description
|
gname
| The name of the replicated object group that you want to drop from the current master site.
|
drop_contents
| By default, when you drop the object group at a master site, all of the objects remain in the schema. They simply are no longer replicated; that is, the replicated objects in the object group no longer send changes to, or receive changes from, other master sites. If you set this argument to TRUE, any replicated objects in the replicated object group are dropped from their associated schemas.
|
all_sites
| If ALL_SITES is TRUE and the invocation site is the master definition site, the procedure synchronously multicasts the request to all masters. In this case, execution is immediate at the master definition site and may be deferred at all other master sites.
|
Table 12 - 121. Parameters for DROP_MASTER_REPGROUP
Exception
| Description
|
nonmaster
| The invocation site is not a master site.
|
nonmasterdef
| The invocation site is not the master definition site and ALL_SITES is TRUE.
|
commfailure
| At least one master site is not accessible and ALL_SITES is TRUE.
|
fullqueue
| The deferred RPC queue has entries for the repschema
|
Table 12 - 122. Exceptions for DROP_MASTER_REPGROUP
DBMS_REPCAT.DROP_MASTER_REPOBJECT
Purpose
To drop a replicated object from a replicated object group. You must call this procedure from the master definition site. For additional information, refer to page 4 - 46.
Syntax
The parameters for the DROP_MASTER_REPOBJECT procedure are described in Table 12 - 123, and the exceptions are listed in Table 12 - 124. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_MASTER_REPOBJECT(
sname IN VARCHAR2,
oname IN VARCHAR2,
type IN VARCHAR2,
drop_objects IN BOOLEAN := FALSE)
Parameter
| Description
|
sname
| The name of the schema in which the object is located.
|
oname
| The name of the object that you want to remove from the replicated object group.
|
type
| The type of object that you want to drop.
|
drop_objects
| By default, the object remains in the schema, but is dropped from the replicated object group; that is, any changes to the object are no longer replicated to other master and snapshot sites. To completely remove the object from all master sites in the replicated environment, set this argument to TRUE.
|
Table 12 - 123. Parameters for DROP_MASTER_REPOBJECT
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missingobject
| The given object does not exist.
|
typefailure
| The given type parameter is not supported.
|
commfailure
| At least one master site is not accessible.
|
Table 12 - 124. Exceptions for DROP_MASTER_REPOBJECT
DBMS_REPCAT.DROP_PRIORITY
Purpose
To drop a member of a priority group by priority level. You must call this procedure from the master definition site. For additional information, refer to page 6 - 32.
Syntax
The parameters for the DROP_PRIORITY procedure are described in Table 12 - 125, and the exceptions are listed in Table 12 - 126. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_PRIORITY( gname IN VARCHAR2,
pgroup IN VARCHAR2,
priority_num IN NUMBER)
Parameter
| Description
|
gname
| The replicated object group with which the priority group is associated.
|
pgroup
| The name of the priority group containing the member that you want to drop.
|
priority_num
| The priority level of the priority group member that you want to remove from the group.
|
Table 12 - 125. Parameters for DROP_PRIORITY
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingprioritygroup
| The given priority group does not exist.
|
Table 12 - 126. Exceptions for DROP_PRIORITY
DBMS_REPCAT.DROP_PRIORITY_GROUP
Purpose
To drop a priority group for a given replicated object group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 33.
Syntax
The parameters for the DROP_PRIORITY_GROUP procedure are described in Table 12 - 127, and the exceptions are listed in Table 12 - 128. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_PRIORITY_GROUP( gname IN VARCHAR2,
pgroup IN VARCHAR2)
Parameter
| Description
|
gname
| The replicated object group with which the priority group is associated.
|
pgroup
| The name of the priority group that you want to drop.
|
Table 12 - 127. Parameters for DROP_PRIORITY_GROUP
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
referenced
| The given priority group is being used in conflict resolution.
|
Table 12 - 128. Exceptions for DROP_PRIORITY_GROUP
DBMS_REPCAT.DROP_PRIORITY_datatype
Purpose
To drop a member of a priority group by value. You must call this procedure from the master definition site. The procedure that you must call is determined by the datatype of your "priority" column. The available procedures are listed below:
For additional information, refer to page 6 - 32.
Syntax
The parameters for the DROP_PRIORITY_PROCEDURE_datatype procedure are described in Table 12 - 129, and the exceptions are listed in Table 12 - 130. The syntax for the DROP_PRIORITY_VARCHAR2 procedure is shown below. (The syntax for the remaining DROP_PRIORITY_datatype procedures is identical, except for the datatype of the value.)
DBMS_REPCAT.DROP_PRIORITY_VARCHAR2( gname IN VARCHAR2,
pgroup IN VARCHAR2,
value IN VARCHAR2)
Parameter
| Description
|
gname
| The replicated object group with which the priority group is associated.
|
pgroup
| The name of the priority group containing the member that you want to drop.
|
value
| The value of the priority group member that you want to remove from the group.
|
Table 12 - 129. Parameters for DROP_PRIORITY_VARCHAR2
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingprioritygroup
| The given priority group does not exist.
|
paramtype
| The value has the incorrect datatype for the priority group.
|
Table 12 - 130. Exceptions for DROP_PRIORITY_VARCHAR2
DBMS_REPCAT.DROP_SITE_PRIORITY
Purpose
To drop a site priority group for a given replicated object group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 36.
Syntax
The parameters for the DROP_SITE_PRIORITY procedure are described in Table 12 - 131, and the exceptions are listed in Table 12 - 132. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_SITE_PRIORITY( gname IN VARCHAR2,
name IN VARCHAR2)
Parameter
| Description
|
gname
| The replicated object group with which the site priority group is associated.
|
name
| The name of the site priority group that you want to drop.
|
Table 12 - 131. Parameters for DROP_SITE_PRIORITY
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
referenced
| The given site priority group is being used in conflict resolution.
|
Table 12 - 132. Exceptions for DROP_SITE_PRIORITY
DBMS_REPCAT.DROP_SITE_PRIORITY_SITE
Purpose
To drop a given site, by name, from a site priority group. You must call this procedure from the master definition site. For additional information, refer to page 6 - 36.
Syntax
The parameters for the DROP_SITE_PRIORITY_SITE procedure are described in Table 12 - 133, and the exceptions are listed in Table 12 - 134. The syntax for this procedure is shown below:
drop_site_priority_site( gname IN VARCHAR2,
name IN VARCHAR2
site IN VARCHAR2)
Parameter
| Description
|
gname
| The replicated object group with which the site priority group is associated.
|
name
| The name of the site priority group whose member you are dropping.
|
site
| The global database name of the site you are removing from the group.
|
Table 12 - 133. Parameters for DROP_SITE_PRIORITY_SITE
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingrepgroup
| The given replicated object group does not exist.
|
missingpriority
| The given site priority group does not exist.
|
missingsite
| The given site does not exist.
|
Table 12 - 134. Exceptions for DROP_SITE_PRIORITY_SITE
DBMS_REPCAT.DROP_SNAPSHOT_REPGROUP
Purpose
To drop a snapshot site from your replicated environment. For additional information, refer to page 5 - 10.
Syntax
The parameters for the DROP_SNAPSHOT_REPGROUP procedure are described in Table 12 - 135, and the exceptions are listed in Table 12 - 136. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_SNAPSHOT_REPGROUP(
gname IN VARCHAR2,
drop_contents IN BOOLEAN := FALSE)
Parameter
| Description
|
gname
| The name of the replicated object group that you want to drop from the current snapshot site. All objects generated to support replication, such as triggers and packages are dropped.
|
drop_contents
| By default, when you drop the replicated object group at a snapshot site, all of the objects remain in their associated schemas; they simply are no longer replicated. If you set this argument to TRUE, any replicated objects in the replicated object group are dropped from their schemas.
|
Table 12 - 135. Parameters for DROP_SNAPSHOT_REPSCHEMA
Exception
| Description
|
nonsnapshot
| The invocation site is not a snapshot site.
|
missrepgrp
| The specified object group does not exist.
|
Table 12 - 136. Exception for DROP_SNAPSHOT_REPSCHEMA
DBMS_REPCAT.DROP_SNAPSHOT_REPOBJECT
Purpose
To drop a replicated object from a snapshot site. For additional information, refer to page 5 - 9.
Syntax
The parameters for the DROP_SNAPSHOT_REPOBJECT procedure are described in Table 12 - 137, and the exceptions are listed in Table 12 - 138. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_SNAPSHOT_REPOBJECT(
sname IN VARCHAR2,
oname IN VARCHAR2,
type IN VARCHAR2,
drop_objects IN BOOLEAN := FALSE)
Parameter
| Description
|
sname
| The name of the schema in which the object is located.
|
oname
| The name of the object that you want to drop from the replicated object group.
|
type
| The type of the object that you want to drop.
|
drop_objects
| By default, the object remains in its associated schema, but is dropped from its associated object group. To completely remove the object from its schema at the current snapshot site, set this argument to TRUE.
|
Table 12 - 137. Parameters for DROP_SNAPSHOT_REPOBJECT
Exception
| Description
|
nonsnapshot
| The invocation site is not a snapshot site.
|
missingobject
| The given object does not exist.
|
typefailure
| The given type parameter is not supported.
|
Table 12 - 138. Exceptions for DROP_SNAPSHOT_REPOBJECT
DBMS_REPCAT.DROP_conflicttype_RESOLUTION
Purpose
To drop an update, delete, or uniqueness conflict resolution routine. You must call these procedures from the master definition site. The procedure that you must call is determined by the type of conflict that the routine resolves.
Conflict Type
| Procedure Name
|
update
| DROP_UPDATE_RESOLUTION
|
uniqueness
| DROP_UNIQUE_RESOLUTION
|
delete
| DROP_DELETE_RESOLUTION
|
For additional information, refer to page 6 - 27.
Syntax
The parameters for the DROP_UPDATE_RESOLUTION procedure are described in Table 12 - 139, and the exceptions are listed in Table 12 - 140. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_UPDATE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
column_group IN VARCHAR2,
sequence_no IN NUMBER)
The parameters for the DROP_DELETE_RESOLUTION procedure are described in Table 12 - 139, and the exceptions are listed in Table 12 - 140. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_DELETE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
sequence_no IN NUMBER)
The parameters for the DROP_UNIQUE_RESOLUTION procedure are described in Table 12 - 139, and the exceptions are listed in Table 12 - 140. The syntax for this procedure is shown below:
DBMS_REPCAT.DROP_UPDATE_RESOLUTION(
sname IN VARCHAR2,
oname IN VARCHAR2,
constraint_name IN VARCHAR2,
sequence_no IN NUMBER)
Parameter
| Description
|
sname
| The schema in which the table is located.
|
oname
| The name of the table for which you want to drop a conflict resolution routine.
|
column_group
| The name of the column group for which you want to drop an update conflict resolution routine.
|
constraint_name
| The name of the Unique constraint for which you want to drop a unique conflict resolution routine.
|
sequence_no
| The sequence number assigned to the conflict resolution method that you want to drop. This number uniquely identifies the routine.
|
Table 12 - 139. Parameters for DROP_UPDATE/DELETE/UNIQUE_ RESOLUTION
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
missingobject
| The given object does not exist as a table in the given schema, or if a conflict resolution routine with the given sequence number is not registered.
|
missingschema
| The given schema does not exist.
|
Table 12 - 140. Exceptions for DROP_UPDATE/DELETE/UNIQUE_ RESOLUTION
DBMS_REPCAT.EXECUTE_DDL
Purpose
To supply DDL that you want to have executed at each master site. You can call this procedure only from the master definition site. For additional information, refer to page 7 - 14.
Syntax
The parameters for the EXECUTE_DDL procedure are described in Table 12 - 141, and the exceptions are listed in Table 12 - 142. The syntax for this procedure is shown below:
DBMS_REPCAT.EXECUTE_DDL(
gname IN VARCHAR2,
master_list IN VARCHAR2 := NULL, |
master_table IN dbms_utility.dblink_array,
ddl_text IN VARCHAR2)
Note: If the DDL is supplied without specifying a schema, the default schema is the replication administrator's schema. Be sure to specify the schema if it is other than the replication administrator's schema.
Parameter
| Description
|
gname
| The name of the replicated object group.
|
master_list
| A comma-separated list of master sites at which you want to execute the supplied DDL. There must be no extra whitespace between site names. The default value, NULL, indicates that the DDL should be executed at all sites, including the master definition site.
|
master_table
| A table of master sites at which you want to execute the supplied DDL. The first master should be at offset 1, the second at offset 2, and so on.
|
ddl_text
| The DDL that you want to have executed at each of the given master sites.
|
Table 12 - 141. Parameters for EXECUTE_DDL
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
nonmaster
| At least one site is not a master site.
|
ddlfailure
| DDL at the master definition site did not succeed.
|
commfailure
| At least one master site is not accessible.
|
Table 12 - 142. Exceptions for EXECUTE_DDL
DBMS_REPCAT.GENERATE_REPLICATION_PACKAGE
Purpose
To generate the packages needed to support replication for a given table at all master sites. You must call this procedure from the master definition site. For additional information, refer to page 6 - 26.
Syntax
The parameters for the GENERATE_REPLICATION_PACKAGE procedure are described in Table 12 - 143, and the exceptions are listed in Table 12 - 144. The syntax for this procedure is shown below:
DBMS_REPCAT.GENERATE_REPLICATION_PACKAGE(
sname IN VARCHAR2,
oname IN VARCHAR2)
Parameter
| Description
|
sname
| The schema in which the table is located.
|
oname
| The name of the table for which you are generating replication support.
|
Table 12 - 143. Parameters for GENERATE_REPLICATION_PACKAGE
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missingobject
| The given object does not exist as a table in the given schema awaiting row-level replication information or as a procedure or package (body) awaiting wrapper generation.
|
commfailure
| At least one master site is not accessible.
|
notcompat
| This procedure requires release 7.3 or greater.
|
notquiesced
| The replicated object group was not quiesced.
|
Table 12 - 144. Exceptions for GENERATE_REPLICATION_PACKAGE
DBMS_REPCAT.GENERATE_REPLICATION_SUPPORT
Purpose
To generate the triggers, packages, and procedures needed to support replication. You must call this procedure from the master definition site. For additional information, refer to page 4 - 21.
Syntax
The parameters for the GENERATE_REPLICATION_SUPPORT procedure are described in Table 12 - 145, and the exceptions are listed in Table 12 - 146. The syntax for this procedure is shown below:
DBMS_REPCAT.GENERATE_REPLICATION_SUPPORT(
sname IN VARCHAR2,
oname IN VARCHAR2,
type IN VARCHAR2,
package_prefix IN VARCHAR2 := NULL,
procedure_prefix IN VARCHAR2 := NULL,
distributed IN BOOLEAN := TRUE,
gen_rep2_trigger IN BOOLEAN := FALSE
gen_obj_owner IN VARCHAR2 := '')
Parameter
| Description
|
sname
| The schema in which the object is located.
|
oname
| The name of the object for which you are generating replication support.
|
type
| The type of the object. The types supported are: TABLE, PACKAGE, and PACKAGE BODY.
|
package_prefix
| For objects of type PACKAGE or PACKAGE BODY this value is prepended to the generated wrapper package name. The default is DEFER_.
|
procedure_prefix
| For objects of type PROCEDURE, PACKAGE or PACKAGE BODY, this value is prepended to the generated wrapper procedure names. By default, no prefix is assigned. The default is DEFER_.
|
distributed
| This parameter must be set to TRUE if your COMPATIBLE parameter is set to 7.3.0 or greater.
|
gen_rep2_trigger
| This parameter is provided for compatibility with previous releases. If you have any pre-release 7.3 snapshot sites, you must set this parameter to TRUE.
|
gen_obj_owner
| The name of the user you want to as as owner of the transaction.
|
Table 12 - 145. Parameters for GENERATE_REPLICATION_SUPPORT
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missingobject
| The given object does not exist as a table in the given schema awaiting row-level replication information or as a procedure or package (body) awaiting wrapper generation.
|
typefailure
| The given type parameter is not supported.
|
notquiesced
| The replicated object group has not been suspended.
|
commfailure
| At least one master site is not accessible.
|
Table 12 - 146. Exceptions for GENERATE_REPLICATION_SUPPORT
DBMS_REPCAT.GENERATE_REPLICATION_TRIGGER
Purpose
To generate the triggers and their associated packages needed to support replication for a given object at all master sites, or to generate the triggers and their associated packages needed to support replication for all of the objects in a given object group at a list of master sites. You must call this procedure from the master definition site. The associated object group must be quiesced. For additional information, refer to page 4 - 35.
Syntax
The parameters for the GENERATE_REPLICATION_TRIGGER procedure are described in Table 12 - 147, and the exceptions are listed in Table 12 - 148.
To generate support for an object at all master sites, use the syntax shown below:
DBMS_REPCAT.GENERATE_REPLICATION_TRIGGER(
sname IN VARCHAR2,
oname IN VARCHAR2,
gen_rep2_trigger IN BOOLEAN := FALSE)
To generate support for an object group at selected master sites, use the syntax shown below:
DBMS_REPCAT.GENERATE_REPLICATION_TRIGGER(
gname IN VARCHAR2,
master_list IN VARCHAR2 := NULL |
master_table IN dbms_utility.dblink_array)
Attention: If you want to generate support for a list of master sites (that is, if you will not be using the default, NULL), you must either use an array or named notation.
Parameter
| Description
|
sname
| The schema in which the object is located.
|
oname
| The name of the object for which you are generating replication support.
|
gen_rep2_trigger
| This parameter is provided for compatibility with previous releases. If you have any pre-release 7.3 snapshot sites, you must set this parameter to TRUE.
|
gname
| The name of the object group for which you want to generate support.
|
master_list
| A comma-separated list of master sites at which you want to generate replication support. By default, support is generated at all master sites.
|
master_table
| A PL/SQL table of master sites at which you want to generate replication support.
|
Table 12 - 147. Parameters for GENERATE_REPLICATION_TRIGGER
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missingobject
| The given object does not exist as a table in the given schema awaiting row-level replication information or as a procedure or package (body) awaiting wrapper generation.
|
notquiesced
| The replicated object group has not been suspended.
|
commfailure
| At least one master site is not accessible.
|
notcompat
| For pre-release 7.3 snapshot sites, you must set GEN_REP2_TRIGGER TRUE.
|
Table 12 - 148. Exceptions for GENERATE_REPLICATION_TRIGGER
DBMS_REPCAT.MAKE_COLUMN_GROUP
Purpose
To create a new column group with one or more members. You must call this procedure from the master definition site. For additional information, refer to page 6 - 22.
Syntax
The parameters for the MAKE_COLUMN_GROUP procedure are described in Table 12 - 149, and the exceptions are listed in Table 12 - 150. The syntax for this procedure is shown below:
DBMS_REPCAT.MAKE_COLUMN_GROUP(
sname IN VARCHAR2,
oname IN VARCHAR2,
column_group IN VARCHAR2,
list_of_column_names IN VARCHAR2)
Parameter
| Description
|
sname
| The schema in which the replicated table is located.
|
oname
| The name of the replicated table for which you are creating a new column group.
|
column_group
| The name that you want assigned to the column group that you are creating.
|
list_of_column_names
| The names of the columns that you are grouping. This can either be a comma-separated list or a PL/SQL table of column names. The PL/SQL table must be of type dbms_repcat.varchar2s. Use the single value `*' to create a column group that contains all of the columns in your table.
|
Table 12 - 149. Parameters for MAKE_COLUMN_GROUP
Exception
| Description
|
nonmasterdef
| The invocation site is not the masterdef site.
|
duplicategroup
| The given column group already exists for the table.
|
missingobject
| The given table does not exist.
|
missingcolumn
| The given column does not exist in the designated table.
|
duplicatecolumn
| The given column is already a member of another column group.
|
Table 12 - 150. Exceptions for MAKE_COLUMN_GROUP
DBMS_REPCAT.PURGE_MASTER_LOG
Purpose
To remove local messages in the RepCatLog associated with a given identification number, source, or replicated object group. For additional information, refer to page 7 - 11.
Syntax
The parameters for the PURGE_MASTER_LOG procedure are described in Table 12 - 151, and the exception is listed in Table 12 - 152. If any parameter is NULL, Oracle treats it as a wildcard. The syntax for this procedure is shown below:
DBMS_REPCAT.PURGE_MASTER_LOG( id IN NATURAL,
source IN VARCHAR2,
gname IN VARCHAR2)
Parameter
| Description
|
id
| The identification number of the request, as it appears in the RepCatLog view.
|
source
| The master site from which the request originated.
|
gname
| The name of the replicated object group for which the request was made.
|
Table 12 - 151. Parameters for PURGE_MASTER_LOG
Exception
| Description
|
nonmaster
| GNAME is not NULL and the invocation site is not a master site.
|
Table 12 - 152. Exception for PURGE_MASTER_LOG
DBMS_REPCAT.PURGE_STATISTICS
Purpose
To remove information from the RepResolution_Statistics view. For additional information, refer to page 7 - 9.
Syntax
The parameters for the PURGE_STATISTICS procedure are described in Table 12 - 153, and the exceptions are listed in Table 12 - 154. The syntax for this procedure is shown below:
DBMS_REPCAT.PURGE_STATISTICS( sname IN VARCHAR2,
oname IN VARCHAR2,
start_date IN DATE,
end_date IN DATE)
Parameter
| Description
|
sname
| The name of the schema in which the replicated table is located.
|
oname
| The name of the table whose conflict resolution statistics you want to purge.
|
start_date/
end_date
| The range of dates for which you want to purge statistics. If START_DATE is NULL, purge all statistics up to the END_DATE. If END_DATE is NULL, purge all statistics after the START_DATE.
|
Table 12 - 153. Parameters for PURGE_STATISTICS
Exception
| Description
|
missingschema
| The given schema does not exist.
|
missingobject
| The given table does not exist.
|
Table 12 - 154. Exceptions for PURGE_STATISTICS
DBMS_REPCAT.REFRESH_SNAPSHOT_REPGROUP
Purpose
To refresh a snapshot site object group with the most recent data from its associated master site. For additional information, refer to page 5 - 20.
Syntax
The parameters for the REFRESH_SNAPSHOT_REPGROUP procedure are described in Table 12 - 155, and the exceptions are listed in Table 12 - 156. The syntax for this procedure is shown below:
DBMS_REPCAT.REFRESH_SNAPSHOT_REPGROUP(
gname IN VARCHAR2,
drop_missing_contents IN BOOLEAN := FALSE,
refresh_snapshots IN BOOLEAN := FALSE,
refresh_other_objects IN BOOLEAN := FALSE
execute_as_user IN BOOLEAN := FALSE)
Parameter
| Description
|
gname
| The name of the replicated object group.
|
drop_missing_contents
| If an object was dropped from the replicated object group, it is not automatically dropped from the schema at the snapshot site. It is simply no longer replicated; that is, changes to this object are no longer sent to its associated master site. Snapshots can continue to be refreshed from their associated master tables; however, any changes to an updatable snapshot will be lost. When an object is dropped from the object group, you can choose to have it dropped from the schema entirely by setting this argument to TRUE.
|
refresh_snapshots
| Set this parameter to TRUE to refresh the contents of the snapshots in the replicated object group.
|
refresh_other_objects
| Set this parameter to TRUE to refresh the contents of the non-snapshot objects in the replicated object group.
|
execute_as_user
| The default, FALSE, indicates that a deferred call is authenticated at the remote system using the authentication context of the user who originally queued the deferred call (as indicated in the ORIGIN_USER column of the DefTran view). Set this to TRUE if you want the execution of a deferred call to be authenticated at the remote system using the authentication context of the session user.
|
Table 12 - 155. Parameters for REFRESH_SNAPSHOT_REPGROUP
Exception
| Description
|
nonsnapshot
| The invocation site is not a snapshot site.
|
nonmaster
| The master is no longer a master site.
|
commfailure
| The master is not accessible.
|
Table 12 - 156. Exceptions for REFRESH_SNAPSHOT_REPGROUP
DBMS_REPCAT.REGISTER_STATISTICS
Purpose
To collect information about the successful resolution of update, delete and uniqueness conflicts for a table. For additional information, refer to page 7 - 8.
Syntax
The parameters for the REGISTER_STATISTICS procedure are described in Table 12 - 157, and the exceptions are listed in Table 12 - 158. The syntax for this procedure is shown below:
DBMS_REPCAT.REGISTER_STATISTICS( sname IN VARCHAR2,
oname IN VARCHAR2)
Parameter
| Description
|
sname
| The name of the schema in which the table is located.
|
oname
| The name of the table for which you want to gather conflict resolution statistics.
|
Table 12 - 157. Parameters for REGISTER_STATISTICS
Exception
| Description
|
missingschema
| The given schema does not exist.
|
missingobject
| The given table does not exist.
|
Table 12 - 158. Exceptions for REGISTER_STATISTICS
DBMS_REPCAT.RELOCATE_MASTERDEF
Purpose
To change your master definition site to another master site in your replicated environment. For additional information, refer to page 7 - 7.
Syntax
The parameters for the RELOCATE_MASTERDEF procedure are described in Table 12 - 159, and the exceptions are listed in Table 12 - 160. The syntax for this procedure is shown below:
DBMS_REPCAT.RELOCATE_MASTERDEF(
gname IN VARCHAR2,
old_masterdef IN VARCHAR2,
new_masterdef IN VARCHAR2,
notify_masters IN BOOLEAN := TRUE,
include_old_masterdef IN BOOLEAN := TRUE)
Parameter
| Description
|
gname
| The name of the object group whose master definition you want to relocate.
|
old_masterdef
| The fully qualified database name of the current master definition site.
|
new_masterdef
| The fully qualified database name of the existing master site that you want to make the new master definition site.
|
notify_masters
| If NOTIFY_MASTERS is TRUE, the procedure synchronously multicasts the change to all masters (including OLD_MASTERDEF only if INCLUDE_OLD_MASTERDEF is TRUE). If any master does not make the change, rollback the changes at all masters.
|
include_old_
masterdef
| If NOTIFY_MASTERS is TRUE and INCLUDE_OLD_MASTERDEF is also TRUE, the old master definition site is also notified of the change.
|
Table 12 - 159. Parameters for RELOCATE_MASTERDEF
Exception
| Description
|
nonmaster
| NEW_MASTERDEF is not a master site or the invocation site is not a master site.
|
nonmasterdef
| OLD_MASTERDEF is not the master definition site.
|
commfailure
| At least one master site is not accessible and NOTIFY_MASTERS is TRUE.
|
Table 12 - 160. Exceptions for RELOCATE_MASTERDEF
Usage Notes
It is not necessary for either the old or new master definition site to be available when you call RELOCATE_MASTERDEF. In a planned reconfiguration, you should invoke RELOCATE_MASTERDEF with NOTIFY_MASTERS TRUE and INCLUDE_OLD_MASTERDEF TRUE. If just the master definition site fails, you should invoke RELOCATE_MASTERDEF with NOTIFY_MASTERS TRUE and INCLUDE_OLD_MASTERDEF FALSE. If several master sites and the master definition site fail, the administrator should invoke RELOCATE_MASTERDEF at each operational master with NOTIFY_MASTERS FALSE.
DBMS_REPCAT.REMOVE_MASTER_DATABASES
Purpose
To remove one or more master databases from a replicated environment. This procedure regenerates the triggers and their associated packages at the remaining master sites. You must call this procedure from the master definition site. For additional information, refer to page 4 - 47.
Syntax
The parameters for the REMOVE_MASTER_DATABASES procedure are described in Table 12 - 161, and the exceptions are listed in Table 12 - 162. The syntax for this procedure is shown below:
DBMS_REPCAT.REMOVE_MASTER_DATABASES(
gname IN VARCHAR2,
master_list IN VARCHAR2 |
master_table IN DBMS_UTILITY.DBLINK_ARRAY)
Parameter
| Description
|
gname
| The name of the object group associated with the replicated environment. This prevents confusion if a master database is involved in more than one replicated environment.
|
master_list
| A comma-separated list of fully qualified master database names that you want to remove from the replicated environment. There must be no extra whitespace between names in the list.
|
master_table
| In place of a list, you may also specify the database names in a PL/SQL table of type DBMS_UTILITY.DBLINK_ARRAY.
|
Table 12 - 161. Parameters for REMOVE_MASTER_DATABASES
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
nonmaster
| At least one of the given databases is not a master site.
|
reconfigerror
| One of the given databases is the master definition site.
|
commfailure
| At least one remaining master site is not accessible.
|
Table 12 - 162. Exceptions for REMOVE_MASTER_DATABASES
DBMS_REPCAT.REPCAT_IMPORT_CHECK
Purpose
To ensure that the objects in the replicated object group have the appropriate object identifiers and status values after you perform an export/import of a replicated object or an object used by the symmetric replication facility. For additional information, refer to page 7 - 14.
Syntax
The parameters for the REPCAT_IMPORT_CHECK procedure are described in Table 12 - 163, and the exceptions are listed in Table 12 - 164. The syntax for this procedure is shown below:
DBMS_REPCAT.REPCAT_IMPORT_CHECK(
gname IN VARCHAR2,
master IN BOOLEAN := TRUE)
Parameter
| Description
|
gname
| The name of the replicated object group. If you omit both parameters, the procedure checks all replicated object groups at your current site.
|
master
| Set this flag to TRUE if you are checking a master site or FALSE if you are checking a snapshot site.
|
Table 12 - 163. Parameters for REPCAT_IMPORT_CHECK
Exception
| Description
|
nonmaster
| MASTER is TRUE and either the database is not a master site for the schema or the database is not the expected database.
|
nonsnapshot
| MASTER is FALSE and the database is not a snapshot site for the schema.
|
missingobject
| A valid replicated object in the schema does not exist.
|
Table 12 - 164. Exceptions for REPCAT_IMPORT_CHECK
DBMS_REPCAT.RESUME_MASTER_ACTIVITY
Purpose
To resume normal replication activity after quiescing a replicated environment. For additional information, refer to page 4 - 44.
Syntax
The parameters for the RESUME_MASTER_ACTIVITY procedure are described in Table 12 - 165, and the exceptions are listed in Table 12 - 166. The syntax for this procedure is shown below:
DBMS_REPCAT.RESUME_MASTER_ACTIVITY(
gname IN VARCHAR2,
override IN BOOLEAN := FALSE)
Parameter
| Description
|
gname
| The name of the replicated object group.
|
override
| If override is TRUE, it ignores any pending RepCat administration requests and restores normal replication activity at each master as quickly as possible. This should be considered only in emergency situations. If override is FALSE, it restores normal replication activity at each master only when there is no pending RepCat administration request for GNAME at that master.
|
Table 12 - 165. Parameters for RESUME_MASTER_ACTIVITY
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
notquiesced
| The replicated object group is not quiescing or quiesced.
|
commfailure
| At least one master site is not accessible.
|
Table 12 - 166. Exceptions for RESUME_MASTER_ACTIVITY
DBMS_REPCAT.SET_COLUMNS
Purpose
To use an alternate column or group of columns, instead of the primary key, to determine which columns to compare when using row-level replication. You must call this procedure from the master definition site. For additional information, refer to page 4 - 16.
Syntax
The parameters for the SET_COLUMNS procedure are described in Table 12 - 167, and the exceptions are listed in Table 12 - 168. The syntax for this procedure is shown below:
DBMS_REPCAT.SET_COLUMNS(
sname IN VARCHAR2,
oname IN VARCHAR2,
column_list IN VARCHAR2 |
column_table IN DBMS_UTILITY.NAME_ARRAY)
Parameter
| Description
|
sname
| The schema in which the table is located.
|
oname
| The name of the table for which you will generate replication support.
|
column_list
| A comma-separated list of the columns in the table that you want to use as a "primary key". There must be no whitespace between entries.
|
column_table
| Instead of a list, you can use a PL/SQL table of type DBMS_UTILITY.NAME_ARRAY to contain the column names. The first column name should be at offset 1, the second at offset 2, and so on.
|
Table 12 - 167. Parameters for SET_COLUMNS
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
missingobject
| The given object does not exist as a table in the given schema awaiting row-level replication information.
|
missingcolumn
| At least one column is not in the table
|
Table 12 - 168. Exceptions for SET_COLUMNS
DBMS_REPCAT.SUSPEND_MASTER_ACTIVITY
Purpose
To suspend replication activity for an object group. You must call this procedure from the master definition site. For additional information, refer to page 4 - 43.
Note: The current implementation of SUSPEND_MASTER_ACTIVITY quiesces all replicated object groups at each master site.
Syntax
The parameter for the SUSPEND_MASTER_ACTIVITY procedure is described in Table 12 - 169, and the exceptions are listed in Table 12 - 170. The syntax for this procedure is shown below:
DBMS_REPCAT.SUSPEND_MASTER_ACTIVITY(
gname IN VARCHAR2
execute_as_user IN BOOLEAN => FALSE)
Parameter
| Description
|
gname
| The name of the object group for which you want to suspend activity.
|
execute_as_user
| The default, FALSE, indicates that a deferred call is authenticated at the remote system using the authentication context of the user who originally queued the deferred call (as indicated in the ORIGIN_USER column of the DefTran view). Set this to TRUE if you want the execution of a deferred call to be authenticated at the remote system using the authentication context of the session user.
|
Table 12 - 169. Parameter for SUSPEND_MASTER_ACTIVITY
Exception
| Description
|
nonmasterdef
| The invocation site is not the master definition site.
|
notnormal
| The replicated object group is not in normal operation.
|
commfailure
| At least one master site is not accessible.
|
missingobjectgroup
| The given object group does not exist.
|
Table 12 - 170. Exceptions for SUSPEND_MASTER_ACTIVITY
DBMS_REPCAT.SWITCH_SNAPSHOT_MASTER
Purpose
To change the master database of a snapshot replicated object group to another master site. This procedure does a full refresh of the affected snapshots and regenerates the triggers and their associated packages as needed. This procedure does not push the queue to the old master site before changing masters. For additional information, refer to
page 7 - 7.
Syntax
The parameters for the SWITCH_SNAPSHOT_MASTER procedure are described in Table 12 - 171, and the exceptions are listed in Table 12 - 172. The syntax for this procedure is shown below:
DBMS_REPCAT.SWITCH_SNAPSHOT_MASTER(
gname IN VARCHAR2,
master IN VARCHAR2
execute_as_user IN BOOLEAN := FALSE)
Parameter
| Description
|
gname
| The name of the snapshot object group for which you want to change master sites.
|
master
| The fully qualified database name of the new master database to use for the snapshot site.
|
execute_as_user
| The default, FALSE, indicates that a deferred call is authenticated at the remote system using the authentication context of the user who originally queued the deferred call (as indicated in the ORIGIN_USER column of the DefTran view). Set this to TRUE if you want the execution of a deferred call to be authenticated at the remote system using the authentication context of the session user.
|
Table 12 - 171. Parameters for SWITCH_SNAPSHOT_MASTER
Exception
| Description
|
nonsnapshot
| The invocation site is not a snapshot site.
|
nonmaster
| The given database is not a master site.
|
commfailure
| The given database is not accessible.
|
Table 12 - 172. Exceptions for SWITCH_SNAPSHOT_MASTER
DBMS_REPCAT.WAIT_MASTER_LOG
Purpose
To determine if changes that were asynchronously propagated to a master site have been applied. For additional information, refer to page 7 - 9.
Syntax
The parameters for the WAIT_MASTER_LOG procedure are described in Table 12 - 173, and the exception is listed in Table 12 - 174. The syntax for this procedure is shown below:
DBMS_REPCAT.WAIT_MASTER_LOG(
gname IN VARCHAR2,
record_count IN NATURAL,
timeout IN NATURAL,
true_count OUT NATURAL)
Parameter
| Description
|
gname
| The name of the replicated object group.
|
record_count
| The procedure returns whenever the number of incomplete activities is at or below this threshold.
|
timeout
| The maximum number of seconds to wait before the procedure returns.
|
true_count
(out parameter)
| Returns the number of incomplete activities.
|
Table 12 - 173. Parameters for WAIT_MASTER_LOG
Exception
| Description
|
nonmaster
| The invocation site is not a master site.
|
Table 12 - 174. Exception for WAIT_MASTER_LOG
DBMS_REPCAT_ADMIN.GRANT_ADMIN_ANY_REPGROUP
Purpose
To grant the necessary privileges to the replication administrator to administer any replicated object group at the current site. For additional information, refer to page 4 - 4.
Syntax
The parameter for the GRANT_ADMIN_ANY_REPGROUP procedure is described in Table 12 - 175, and the exception is listed in Table 12 - 176. The syntax for this procedure is shown below:
DBMS_REPCAT_ADMIN.GRANT_ADMIN_ANY_REPGROUP(
userid IN VARCHAR2)
Parameter
| Description
|
userid
| The name of the replication administrator to whom you want to grant the necessary privileges and roles to administer any replicated object groups at the current site.
|
Table 12 - 175. Parameter for GRANT_ADMIN_ANY_REPGROUP
Exception
| Description
|
ORA-01917
| The user does not exist.
|
Table 12 - 176. Exception for GRANT_ADMIN_ANY_REPGROUP
DBMS_REPCAT_ADMIN.GRANT_ADMIN_REPGROUP
Purpose
To grant the necessary privileges to the replication administrator to administer a schema at the current site. This procedure is most useful if your object group does not span schemas. For additional information, refer to page 4 - 4.
Syntax
The parameter for the GRANT_ADMIN_REPGROUP procedure is described in Table 12 - 177, and the exception is listed in Table 12 - 178. The syntax for this procedure is shown below:
DBMS_REPCAT_ADMIN.GRANT_ADMIN_REPGROUP(userid IN VARCHAR2)
Parameter
| Description
|
userid
| The name of the replication administrator. This user is then granted the necessary privileges and roles to administer the schema of the same name within a replicated object group at the current site.
|
Table 12 - 177. Parameter for GRANT_ADMIN_GROUP
Exception
| Description
|
ORA-01917
| The user does not exist.
|
Table 12 - 178. Exception for GRANT_ADMIN_GROUP
DBMS_REPCAT_ADMIN.REVOKE_ADMIN_ANY_REPGROUP
Purpose
To revoke the privileges and roles from the replication administrator that would be granted by GRANT_ADMIN_ANY_REPGROUP. For additional information, refer to page 4 - 4.
Attention: Identical privileges and roles that were granted independently of GRANT_ADMIN_ANY_REPGROUP are also revoked.
Syntax
The parameter for the REVOKE_ADMIN_ANY_REPGROUP procedure is described in Table 12 - 179, and the exception is listed in Table 12 - 180. The syntax for this procedure is shown below:
DBMS_REPCAT_ADMIN.REVOKE_ADMIN_ANY_REPGROUP(
userid IN VARCHAR2)
Parameter
| Description
|
userid
| The name of the replication administrator whose privileges you want to revoke.
|
Table 12 - 179. Parameter for REVOKE_ADMIN_ANY_REPGROUP
Exception
| Description
|
ORA-01917
| The user does not exist.
|
Table 12 - 180. Exception for REVOKE_ADMIN_ANY_REPGROUP
DBMS_REPCAT_ADMIN.REVOKE_ADMIN_REPGROUP
Purpose
To revoke the privileges and roles from the replication administrator that would be granted by GRANT_ADMIN_REPGROUP. For additional information, refer to page 4 - 4.
Attention: Identical privileges and roles that were granted independently of GRANT_ADMIN_REPGROUP are also revoked.
Syntax
The parameter for the REVOKE_ADMIN_REPGROUP procedure is described in Table 12 - 181, and the exception is listed in Table 12 - 182. The syntax for this procedure is shown below:
DBMS_REPCAT_ADMIN.REVOKE_ADMIN_REPGROUP(userid IN VARCHAR2)
Parameter
| Description
|
userid
| The name of the replication administrator whose privileges you want to revoke.
|
Table 12 - 181. Parameter for REVOKE_ADMIN_REPGROUP
Exception
| Description
|
ORA-01917
| The user does not exist.
|
Table 12 - 182. Exception for REVOKE_ADMIN_ANY_REPGROUP
DBMS_REPCAT_AUTH.GRANT_SURROGATE_REPCAT
Purpose
To grant the privileges needed by the symmetric replication facility to a user. For additional information, refer to page 4 - 7.
Syntax
The parameter for the GRANT_SURROGATE_REPCAT procedure is described in Table 12 - 183, and the exception is listed in Table 12 - 184. The syntax for this procedure is shown below:
DBMS_REPCAT_AUTH.GRANT_SURROGATE_REPCAT(userid IN VARCHAR2)
Parameter
| Description
|
userid
| The name of the user to whom you wish to grant the necessary privileges.
|
Table 12 - 183. Parameter for GRANT_SURROGATE_REPCAT
Exception
| Description
|
ORA-01917
| The user does not exist
|
Table 12 - 184. Exception for GRANT_SURROGATE_REPCAT
DBMS_REPCAT_AUTH.REVOKE_SURROGATE_REPCAT
Purpose
To revoke the privileges granted to the surrogate repcat user. For additional information, refer to page 4 - 7.
Syntax
The parameters for the REVOKE_SURROGATE_REPCAT procedure are described in Table 12 - 185, and the exceptions are listed in Table 12 - 186. The syntax for this procedure is shown below:
DBMS_REPCAT_AUTH.REVOKE_SURROGATE_REPCAT(userid IN VARCHAR2)
Parameter
| Description
|
userid
| The name of the user from whom you wish to revoke the necessary privileges.
|
Table 12 - 185. Parameters for REVOKE_SURROGATE_REPCAT
Exception
| Description
|
ORA-01917
| The user does not exist
|
Table 12 - 186. Exception for REVOKE_SURROGATE_REPCAT
DBMS_REPUTIL.REPLICATION_OFF
Purpose
To modify tables without replicating the modifications to any other sites in the replicated environment, or to disable row-level replication when using procedural replication. You should generally quiesce your replicated environment before setting this flag. For additional information, refer to page 8 - 18.
Syntax
The syntax for the REPLICATION_OFF procedure is shown below. This procedure takes no arguments.
DBMS_REPUTIL.REPLICATION_OFF
DBMS_REPUTIL.REPLICATION_ON
Purpose
To re-enable the replication of changes after it has been temporarily suspended by calling REPLICATION_OFF. For additional information, refer to page 8 - 19.
Syntax
The syntax for the REPLICATION_ON procedure is shown below. This procedure takes no arguments.
DBMS_REPUTIL.REPLICATION_ON
DBMS_SNAPSHOT.I_AM_A_REFRESH
Purpose
To return the value of the I_AM_REFRESH package state. For additional information, refer to page 8 - 20.
Syntax
The I_AM_A_REFRESH function takes no arguments. A return value of TRUE indicates that all local replication triggers for snapshots will be effectively disabled in this session because each replication trigger first checks this state. A return value of FALSE indicates that these triggers are enabled. The syntax for this procedure is shown below.
DBMS_SNAPSHOT.I_AM_A_REFRESH RETURN BOOLEAN
DBMS_SNAPSHOT.PURGE_LOG
Purpose
To purge rows from the snapshot log. For additional information, refer to page 3 - 12.
Syntax
The parameters for the PURGE_LOG procedure are described in Table 12 - 187. The syntax for this procedure is shown below:
DBMS_SNAPSHOT.PURGE_LOG(
master IN VARCHAR2,
num IN BINARY_INTEGER DEFAULT 1
flag IN VARCHAR2 DEFAULT 'NOP')
parameter
| description
|
master
| Name of the master table.
|
num
| Number of least recently refreshed snapshots whose rows you want to remove from snapshot log. For example, the following statement deletes rows needed to refresh the two least recently refreshed snapshots:
EXECUTE dbms_snapshot.purge_log('master_table', 2);
To delete all rows in the snapshot log, indicate a high number of snapshots to disregard, as in this example:
EXECUTE dbms_snapshot.purge_log('master_table', 9999);
This statement completely purges the snapshot log that corresponds to MASTER_TABLE if fewer than 9999 snapshots are based on MASTER_TABLE. A simple snapshot whose rows have been purged from the snapshot log must be completely refreshed the next time it is refreshed.
|
flag
| Specify DELETE to guarantee that rows are deleted from the snapshot log for at least one snapshot. This argument can override the setting for the argument NUM. For example, the following statement deletes rows from the least recently refreshed snapshot that actually has dependent rows in the snapshot log:
EXECUTE dbms_snapshot.purge_log('master_table', 0, 'DELETE');
|
Table 12 - 187. Parameters for DBMS_SNAPSHOT.PURGE_LOG
DBMS_SNAPSHOT.REFRESH
Purpose
To consistently refresh one or more snapshots that are not members of the same refresh group. For additional information, refer to page 3 - 20.
Syntax
The parameters for the REFRESH procedure are described in Table 12 - 188. The syntax for this procedure is shown below:
DBMS_SNAPSHOT.REFRESH(
list IN VARCHAR2,
method IN VARCHAR2 DEFAULT NULL,
rollback_seg IN VARCHAR2 DEFAULT NULL,
push_deferred_rpc IN BOOLEAN DEFAULT TRUE,
refresh_after_errors IN BOOLEAN DEFAULT FALSE)
parameter
| description
|
list
| Comma-separated list of snapshots that you want to refresh. (Synonyms are not supported.) These snapshots can be located in different schemas and have different master tables; however, all of the listed snapshots must be in your current database. Alternatively, you may pass in a PL/SQL table of type DBMS_UTILITY.UNCL_ARRAY, where each element is the name of a snapshot.
|
method
| Type of refresh to perform for each snapshot listed; `F' or `f' indicates a fast refresh, `C' or `c' indicates a complete refresh, and `?' indicates a default refresh. If you specified a refresh mode when you created the snapshot, that mode is used when you specify a default refresh. If no mode was specified, Oracle performs a fast refresh if possible; otherwise, it performs a complete refresh. If the METHOD list contains fewer elements than the snapshot LIST, the trailing elements in the snapshot list are refreshed using a default refresh. For example, the following EXECUTE statement within SQL*Plus:
EXECUTE dbms_snapshot.refresh('emp, dept,
scott.salary', 'CF');
performs a complete refresh of the EMP snapshot, a fast refresh of the DEPT snapshot, and a default refresh of the SCOTT.SALARY snapshot.
|
rollback_seg
| Name of the snapshot site rollback segment to use while refreshing snapshots.
When you call REFRESH, all of the listed snapshots are updated to a single point in time. If the refresh fails for any of the snapshots, none of the snapshots are updated.
|
push_deferred_rpc
| Used by updatable snapshots only. Use the default value, TRUE, if you want to push changes from the snapshot to its associated master before refreshing the snapshot. Otherwise, these changes may appear to be temporarily lost.
|
refresh_after_errors
| Used by updatable snapshots only. Set this parameter to TRUE if you want the refresh to proceed even if there are outstanding conflicts logged in the DefError view for the snapshot's master.
|
Table 12 - 188. Parameters for DBMS_SNAPSHOT.REFRESH
DBMS_SNAPSHOT.SET_I_AM_A_REFRESH
Purpose
To set the I_AM_REFRESH package state to the appropriate value. For additional information, refer to page 8 - 20.
Syntax
The parameter for the SET_I_AM_A_REFRESH procedure is described in Table 12 - 189. The syntax for this procedure is shown below.
DBMS_SNAPSHOT.SET_I_AM_A_REFRESH(value IN BOOLEAN)
parameter
| description
|
value
| Value that you want to set the I_AM_A_REFRESH package state to. If this state is set to TRUE, all local replication triggers for snapshots will be effectively disabled in this session because each replication trigger first checks this state. If this state is set to FALSE, these triggers will be enabled.
|
Table 12 - 189. Parameters for DBMS_SNAPSHOT.SET_I_AM_A_REFRESH
Package Variables
Table 12 - 190 describes the package variables that are used by the symmetric replication facility. You may need to check the value of one or more of these variables in your own packages or triggers.
variable
| type
| description
|
schema.rep$what_am_i.
i_am_a_snapshot
| BOOLEAN
| TRUE indicates that the local site is a snapshot site for the replicated object group. If the local site is a master site for the replicated object group, this variable is FALSE.
|
dbms_reputil.
replication_is_on
| BOOLEAN
| TRUE indicates that the generated replication triggers are enabled. FALSE indicates that replication is disabled at the current site for the replicated object group. This variable is set by calling the REPLICATION_ON or REPLICATION_OFF procedures in the DBMS_REPUTIL package.
|
dbms_reputil.
from_remote
| BOOLEAN
| This variable is set to TRUE at the beginning of procedures in the $RP replication packages, and is set to FALSE at the end of these procedures. You may need to check this variable if you have any triggers that could be fired as the result of an update by a $RP package.
|
dbms_reputil.
global_name
| VARCHAR2(128)
| This variable contains the global database name of the local database.
|
Table 12 - 190. Replication Package Variables