98 DBMS_HEAT_MAP_ADMIN

The DBMS_HEAT_MAP_ADMIN package provides administrative interfaces for managing Heat Map settings in the database, such as configuring retention time and enabling or disabling heat map tracking. This package is intended for database administrators who need to control how Heat Map data is collected and maintained.

This chapter contains the following topics:

See Also:

98.1 DBMS_HEAT_MAP_ADMIN Overview

The DBMS_HEAT_MAP_ADMIN package provides an interface to configure and manage Heat Map data retention in the database.

The DBMS_HEAT_MAP_ADMIN package provides subprograms to manage Heat Map data retention in the database. Heat Map tracks data modification activity for ILM. Using this package, you can specify how long Heat Map data is retained before being automatically deleted by the background Heat Map delete service. By setting an appropriate retention period, you can optimize storage usage and ensure that Heat Map tables do not grow indefinitely.

The package includes procedures and functions to set and retrieve the retention time. The background delete service is disabled by default and is enabled automatically when a valid retention period is specified.

98.2 DBMS_HEAT_MAP_ADMIN Security Model

The EXECUTE privilege on the DBMS_HEAT_MAP_ADMIN package is required to use its subprograms.

By default, this privilege is granted to the DBA role. Users who need to modify Heat Map retention settings must have this privilege directly or through a role that inherits it.

98.3 Summary of DBMS_HEAT_MAP_ADMIN Subprograms

This table lists and briefly describes the DBMS_HEAT_MAP_ADMIN package subprograms.

Table 98-1 DBMS_HEAT_MAP_ADMIN Package Subprograms

Subprogram Description

GET_RETENTION_TIME Function

Returns the current retention time value for Heat Map data in days.

SET_RETENTION_TIME Procedure

Enables the background Heat Map delete service and sets the number of days that Heat Map data is retained.

98.3.1 GET_RETENTION_TIME Function

This function returns the current retention time value for Heat Map data in days.

Syntax 

DBMS_HEAT_MAP_ADMIN.GET_RETENTION_TIME
   RETURN NUMBER;

Return Value

Returns the Heat Map retention time in days.
  • The default value is 4,294,967,295, indicating that background Heat Map delete service is disabled.
  • If a valid retention time has been set using SET_RETENTION_TIME, this function returns that value.

Usage Notes

  • Use this function to verify the current Heat Map retention time configuration.
  • When the service is disabled, the returned value can be used as confirmation before enabling retention.

98.3.2 SET_RETENTION_TIME Procedure

This procedure enables the background Heat Map delete service and sets the number of days that Heat Map data is retained.

Syntax 

DBMS_HEAT_MAP_ADMIN.SET_RETENTION_TIME (
   days IN NUMBER);

Parameters

Table 98-2 SET_RETENTION_TIME Procedure Parameters

Parameter Description

days

Specifies the number of days to retain Heat Map data. Valid values range from 1 to 4,294,967,294. A value of 4,294,967,295 disables the background Heat Map delete service. Invalid values (negative, 0, or NULL) raise an INVALID_ARGUMENT_VALUE error.