USER_DATASTORE Attributes

USER_DATASTORE has the following attributes:

Table 8 USER_DATASTORE Attributes

Attribute Attribute Value

Attribute	Attribute Value
`procedure`	Specify the procedure that synthesizes the document to be indexed. This procedure can be owned by any user and must be executable by the index owner.
`output_type`	Specify the data type of the second argument to `procedure`. Valid values are `CLOB`, `BLOB`, `CLOB_LOC`, `BLOB_LOC`, or `VARCHAR2`. The default is `CLOB`. When you specify `CLOB_LOC`, `BLOB_LOC`, you indicate that no temporary `CLOB` or `BLOB` is needed, because your procedure copies a locator to the `IN`/`OUT` second parameter.

procedure

Specify the procedure that synthesizes the document to be indexed.

This procedure can be owned by any user and must be executable by the index owner.

output_type

Specify the data type of the second argument to procedure. Valid values are CLOB, BLOB, CLOB_LOC, BLOB_LOC, or VARCHAR2. The default is CLOB.

When you specify CLOB_LOC, BLOB_LOC, you indicate that no temporary CLOB or BLOB is needed, because your procedure copies a locator to the IN/OUT second parameter.

procedure

Specify the name of the procedure that synthesizes the document to be indexed. This specification must be in the form PROCEDURENAME or PACKAGENAME.PROCEDURENAME. You can also specify the schema owner name.

The procedure you specify must have two arguments defined as follows:

procedure (r IN ROWID, c IN OUT NOCOPY output_type)

The first argument r must be of type ROWID. The second argument c must be of the type specified in the output_type attribute. NOCOPY is a compiler hint that instructs Oracle Text to pass parameter c by reference if possible.

Note: Procedure names should not include the semicolon character.

The stored procedure is called once for each row indexed. Given the rowid of the current row, procedure must write the text of the document into its second argument, whose type you specify with output_type.