Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 2 (11.2.1)

Part Number E17595-04
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

indexOptimizer

Optimizing the index reduces fragmentation and may significantly increase the speed of searches. In general, the fragmentation percentage should be less than 50%. A higher percentage indicates that search performance is compromised. If it is over 75%, then you should optimize the index as soon as possible.

Optimization of a very large index may take several hours. Schedule optimization during hours of low usage to ensures minimal disruption to users.

Object Type

Universal

State Properties

Property Value
endTime The date and time that the last optimization ended, in the form
Day, DD Mon YYYY, HH:MM:SS GMT
startTime The date and time that the last optimization started, in the same form as endTime
status BLOCKED: Oracle Enterprise Scheduler attempted to start index optimization, but its execution was blocked. For example, a blackout date might prevent the job from executing.The job starts as soon as the blocking condition ends.

DISABLED: Index optimization is currently disabled.

EXECUTING: The index is currently being optimized.

FAILED: Index optimization stopped with an error.

HOLD: The Oracle Enterprise Scheduler administrator explicitly held execution of the index optimization.

LAUNCHING: Index optimization has started.

SCHEDULED: Index optimization is scheduled.

STOPPED: Index optimization has stopped.


Supported Operations

activate
deactivate
export
getState
start
update

Administration GUI Page

Global Settings - Index Optimization

XML Description

The <search:indexOptimizer> element describes index optimization:

<search:indexOptimizer>
   <search:frequency>

<!-- For hourly optimization -->
      <search:hourly>
         <search:hoursBtwnLaunches>

<!-- For daily optimization -->
      <search:daily>
         <search:daysBtwnLaunches>
         <search:startHour>

<!-- For weekly optimization -->
      <search:weekly>
         <search:weeksBtwnLaunches>
         <search:startDayOfWeek>
         <search:startHour>

<!-- For monthly optimization -->
      <search:monthly>
         <search:monthsBtwnLaunches>
         <search:startDayOfMonth>
         <search:startHour>

<!-- For all frequencies -->
   <search:duration>
      <search:maxHours>

Element Descriptions 

<search:indexOptimizer>

Describes index optimization schedule. It contains these elements:

<search:frequency>
<search:duration>
<search:frequency>

Describes the optimization schedule. It contains one of these elements:

<search:hourly>
<search:daily>
<search:weekly>
<search:monthly>
<search:hourly>

Describes an hourly schedule. It contains a <search:hoursBtwnLaunches> element.

<search:hoursBtwnLaunches>

The number of hours between optimizations.

<search:daily>

Describes a daily schedule. It contains these elements:

<search:daysBtwnLaunches>
<search:startHour>
<search:daysBtwnLaunches>

The number of days between optimizations.

<search:startHour>

The time the crawl begins using a 24-hour clock, such as 9 for 9:00 a.m. or 23 for 11:00 p.m. The default value is 1.

<search:weekly>

Describes a weekly schedule (default). It contains these elements:

<search:weeksBtwnLaunches>
<search:startDayOfWeek>
<search:startHour>
<search:weeksBtwnLaunches>

The number of weeks between optimizations.

<search:startDayOfWeek>

The day of the week that the crawl begins, such as MONDAY or TUESDAY. The default is SATURDAY.

<search:monthly>

Describes a monthly schedule. It contains these elements:

<search:monthsBtwnLaunches>
<search:startDayOfMonth>
<search:startHour>
<search:monthsBtwnLaunches>

The number of time periods between starting a crawl.

<search:startDayOfMonth>

An integer value for the day of the month that the crawl begins, such as 1 or 15.

<search:duration>

Controls the duration of the optimization process. It contains a <search:maxhours> element.

Attribute Value
haslimit Set to true to enforce the time limit, or set to false to allow the process to finish. Required.

<search:maxHours>

The number of hours the optimization process is allowed to continue. For best results, allow the optimization to finish.

Example

This XML document describes the index optimizer settings:

<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:indexOptimizer>
      <search:frequency>
         <search:weekly>
            <search:weeksBtwnLaunches>3</search:weeksBtwnLaunches>
            <search:startDayOfWeek>MONDAY</search:startDayOfWeek>
            <search:startHour>23</search:startHour>
         </search:weekly>
      </search:frequency>
      <search:duration haslimit="true">
         <search:maxHours>8</search:maxHours>
      </search:duration>
   </search:indexOptimizer>
</search:config>