| General Information |
| Source |
{ORACLE_HOME}/ctx/admin/dr0ddl.pkh |
| Constants |
| Name |
Data Type |
Value |
| LOCK_WAIT |
NUMBER |
0 |
| LOCK_NOWAIT |
NUMBER |
1 |
| LOCK_NOWAIT_ERROR |
NUMBER |
2 |
| MAXTIME_UNLIMITED |
NUMBER |
2147483647 |
| OPTLEVEL_FAST |
VARCHAR2(4) |
'FAST' |
| OPTLEVEL_FULL |
VARCHAR2(4) |
'FULL' |
| OPTLEVEL_REBUILD |
VARCHAR2(7) |
'REBUILD' |
| OPTLEVEL_TOKEN |
VARCHAR2(5) |
'TOKEN' |
| OPTLEVEL_TOKEN_TYPE |
VARCHAR2(10) |
'TOKEN_TYPE' |
|
| Dependencies |
SELECT name FROM dba_dependencies WHERE referenced_name = 'CTX_DDL'
UNION
SELECT referenced_name FROM dba_dependencies WHERE name = 'CTX_DDL'; |
| Security Model |
No privs granted. Runs under AUTHID CURRENT_USER |
| Subprograms |
|
| |
| ADD_ATTR_SECTION |
| Add an attribute section to the group attr sections can be added only to the xml sectioner.
They denote attributes whose text should be indexed |
ctx_ddl.add_attr_section(
group_name IN VARCHAR2,
section_name IN VARCHAR2,
tag IN VARCHAR2); |
| TBD |
| |
ADD_AUTO_OPTIMIZE (new 11.2.0.2)  |
| Undocumented |
ctx_ddl.add_auto_optimize(
idx_name IN VARCHAR2,
part_name IN VARCHAR2 DEFAULT NULL,
optlevel IN VARCHAR2 DEFAULT ctx_ddl.optlevel_merge); |
| TBD |
| |
| ADD_FIELD_SECTION |
| Creates a filed section and assigns it to the specified section group |
ctx_ddl.add_field_section(
group_name IN VARCHAR2,
section_name IN VARCHAR2,
tag IN VARCHAR2,
visible IN BOOLEAN DEFAULT FALSE); |
| TBD |
| |
| ADD_INDEX |
| Adds an index to a catalog index preference |
ctx_ddl.add_index(
set_name IN VARCHAR2,
column_list IN VARCHAR2,
storage_clause IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| ADD_MDATA |
Changes the MDATA value of a document
Overload 1 |
ctx_ddl.add_mdata(
idx_name IN VARCHAR2,
section_name IN VARCHAR2,
mdata_value IN VARCHAR2,
mdata_rowid IN ROWID,
part_name IN VARCHAR2 DEFAULT NULL); |
| TBD |
| Overload 2 |
ctx_ddl.add_mdata(
idx_name IN VARCHAR2,
section_name IN VARCHAR2,
mdata_values IN sys.odcivarchar2list,
mdata_rowids IN sys.odciridlist,
part_name IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| ADD_MDATA_COLUMN |
| Map the specified FILTER BY or ORDER BY column name to an MDATA section |
ctx_ddl.add_mdata_column(
group_name IN VARCHAR2,
section_name IN VARCHAR2,
column_name IN VARCHAR2); |
| TBD |
| |
| ADD_MDATA_SECTION |
| Adds an MDATA metadata section to a document |
ctx_ddl.add_mdata_section(
group_name IN VARCHAR2,
section_name IN VARCHAR2,
tag IN VARCHAR2); |
| TBD |
| |
ADD_MVDATA_SECTION (new 11.2.0.2)  |
| Add a new MV Section. There is a maximum of 100 sections within a section group. |
ctx_ddl.add_mvdata_section(
group_name IN VARCHAR2, -- section group name, [user.]section_group_name
section_name IN VARCHAR2, --
tag IN VARCHAR2, -- the unique pattern that marks the start of a section
datatype IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| ADD_NDATA_SECTION |
| Adds a new NDATA section to a document |
ctx_ddl.add_ndata_section(
group_name IN VARCHAR2,
section_name IN VARCHAR2,
tag IN VARCHAR2); |
| TBD |
| |
| ADD_SDATA_COLUMN |
| Map the specified FILTER BY or ORDER BY column name to an SDATA section |
ctx_ddl.add_sdata_column(
group_name IN VARCHAR2,
section_name IN VARCHAR2,
column_name IN VARCHAR2); |
| TBD |
| |
| ADD_SDATA_SECTION |
| Adds a new SDATA section to a document |
ctx_ddl.add_sdata_section(
group_name IN VARCHAR2,
section_name IN VARCHAR2,
tag IN VARCHAR2
datatype IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| ADD_SPECIAL_SECTION |
| Add a special section to the group special sections are not detected by tags.
Instead, they are detected automatically in the document text |
ctx_ddl.add_special_section(
group_name IN VARCHAR2,
section_name IN VARCHAR2); |
| TBD |
| |
ADD_STOPCLASS (new parameter 11.2.0.3)  |
| Add a stopclass to a stoplist |
ctx_ddl.add_stopclass(
stoplist_name IN VARCHAR2,
stopclass IN VARCHAR2
stoppattern IN VARCHAR2); |
| TBD |
| |
| ADD_STOPTHEME |
| Add a stoptheme to a stop list |
ctx_ddl.add_stoptheme(
stoplist_name IN VARCHAR2,
stoptheme IN VARCHAR2); |
| TBD |
| |
| ADD_STOPWORD |
| Adds a stopword to a stoplist |
ctx_ddl.add_stopword(
stoplist_name IN VARCHAR2,
stopword IN VARCHAR2,
language IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| ADD_STOP_SECTION |
| Add a stop section to the group stop sections can be added only to the auto sectioner.
They denote those tags which should not be indexed |
ctx_ddl.add_stop_section(
group_name IN VARCHAR2,
tag IN VARCHAR2); |
| TBD |
| |
| ADD_SUB_LEXER |
| Adds a sub-lexer to a multi-lexer preference |
ctx_ddl.add_sub_lexer(
lexer_name IN VARCHAR2,
language IN VARCHAR2,
sub_lexer IN VARCHAR2,
alt_value IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| ADD_ZONE_SECTION |
| Creates a zone section and adds it to the specified section group |
ctx_ddl.add_zone_section(
group_name IN VARCHAR2,
section_name IN VARCHAR2,
tag IN VARCHAR2); |
| TBD |
| |
ALTER_INDEX (new 11.2.0.2)  |
| Undocumented |
ctx_ddl.alter_index(idx_name IN VARCHAR2, parameters IN VARCHAR2); |
| TBD |
| |
| COPY_POLICY |
| Create a policy which is a metadata copy of an existing policy or index |
ctx_ddl.copy_policy(
source_policy IN VARCHAR2,
policy_name IN VARCHAR2); |
| TBD |
| |
| CREATE_INDEX_SET |
| Creates an index set for CTXCAT index types. Only CTXAPP users and CTXSYS can create an index set |
ctx_ddl.create_index_set(set_name IN VARCHAR2); |
| TBD |
| |
| CREATE_POLICY |
| Create a policy to use with ORA:CONTAINS() |
ctx_ddl.create_policy(
policy_name IN VARCHAR2,
filter IN VARCHAR2 DEFAULT NULL,
section_group IN VARCHAR2 DEFAULT NULL,
lexer IN VARCHAR2 DEFAULT NULL,
stoplist IN VARCHAR2 DEFAULT NULL,
wordlist IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| CREATE_PREFERENCE |
| Creates a preference in the Text data dictionary |
ctx_ddl.create_preference(
preference_name IN VARCHAR2,
object_name IN VARCHAR2); |
| TBD |
| |
| CREATE_SECTION_GROUP |
| Creates a section group in the Text data dictionary |
ctx_ddl.create_section_group(
group_name IN VARCHAR2,
group_type IN VARCHAR2); |
| TBD |
| |
| CREATE_SHADOW_INDEX |
| Undocumented |
ctx_ddl.create_shadow_index(
idx_name IN VARCHAR2,
parameter_string IN VARCHAR2 DEFAULT NULL,
parallel_degree IN NUMBER DEFAULT 1); |
| TBD |
| |
| CREATE_STOP_LIST |
| Creates a new stoplist |
ctx_ddl.create_stop_list(
stoplist_name IN VARCHAR2,
stoplist_type IN VARCHAR2 DEFAULT 'BASIC_STOPLIST'); |
| TBD |
| |
| DROP_INDEX_SET |
| Drops an index set |
ctx_ddl.drop_index_set(set_name IN VARCHAR2); |
| TBD |
| |
| DROP_POLICY |
| Drops a policy |
ctx_ddl.drop_policy(policy_name IN VARCHAR2); |
| TBD |
| |
| DROP_PREFERENCE |
| Deletes a preference from the Text data dictionary |
ctx_ddl.drop_preference(preference_name IN VARCHAR2); |
| TBD |
| |
| DROP_SECTION_GROUP |
| Deletes a section group from the Text data dictionary |
ctx_ddl.create_section_group(group_name IN VARCHAR2); |
| TBD |
| |
| DROP_SHADOW_INDEX |
| Undocumented |
ctx_ddl.drop_shadow_index(idx_name IN VARCHAR2); |
| TBD |
| |
| DROP_STOPLIST |
| Drop a stop list |
ctx_ddl.drop_stoplist(stoplist_name IN VARCHAR2); |
| TBD |
| |
| EXCHANGE_SHADOW_INDEX |
| Undocumented |
ctx_ddl.exchange_shadow_index(
idx_name IN VARCHAR2,
parameter_string IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
INSERT_MVDATA_VALUES (new 11.2.0.2)  |
| Insert mvdata section values in a list of documents |
ctx_ddl.insert_mvdata_values(
idx_name IN VARCHAR2 DEFAULT NULL, -- index name
section_name IN VARCHAR2 DEFAULT NULL,
mvdata_values IN sys.odcinumberlist, -- mvdata values
mvdata_rowids IN sys.odciridlist, -- rowids to be updated
part_name IN VARCHAR2 DEFAULT NULL); -- partition name |
| TBD |
| |
OPTIMIZE_INDEX (new parameter 11.2.0.3)  |
| Optimize an index |
ctx_ddl.optimize_index(
idx_name IN VARCHAR2,
optlevel IN VARCHAR2,
maxtime IN NUMBER DEFAULT NULL,
token IN VARCHAR2 DEFAULT NULL,
part_name IN VARCHAR2 DEFAULT NULL,
token_type IN NUMBER DEFAULT NULL,
parallel_degree IN NUMBER DEFAULT 1,
memory IN VARCHAR2,
background IN BOOLEAN); |
| TBD |
| |
| POPULATE_PENDING |
| Loads the DML pending queue with all base table rowids intended to be used after a create index ... NOPOPULATE |
ctx_ddl.populate_pending(
idx_name IN VARCHAR2,
part_name IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| RECREATE_INDEX_ONLINE |
| Undocumented |
ctx_ddl.recreate_index_online(
idx_name IN VARCHAR2,
parameter_string IN VARCHAR2 DEFAULT NULL,
parallel_degree IN NUMBER DEFAULT 1,
partition_name IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
REMOVE_AUTO_OPTIMIZE (new 11.2.0.2)  |
| Undocumented |
ctx_ddl.remove_auto_optimize(
idx_name IN VARCHAR2,
part_name IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| REMOVE_INDEX |
| Removes an index from a CTXCAT index preference |
ctx_ddl.remove_index(
set_name IN VARCHAR2,
column_list IN VARCHAR2); |
| TBD |
| |
| REMOVE_MDATA |
Removes MDATA values from a document
Overload 1 |
ctx_ddl.remove_mdata(
idx_name IN VARCHAR2,
section_name IN VARCHAR2,
mdata_value IN VARCHAR2,
mdata_rowid IN ROWID,
part_name IN VARCHAR2 DEFAULT NULL); |
| TBD |
| Overload 2 |
ctx_ddl.remove_mdata(
idx_name IN VARCHAR2,
section_name IN VARCHAR2,
mdata_values IN sys.odcivarchar2list,
mdata_rowids IN sys.odciridlist,
part_name IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| REMOVE_SECTION |
May be used by CTXAPP and CTXADMIN to drop their own sections
Overload 1 |
ctx_ddl.remove_section(
group_name IN VARCHAR2,
section_name IN VARCHAR2); |
| TBD |
| Overload 2 |
ctx_ddl.remove_section(
group_name IN VARCHAR2,
section_id IN NUMBER); |
| TBD |
| |
| REMOVE_STOPCLASS |
| Deletes a stopclass from a stoplist |
ctx_ddl.remove_stopclass(
stoplist_name IN VARCHAR2,
stopclass IN VARCHAR2); |
| TBD |
| |
| REMOVE_STOPTHEME |
| Deletes a stoptheme from a stoplist |
ctx_ddl.remove_stoptheme(
stoplist_name IN VARCHAR2,
stoptheme IN VARCHAR2); |
| TBD |
| |
| REMOVE_STOPWORD |
| Removes a stopword from a stoplist |
ctx_ddl.remove_stopword(
stoplist_name IN VARCHAR2,
stopword IN VARCHAR2,
language IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
| REMOVE_SUB_LEXER |
| Remove a sub lexer from a multi-lexer preference |
ctx_ddl.remove_sub_lexer(
lexer_name IN VARCHAR2,
language IN VARCHAR2); |
| TBD |
| |
| REPLACE_INDEX_METADATA |
| Replaces metadata for local domain indexes |
ctx_ddl.replace_index_metadata(
idx_name IN VARCHAR2,
parameter_string IN VARCHAR2); |
| TBD |
| |
| SET_ATTRIBUTE |
| Sets a preference attribute |
ctx_ddl.set_attribute(
preference_name IN VARCHAR2,
attribute_name IN VARCHAR2,
attribute_value IN VARCHAR2); |
| TBD |
| |
SPLIT_DOLLARI (new 11.2.0.2)  |
| Split the $I table |
ctx_ddl.split_dollari(
idx_name IN VARCHAR2,
part_name IN VARCHAR2,
mapping_tab IN VARCHAR2, -- mapping table name
name_prefix IN VARCHAR2, -- the prefix used for naming the output $I tables
tspace IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
SPLIT_ZONE_TOKENS (new 11.2.0.2)  |
| Move contents of a zone section to one or more zone sections |
ctx_ddl.split_zone_tokens(
idx_name IN VARCHAR2,
part_name IN VARCHAR2 DEFAULT NULL,
source_section IN VARCHAR2,
split_map IN split_tab); |
| TBD |
| |
| SYNC_INDEX |
| Synchronize index |
ctx_ddl.sync_index(
idx_name IN VARCHAR2 DEFAULT NULL,
memory IN VARCHAR2 DEFAULT NULL,
part_name IN VARCHAR2 DEFAULT NULL,
parallel_degree IN NUMBER DEFAULT 1,
maxtime IN NUMBER DEFAULT NULL,
locking IN NUMBER DEFAULT LOCK_WAIT); |
| TBD |
| |
| UNSET_ATTRIBUTE |
| Removes a set attribute from a preference |
ctx_ddl.unset_attribute(
preference_name IN VARCHAR2,
attribute_name IN VARCHAR2); |
| TBD |
| |
UPDATE_MVDATA_SET (new 11.2.0.2)  |
| Update mvdata section values as a set at document level |
ctx_ddl.update_mvdata_set(
idx_name IN VARCHAR2 DEFAULT NULL,
section_name IN VARCHAR2 DEFAULT NULL,
mvdata_values IN sys.odcinumberlist, -- mvdata values
mvdata_rowids IN sys.odciridlist, -- rowids to be updated
part_name IN VARCHAR2 DEFAULT NULL); -- partition name |
| TBD |
| |
| UPDATE_POLICY |
| Updates a policy. Replaces the preferences of the policy. Arguments left NULL are not replaced. |
ctx_ddl.update_policy(
policy_name IN VARCHAR2,
filter IN VARCHAR2 DEFAULT NULL,
section_group IN VARCHAR2 DEFAULT NULL,
lexer IN VARCHAR2 DEFAULT NULL,
stoplist IN VARCHAR2 DEFAULT NULL,
wordlist IN VARCHAR2 DEFAULT NULL); |
| TBD |
| |
UPDATE_SDATA (new 11.2.0.2)  |
| Update sdata section value |
ctx_ddl.update_sdata(
idx_name IN VARCHAR2,
section_name IN VARCHAR2,
sdata_value IN sys.anydata,
sdata_rowid IN ROWID,
part_name IN VARCHAR2 default NULL); |
| TBD |
| |
UPDATE_SUB_LEXER (new 11.2.0.2)  |
| Update a sub lexer in a multi-lexer preference |
ctx_ddl.update_sub_lexer(
lexer_name IN VARCHAR2,
language IN VARCHAR2,
sub_lexer IN VARCHAR2); |
| TBD |
| |
ZONE_TO_FIELD (new 11.2.0.2)  |
| Migrate from zone to field sections |
ctx_ddl.zone_to_field(
dx_name IN VARCHAR2,
part_name IN VARCHAR2 DEFAULT NULL,
lex_pref IN VARCHAR2,
storage_pref IN VARCHAR2,
attr_val_tab IN VARCHAR2,
zone_sec_list IN sec_tab,
fld_sec_list IN sec_tab); |
| TBD |