Filter: Attributes

For CHARSET_FILTER

charset: Source character set. CHARSET part of NLS_LANG, plus special JAUTO for Japanese character set autodetect.

For INSO_FILTER

The INSO filter is a universal filter that filters most document formats. Use it for indexing single and mixed format columns. The INSO_FILTER has no attributes.

For NULL_FILTER

The NULL_FILTER object is used to specify that plain text is stored in the text column and no filtering needs to be performed. NULL_FILTER has no attributes.

For PROCEDURE_FILTER

The PROCEDURE FILTER object is used to specify an stored procedure for filtering documents in a column. PROCEDURE FILTER has the following attributes. (See the product documentation for detailed usage information about the requirements for these attributes and about creating a procedure for filtering.)

charset_parameter: If TRUE, the value of the charset column of the document being filtered is passed to the filter procedure before input_type and output_type, but after rowid_parameter and format_parameter.
Values: TRUE or FALSE (default)

format_parameter: If TRUE, the value of the format column of the document being filtered is passed to the filter procedure before input_type and output_type, but after rowid_parameter.
Values: TRUE or FALSE (default)

input_type: Specifies the type of the input argument (the unfiltered document) of the filter procedure.
Values: BLOB, CLOB, VARCHAR2, FILE.

output_type: Specifies the type of the output argument (the filtered document) of the filter procedure.
Values: CLOB, VARCHAR2, FILE.

procedure: Name of the stored procedure to be used for filtering. Must by owned by CTXSYS.

rowid_parameter: If TRUE, the rowid of the document being filtered is passed to the filter procedure as the first parameter, before input_type and output_type. For example, if input_type is BLOB and output_type is CLOB and rowid_parameter is TRUE, the filter procedure should have the signature: procedure (IN ROWID, IN BLOB, IN OUT NOCOPY CLOB). Using a rowid_parameter is useful if the filter needs data from other columns or other tables.
Values: TRUE or FALSE (default)

For USER_FILTER

The USER FILTER object is used to specify an external filter for filtering documents in a column. USER FILTER has the following attribute:

command: The executable for the single external filter used to filter all text stored in a column. If more than one document format is stored in the column, the external filter specified for command must recognize and handle all such formats. If all the document formats are supported by the INSO_FILTER, use INSO_FILTER instead of USER_FILTER unless additional tasks besides filtering are required for the documents.

Buttons (Apply, Revert, Show SQL/Hide SQL)

See also: Main topics (outline)