As funcionalidades de criação e atualização de índices são implementadas tanto no componente Zend_Search_Lucene como no projeto Java Lucene. Você pode usar qualquer uma destas opções para criar índices pesquisáveis pelo Zend_Search_Lucene.

O código PHP abaixo mostra um exemplo de como indexar um arquivo usando a API de indexação do Zend_Search_Lucene:

// Cria o índice
$index = Zend_Search_Lucene::create('/data/my-index');

$doc = new Zend_Search_Lucene_Document();

// Armazena a URL do documento para identificá-lo nos resultados da pesquisa
$doc->addField(Zend_Search_Lucene_Field::Text('url', $docUrl));

// Indexa os conteúdos do documento
$doc->addField(Zend_Search_Lucene_Field::UnStored('contents', $docContent));

// Adiciona o documento ao índice
$index->addDocument($doc);

Documentos adicionados recentemente são imediatamente pesquisáveis no índice.

O mesmo procedimento é empregado para atualizar um índice existente. A única diferença é que o método open() é chamado no lugar do método create():

// Abre um índice existente
$index = Zend_Search_Lucene::open('/data/my-index');

$doc = new Zend_Search_Lucene_Document();
// Armazena a URL do documento para identificá-lo no resultado da pesquisa
$doc->addField(Zend_Search_Lucene_Field::Text('url', $docUrl));
// Indexa o conteúdo do documento
$doc->addField(Zend_Search_Lucene_Field::UnStored('contents',
                                                  $docContent));

// Adiciona o documento ao índice
$index->addDocument($doc);

O formato de arquivo do índice Lucene não suporta a atualização do documento. Os documentos devem ser removidos e adicionados novamente ao índice para atualizá-los de forma eficaz.

O método Zend_Search_Lucene::delete() funciona com uma identificação interna do índice do documento. Ela pode ser recuperada de uma consulta pela propriedade 'id':

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

Existem dois métodos para recuperar o tamanho de um índice no Zend_Search_Lucene.

O método Zend_Search_Lucene::maxDoc() retorna um número maior do que o maior número possível de documentos. É na verdade o número total de documentos no índice incluindo os documentos excluídos, por isso ele tem um sinônimo: Zend_Search_Lucene::count().

O método Zend_Search_Lucene::numDocs() retorna o número total de documentos que não foram excluídos.

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

O método Zend_Search_Lucene::isDeleted($id) pode ser usado para verificar se um documento foi excluído.

for ($count = 0; $count < $index->maxDoc(); $count++) {
    if ($index->isDeleted($count)) {
        echo "O documento #$id foi excluído.\n";
    }
}

A otimização do índice remove os documentos excluídos e comprime as IDs dos documentos em um intervalo menor. Assim, uma id interna de um documento pode ser alterada durante a otimização do índice.

Um índice Lucene é composto por vários segmentos. Cada segmento é um conjunto de dados completamente independente.

Os arquivos de segmento de índice Lucene não podem ser atualizados devido ao seu projeto. A atualização de um segmento necessita de uma reorganização completa do segmento. Veja os formatos de arquivos de índice Lucene para mais detalhes (http://lucene.apache.org/java/2_3_0/fileformats.html) ^[10]. Novos documentos são adicionados ao índice através da criação de um novo segmento.

O aumento do número de segmentos reduz a qualidade do índice, mas uma otimização do índice resolverá o problema. Essencialmente, a otimização mescla vários segmentos em um novo. Além disso, este processo não atualiza os segmentos. Ele gera um novo grande segmento e atualiza a lista de segmentos (arquivo 'segments').

A otimização completa do índice pode ser feita chamando o método Zend_Search_Lucene::optimize(). Ele funde todos os segmentos de índice em um novo segmento:

// Abre um índice existente
$index = Zend_Search_Lucene::open('/data/my-index');

// Otimiza o índice
$index->optimize();

A otimização automática do índice é realizada para manter os índices em um estado consistente.

A otimização automática é um processo iterativo controlado por várias opções de índice. Ele funde segmentos muito pequenos para obter outros maiores, então mescla esses segmentos em segmentos ainda maiores e assim por diante.

Por padrão, arquivos de índice estão disponíveis para leitura e escrita por todos.

É possível substituir esse comportamento com o método Zend_Search_Lucene_Storage_Directory_Filesystem::setDefaultFilePermissions():

// Recupera as permissões padrões
$currentPermissions =
    Zend_Search_Lucene_Storage_Directory_Filesystem::getDefaultFilePermissions();

// Fornece permissões de leitura e escrita apenas para o usuário e grupo atuais
Zend_Search_Lucene_Storage_Directory_Filesystem::setDefaultFilePermissions(0660);