silverstripe-fulltextsearch/docs/en/01_getting_started/10_module_scope.md

# Introduction

This is a module aimed at adding support for standalone fulltext search engines to SilverStripe.

It contains several layers:

 * A fulltext API, ignoring the actual provision of fulltext searching
 * A connector API, providing common code to allow connecting a fulltext searching engine to the fulltext API
 * Some connectors for common fulltext searching engines (currently only [Apache Solr](http://lucene.apache.org/solr/))

## Reasoning

There are several fulltext search engines that work in a similar manner. They build indexes of denormalized data that
are then searched through using some custom query syntax.

Traditionally, fulltext search connectors for SilverStripe have attempted to hide this design, instead presenting
fulltext searching as an extension of the object model. However, the disconnect between the fulltext search engine's
design and the object model meant that searching was inefficient. The abstraction would also often break and it was
hard to then figure out what was going on.

This module instead provides the ability to define those indexes and queries in PHP. The indexes are defined as a mapping
between the SilverStripe object model and the connector-specific fulltext engine index model. This module then interrogates model metadata
to build the specific index definition.

It also hooks into SilverStripe framework in order to update the indexes when the models change and connectors then convert those index and query definitions
into fulltext engine specific code.

The intent of this module is not to make changing fulltext search engines seamless. Where possible this module provides
common interfaces to fulltext engine functionality, abstracting out common behaviour. However, each connector also
offers its own extensions, and there is some behaviour (such as getting the fulltext search engines installed, configured
and running) that each connector deals with itself, in a way best suited to that search engine's design.
prune module scope, add boosting docs 2018-05-24 16:24:37 +02:00			`# Introduction`
Import first version of fulltextsearch module 2011-05-02 06:33:05 +02:00
			`This is a module aimed at adding support for standalone fulltext search engines to SilverStripe.`

Update documentation 2012-07-19 03:27:53 +02:00			`It contains several layers:`
Import first version of fulltextsearch module 2011-05-02 06:33:05 +02:00
Documentation 2012-08-29 21:52:56 +02:00			`* A fulltext API, ignoring the actual provision of fulltext searching`
prune module scope, add boosting docs 2018-05-24 16:24:37 +02:00			`* A connector API, providing common code to allow connecting a fulltext searching engine to the fulltext API`
			`* Some connectors for common fulltext searching engines (currently only [Apache Solr](http://lucene.apache.org/solr/))`
Import first version of fulltextsearch module 2011-05-02 06:33:05 +02:00
			`## Reasoning`

			`There are several fulltext search engines that work in a similar manner. They build indexes of denormalized data that`
prune module scope, add boosting docs 2018-05-24 16:24:37 +02:00			`are then searched through using some custom query syntax.`
Import first version of fulltextsearch module 2011-05-02 06:33:05 +02:00
			`Traditionally, fulltext search connectors for SilverStripe have attempted to hide this design, instead presenting`
prune module scope, add boosting docs 2018-05-24 16:24:37 +02:00			`fulltext searching as an extension of the object model. However, the disconnect between the fulltext search engine's`
Import first version of fulltextsearch module 2011-05-02 06:33:05 +02:00			`design and the object model meant that searching was inefficient. The abstraction would also often break and it was`
			`hard to then figure out what was going on.`

Update documentation 2012-07-19 03:27:53 +02:00			`This module instead provides the ability to define those indexes and queries in PHP. The indexes are defined as a mapping`
DOCS Update namespaces and code formatting in documentation 2017-11-20 22:51:32 +01:00			`between the SilverStripe object model and the connector-specific fulltext engine index model. This module then interrogates model metadata`
			`to build the specific index definition.`
Import first version of fulltextsearch module 2011-05-02 06:33:05 +02:00
DOCS Update namespaces and code formatting in documentation 2017-11-20 22:51:32 +01:00			`It also hooks into SilverStripe framework in order to update the indexes when the models change and connectors then convert those index and query definitions`
Update documentation 2012-07-19 03:27:53 +02:00			`into fulltext engine specific code.`
Import first version of fulltextsearch module 2011-05-02 06:33:05 +02:00
			`The intent of this module is not to make changing fulltext search engines seamless. Where possible this module provides`
			`common interfaces to fulltext engine functionality, abstracting out common behaviour. However, each connector also`
Update documentation 2012-07-19 03:27:53 +02:00			`offers its own extensions, and there is some behaviour (such as getting the fulltext search engines installed, configured`
			`and running) that each connector deals with itself, in a way best suited to that search engine's design.`