Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
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
PDF · Mobi · ePub

storageArea

A storage area is a physical structure, such as a file, that Oracle SES uses to store data and metadata. You can set the maximum size of a storage area. Otherwise, it grows as required by your data sources and may consume all available resources.

See Also:

Object Type

Creatable

Object Key

name

Object Key Command Syntax

--NAME=object_name

-n object_name

State Properties

None

Supported Operations

create
createAll
delete
deleteAll
deleteList
export
exportAll
exportList
getAllObjectKeys
update
updateAll

Administration GUI Page

None

XML Description

A <search:storageAreas> element describes a storage area:

<search:storageAreas>
   <search:storageArea>
      <search:name>
      <search:description>
      <search:usage>
       <search:locations>
          <search:location>
             <search:path>
             <search:device>
             <search:preAllocatedSpace>
             <search:quota>
             <search:currentSize>

Element Contents: 

<search:storageAreas>

Contains one or more <search:storageArea> elements, each defining a storage area for use by Oracle SES.

<search:storageArea>

Describes a storage area. It contains these elements:

<search:name>
<search:description>
<search:usage>
<search:locations>
<search:name>

Name of the storage area. (Required)

<search:description>

Description of the storage area. (Required)

<search:usage>

One of these usage types. You can create only the PARTITION storage type. (Required)

  • PARTITION: Used by the crawler to store the document index.

  • CACHE_FILE: Used to store the secure cache. You can update the quota, but no other parameters. You cannot create or delete the cache file storage area.

  • SYSTEM: Internal storage area. You can update the quota, but no other parameters. You cannot create or delete the system storage area.

<search:locations>

Contains a <search:location> element.

<search:location>

Describes the physical attributes of the storage area. (Required)

It contains these elements:

<search:path>
<search:device>
<search:preAllocatedSpace>
<search:quota>
<search:currentSize>
<search:path>

Fully qualified path for the storage area. The full path must exist.

<search:device>

Contains DEFAULT or the name of a hard drive, CD-ROM, network share, or similar storage hardware. If you omit this element or enter DEFAULT, then Oracle SES creates a tablespace in the default tablespace directory for the Oracle Database instance.

<search:preAllocatedSpace>

The initial size of the file in megabytes.

<search:quota>

The maximum size of the storage area in megabytes. (Required)

To remove a quota that was set previously, enter -1. Oracle SES does not check the size of a storage area after its quota is removed.

<search:currentSize>

The current size of the file in megabytes. (Read-only)

Attribute Value
lastRefreshDate Date of the most recent refresh, when the current size was calculated.

Example

This XML document creates a tablespace named PROSPERITY in a file named /ses_install/data/PROSPERITY_1.dbf for storing the Secure Cache. It has an initial size of 4MB and a maximum size of 64MB.

<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.1.2.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:storageAreas>
      <search:storageArea>
         <search:name>Prosperity</search:name>
         <search:description>Secure cache new storage</search:description>
         <search:usage>CACHE_FILE</search:usage>
         <search:locations>
            <search:location>
               <search:path>/ses_install/data/</search:path>
               <search:preAllocatedSpace>4</search:preAllocatedSpace>
               <search:quota>64</search:quota>
            </search:location>
         </search:locations>
      </search:storageArea>
   </search:storageAreas>
</search:config>