1 package dbms_ilm_admin authid definer
2 as
3
4 /*
5 * Parameters for controling ILM execution
6 */
7
8 EXECUTION_INTERVAL constant number := 1;
9 RETENTION_TIME constant number := 2;
10 EXECUTION_MODE constant number := 4;
11 JOBLIMIT constant number := 5;
12 ENABLED constant number := 7;
13 TBS_PERCENT_USED constant number := 8;
14 TBS_PERCENT_FREE constant number := 9;
15 DEG_PARALLEL constant number := 10;
16 POLICY_TIME constant number := 11;
17 ABS_JOBLIMIT constant number := 12;
18 JOB_SIZELIMIT constant number := 13;
19
20 /*
21 * Constants for parameter values
22 */
23
24 /* ILM Execution mode constants */
25 ILM_EXECUTION_OFFLINE constant number := 1;
26 ILM_EXECUTION_ONLINE constant number := 2;
27 ILM_EXECUTION_DEFAULT constant number := 3;
28
29 ILM_ENABLED constant number := 1;
30 ILM_DISABLED constant number := 2;
31
32 ILM_LIMIT_DEF constant number := 2;
33
34 ILM_POLICY_IN_DAYS constant number := 0;
35 ILM_POLICY_IN_SECONDS constant number := 1;
36
37 /* ADO execution data is purged periodically for all completed jobs
38 * older then the ILM_RETENTION_TIME */
39 ILM_RETENTION_TIME constant number := 30;
40
41 /* Denote default value for the parameter*/
42 ILM_DEFAULT constant number := -1;
43
44 /*
45 * description - Customize environment for ILM execution by specifying
46 * the values for ILM execution related parameters. These
47 * values take effect for the next background ILM execution
48 *
49 * parameter - One of the constants defined in this package
50 * value - Value of this parameter.
51 */
52 procedure customize_ilm(
53 parameter number,
54 value in number);
55
56 /* Procedure to turn off background ILM */
57 procedure disable_ilm;
58
59 /* Procedure to turn on background ILM */
60 procedure enable_ilm;
61
62 /* Heat map segment access constants */
63 HEAT_MAP_SEG_WRITE constant number := 1;
64 HEAT_MAP_SEG_READ constant number := 2;
65 HEAT_MAP_SEG_SCAN constant number := 4;
66 HEAT_MAP_SEG_LOOKUP constant number := 8;
67
68 /* Procedure to delete all rows except the dummy row. */
69 procedure clear_heat_map_all;
70
71 /* Procedure to Update/insert heat map rows for all tables */
72 procedure set_heat_map_all(
73 access_date IN DATE,
74 segment_access_summary IN number);
75
76 /* Procedure to update/insert a row for this table/segment. */
77 procedure set_heat_map_table(
78 owner IN VARCHAR2,
79 tablename IN VARCHAR2,
80 partition IN VARCHAR2 default '',
81 access_date IN DATE,
82 segment_access_summary IN number);
83
84 /*
85 * Procedure to clear all/some statistics for table: deletes rows for
86 * given table/segment which match given pattern or all such rows
87 */
88 procedure clear_heat_map_table(
89 owner IN VARCHAR2,
90 tablename IN VARCHAR2,
91 partition IN VARCHAR2 default '',
92 access_date IN DATE default NULL,
93 segment_access_summary IN number default NULL);
94
95 /*
96 * Procedure to set start date of heat map data
97 */
98 procedure set_heat_map_start(start_date IN DATE);
99
100
101 /* exceptions:
102 *
103 * dbms_ilm_admin api operations can raise any one of the following
104 * top-level exceptions.
105 *
106 */
107
108 /* insufficient privileges */
109 insufficient_privileges exception;
110 pragma exception_init(insufficient_privileges, -38330);
111
112 /* invalid arugment value */
113 invalid_argument_value exception;
114 pragma exception_init(invalid_argument_value, -38327);
115
116 /* invalid dictionary state */
117 invalid_ilm_dictionary exception;
118 pragma exception_init(invalid_ilm_dictionary, -38328);
119
120 /* ADO online mode unsupported with Supplemental Logging */
121 unsupported_ilm_supl exception;
122 pragma exception_init(unsupported_ilm_supl, -38343);
123
124 end dbms_ilm_admin;