-
-
Notifications
You must be signed in to change notification settings - Fork 123
Terminology
*** This is Legacy documentation *** here's the links to the current docs:
Tip: There are many unit tests in the source code that can be used as Examples of how to do things. There is also a test web project that has plenty of examples of how to configure indexes and search them.
Describes the different terms/names used throughout Examine
An Index is the repository that stores searchable data, generally Examine uses Lucene as its index repository but if you really wanted it is possible to use any repository, though this would require writing a lot of code.
Examine is made up of 3 basic parts: Indexers , Searchers and Index Sets. Each one of these components requires exactly 1 of the other components, there is a 1 to 1 to 1 ratio between these objects. For example, each Index Set will have an associated Indexer and Searcher.
An indexer in Examine is the object that performs the storing data into the index. The most basic interface that defines an indexer is Examine.IIndexer. An indexer's functionality is to: Add or update index data for a data entity, delete index data for a data entity, re-index all data based on a specified data source.
A searcher in Examine is the object that performs the searching of data that is stored in the index.The most basic interface that defines a searcher is Examine.ISearcher. Examine has the capability to search based on it's own Fluent Api, or by querying directly to Lucene using raw lucene search syntax.
An index set is what defines an index, where the index is saved and how the information is stored in the index.