6
CTX_ADM Package

This chapter provides reference information for using the CTX_ADM PL/SQL package to administer servers and the data dictionary.

CTX_ADM contains the following stored procedures:

Name	Description
RECOVER	Cleans up database objects for deleted Text tables
SET_PARAMETER	Sets system-level defaults for index creation
SHUTDOWN	Shuts down a single ctxsrv server or all currently running servers

---

RECOVER

The RECOVER procedure cleans up the Text data dictionary, deleting objects such as leftover preferences.

Syntax

CTX_ADM.RECOVER;

Example

begin
ctx_adm.recover;
end;

Notes

You need not call CTX_ADM.RECOVER to perform system recovery if ctxsrv servers are running; any ctxsrv servers that are running automatically perform system recovery approximately every fifteen minutes. RECOVER provides a method for users to perform recovery on command.

---

SET_PARAMETER

The SET_PARAMETER procedure sets system-level parameters for index creation.

Syntax

CTX_ADM.SET_PARAMETER(param_name IN VARCHAR2,
                      param_value IN VARCHAR2);

param_name

Specify the name of the parameter to set, which can be one of the following:

• max_index_memory (maximum memory allowed for indexing)

• default_index_memory (default memory allocated for indexing)

• log_directory (directory for ctx_ouput files)

• default_datastore (default datastore preference)

• default_filter_text (default text filter preference)

• default_filter_binary (default binary filter preference)

• default_section_html (default html section group preference)

• default_section_text (default text section group preference)

• default_lexer (default lexer preference)

• default_wordlist (default wordlist preference)

• default_stoplist (default stoplist preference)

• default_storage (default storage preference)

  See Also: To learn more about the default values for these parameters, see "System Parameters" in Chapter 3.

param_value

Specify the value to assign to the parameter. For max_index_memory and default_index_memory, the value you specify must have the following syntax:

number[M|G|K]

where M stands for megabytes, G stands for gigabytes, and K stands for kilobytes.

For each of the other parameters, specify the name of a preference to use as the default for indexing.

Example

begin
ctx_adm.set_parameter('default_lexer', 'my_lexer');
end;

---

SHUTDOWN

The SHUTDOWN procedure shuts down the specified ctxsrv server.

Syntax

CTX_ADM.SHUTDOWN(name   IN VARCHAR2 DEFAULT 'ALL',
                 sdmode IN NUMBER   DEFAULT NULL);

name

Specify the name (internal identifier) of the ctxsrv server to shutdown.

Default is ALL.

sdmode

Specify the shutdown mode for the server:

• 0 or NULL (Normal)

• 1 (Immediate)

• 2 (Abort)

Default is NULL.

Examples

begin
ctx_adm.shutdown('DRSRV_3321', 1);
end;

Notes

If you do not specify a ctxsrv server to shut down, CTX_ADM.SHUTDOWN shuts down all currently running ctxsrv servers.

The names of all currently running ctxsrv servers can be obtained from the CTX_SERVERS view.

Related Topics

"ctxsrv" in Chapter 11

---