トップページ　→関数リファレンス　→検索エンジン用の拡張モジュール　→Solr　→SolrClient

関数・クラス解説

SolrClient::addDocument

version:PECL solr >= 0.9.2 (公式)

Adds a document to the index

公式リファレンス

書式

public SolrClient::addDocument ( SolrInputDocument $doc [, bool $overwrite = TRUE [, int $commitWithin = 0 ]] ) : SolrUpdateResponse

説明

This method adds a document to the index.

パラメータ

doc: The SolrInputDocument instance.
overwrite: Whether to overwrite existing document or not. If FALSE there will be duplicates (several documents with the same ID).
警告 PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag. $allowDups = false is the same as $overwrite = true
commitWithin: Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means disabled. When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a commit when the oldest add in the buffer is due.

返値

Returns a SolrUpdateResponse object or throws an Exception on failure.

エラー

Throws SolrClientException if the client had failed, or there was a connection issue. Throws SolrServerException if the Solr Server had failed to process the request.

注意

警告 PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag. $allowDups = false is the same as $overwrite = true

サンプル

例1 SolrClient::addDocument() example 


$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$doc = new SolrInputDocument();

$doc->addField('id', 334455);
$doc->addField('cat', 'Software');
$doc->addField('cat', 'Lucene');

$updateResponse = $client->addDocument($doc);

// you will have to commit changes to be written if you didn't use $commitWithin
$client->commit();

print_r($updateResponse->getResponse());


 上の例の出力は、たとえば以下のようになります。 

SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 1
        )

)

 例2 SolrClient::addDocument() example 2 


$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$doc = new SolrInputDocument();

$doc->addField('id', 334455);
$doc->addField('cat', 'Software');
$doc->addField('cat', 'Lucene');

// No need to call commit() because $commitWithin is passed, so Solr Server will auto commit within 10 seconds
$updateResponse = $client->addDocument($doc, false, 10000);

print_r($updateResponse->getResponse());


 上の例の出力は、たとえば以下のようになります。 

SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 1
        )

)