DBMS_ROWID , 2 of 2

Summary of DBMS_ROWID Subprograms

Table 62-1 DBMS_ROWID Subprograms

Subprogram	Description
ROWID_CREATE Function	Creates a `ROWID`, for testing only.
ROWID_INFO Procedure	Returns the type and components of a `ROWID`.
ROWID_TYPE Function	Returns the `ROWID` type: 0 is restricted, 1 is extended.
ROWID_OBJECT Function	Returns the object number of the extended `ROWID`.
ROWID_RELATIVE_FNO Function	Returns the file number of a `ROWID`.
ROWID_BLOCK_NUMBER Function	Returns the block number of a `ROWID`.
ROWID_ROW_NUMBER Function	Returns the row number.
ROWID_TO_ABSOLUTE_FNO Function	Returns the absolute file number associated with the `ROWID` for a row in a specific table.
ROWID_TO_EXTENDED Function	Converts a `ROWID` from restricted format to extended.
ROWID_TO_RESTRICTED Function	Converts an extended `ROWID` to restricted format.
ROWID_VERIFY Function	Checks if a `ROWID` can be correctly extended by the `ROWID_TO_EXTENDED` function.

ROWID_CREATE Function

This function lets you create a ROWID, given the component parts as parameters.

This is useful for testing ROWID operations, because only the Oracle Server can create a valid ROWID that points to data in a database.

Syntax

DBMS_ROWID.ROWID_CREATE (
   rowid_type    IN NUMBER, 
   object_number IN NUMBER,
   relative_fno  IN NUMBER,
   block_number  IN NUMBER,
   row_number    IN NUMBER) 
  RETURN ROWID;

Pragmas

pragma RESTRICT_REFERENCES(rowid_create,WNDS,RNDS,WNPS,RNPS);

Parameters

Table 62-2 ROWID_CREATE Function Parameters

Parameter	Description
rowid_type	Type (restricted or extended). Set the `rowid_type` parameter to 0 for a restricted `ROWID`. Set it to 1 to create an extended `ROWID`. If you specify `rowid_type` as 0, then the required `object_number` parameter is ignored, and `ROWID_CREATE` returns a restricted `ROWID`.
object_number	Data object number (`rowid_object_undefined` for restricted).
relative_fno	Relative file number.
block_number	Block number in this file.
file_number	File number in this block.

Example

Create a dummy extended ROWID:

   my_rowid := DBMS_ROWID.ROWID_CREATE(1, 9999, 12, 1000, 13);

Find out what the rowid_object function returns:

   obj_number := DBMS_ROWID.ROWID_OBJECT(my_rowid);

The variable obj_number now contains 9999.

ROWID_INFO Procedure

This procedure returns information about a ROWID, including its type (restricted or extended), and the components of the ROWID. This is a procedure, and it cannot be used in a SQL statement.

Syntax

DBMS_ROWID.ROWID_INFO (
   rowid_in         IN   ROWID,
   rowid_type       OUT  NUMBER,
   object_number    OUT  NUMBER,
   relative_fno     OUT  NUMBER,
   block_number     OUT  NUMBER,
   row_number       OUT  NUMBER);

Pragmas

   pragma RESTRICT_REFERENCES(rowid_info,WNDS,RNDS,WNPS,RNPS);

Parameters

Table 62-3 ROWID_INFO Procedure Parameters

Parameter	Description
rowid_in	`ROWID` to be interpreted. This determines if the `ROWID` is a restricted (0) or extended (1) `ROWID`.
rowid_type	Returns type (restricted/extended).
object_number	Returns data object number (`rowid_object_undefined` for restricted).
relative_fno	Returns relative file number.
block_number	Returns block number in this file.
file_number	Returns file number in this block.

See Also:

"ROWID_TYPE Function"

Example

This example reads back the values for the ROWID that you created in the ROWID_CREATE:

DBMS_ROWID.ROWID_INFO(my_rowid, rid_type, obj_num,
  file_num, block_num, row_num);

DBMS_OUTPUT.PUT_LINE('The type is ' || rid_type);
DBMS_OUTPUT.PUT_LINE('Data object number is ' || obj_num);
-- and so on...

ROWID_TYPE Function

This function returns 0 if the ROWID is a restricted ROWID, and 1 if it is extended.

Syntax

DBMS_ROWID.ROWID_TYPE (
   rowid_id IN ROWID)
  RETURN NUMBER;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_type,WNDS,RNDS,WNPS,RNPS);

Parameters

Table 62-4 ROWID_TYPE Function Parameters

