9
CTX_OUTPUT Package

This chapter provides reference information for using the CTX_OUTPUT PL/SQL package.

CTX_OUTPUT contains the following stored procedures:

Name	Description
ADD_EVENT	Add an event to the index log.
END_LOG	Halts logging of index and document services requests.
LOGFILENAME	Returns the name of the current log file.
REMOVE_EVENT	Remove an event from the index log.
START_LOG	Starts logging index and document service requests.

---

ADD_EVENT

Use this procedure to add an event to the index log for more detailed log output. Currently the only event you can add is the CTX_OUTPUT.EVENT_INDEX_PRINT_ROWID which logs the rowid of each row after it is indexed. This is useful for debugging a failed index operation.

Syntax

CTX_OUTPUT.ADD_EVENT(event in varchar2);

event

Specify the type of index event to log. Currently the only event you can add is the CTX_OUTPUT.EVENT_INDEX_PRINT_ROWID which logs the rowid of each row after it is indexed.

Example

begin


CTX_OUTPUT.ADD_EVENT(CTX_OUTPUT.EVENT_INDEX_PRINT_ROWID);

end;

---

END_LOG

Halt logging index and document service requests

Syntax

CTX_OUTPUT.END_LOG;

Example

begin
CTX_OUTPUT.END_LOG;
end;

---

LOGFILENAME

Returns the filename for the current log. This procedure looks for the log file in the directory specified by the LOG_DIRECTORY system parameter.

Syntax

CTX_OUTPUT.LOGFILENAME RETURN VARCHAR2;

Returns

Log file name.

Example

declare
   logname varchar2(100);
begin
   logname := CTX_OUTPUT.LOGFILENAME;
   dbms_output.put_line('The current log file is: '||logname); 
end;

---

REMOVE_EVENT

Use this procedure to remove an event from the index log.

Syntax

CTX_OUTPUT.REMOVE_EVENT(event in varchar2);

event

Specify the type of index event to remove from the log. Currently the only event you can add and remove is the CTX_OUTPUT.EVENT_INDEX_PRINT_ROWID.

Example

begin


CTX_OUTPUT.REMOVE_EVENT(CTX_OUTPUT.EVENT_INDEX_PRINT_ROWID);

end;

---

START_LOG

Begin logging index and document service requests.

Syntax

CTX_OUTPUT.START_LOG(logfile in varchar2);

logfile

Specify the name of the log file. The log is stored in the directory specified by the system parameter LOG_DIRECTORY.

Example

begin
CTX_OUTPUT.START_LOG('mylog1');
end;