Summary of DBMS_RESUMABLE Subprograms

Table 60-1 DBMS_RESUMABLE Subprograms

Subprogram	Description
ABORT Procedure	Aborts a suspended resumable space allocation.
GET_SESSION_TIMEOUT Function	Returns the current timeout value of the resumable space allocations for a session with session_id.
SET_SESSION_TIMEOUT Procedure	Sets the timeout of resumable space allocations for a session with session_id.
GET_TIMEOUT Function	Returns the current timeout value of resumable space allocations for the current session.
SET_TIMEOUT Procedure	Sets the timeout of resumable space allocations for the current session.
SPACE_ERROR_INFO Function	Looks for space-related errors in the error stack. If it cannot find a space-related error, it will return FALSE.

ABORT Procedure

This procedure aborts a suspended resumable space allocation. The parameter session_id is the session ID in which the statement is executed. For a parallel DML/DDL, session_id is any session ID that participates in the parallel DML/DDL. This operation is guaranteed to succeed. The procedure can be called either inside or outside of the AFTER SUSPEND trigger.

To call an ABORT procedure, you must be the owner of the session with session_id, have ALTER SYSTEM privileges, or be a DBA.

Syntax

DBMS_RESUMABLE.ABORT (
   session_id  IN NUMBER);

Parameters

Table 60-2 ABORT Procedure Parameters

Parameter	Description
session_id	The session identifier of the resumable space allocation.

GET_SESSION_TIMEOUT Function

This function returns the current timeout value of resumable space allocations for a session with session_id. The timeout is returned in seconds. If session_id does not exist, the GET_SESSION_TIMEOUT function returns -1.

Syntax

DBMS_RESUMABLE.GET_SESSION_TIMEOUT (
   session_id  IN NUMBER);

Parameters

Table 60-3 GET_SESSION_TIMEOUT Function Parameters

Parameter	Description
session_id	The session identifier of the resumable space allocation.

SET_SESSION_TIMEOUT Procedure

This procedure sets the timeout of resumable space allocations for a session with session_id. The timeout is returned in seconds. The new timeout setting applies to the session immediately. If session_id does not exist, no operation occurs.

Syntax

DBMS_RESUMABLE.SET_SESSION_TIMEOUT (
   session_id  IN NUMBER,
   timeout     IN NUMBER);

Parameters

Table 60-4 SET_SESSION_TIMEOUT Procedure Parameters

Parameter	Description
session_id	The session identifier of the resumable space allocation.
timeout	The timeout of the resumable space allocation.

GET_TIMEOUT Function

This function returns the current timeout value of resumable space allocations for the current session. The returned value is in seconds. If session_id does not exist, the GET_TIMEOUT function returns -1.

Syntax

DBMS_RESUMABLE.GET_TIMEOUT;

SET_TIMEOUT Procedure

This procedure sets the timeout of resumable space allocations for the current session. The timeout is returned in seconds. The new timeout setting applies to the session immediately. If session_id does not exist, no operation occurs.

Syntax

DBMS_RESUMABLE.SET_TIMEOUT (
   timeout  IN NUMBER);

Parameters

Table 60-5 SET_TIMEOUT Procedure Parameters

Parameter	Description
timeout	The timeout of the resumable space allocation.

SPACE_ERROR_INFO Function

This function looks for space-related errors in the error stack. If it cannot find a space related error, it will return FALSE. Otherwise, TRUE is returned and information about the particular object that causes the space error is returned.

Syntax

DBMS_RESUMABLE.SPACE_ERROR_INFO
   error_type        OUT VARCHAR2, 
   object_type       OUT VARCHAR2, 
   object_owner      OUT VARCHAR2, 
   table_space_name  OUT VARCHAR2, 
   object_name       OUT VARCHAR2, 
   sub_object_name   OUT VARCHAR2) 
return boolean;

Parameters

Table 60-6 SPACE_ERROR_INFO Function Parameters

Parameter	Description
error_type	The space error type. It will be one of the following: NO MORE SPACE MAX EXTENTS REACHED SPACE QUOTA EXCEEDED
object_type	The object type. It will be one of the following: TABLE SPACE ROLLBACK SEGMENT UNDO SEGMENT TABLE INDEX CLUSTER TEMP SEGMENT INDEX PARTITION TABLE PARTITION LOB SEGMENT TABLE SUBPARTITION INDEX SUBPARTITION LOB SUBPARTITION
object_owner	The owner of the object. NULL if it cannot be determined.
table_space_name	The table space where the object resides. NULL if it cannot be determined.
object_name	The name of rollback segment, temp segment, table, index, or cluster.
sub_object_name	The partition name or sub-partition name of LOB, TABLE, or INDEX. NULL if it cannot be determined.