<commit_before>eZ Components - Search
~~~~~~~~~~~~~~~~~~~~~~

.. contents:: Table of Contents


Introduction
============

The search component allows you to index and search documents. A document
consists of an object. A definition maps the object's properties to fields of a
document, just like the PersistentObject_ component. The indexing process takes
the document and indexes the fields depending on the data type. The searching
part allows you to search for documents in the index with a rich query
language.

.. _PersistentObject: introduction_PersistentObject.html


Class overview
==============

This section gives you an overview of the main classes in the Search
component.

ezcSearchSession
   This class provide access to the search index for both indexing and
   searching. All operations towards the index go through this class which
   is configured with a search handler and a definition manager.

ezcSearchSolrHandler
   The handler that uses Solr_ for indexing and searching.

ezcSearchQueryBuilder
   A class that allows you to build a search query from a search string.

ezcSearchQuery
   An interface to building complex search queries in case
   ezcSearchQueryBuilder is not up to the task.

.. _Solr: http://lucene.apache.org/solr/

Search Handlers
===============

Search handlers provide the link between the abstract query and document
interfaces to the mechanism that actually stores the index, and allows
querying for documents. Not all handlers handle all the different query
words or datatypes in the index, but effort is to put in to make as much
use of the handler's functionality as possible.

Solr
----

Currently the only implemented handler is a handler that talks to Apache's
Solr_. This handler can be accessed over TCP/IP as a web service. Solr is a<commit_msg>- Fixed wrong explanation: it's NOT the handler that is accessed over TCP/IP, but Solr<commit_after>eZ Components - Search
~~~~~~~~~~~~~~~~~~~~~~

.. contents:: Table of Contents


Introduction
============

The search component allows you to index and search documents. A document
consists of an object. A definition maps the object's properties to fields of a
document, just like the PersistentObject_ component. The indexing process takes
the document and indexes the fields depending on the data type. The searching
part allows you to search for documents in the index with a rich query
language.

.. _PersistentObject: introduction_PersistentObject.html


Class overview
==============

This section gives you an overview of the main classes in the Search
component.

ezcSearchSession
   This class provide access to the search index for both indexing and
   searching. All operations towards the index go through this class which
   is configured with a search handler and a definition manager.

ezcSearchSolrHandler
   The handler that uses Solr_ for indexing and searching.

ezcSearchQueryBuilder
   A class that allows you to build a search query from a search string.

ezcSearchQuery
   An interface to building complex search queries in case
   ezcSearchQueryBuilder is not up to the task.

.. _Solr: http://lucene.apache.org/solr/

Search Handlers
===============

Search handlers provide the link between the abstract query and document
interfaces to the mechanism that actually stores the index, and allows
querying for documents. Not all handlers handle all the different query
words or datatypes in the index, but effort is to put in to make as much
use of the handler's functionality as possible.

Solr
----

Currently the only implemented handler is a handler that talks to Apache's
Solr_. The handler accesses Solr over TCP/IP as a web service. Solr is a
{'fraction_non_alphanumeric': 0.0617519042437432, 'fraction_numerical': 0.0, 'mean_word_length': 4.375730994152047, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6565968', 'n_tokens_mistral': 900, 'n_tokens_neox': 856, 'n_words': 520}