22
DBMS_REPCAT_INSTANTIATE

DBMS_REPCAT_INSTANTIATE package instantiates deployment templates.

This chapter discusses the following topics:

Summary of DBMS_REPCAT_INSTANTIATE Subprograms

Summary of DBMS_REPCAT_INSTANTIATE Subprograms

Table 22-1 DBMS_REPCAT_INSTANTIATE Package Subprograms

Subprogram	Description
DROP_SITE_INSTANTIATION Procedure	Public procedure that removes the target site from the `DBA_REPCAT_TEMPLATE_SITES` view.
INSTANTIATE_OFFLINE Function	Public function that generates a script at the master site that is used to create the materialized view environment at the remote materialized view site while offline.
INSTANTIATE_ONLINE Function	Public function that generates a script at the master site that is used to create the materialized view environment at the remote materialized view site while online.

DROP_SITE_INSTANTIATION Procedure

This procedure drops a template instantiation at a target site. This procedure removes all related metadata at the master site and disables the specified site from refreshing its materialized views. You must execute this procedure as the user who originally instantiated the template. To see who instantiated the template, query the ALL_REPCAT_TEMPLATE_SITES view.

Syntax

DBMS_REPCAT_INSTANTIATE.DROP_SITE_INSTANTIATION(
     refresh_template_name  IN   VARCHAR2,
     site_name              IN   VARCHAR2);

Table 22-2 DROP_SITE_INSTANTIATION Procedure Parameters

Parameter	Description
refresh_template_name	The name of the deployment template to be dropped.
site_name	Identifies the master site where you want to drop the specified template instantiation.

INSTANTIATE_OFFLINE Function

This function generates a file at the master site that is used to create the materialized view environment at the remote materialized view site while offline. This generated file is an offline instantiation file and should be used at remote materialized view sites that are not able to remain connected to the master site for an extended amount of time.

This is an ideal solution when the remote materialized view site is a laptop. Use the packaging interface in the Replication Management tool to package the generated file and data into a single file that can be posted on an FTP site or loaded to a CD-ROM, floppy disk, and so on.

The script generated by this function is stored in the USER_REPCAT_TEMP_OUTPUT temporary view and is used by several Oracle tools, including the Replication Management tool, during the distribution of deployment templates. The number returned by this function is used to retrieve the appropriate information from the USER_REPCAT_TEMP_OUTPUT view.

The user who executes this public function becomes the "registered" user of the instantiated template at the specified site.

Note:

This function is used in performing an offline instantiation of a deployment template.

This function should not be confused with the procedures in the DBMS_OFFLINE_OG package (used for performing an offline instantiation of a master table) or with the procedures in the DBMS_OFFLINE_SNAPSHOT package (used for performing an offline instantiation of a materialized view). See these respective packages for more information on their usage.

See Also:

"Packaging a Deployment Template for Instantiation"
Oracle9i Replication
The Replication Management tool's online help

Syntax

DBMS_REPCAT_INSTANTIATE.INSTANTIATE_OFFLINE(
     refresh_template_name   IN   VARCHAR2,
     site_name               IN   VARCHAR2, 
     runtime_parm_id         IN   NUMBER    := -1e-130,
     next_date               IN   DATE      := SYSDATE,
     interval                IN   VARCHAR2  := 'SYSDATE + 1',
     use_default_gowner      IN   BOOLEAN   := true)
     return NUMBER;

Table 22-3 INSTANTIATE_OFFLINE Function Parameters

Parameter	Description
refresh_template_name	The name of the deployment template to be instantiated.
site_name	The name of the remote site that is instantiating the deployment template.
runtime_parm_id	If you have defined runtime parameter values using the `INSERT_RUNTIME_PARMS` procedure, specify the identification used when creating the runtime parameters (the identification was retrieved by using the `GET_RUNTIME_PARM_ID` function).
next_date	The next refresh date value to be used when creating the refresh group.
interval	The refresh interval to be used when creating the refresh group.
use_default_gowner	If `true`, then any materialized view groups created are owned by the default user `PUBLIC`. If `false`, then any materialized view groups created are owned by the user performing the instantiation.

