Common Subprograms for LCR$_ROW_RECORD and LCR$_DDL_RECORD

The following functions and procedures are common to both the LCR$_ROW_RECORD and LCR$_DDL_RECORD type.

Table 108-26 Summary of Common Subprograms for Row and DDL Types 

Subprogram	Description
"GET_COMMAND_TYPE Member Function"	Returns the command type of the LCR
"GET_OBJECT_NAME Member Function"	Returns the name of the object that is changed by the LCR
"GET_OBJECT_OWNER Member Function"	Returns the owner of the object that is changed by the LCR
"GET_SCN Member Function"	Returns the system change number (SCN) of the LCR
"GET_SOURCE_DATABASE_NAME Member Function"	Returns the source database name.
"GET_TAG Member Function"	Returns the tag for the LCR
"GET_TRANSACTION_ID Member Function"	Returns the transaction identifier of the LCR
"IS_NULL_TAG Member Function"	Returns Y if the tag for the LCR is NULL, or returns N if the tag for the LCR is not NULL
"SET_COMMAND_TYPE Member Procedure"	Sets the command type
"SET_OBJECT_NAME Member Procedure"	Sets the name of the object that is changed by the LCR
"SET_OBJECT_OWNER Member Procedure"	Sets the owner of the object that is changed by the LCR
"SET_SOURCE_DATABASE_NAME Member Procedure"	Sets the source database name of the object that is changed by the LCR
"SET_TAG Member Procedure"	Sets the tag for the LCR

GET_COMMAND_TYPE Member Function

Returns the command type of the LCR.

Syntax

MEMBER FUNCTION GET_COMMAND_TYPE RETURN VARCHAR2;

GET_OBJECT_NAME Member Function

Returns the name of the object that is changed by the LCR.

Syntax

MEMBER FUNCTION GET_OBJECT_NAME RETURN VARCHAR2;

GET_OBJECT_OWNER Member Function

Returns the owner of the object that is changed by the LCR.

Syntax

MEMBER FUNCTION GET_OBJECT_OWNER RETURN VARCHAR2;

GET_SCN Member Function

Returns the system change number (SCN) of the LCR.

Syntax

MEMBER FUNCTION GET_SCN RETURN NUMBER;

GET_SOURCE_DATABASE_NAME Member Function

Returns the global name of the source database name. The source database is the database where the change occurred.

Syntax

MEMBER FUNCTION GET_SOURCE_DATABASE_NAME RETURN VARCHAR2;

GET_TAG Member Function

Returns the tag for the LCR. An LCR tag is a binary tag that enables tracking of the LCR. For example, this tag may be used to determine the original source database of the DML or DDL change when apply forwarding is used.

Syntax

MEMBER FUNCTION GET_TAG RETURN RAW;

GET_TRANSACTION_ID Member Function

Returns the transaction identifier of the LCR.

Syntax

MEMBER FUNCTION GET_TRANSACTION_ID RETURN VARCHAR2;

IS_NULL_TAG Member Function

Returns Y if the tag for the LCR is NULL, or returns N if the tag for the LCR is not NULL.

Syntax

MEMBER FUNCTION IS_NULL_TAG RETURN VARCHAR2;

SET_COMMAND_TYPE Member Procedure

Sets the command type. If the command type specified cannot be interpreted, then an error is raised. For example, changing INSERT to GRANT would raise an error.

Syntax

MEMBER PROCEDURE SET_COMMAND_TYPE(
   command_type    IN VARCHAR2);

Parameter

Table 108-27 SET_COMMAND_TYPE Procedure Parameter

Parameter	Description
command_type	The command type. This parameter should be set to a non-NULL value.

SET_OBJECT_NAME Member Procedure

Sets the name of the object that is changed by the LCR.

Syntax

MEMBER PROCEDURE SET_OBJECT_NAME(
   object_name     IN VARCHAR2);

Parameter

Table 108-28 SET_OBJECT_NAME Procedure Parameter

Parameter	Description
object_name	The name of the object

SET_OBJECT_OWNER Member Procedure

Sets the owner of the object that is changed by the LCR.

Syntax

MEMBER PROCEDURE SET_OBJECT_OWNER(
   object_owner IN VARCHAR2);

Parameter

Table 108-29 SET_OBJECT_OWNER Procedure Parameter

Parameter	Description
object_owner	The schema that contains the object

SET_SOURCE_DATABASE_NAME Member Procedure

Sets the source database name of the object that is changed by the LCR.

Syntax

MEMBER PROCEDURE SET_SOURCE_DATABASE_NAME(
   source_database_name       IN VARCHAR2);

Parameter

Table 108-30 SET_SOURCE_DATABASE_NAME Procedure Parameter

Parameter	Description
source_database_name	The source database of the change. If you do not include the domain name, then the local domain is appended to the database name automatically. For example, if you specify DBS1 and the local domain is .NET, then DBS1.NET is specified automatically. This parameter should be set to a non-NULL value.

SET_TAG Member Procedure

Sets the tag for the LCR. An LCR tag is a binary tag that enables tracking of the LCR. For example, this tag may be used to determine the original source database of the change when apply forwarding is used.

Syntax

MEMBER PROCEDURE SET_TAG(
   tag        IN RAW);

Parameter

Table 108-31 SET_TAG Procedure Parameter

Parameter	Description
tag	The binary tag for the LCR. The size limit for a tag value is two kilobytes.