[Home] [Help]
PACKAGE: CTXSYS.DRIPARSE
Source
1 package driparse authid definer as
2
3 type createRec is record (
4 populate boolean,
5 swap boolean,
6 idxmem number,
7 langcol varchar2(256),
8 fmtcol varchar2(256),
9 csetcol varchar2(256),
10 datastore varchar2(65),
11 filter varchar2(65),
12 section varchar2(65),
13 lexer varchar2(65),
14 wordlist varchar2(65),
15 stoplist varchar2(65),
16 storage varchar2(65),
17 indexset varchar2(65),
18 classifier varchar2(65),
19 txntional varchar2(65),
20 sync_type varchar2(65),
21 sync_memory varchar2(100),
22 sync_paradegree number,
23 sync_interval varchar2(4000),
24 tree boolean,
25 sync_dpl boolean,
26 secname varchar2(256),
27 configcol varchar2(256)
28 );
29
30 type alterRec is record (
31 operation number,
32 op_subtype varchar2(30),
33 string1 varchar2(80),
34 string2 varchar2(64),
35 number1 number,
36 flag1 boolean,
37 idx_opt createRec,
38 num1 number
39 );
40
41 OP_NULL constant number := -1;
42 -- Deprecated operation
43 --OP_SYNC constant number := 1;
44 OP_RESUME constant number := 2;
45 OP_REPLACE constant number := 3;
46 OP_ADD_STOPWORD constant number := 4;
47 -- Deprecated operation
48 --OP_OPTIMIZE constant number := 5;
49 OP_ADD_SECTION constant number := 6;
50 -- internal only
51 OP_EXCHANGE constant number := 7;
52 -- end of internal only
53 OP_ADD_STAGE_ITAB constant number := 8;
54 OP_REMOVE_STAGE_ITAB constant number := 9;
55 OP_ADD_BIG_IO constant number := 10;
56 OP_REMOVE_BIG_IO constant number := 11;
57 OP_ADD_SEPARATE_OFFSETS constant number := 12;
58 OP_ADD_SUB_LEXER constant number := 13;
59 OP_REM_SUB_LEXER constant number := 14;
60 OP_REM_STOPWORD constant number := 15;
61 OP_REM_STOPWORDS constant number := 16;
62 OP_MIGRATE_TO_MULTISTOP constant number := 17;
63 OP_MIGRATE_FIELD_TO_MDATA constant number := 18;
64 OP_UPD_SUB_LEXER constant number := 19;
65 OP_READ_TRUE constant number := 20;
66 OP_READ_FALSE constant number := 21;
67 OP_WRITE_TRUE constant number := 22;
68 OP_WRITE_FALSE constant number := 23;
69
70
71 /* ======================================================================= */
72 /* ======================================================================= */
73 /* CONTEXT */
74 /* ======================================================================= */
75 /* ======================================================================= */
76
77 /*----------------------- InitCreateRec -----------------------*/
78 /*
79 NAME
80 InitCreateRec
81
82 DESCRIPTION
83 initialize createrec
84
85 ARGUMENTS
86
87 NOTES
88
89 EXCEPTIONS
90
91 RETURNS
92
93 */
94 FUNCTION InitCreateRec return createRec;
95
96 /*----------------------- ParseCreate -----------------------*/
97 /*
98 NAME
99 ParseCreate
100
101 DESCRIPTION
102 parse create index parameters string
103
104 ARGUMENTS
105 params paramstring
106 alter_op zero unless called from ParseAlter
107 opts create index options (OUT)
108
109 NOTES
110
111 EXCEPTIONS
112
113 RETURNS
114
115 */
116 PROCEDURE ParseCreate(
117 params in varchar2,
118 alter_op in number,
119 opts out createRec,
120 metadataonly out boolean,
121 isPart in boolean default FALSE
122 );
123
124 /*----------------------- ParsePartCreate -----------------------*/
125 /*
126 NAME
127 ParsePartCreate
128
129 DESCRIPTION
130 parse create index (partition create) parameters string
131
132 ARGUMENTS
133 params paramstring
134 opts create index options (OUT)
135
136 NOTES
137
138 EXCEPTIONS
139
140 RETURNS
141
142 */
143 PROCEDURE ParsePartCreate(
144 params in varchar2,
145 alter_op in number,
146 def_idxmem in number,
147 opts out createRec,
148 metadataonly out boolean
149 );
150
151 /*----------------------- ParseAlter -----------------------*/
152 /*
153 NAME
154 ParseAlter
155
156 DESCRIPTION
157 parse alter index parameters string
158
159 ARGUMENTS
160 idxid index id
161 params paramstring
162 opts alter index options (OUT)
163 isPart if the index is partitioned -- only set in
164 recreate_index_online
165
166 NOTES
167
168 EXCEPTIONS
169
170 RETURNS
171
172 */
173 PROCEDURE ParseAlter(
174 idxid in number,
175 params in varchar2,
176 opts in out alterRec,
177 isPart in boolean default FALSE
178 );
179
180 /*----------------------- ParsePartAlter -----------------------*/
181 /*
182 NAME
183 ParsePartAlter
184
185 DESCRIPTION
186 parse alter index partition parameters string
187
188 ARGUMENTS
189 idxid index id
190 params paramstring
191 opts alter index options (OUT)
192
193 NOTES
194
195 EXCEPTIONS
196
197 RETURNS
198
199 */
200 PROCEDURE ParsePartAlter(
201 idxid in number,
202 params in varchar2,
203 opts in out alterRec
204 );
205
206 /* ======================================================================= */
207 /* ======================================================================= */
208 /* CTXCAT */
209 /* ======================================================================= */
210 /* ======================================================================= */
211
212 /*----------------------- ParseCreateCat -----------------------*/
213 /*
214 NAME
215 ParseCreateCat
216
217 DESCRIPTION
218 parse create index parameters string for ctxcat indextype
219
220 ARGUMENTS
221 params paramstring
222 opts create index options (OUT)
223
224 NOTES
225
226 EXCEPTIONS
227
228 RETURNS
229
230 */
231 PROCEDURE ParseCreateCat(
232 params in varchar2,
233 opts out createRec
234 );
235
236 /*----------------------- ParseAlterCat -----------------------*/
237 /*
238 NAME
239 ParseAlterCat
240
241 DESCRIPTION
242 parse alter index parameters string for ctxcat indextype
243
244 ARGUMENTS
245 params paramstring
246 opts create index options (OUT)
247
248 NOTES
249
250 EXCEPTIONS
251
252 RETURNS
253
254 */
255 PROCEDURE ParseAlterCat(
256 idxid in number,
257 params in varchar2,
258 opts out alterRec
259 );
260
261 /*----------------------- normalize_column_list -----------------------*/
262 /*
263 NAME
264 normalize_column_list
265
266 DESCRIPTION
267 normalize a column list
268
269 ARGUMENTS
270 column_list column list
271
272 NOTES
273
274 EXCEPTIONS
275
276 RETURNS
277 normalized column list
278 */
279 FUNCTION normalize_column_list(
280 column_list in varchar2
281 ) RETURN varchar2;
282
283
284
285
286 /* ======================================================================= */
287 /* ======================================================================= */
288 /* CTXRULE */
289 /* ======================================================================= */
290 /* ======================================================================= */
291
292 /*----------------------- ParseCreateRule -----------------------*/
293 /*
294 NAME
295 ParseCreateRule
296
297 DESCRIPTION
298 parse create index parameters string for ctxrule indextype
299
300 ARGUMENTS
301 params paramstring
302 alter_op zero unless called from ParseAlter
303 opts create index options (OUT)
304
305 NOTES
306
307 EXCEPTIONS
308
309 RETURNS
310
311 */
312 PROCEDURE ParseCreateRule(
313 params in varchar2,
314 alter_op in number,
315 opts out createRec
316 );
317
318 /*----------------------- ParseAlterRule -----------------------*/
319 /*
320 NAME
321 ParseAlter
322
323 DESCRIPTION
324 parse alter index parameters string for ctxrule indextype
325
326 ARGUMENTS
327 idxid index id
328 params paramstring
329 opts alter index options (OUT)
330
331 NOTES
332
333 EXCEPTIONS
334
335 RETURNS
336
337 */
338 PROCEDURE ParseAlterRule(
339 idxid in number,
340 params in varchar2,
341 opts in out alterRec
342 );
343
344 /* ======================================================================= */
345 /* ======================================================================= */
346 /* CTXXPATH */
347 /* ======================================================================= */
348 /* ======================================================================= */
349
350 /*----------------------- ParseCreateXPath -----------------------*/
351 /*
352 NAME
353 ParseCreateXPath
354
355 DESCRIPTION
356 parse create index parameters string for ctxxpath indextype
357
358 ARGUMENTS
359 params paramstring
360 opts create index options (OUT)
361
362 NOTES
363
364 EXCEPTIONS
365
366 RETURNS
367
368 */
369 PROCEDURE ParseCreateXPath(
370 params in varchar2,
371 alter_op in number,
372 opts out createRec
373 );
374
375 /*----------------------- ParseAlterXPath -----------------------*/
376 /*
377 NAME
378 ParseAlter
379
380 DESCRIPTION
381 parse alter index parameters string
382
383 ARGUMENTS
384 idxid index id
385 params paramstring
386 opts alter index options (OUT)
387
388 NOTES
389
390 EXCEPTIONS
391
392 RETURNS
393
394 */
395 PROCEDURE ParseAlterXPath(
396 idxid in number,
397 params in varchar2,
398 opts in out alterRec
399 );
400
401 PROCEDURE ParseMigrate (
402 params in out varchar2,
403 opts in out alterRec
404 );
405
406 end driparse;