Exceptions

Table 22-4 INSTANTIATE_OFFLINE Function Exceptions

Exception	Description
miss_refresh_template	The deployment template name specified is invalid or does not exist.
dupl_template_site	The deployment template has already been instantiated at the materialized view site. A deployment template can be instantiated only once at a particular materialized view site.
not_authorized	The user attempting to instantiate the deployment template is not authorized to do so.

Returns

Table 22-5 INSTANTIATE_OFFLINE Function Returns

Return Value	Description
<system-generated number>	Specifies the generated system number for the `output_id` when you select from the `USER_REPCAT_TEMP_OUTPUT` view to retrieve the generated instantiation script.

INSTANTIATE_ONLINE Function

This function generates a script at the master site that is used to create the materialized view environment at the remote materialized view site while online. This generated script should be used at remote materialized view sites that are able to remain connected to the master site for an extended amount of time, as the instantiation process at the remote materialized view site may be lengthy (depending on the amount of data that is populated to the new materialized views).

The user who executes this public function becomes the "registered" user of the instantiated template at the specified site.

See Also:

"Packaging a Deployment Template for Instantiation"
Oracle9i Replication
The Replication Management tool's online help

Syntax

DBMS_REPCAT_INSTANTIATE.INSTANTIATE_ONLINE(
     refresh_template_name   IN   VARCHAR2,
     site_name               IN   VARCHAR2, 
     runtime_parm_id         IN   NUMBER    := -1e-130,
     next_date               IN   DATE      := SYSDATE,
     interval                IN   VARCHAR2  := 'SYSDATE + 1',
     use_default_gowner      IN   BOOLEAN   := true)
     return NUMBER;

Table 22-6 INSTANTIATE_ONLINE Function Parameters

Parameter	Description
refresh_template_name	The name of the deployment template to be instantiated.
site_name	The name of the remote site that is instantiating the deployment template.
runtime_parm_id	If you have defined runtime parameter values using the `INSERT_RUNTIME_PARMS` procedure, specify the identification used when creating the runtime parameters (the identification was retrieved by using the `GET_RUNTIME_PARM_ID` function).
next_date	Specifies the next refresh date value to be used when creating the refresh group.
interval	Specifies the refresh interval to be used when creating the refresh group.
use_default_gowner	If `true`, then any materialized view groups created are owned by the default user `PUBLIC`. If `false`, then any materialized view groups created are owned by the user performing the instantiation.

Exceptions

Table 22-7 INSTANTIATE_ONLINE Function Exceptions

Exception	Description
miss_refresh_template	The deployment template name specified is invalid or does not exist.
dupl_template_site	The deployment template has already been instantiated at the materialized view site. A deployment template can be instantiated only once at a particular materialized view site.
not_authorized	The user attempting to instantiate the deployment template is not authorized to do so.

Returns

Table 22-8 INSTANTIATE_ONLINE Function Returns

Return Value	Description
<system-generated number>	Specifies the generated system number for the output_id when you select from the `USER_REPCAT_TEMP_OUTPUT` view to retrieve the generated instantiation script.

22 DBMS_REPCAT_INSTANTIATE

Summary of DBMS_REPCAT_INSTANTIATE Subprograms

Table 22-1 DBMS_REPCAT_INSTANTIATE Package Subprograms

DROP_SITE_INSTANTIATION Procedure

Syntax

Table 22-2 DROP_SITE_INSTANTIATION Procedure Parameters

INSTANTIATE_OFFLINE Function

Syntax

Table 22-3 INSTANTIATE_OFFLINE Function Parameters

Exceptions

Table 22-4 INSTANTIATE_OFFLINE Function Exceptions

Returns

Table 22-5 INSTANTIATE_OFFLINE Function Returns

INSTANTIATE_ONLINE Function

Syntax

Table 22-6 INSTANTIATE_ONLINE Function Parameters

Exceptions

Table 22-7 INSTANTIATE_ONLINE Function Exceptions

Returns

Table 22-8 INSTANTIATE_ONLINE Function Returns

22
DBMS_REPCAT_INSTANTIATE