Parameter	Description
row_id	`ROWID` to be interpreted.

Example

IF DBMS_ROWID.ROWID_TYPE(my_rowid) = 1 THEN
   my_obj_num := DBMS_ROWID.ROWID_OBJECT(my_rowid);

ROWID_OBJECT Function

This function returns the data object number for an extended ROWID. The function returns zero if the input ROWID is a restricted ROWID.

Syntax

DBMS_ROWID.ROWID_OBJECT (
   rowid_id IN ROWID)
  RETURN NUMBER;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_object,WNDS,RNDS,WNPS,RNPS);

Parameters

Table 62-5 ROWID_OBJECT Function Parameters

Parameter	Description
row_id	`ROWID` to be interpreted.

Note:

The ROWID_OBJECT_UNDEFINED constant is returned for restricted ROWIDs.

Example

SELECT dbms_rowid.rowid_object(ROWID)
   FROM emp
   WHERE empno = 7499;

ROWID_RELATIVE_FNO Function

This function returns the relative file number of the ROWID specified as the IN parameter. (The file number is relative to the tablespace.)

Syntax

DBMS_ROWID.ROWID_RELATIVE_FNO (
   rowid_id IN ROWID)
  RETURN NUMBER;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_relative_fno,WNDS,RNDS,WNPS,RNPS);

Parameters

Table 62-6 ROWID_RELATIVE_FNO Function Parameters

Parameter	Description
row_id	`ROWID` to be interpreted.

Example

The example PL/SQL code fragment returns the relative file number:

DECLARE
   file_number    INTEGER;
   rowid_val      ROWID;
BEGIN
   SELECT ROWID INTO rowid_val
     FROM dept 
     WHERE loc = 'Boston';
   file_number :=
     dbms_rowid.rowid_relative_fno(rowid_val);
    ...

ROWID_BLOCK_NUMBER Function

This function returns the database block number for the input ROWID.

Syntax

DBMS_ROWID.ROWID_BLOCK_NUMBER (
   row_id IN ROWID)
  RETURN NUMBER;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_block_number,WNDS,RNDS,WNPS,RNPS);

Parameters

Table 62-7 ROWID_BLOCK_NUMBER Function Parameters

Parameter	Description
row_id	`ROWID` to be interpreted.

Example

The example SQL statement selects the block number from a ROWID and inserts it into another table:

INSERT INTO T2 (SELECT dbms_rowid.rowid_block_number(ROWID)
   FROM some_table 
   WHERE key_value = 42);

ROWID_ROW_NUMBER Function

This function extracts the row number from the ROWID IN parameter.

Syntax

DBMS_ROWID.ROWID_ROW_NUMBER (
   row_id IN ROWID)
  RETURN NUMBER;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_row_number,WNDS,RNDS,WNPS,RNPS);

Parameters

Table 62-8 ROWID_ROW_NUMBER Function Parameters

Parameter	Description
row_id	`ROWID` to be interpreted.

Example

Select a row number:

SELECT dbms_rowid.rowid_row_number(ROWID) 
   FROM emp
   WHERE ename = 'ALLEN';

ROWID_TO_ABSOLUTE_FNO Function

This function extracts the absolute file number from a ROWID, where the file number is absolute for a row in a given schema and table. The schema name and the name of the schema object (such as a table name) are provided as IN parameters for this function.

Syntax

DBMS_ROWID.ROWID_TO_ABSOLUTE_FNO (
   row_id      IN ROWID,
   schema_name IN VARCHAR2,
   object_name IN VARCHAR2)
  RETURN NUMBER;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_to_absolute_fno,WNDS,WNPS,RNPS);

Parameters

Table 62-9 ROWID_TO_ABSOLUTE_FNO Function Parameters

Parameter	Description
row_id	`ROWID` to be interpreted.
schema_name	Name of the schema which contains the table.
object_name	Table name.

Example

DECLARE
   abs_fno        INTEGER;
   rowid_val      CHAR(18);
   object_name    VARCHAR2(20) := 'EMP';
BEGIN
    SELECT ROWID INTO rowid_val 
     FROM emp
     WHERE empno = 9999;
     abs_fno := dbms_rowid.rowid_to_absolute_fno(
     rowid_val, 'SCOTT', object_name);

Note:

For partitioned objects, the name must be a table name, not a partition or a sub/partition name.

ROWID_TO_EXTENDED Function

This function translates a restricted ROWID that addresses a row in a schema and table that you specify to the extended ROWID format. Later, it may be removed from this package into a different place.

Syntax

