This Bundle provides a simple API to index and query a Solr Index.

And do not forget to join the Gitter chat

The bundle requires a working doctrine-orm or doctrine-mongodb configuration. There are no differences in the use.

Bundle

1. Register bundle in AppKernel.php

   # app/AppKernel.php
   
   $bundles = array(
       // ...
       new FS\SolrBundle\FSSolrBundle(),
       // ...
   );
   

2. Add Bundle to autoload

   A. Via composer, add in your composer.json

   "require": {
       // ...  
       "floriansemm/solr-bundle": "dev-master"
   }
   

   B. or manually, in app/autoload.php

   i. In symfony 2.1.4 (supposing you clone the bundle in vendor/floriansemm/solr-bundle/FS/, making available vendor/floriansemm/solr-bundle/FS/SolrBundle/FSSolrBundle.php)

   $loader->add('FS\\SolrBundle', array(__DIR__.'/../vendor/floriansemm/solr-bundle'));		
   

   ii. in older version it could be

   $loader->registerNamespaces(array(
       // ...
       'FS' => __DIR__.'/../vendor/bundles',
       // ...
   ));
   

You have to setup the connection options

# app/config/config.yml
fs_solr:
  endpoints:
    core1:
      host: host
      port: 8983
      path: /solr/core1
      core: corename
      timeout: 5
    core2:
      host: host
      port: 8983
      path: /solr/core2
      core: corename
      timeout: 5

With this config you can setup two cores: core1 and core2. See section Specify cores for more information.

To put an entity to the index, you must add some annotations to your entity:

// your Entity

// ....
use FS\SolrBundle\Doctrine\Annotation as Solr;

/**
 * @Solr\Document(repository="Full\Qualified\Class\Name")
 * @ORM\Table()
 */
class Post
{
	/**
	 * @Solr\Id
	 *
	 * @ORM\Column(name="id", type="integer")
	 * @ORM\Id
	 * @ORM\GeneratedValue(strategy="AUTO")
	 */

	private $id;
	/**
	 *
	 * @Solr\Field(type="string")
	 *
	 * @ORM\Column(name="title", type="string", length=255)
	 */
	private $title = '';

	/**
	* 
	* @Solr\Field(type="string")
	*
	* @ORM\Column(name="text", type="text")
	*/
	private $text = '';

	/**
	* @Solr\Field(type="date")
	*
	* @ORM\Column(name="created_at", type="datetime")
	*/
	private $created_at = null;
}

Currently is a basic set of types implemented.

• string
• text
• date
• integer
• float
• double
• long
• boolean

It is possible to use custum field types (schema.xml).

In some cases a entity should not be index. For this you have the SynchronizationFilter Annotation.

/**
* @Solr\Document
* @Solr\SynchronizationFilter(callback="shouldBeIndex")
*/
class SomeEntity
{
	/**
	* @return boolean
	*/
	public function shouldBeIndex()
	{
		// put your logic here
	}
}

The callback property specifies an callable function, which decides whether the should index or not.

It is possible to specify a core dedicated to a document

   /**
	* @Solr\Document(index="core0")
	*/
	class SomeEntity
	{
	    // ...
	}

All documents will be indexed in the core core0. If your entities/document have different languages then you can setup a callback method, which returns the preferred core for the entity.

   /**
	* @Solr\Document(indexHandler="indexHandler")
	*/
	class SomeEntity
	{
	    public function indexHandler()
	    {
	        if ($this->language == 'en') {
	            return 'core0';
	        }
	    }
	}

Each core must setup up in the config.yml under endpoints. If you leave the index or indexHandler property empty, then a default core will be used (first in the endpoints list). To index a document in all cores use * as index value:

    @Solr\Document(index="*")

Solr comes with a set of predefined field-name/field-types mapping:

• title (solr-type: general_text)
• text (solr-type: general_text)
• category (solr-type: general_text)
• content_type (solr-type: string)

For details have a look into your schema.xml.

So if you have an entity with a property "category", then you don't need a type-declaration in the annotation:

/**
* @Solr\Field
* @ORM\Column(name="category", type="text")
*/
private $category = '';

The field has in this case automaticaly the type "general_text".

If you persist this entity, it will put automaticlly to the index. Update and delete happens automatically too.

To query the index you have to call some services.

$query = $this->get('solr')->createQuery('AcmeDemoBundle:Post');
$query->addSearchTerm('title', 'my title');

$result = $result = $query->getResult();

The $result array contains all found entities. The solr-service does all mappings from SolrDocument to your entity for you.

The pervious examples have queried only the field 'title'. You can also query all fields with a string.

$query = $this->get('solr.client')->createQuery('AcmeDemoBundle:Post');
$query->queryAllFields('my title');

$result = $query->getResult();

To narrow the mapping, you can use the addField() method.

$query = $this->get('solr.client')->createQuery('AcmeDemoBundle:Post');
$query->addSearchTerm('title', 'my title');
$query->addField('id');
$query->addField('text');

$result = $query->getResult();

In this case only the fields id and text will be mapped (addField()), so title and created_at will be empty. If nothing was found $result is empty.

HydrationMode tells the Bundle how to create an entity from a document.

1. FS\SolrBundle\Doctrine\Hydration\HydrationModes::HYDRATE_INDEX - use only the data from solr
2. FS\SolrBundle\Doctrine\Hydration\HydrationModes::HYDRATE_DOCTRINE - merge the data from solr with the entire doctrine-entity

With a custom query:

$query = $this->get('solr')->createQuery('AcmeDemoBundle:Post');
$query->setHydrationMode($mode)

With a custom document-repository you have to set the property $hydrationMode itself:

public function find($id)
{
    $this->hydrationMode = HydrationModes::HYDRATE_INDEX;

    return parent::find($id);
}

To index your entities manually, you can do it the following way:

$this->get('solr')->addDocument($entity);
$this->get('solr')->updateDocument($entity);
$this->get('solr')->deleteDocument($entity);

deleteDocument() requires that the entity-id is set.

If you specify your own repository you must extend the FS\SolrBundle\Repository\Repository class. The useage is the same like Doctrine-Repositories:

$myRepository = $this->get('solr')->getRepository('AcmeDemoBundle:Post');
$result = $myRepository->mySpecialFindMethod();

If you haven't declared a concrete repository in your entity and you calling $this->get('solr')->getRepository('AcmeDemoBundle:Post'), you will get an instance of FS\SolrBundle\Repository\Repository.

There are comming two commands with this bundle:

• solr:index:clear - delete all documents in the index
• solr:synchronize - synchronize the db with the index