category Zend
package Zend_Search_Lucene
subpackage Index
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Open the index for writing

__construct(\Zend_Search_Lucene_Storage_Directory $directory, array $segmentInfos, integer $targetFormatVersion) 

Parameters

$directory

\Zend_Search_Lucene_Storage_Directory

$segmentInfos

array

$targetFormatVersion

integer

Adds a document to this index.

addDocument(\Zend_Search_Lucene_Document $document) 

Parameters

$document

\Zend_Search_Lucene_Document

Merges the provided indexes into this index.

addIndexes(array $readers) : void

Parameters

$readers

array

Commit current changes

commit() 

Create empty index

createIndex(\Zend_Search_Lucene_Storage_Directory $directory, integer $generation, integer $nameCount) 
Static

Parameters

$directory

\Zend_Search_Lucene_Storage_Directory

$generation

integer

$nameCount

integer

Merges all segments together into new one

optimize() : boolean

Returns true on success and false if another optimization or auto-optimization process is running now

Returns

boolean

Check if we have anything to merge

_hasAnythingToMerge() : boolean

Returns

boolean

Merge segments if necessary

_maybeMergeSegments() 

Merge specified segments

_mergeSegments(array $segments) 

$segments is an array of SegmentInfo objects

Parameters

$segments

array

Get name for new segment

_newSegmentName() : string

Returns

string

Update segments file by adding current segment to a list

_updateSegments() 

Exceptions

\Zend_Search_Lucene_Exception

 Properties

 

Number of documents required before the buffered in-memory documents are written into a new Segment

$maxBufferedDocs : integer

Default

10

Default value is 10

 

Largest number of documents ever merged by addDocument().

$maxMergeDocs : integer

Default

PHP_INT_MAX

Small values (e.g., less than 10,000) are best for interactive indexing, as this limits the length of pauses while indexing to a few seconds. Larger values are best for batched indexing and speedier searches.

Default value is PHP_INT_MAX

 

Determines how often segment indices are merged by addDocument().

$mergeFactor : integer

Default

10

With smaller values, less RAM is used while indexing, and searches on unoptimized indices are faster, but indexing speed is slower.

With larger values, more RAM is used during indexing, and while searches on unoptimized indices are slower, indexing is faster.

Thus larger values (> 10) are best for batch index creation, and smaller values (< 10) for indices that are interactively maintained.

Default value is 10

 

Current segment to add documents

$_currentSegment : \Zend_Search_Lucene_Index_SegmentWriter_DocumentWriter

Default

null
 

File system adapter.

$_directory : \Zend_Search_Lucene_Storage_Directory

Default

null
 

List of indexfiles extensions

$_indexExtensions : array

Default

array('.cfs' => '.cfs', '.cfx' => '.cfx', '.fnm' => '.fnm', '.fdx' => '.fdx', '.fdt' => '.fdt', '.tis' => '.tis', '.tii' => '.tii', '.frq' => '.frq', '.prx' => '.prx', '.tvx' => '.tvx', '.tvd' => '.tvd', '.tvf' => '.tvf', '.del' => '.del', '.sti' => '.sti')
Static
 

List of the segments, created by index writer Array of Zend_Search_Lucene_Index_SegmentInfo objects

$_newSegments : array

Default

array()
 

Array of Zend_Search_Lucene_Index_SegmentInfo objects for this index.

$_segmentInfos : array

Default

It's a reference to the corresponding Zend_Search_Lucene::$_segmentInfos array

 

List of segments to be deleted on commit

$_segmentsToDelete : array

Default

array()
 

Index target format version

$_targetFormatVersion : integer

Default

 

Changes counter.

$_versionUpdate : integer

Default

0