We have moved!

You are currently looking at documentation for Umbraco 8 and older versions.
An automated guess is that docs.umbraco.com/umbraco-cms/reference/searching/examine/ could be the link to the new documentation for Umbraco 9 and newer versions.

    Examine

    Examine uses Lucene as its search and index engine. Searching using Examine with Lucene can be powerful and fast.

    What is Examine?

    The Examine documentation is found here https://shazwazza.github.io/Examine/ and the source code repository for Examine is here https://github.com/Shazwazza/Examine.

    Examine allows you to index and search data quickly. Examine is a library that sits on top of Lucene.Net, a high performance search engine library. Examine provides APIs to make searching and indexing as straight forward as possible. Umbraco provides a further layer on top, UmbracoExamine, that opens up the Umbraco-specific APIs for indexing and searching content and media out of the box.

    Examine is provider based so it is extensible and allows you to configure your own custom indexes if required. The backoffice search in Umbraco also uses this same search engine, so you can trust that you're in good hands.

    Quick start

    Get up and running with Examine straight away with this quick start guide.

    Customizing indexes

    Learn how to customize the built in Umbraco indexes and how to create your own Lucene indexes using Examine in Umbraco 8.

    PDF indexing and multisearchers

    Learn how to index PDF files in Examine and how to create a multisearcher that searches through both the External Index and the Pdf Index.

    Terminology

    Describes the different terms and objects used in Examine such as Indexers, Searchers, Index Set, etc...

    Examine Management in the backoffice

    Provides an overview of the available Examine functionality available directly within the Umbraco backoffice.

    Examine events

    Details about subscribing to Examine events which can provide a way to modify the data being indexed.

    API - Examine Manager

    Describes the singleton object which exposes all of the index and search providers which are registered in the configuration of the Umbraco application.