Replication Management API Reference, 124 of 179

INSTANTIATE_OFFLINE_REPAPI function

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

This is an ideal solution where the remote snapshot site is a laptop running Oracle8i Lite (which includes RepAPI). The generated file can be posted on an FTP site or loaded to a CD-ROM, floppy disk, and so on.

The file generated by this function is stored at the master site in the directory specified by the parameter OFFLINE_DIRPATH. The file is named based on the USER_NAME, REFRESH_TEMPLATE_NAME, and SITE_ID and is identified with the file type extension .oli. For example, an offline instantiation for the user SCOTT of the template named MYTEMPLATE at site 1234 is named the following:

scott_mytemplate_1234.oli.

This is a public function to generate an offline instantiation file for the connected user.

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 snapshot). See these respective packages for more information on their usage.

Syntax

DBMS_REPCAT_INSTANTIATE.INSTANTIATE_OFFLINE_REPAPI(
  refresh_template_name   IN   VARCHAR2,
  site_id                 IN   VARCHAR2   := NULL,
  master                  IN   VARCHAR2   := NULL,
  url                     IN   VARCHAR2   := NULL,
  ssl                     IN   NUMBER     := 0,
  trace_vector            IN   NUMBER     := DBMS_REPCAT_RGT.NO_TRACE_DUMP,
  resultset_threshold     IN   NUMBER     := DBMS_REPCAT_INSTANTIATE.
                                             RESULTSET_THRESHOLD,
  lob_threshold           IN   NUMBER     := DBMS_REPCAT_INSTANTIATE.
                                             LOB_THRESHOLD);

Table 8-225 INSTANTIATE_OFFLINE_REPAPI Function Parameters (Page 1 of 2)

Parameter	Description
refresh_template_name	The name of the deployment template to be instantiated.
site_id	A temporary name assigned to this offline instantiation. This temporary name is part of the offline instantiation file name. If the default `NULL` value is used, Oracle generates a number for this temporary name. It may be useful to specify a name if you want the offline instantiation file name to indicate its intended snapshot site. The `site_id` must be unique. That is, no two offline instantiation files can have the same `site_id`. This temporary name is always overwritten by the RepAPI client when the deployment template is instantiated. Oracle Corporation recommends that you use the default `NULL` value for this parameter.
master	An optional alias used for the server by the RepAPI client. If specified, then the RepAPI client must always refer to the server by this alias.
url	The published URL at the master site for access to the database. If specified, then the RepAPI client must always refer to the server by this URL.
ssl	1 indicates that the snapshots use secure sockets layer (SSL) to communicate with the master site. 0 indicates that SSL is not used.
trace_vector	The trace level for debugging.
resultset_threshold	The maximum size of non-LOB row data sent during the snapshot refresh process.
lob_threshold	The maximum size of LOB row data sent during the snapshot refresh process.

Table 8-226 INSTANTIATE_OFFLINE_REPAPI Function Exceptions

Exception	Description
miss_refresh_template	The template does not exist.
miss_user	The username does not exist in the database.
miss_template_site	The template has not been instantiated for the user and site.

Returns

Table 8-227 INSTANTIATE_OFFLINE_REPAPI Function Returns

Return Value	Description
0	An error was encountered.
1	No errors were encountered.