[Home] [Help]
PACKAGE: CTXSYS.CTX_OUTPUT
Source
1 package CTX_OUTPUT as
2
3 /* print each ROWID as it is indexed */
4 EVENT_INDEX_PRINT_ROWID constant number := 1;
5
6 /* print tokens as they are indexed by sync or create index */
7 EVENT_INDEX_PRINT_TOKEN constant number := 4;
8
9 /* print tokens as they are optimized */
10 EVENT_OPT_PRINT_TOKEN constant number := 2;
11
12 /* trace DRG errors */
13 EVENT_DRG_DUMP_ERRORSTACK constant number := 8;
14 DRG_DUMP_ALL_ERRORS constant number := -1;
15
16 TRACE_IDX_USER_DATASTORE constant number := 1;
17 TRACE_IDX_INSO_FILTER constant number := 2;
18 TRACE_IDX_AUTO_FILTER constant number := 2;
19 TRACE_QRY_XX_TIME constant number := 3;
20 TRACE_QRY_XF_TIME constant number := 4;
21 TRACE_QRY_X_ROWS constant number := 5;
22 TRACE_QRY_IF_TIME constant number := 6;
23 TRACE_QRY_IR_TIME constant number := 7;
24 TRACE_QRY_I_ROWS constant number := 8;
25 TRACE_QRY_I_SIZE constant number := 9;
26 TRACE_QRY_R_TIME constant number := 10;
27 TRACE_QRY_CON_TIME constant number := 11;
28 TRACE_QRY_K_TIME constant number := 12;
29 TRACE_QRY_S_TIME constant number := 15;
30 TRACE_QRY_O_TIME constant number := 19;
31 TRACE_QRY_OR_TIME constant number := 20;
32 TRACE_QRY_O_ROWS constant number := 21;
33 TRACE_QRY_O_SIZE constant number := 22;
34 TRACE_QRY_D_TIME constant number := 23;
35 TRACE_QRY_SUBSTR_TIME constant number := 24;
36 TRACE_QRY_SNIPPET_TIME constant number := 25;
37 TRACE_HIL_DOCSERV_TIME constant number := 26;
38 TRACE_QRY_FACET_TOT_TIME constant number := 27;
39 TRACE_QRY_FACET_INI_TIME constant number := 28;
40 TRACE_QRY_FACET_EXC_TIME constant number := 29;
41 TRACE_QRY_FACET_OUT_TIME constant number := 30;
42 TRACE_QRY_MVTOK_ROWS constant number := 31;
43 TRACE_QRY_MVTOK_SIZE constant number := 32;
44 TRACE_CTXTREE_GETDS_TIME constant number := 33;
45 TRACE_CTXTREE_ADDND_TIME constant number := 34;
46 TRACE_CTXTREE_GETND_TIME constant number := 35;
47 TRACE_CTXTREE_REMND_TIME constant number := 36;
48 TRACE_QRY_VV_TIME constant number := 37;
49 TRACE_QRY_VF_TIME constant number := 38;
50 TRACE_QRY_V_ROWS constant number := 39;
51
52 -- 0, 13, 14, 16-18 reserved for internal use
53
54 /*------------------------------- start_log ---------------------------------*/
55 /*
56 NAME
57 start_log - begin logging index and document service requests
58
59 DESCRIPTION
60
61 ARGUMENTS
62 logfile (IN) logfile name
63 overwrite (IN) overwrite existing log file if any (default is TRUE)
64
65 RETURNS
66 none
67
68 NOTES
69 */
70
71 procedure start_log(
72 logfile in varchar2,
73 overwrite in boolean DEFAULT true
74 );
75 /*------------------------------- start_query_log --------------------------*/
76 /*
77 NAME
78 start_query_log - begin logging query against context index
79
80 DESCRIPTION
81
82 ARGUMENTS
83 logfile (IN) logfile name
84 overwrite (IN) overwrite existing log file if any (default is TRUE)
85
86 RETURNS
87 none
88
89 NOTES
90 */
91
92 procedure start_query_log(
93 logfile in varchar2,
94 overwrite in boolean DEFAULT true
95 );
96
97 /*------------------------------- add_event -------------------------------*/
98 /*
99 NAME
100 add_event - add an event to the logging event list
101
102 DESCRIPTION
103
104 ARGUMENTS
105 event (IN) event number
106
107 RETURNS
108 none
109
110 NOTES
111 */
112
113 procedure add_event(
114 event in number,
115 errnum in number := null
116 );
117
118 /*------------------------------- remove_event ----------------------------*/
119 /*
120 NAME
121 remove_event - remove an event from the logging event list
122
123 DESCRIPTION
124
125 ARGUMENTS
126 event (IN) event number
127
128 RETURNS
129 none
130
131 NOTES
132 */
133
134 procedure remove_event(
135 event in number,
136 errnum in number := null
137 );
138
139 /*------------------------------- end_log ---------------------------------*/
140 /*
141 NAME
142 end_log - halt logging index and document service requests
143
144 DESCRIPTION
145
146 ARGUMENTS
147
148 RETURNS
149 none
150
151 NOTES
152 */
153
154 procedure end_log;
155
156 /*------------------------------- end_query_log -----------------------------*/
157 /*
158 NAME
159 end_query_log - halt query logging
160
161 DESCRIPTION
162
163 ARGUMENTS
164
165 RETURNS
166 none
167
168 NOTES
169 */
170
171 procedure end_query_log;
172
173
174 /*---------------------------- logfilename ---------------------------------*/
175 /*
176 NAME
177 logfilename - returns the current log file name
178
179 DESCRIPTION
180
181 ARGUMENTS
182
183 RETURNS
184 log file name
185
186 NOTES
187 */
188 function logfilename return varchar2;
189
190 /*-------------------------- logfileoverwrite -------------------------------*/
191 /*
192 NAME
193 logfileoverwrite - returns the current overwrite setting
194
195 DESCRIPTION
196
197 ARGUMENTS
198
199 RETURNS
200 log file overwrite setting
201
202 NOTES
203 */
204 function logfileoverwrite return boolean;
205
206 /*-------------------------- dumpederrors -----------------------------------*/
207 /*
208 NAME
209 dumpederrors - returns an array of all current errors with stack traces
210 DESCRIPTION
211
212 ARGUMENTS
213
214 RETURNS
215 dumped errors array
216
217 NOTES
218 */
219 function dumpederrors return dr$numtable;
220
221 /*---------------------------- add_trace ---------------------------------*/
222 /*
223 NAME
224 add_trace - enable trace specfied in the trace_id argument
225
226 DESCRIPTION
227
228 ARGUMENTS
229
230 RETURNS
231
232 NOTES
233 */
234 procedure add_trace(trace_id binary_integer);
235
236 /*-------------------------- remove_trace ---------------------------------*/
237 /*
238 NAME
239 remove_trace - disable trace specfied in the trace_id argument
240
241 DESCRIPTION
242
243 ARGUMENTS
244
245 RETURNS
246
247 NOTES
248 */
249 procedure remove_trace(trace_id binary_integer);
250
251 /*-------------------------- reset_trace --------------------------------*/
252 /*
253 NAME
254 reset_trace - reset trace specfied in the trace_id argument
255
256 DESCRIPTION
257 resets the specified trace to 0.
258
259 ARGUMENTS
260
261 RETURNS
262
263 NOTES
264 */
265 procedure reset_trace(trace_id binary_integer);
266
267 /*--------------------------- log_traces ---------------------------------*/
268 /*
269 NAME
270 log_traces - dumps all active traces to the logfile
271
272 DESCRIPTION
273
274 ARGUMENTS
275
276 RETURNS
277
278 NOTES
279 the traces are NOT reset to 0.
280 */
281 procedure log_traces;
282
283 /*---------------------- get_trace_value ---------------------------------*/
284 /*
285 NAME
286 get_trace_value - returns the current value of the specified trace
287
288 DESCRIPTION
289
290 ARGUMENTS
291
292 RETURNS
293
294 NOTES
295 the traces are NOT reset to 0.
296 */
297 function get_trace_value(trace_id binary_integer) return number;
298
299 /*-------------------------- enable_query_stats -----------------------------*/
300 /*
301 NAME
302 enable_query_stats - enables query stats collection
303
304 DESCRIPTION
305
306 ARGUMENTS
307
308 RETURNS
309
310 NOTES
311
312 */
313 procedure enable_query_stats(indexname varchar2);
314 PRAGMA SUPPLEMENTAL_LOG_DATA(enable_query_stats, AUTO);
315
316 /*-------------------------- disable_query_stats ---------------------------*/
317 /*
318 NAME
319 disable_query_stats - disables query stats collection
320
321 DESCRIPTION
322
323 ARGUMENTS
324
325 RETURNS
326
327 NOTES
328
329 */
330 procedure disable_query_stats(indexname varchar2);
331 PRAGMA SUPPLEMENTAL_LOG_DATA(disable_query_stats, AUTO);
332
333 /*--------------------------- logging ---------------------------------------*/
334 /*
335 NAME
336 logging - is logging enabled
337
338 DESCRIPTION
339 returns TRUE if logging is enabled through start_log or event
340 */
341 function logging return boolean;
342
343 end ctx_output;