DBMS_ROWID.ROWID_TO_EXTENDED (
   old_rowid       IN ROWID,
   schema_name     IN VARCHAR2,   
   object_name     IN VARCHAR2,
   conversion_type IN INTEGER)
  RETURN ROWID;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_to_extended,WNDS,WNPS,RNPS);

Parameters

Table 62-10 ROWID_TO_EXTENDED Function Parameters

Parameter	Description
old_rowid	`ROWID` to be converted.
schema_name	Name of the schema which contains the table (optional).
object_name	Table name (optional).
conversion_type	`rowid_convert_internal`/`external_convert_external` (whether `old_rowid` was stored in a column of `ROWID` type, or the character string).

Returns

ROWID_TO_EXTENDED returns the ROWID in the extended character format. If the input ROWID is NULL, then the function returns NULL. If a zero-valued ROWID is supplied (00000000.0000.0000), then a zero-valued restricted ROWID is returned.

Example

Assume that there is a table called RIDS in the schema SCOTT, and that the table contains a column ROWID_COL that holds ROWIDs (restricted), and a column TABLE_COL that point to other tables in the SCOTT schema. You can convert the ROWIDs to extended format with the statement:

UPDATE SCOTT.RIDS
   SET rowid_col =
   dbms_rowid.rowid_to_extended (
      rowid_col, 'SCOTT", TABLE_COL, 0);

Usage Notes

If the schema and object names are provided as IN parameters, then this function verifies SELECT authority on the table named, and converts the restricted ROWID provided to an extended ROWID, using the data object number of the table. That ROWID_TO_EXTENDED returns a value, however, does not guarantee that the converted ROWID actually references a valid row in the table, either at the time that the function is called, or when the extended ROWID is actually used.

If the schema and object name are not provided (are passed as NULL), then this function attempts to fetch the page specified by the restricted ROWID provided. It treats the file number stored in this ROWID as the absolute file number. This can cause problems if the file has been dropped, and its number has been reused prior to the migration. If the fetched page belongs to a valid table, then the data object number of this table is used in converting to an extended ROWID value. This is very inefficient, and Oracle recommends doing this only as a last resort, when the target table is not known. The user must still know the correct table name at the time of using the converted value.

If an extended ROWID value is supplied, the data object number in the input extended ROWID is verified against the data object number computed from the table name parameter. If the two numbers do not match, the INVALID_ROWID exception is raised. If they do match, the input ROWID is returned.

See Also:

The ROWID_VERIFY Function has a method to determine if a given ROWID can be converted to the extended format.

ROWID_TO_RESTRICTED Function

This function converts an extended ROWID into restricted ROWID format.

Syntax

DBMS_ROWID.ROWID_TO_RESTRICTED (
   old_rowid       IN ROWID,
   conversion_type IN INTEGER)
  RETURN ROWID;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_to_restricted,WNDS,RNDS,WNPS,RNPS);

Parameters

Table 62-11 ROWID_TO_RESTRICTED Function Parameters

Parameter Description

old_rowid

ROWID to be converted.

conversion_type

Internal or external - format of returned ROWID.

rowid_convert_internal/external_convert_external (whether returned ROWID will be stored in a column of ROWID type or the character string)

ROWID_VERIFY Function

This function verifies the ROWID. It returns 0 if the input restricted ROWID can be converted to extended format, given the input schema name and table name, and it returns 1 if the conversion is not possible.

Note:

You can use this function in a WHERE clause of a SQL statement, as shown in the example.

Syntax

DBMS_ROWID.ROWID_VERIFY (
   rowid_in        IN ROWID,
   schema_name     IN VARCHAR2,
   object_name     IN VARCHAR2,
   conversion_type IN INTEGER
  RETURN NUMBER;

Pragmas

   pragma RESTRICT_REFERENCES(rowid_verify,WNDS,WNPS,RNPS);

Parameters

Table 62-12 ROWID_VERIFY Function Parameters

Parameter	Description
rowid_in	`ROWID` to be verified.
schema_name	Name of the schema which contains the table.
object_name	Table name.
conversion_type	`rowid_convert_internal`/`external_convert_external` (whether `old_rowid` was stored in a column of `ROWID` type or the character string).

Example

Considering the schema in the example for the ROWID_TO_EXTENDED function, you can use the following statement to find bad ROWIDs prior to conversion. This enables you to fix them beforehand.

SELECT ROWID, rowid_col 
   FROM SCOTT.RIDS
   WHERE dbms_rowid.rowid_verify(rowid_col, NULL, NULL, 0) =1;