DBA Data[Home] [Help]

PACKAGE: APPS.HR_DATA_PUMP

Source


1 package hr_data_pump AUTHID CURRENT_USER as
2 /* $Header: hrdpump.pkh 120.1 2006/01/05 11:14:13 arashid noship $ */
3 /*
4   Notes
5   o This package holds definition for the Data Pump engine.
6     The procedures in this package are public but should not be
7     called directly.  Concurrent manager definitions exist to
8     allow Data Pump to be run via the manager.
9 */
10 g_disable_lookup_checks boolean := false;
11 
12 /*---------------------------------------------------------------------------*/
13 /*------------------------ public logging procedures ------------------------*/
14 /*---------------------------------------------------------------------------*/
15 /*
16  *  These procedures are designed specifically to implement parts
17  *  of the Data Pump logging strategy.  They are complemented by
18  *  other, private procedures.  These particular ones are declared
19  *  public so they can be called from within Meta Mapper generated
20  *  and get_id function calls, where appropriate.
21  */
22 
23 ------------------------------------ entry ------------------------------------
24 /*
25   NAME
26     entry
27   DESCRIPTION
28     This logs an entry message.
29   NOTES
30     Logging procedure to flag entry to procedure.
31 */
32 
33 procedure entry
34 (
35    p_procedure_name in varchar2
36 );
37 
38 ------------------------------------ exit -------------------------------------
39 /*
40   NAME
41     exit
42   DESCRIPTION
43     This logs an exit message.
44   NOTES
45     Logging procedure to flag exit from procedure.
46 */
47 
48 procedure exit
49 (
50    p_procedure_name in varchar2
51 );
52 
53 ---------------------------------- api_trc_on ---------------------------------
54 /*
55   NAME
56     api_trc_on
57   DESCRIPTION
58     This turns tracing on before an API call.
59 */
60 
61 procedure api_trc_on;
62 
63 ---------------------------------- api_trc_off --------------------------------
64 /*
65   NAME
66     api_trc_off
67   DESCRIPTION
68     Turns tracing off after an API call.
69 */
70 
71 procedure api_trc_off;
72 
73 ----------------------------------- message -----------------------------------
74 /*
75   NAME
76     message
77   DESCRIPTION
78     General message logging.
79   NOTES
80     Will log the message text passed to this procedure.
81 */
82 
83 procedure message
84 (
85    p_message varchar2
86 );
87 
88 ------------------------------------- fail ------------------------------------
89 /*
90   NAME
91     fail
92   DESCRIPTION
93     Log failure information.
94   NOTES
95     This logs the failure information text to an internal
96     data structure, which can then be output as necessary.
97 */
98 procedure fail
99 (
100    p_function_name in varchar2,
101    p_error_message in varchar2,
102    p_arg01         in varchar2 default null,
103    p_arg02         in varchar2 default null,
104    p_arg03         in varchar2 default null,
105    p_arg04         in varchar2 default null,
106    p_arg05         in varchar2 default null,
107    p_arg06         in varchar2 default null,
108    p_arg07         in varchar2 default null,
109    p_arg08         in varchar2 default null
110 );
111 pragma restrict_references (fail, WNDS);
112 
113 /*---------------------------------------------------------------------------*/
114 /*------------------------ main interface procedures ------------------------*/
115 /*---------------------------------------------------------------------------*/
116 
117 ---------------------------------- slave --------------------------------------
118 /*
119   NAME
120     slave
121   DESCRIPTION
122     Entry point for slave process.
123   NOTES
124     This procedure should be called via the concurrent manager.
125     Under normal circumstances, it should NOT be called directly.
126 */
127 
128 procedure slave
129 (
130    errbuf              out nocopy varchar2,
131    retcode             out nocopy number,
132    p_business_group_id in  number,
133    p_security_group_id in  number,
134    p_batch_id          in  number,
135    p_max_errors        in  binary_integer,
136    p_validate          in  varchar2 default 'N'
137   ,p_pap_group_id      in  number   default null
138 );
139 
140 ---------------------------------- main ---------------------------------------
141 /*
142   NAME
143     main
144   DESCRIPTION
145     Main entry point for Data Pump engine.
146   NOTES
147     This procedure should be called via the concurrent manager.
148     Under normal circumstances, it should NOT be called directly.
149 */
150 
151 procedure main
152 (
153    errbuf     out nocopy varchar2,
154    retcode    out nocopy number,
155    p_batch_id in  number,
156    p_validate in  varchar2 default 'N'
157   ,p_pap_group_id in  number default null
158 );
159 
160 -------------------------------- purgemain ------------------------------------
161 /*
162   NAME
163     purgemain
164   DESCRIPTION
165     Main entry point for Data Pump purge.
166   NOTES
167     This procedure should be called via the concurrent manager.
168     Under normal circumstances, it should NOT be called directly.
169 */
170 
171 procedure purgemain
172 (errbuf                  out nocopy varchar2
173 ,retcode                 out nocopy number
174 ,p_batch_id           in            number   default null
175 ,p_all_batches        in            varchar2 default 'N'
176 ,p_preserve_user_keys in            varchar2 default 'N'
177 ,p_purge_unprocessed  in            varchar2 default 'Y'
178 ,p_purge_errored      in            varchar2 default 'Y'
179 ,p_purge_completed    in            varchar2 default 'Y'
180 ,p_delete_header      in            varchar2 default 'Y'
181 ,p_pap_group_id       in            number   default null
182 );
183 
184 -------------------------------- purgeslave -----------------------------------
185 /*
186   NAME
187     purgeslave
188   DESCRIPTION
189     Entry point for Data Pump purge slave process.
190   NOTES
191     This procedure should be called via the concurrent manager.
192     Under normal circumstances, it should NOT be called directly.
193 */
194 procedure purgeslave
195 (errbuf                  out nocopy varchar2
196 ,retcode                 out nocopy number
197 ,p_batch_id           in            number   default null
198 ,p_all_batches        in            varchar2 default 'N'
199 ,p_preserve_user_keys in            varchar2 default 'N'
200 ,p_purge_unprocessed  in            varchar2 default 'Y'
201 ,p_purge_errored      in            varchar2 default 'Y'
202 ,p_purge_completed    in            varchar2 default 'Y'
203 ,p_delete_header      in            varchar2 default 'Y'
204 ,p_chunk_size         in            number
205 ,p_thread_number      in            number
206 ,p_threads            in            number
207 ,p_pap_group_id       in            number
208 ,p_lower_bound        in            number
209 ,p_upper_bound        in            number
210 );
211 
212 end hr_data_pump;