インデックスの作成機能および更新機能は、 Zend_Search_Lucene モジュールと Java Lucene で実装されています。 これらの両方の機能を使用することができます。

以下の PHP コードでは、Zend_Search_Lucene のインデックス作成 API を用いてファイルをインデックス化する例を示します。

<?php
// インデックスを作成します
$index = Zend_Search_Lucene::create('/data/my-index');

$doc = new Zend_Search_Lucene_Document();

// ドキュメントの URL を、検索結果の ID として保存します。
$doc->addField(Zend_Search_Lucene_Field::Text('url', $docUrl));

// ドキュメントの内容をインデックス化します。
$doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $docContent));

// ドキュメントをインデックスに追加します。
$index->addDocument($doc);
?>

新しく追加されたドキュメントは、 すぐにインデックスから取得できるようになります。

既存のインデックスを更新する際にも同じ手順を使用します。ただひとつの違いは、 create() メソッドではなく open() メソッドをコールするということです。

<?php
// 既存のインデックスをオープンします。
$index = Zend_Search_Lucene::open('/data/my-index');

$doc = new Zend_Search_Lucene_Document();
// ドキュメントの URL を、検索結果の ID として保存します。
$doc->addField(Zend_Search_Lucene_Field::Text('url', $docUrl));
// ドキュメントの内容をインデックス化します。
$doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $docContent));

// ドキュメントをインデックスに追加します。
$index->addDocument($doc);
?>

Lucene インデックスファイルは、ドキュメントの更新をサポートしていません。 更新するためには、いったん削除した上で改めて追加する必要があります。

そのためには、インデックス内部のドキュメント ID を使用して Zend_Search_Lucene::delete() メソッドをコールします。 この ID は、クエリでヒットした内容から 'id' プロパティで取得できます。

<?php
$removePath = ...;
$hits = $index->find('path:' . $removePath);
foreach ($hits as $hit) {
    $index->delete($hit->id);
}
?>

Zend_Search_Lucene のインデックスの大きさを知るには、二通りの方法があります。

Zend_Search_Lucene::maxDoc() は、 最大のドキュメント番号にひとつ足した値を返します。 これは、削除されたドキュメントを含む、インデックス内のドキュメントの総数を表します。 そこで、このメソッドのシノニムとして Zend_Search_Lucene::count() を用意しました。

Zend_Search_Lucene::numDocs() は、削除されていないドキュメントの総数を返します。

<?php
$indexSize = $index->count();
$documents = $index->numDocs();
?>

Zend_Search_Lucene::isDeleted($id) メソッドで、そのドキュメントが削除されているかどうかを調べます。

<?php
for ($count = 0; $count < $index->maxDoc(); $count++) {
    if ($index->isDeleted($count)) {
        echo "ドキュメント #$id は削除されました。\n";
    }
}
?>

インデックスの最適化を行うと、削除されたドキュメントを取り除き、 ドキュメントの ID を前のほうに詰め込みます。 つまり、内部でのドキュメント ID は変わる可能性があります。

Lucene のインデックスは、セグメントから構成されます。 各セグメントはデータの一部分を表し、それぞれ完全に独立しています。

Lucene インデックスセグメントのファイルは、その性質上更新することはできません。 セグメントを更新するには、セグメント全体を再構成する必要があります (Lucene インデックスファイルのフォーマットについての詳細は、 http://lucene.apache.org/java/docs/fileformats.html を参照ください)。このことより、新しいドキュメントをインデックスに追加する際には、 新しいセグメントを作成することになります。

セグメントの数が増えるとインデックスの効率が下がります。 しかし、インデックスの最適化によってこれを修復することができます。 最適化により、複数のセグメントに分かれているデータがひとつにまとめられます。 この処理も、セグメントを更新することはありません。まず大きなセグメントを新しく作成し、 これまでいくつものセグメントに分かれていたデータをひとまとめにしてそこに格納し、 その後でセグメント一覧 ('segments' ファイル) を更新します。

インデックス全体の最適化を行うには、Zend_Search_Lucene::optimize() をコールします。これは、すべてのインデックスセグメントを新しいひとつのセグメントにまとめます。

<?php
// 既存のインデックスをオープンします
$index = Zend_Search_Lucene::open('/data/my-index');

// インデックスを最適化します
$index->optimize();
?>

自動的なインデックス最適化により、インデックスの一貫性を保ちます。

自動的な最適化は、いくつかのインデックスオプションにもとづいて段階的に進められます。 まず非常に小さなセグメントが少し大きめのセグメントに統合され、 さらにそれがもう少し大きな別のセグメントに統合され、... といった具合です。

制限はプラットフォームに依存します。

32 ビットプラットフォームでは、インデックスの大きさは最大 2GB までとなります。