SlideShare a Scribd company logo
Solr Recipes Workshop
         uberconf - July 14, 2011
        Presented by Erik Hatcher
   erik.hatcher@lucidimagination.com
            Lucid Imagination
    http://www.lucidimagination.com
About me...

• Co-author, “Lucene in Action”
• Commiter, Lucene and Solr
• Lucene PMC and ASF member
• Member of Technical Staff / co-founder,
  Lucid Imagination
About Lucid Imagination...
•   Lucid Imagination provides commercial-grade
    support, training, high-level consulting and value-
    added software for Lucene and Solr.

•   We make Lucene ‘enterprise-ready’ by offering:

    •   Free, certified, distributions and downloads.

    •   Support, training, and consulting.

    •   LucidWorks Enterprise, a commercial search
        platform built on top of Solr.
What is Lucene?
•   An open source Java-based IR library with best practice indexing
    and query capabilities, fast and lightweight search and indexing.

•   100% Java (.NET, Perl and other versions too).

•   Stable, mature API.

•   Continuously improved and tuned over more than 10 years.

•   Cleanly implemented, easy to embed in an application.

•   Compact, portable index representation.

•   Programmable text analyzers, spell checking and highlighting.

•   Not a crawler or a text extraction tool.
Lucene's History
•   Created by Doug Cutting in 1999

    •   built on ideas from search projects Doug created at Xerox PARC
        and Apple.

•   Donated to the Apache Software Foundation (ASF) in 2001.

•   Became an Apache top-level project in 2005.

•   Has grown and morphed through the years and is now both:

    •   A search library.

    •   An ASF Top-Level Project (TLP) encompassing several sub-projects.

•   Lucene and Solr "merged" development in early 2010.
What is Solr?
•   An open source search engine.

•   Indexes content sources, processes query requests, returns
    search results.

•   Uses Lucene as the "engine", but adds full enterprise search
    server features and capabilities.

•   A web-based application that processes HTTP requests and
    returns HTTP responses.

•   Initially started in 2004 and developed by CNET as an in-house
    project to add search capability for the company website.

•   Donated to ASF in 2006.
What Version of Solr?

•   There’s more than one answer!

•   The current, released, stable version is 3.3

•   The development release is referred to as “trunk”.

    •   This is where the new, less tested work goes on

    •   Also referred to as 4.0

•   LucidWorks Enterprise is built on a trunk snapshot +
    additional features.
Who uses Lucene/Solr?




     And many many many many more...!
Ingestion
• CSV
• Relational databases
• File system
• Web crawl
• API / Solr XML, JSON, and javabin/SolrJ
• Others - XML feeds (e.g. RSS/Atom), e-mail
Solr indexing options
Solr XML
POST to /update
<add>
  <doc>
    <field name="id">rawxml1</field>
    <field name="content_type">text/xml</field>
    <field name="category">index example</field>
    <field name="title">Simple Example</field>
    <field name="filename">addExample.xml</field>
    <field name="text">A very simple example of
         adding a document to the index.</field>
  </doc>
</add>
CSV indexing
•   http://localhost:8983/solr/update/csv

•   Files can be sent over HTTP:

    •   curl http://localhost:8983/solr/update/csv --data-binary
        @data.csv -H 'Content-type:text/plain; charset=utf-8’

•   or streamed from the file system:

    •   curl http://localhost:8983/solr/update/csv?
        stream.file=exampledocs/
        data.csv&stream.contentType=text/plain;charset=utf-8
CSV indexing params
•   header: Default is true. Indicates that the first line of the file
    contains field names.

•   fieldnames: A comma-separated list of fieldnames which will
    override the header parameter.

•   separator: Defaults to a comma, but other characters can be
    used.

•   trim: If true, remove whitespace before and after separator.

•   Full parameter list: http://wiki.apache.org/solr/UpdateCSV

•   Yes, tab-delimited files are supported too:

    •   &separator=%09
Rich documents
•   Tika is a toolkit for detecting and extracting metadata and
    structured text content from various document formats using
    existing parser libraries.

•   Tika identifies MIME types and then uses the appropriate parser
    to extract text.

•   The ExtractingRequestHandler uses Tika to identify types and
    extract text, and then indexes the extracted text.

•   The ExtractingRequestHandler is sometimes called "Solr Cell",
    which stands for Content Extraction Library.

•   File formats include MS Office, Adobe PDF, XML, HTML, MPEG
    and many more.
Solr Cell basics

• defaultField: If uprefix is not set, and a field
  cannot be determined, the default field is
  used.
• Full list of parameters: http://wiki.apache.org/
  solr/ExtractingRequestHandler
Solr Cell config
Solr Cell parameters
•   The literal parameter is very important.

    •   A way to add other fields not indexed using Tika to documents.

    •   &literal.id=12345

    •   &literal.category=sports

•   Using curl to index a file on the file system:

    •   curl 'http://localhost:8983/solr/update/extract?
        literal.id=doc1&commit=true' -F myfile=@tutorial.html

•   Streaming a file from the file system:

    •   curl "http://localhost:8983/solr/update/extract?stream.file=/some/path/
        news.doc&stream.contentType=application/msword&literal.id=12345"
Streaming remote docs

• Streaming a file from a URL:
 • curl http://localhost:8983/solr/update/
    extract?literal.id=123&stream.url=http://
    www.solr.com/content/goodContent.pdf
    -H 'Content-type:application/pdf’
Indexing from RDBMS
• Techniques
 • DIH
 • Custom script
• Hurdles
 • Flattening
 • Performance
DataImportHandler
•   The DataImportHandler (DIH):

    •   An "in-process" module that can be used to index data directly
        from relational databases and other data sources.

    •   Configuration driven.

    •   A tool that can aggregate data from multiple database tables, or
        even multiple data sources to be indexed as a single Solr
        document.

    •   Provides powerful and customizable data transformation tools.

    •   Can do full import or delta import.

    •   Pluggable to allow indexing of any type of data source.
Using Solr’s Data
            Import Handler
    •   One or more configuration files can be created for
        DIH instances.

    •   All DIH configuration files must be declared in a
        request handler in solrconfig.xml and given a unique
        name:

<requestHandler
  class="org.apache.solr.handler.dataimport.DataImportHandler”
  name="/dataimport">
    <lst name="defaults">
      <str name="config">db-config.xml</str>
    </lst>
</requestHandler>
Enabling the
    DataImportHandler
•   The jar files for DIH must be included on the
    path

    •   apache-solr-dataimporthandler-3.3.0.jar

    •   apache-solr-dataimporthandler-extras-3.3.0.jar

    •   This is a change since version 1.4.1

•   The example solrconfig file include a “lib”
    command to include these files.
DIH Components
•   Data sources:

    •   Provide access to relational databases, plain files, XML, etc.

•   Entity processors:

    •   Configuration elements that work with data sources and do
        most of the work.

    •   Can be nested.

•   Transformers:

    •   Modify data in many different ways.

    •   Can be chained together.
DIH Capabilities
•   From a database. (SQL entity processor, Jdbc
    datasource)

•   An RSS or Atom feed. (XPath entity processor,
    URL datasource)

•   XML files. (Xpath entity processor, File datasource)

•   Plain text files. (Plaintext entity processor, File
    datasource)

•   From a mail server. (Mail entity processor)
DIH with database
• Create a document with database fields
  title, ISBN mapped to Solr fields title, id
• No EntityProcessor is included so the
  default SqlEntityProcessor is used.
DIH with RSS
• Using the XPathEntityProcessor to map
  data to index fields.
DIH with email
•   Mail Input: Example DIH Configuration File

•   Using the MailEntityProcessor to index email data.
DIH - richer example
DIH DataSources
•   JdbcDataSource: Default if none is specified. Iterates
    rows of a database one by one.

•   URLDataSource: Used to fetch content from file:// or
    http:// locations.

•   FileDataSource: Similar to URLDataSource, but
    locations are specified with a "basePath" parameter.

•   The class
    org.apache.solr.handler.dataimport.DataSource can be
    extended to create custom data sources.
DIH EntityProcessors
•   SqlEntityProcessor: Default if none is specified. works with a
    JdbcDataSource to index database tables.

•   XPathEntityProcessor: Implements a streaming parser which
    supports a subset of xpath syntax. Complete xpath syntax is not
    yet supported.

•   FileListEntityProcessor: Does not use a DataSource. Enumerates
    a list of files. Typically used as an "outer" entity.

•   CachedSqlEntityProcessor: An extension of the
    SqlEntityProcessor reduces the number of queries executed by
    caching rows. (Only for inner nested entities.)

•   PlainTextEntityProcessor: Reads text into a "plainText" field.
DIH transforming

• Fields that are processed can either be
  indexed directly or transformed and
  modified.
• New fields can be created.
• Transformers can be chained.
DIH Transformers
•   RegexTransformer: Manipulates field values using regular
    expressions.

•   DateFormatTransformer: Parses date/time strings into
    java.util.Date instances.

•   NumberFormatTransformer: Parses numbers from a string.

•   TemplateTransformer: Explicitly sets a text value.
    Optionally can use variable names.

•   HTMLStringTransformer: Removes HTML markup.

•   ClobTransformer: Creates a string from a CLOB data type.

•   ScriptTransformer: Write custom transformers in
    JavaScript or other scripting languages.
DIH Full and Delta
         Imports
•   The DIH can be used for both full imports and delta
    imports.

•   The query element is used for a full import.

•   The deltaQuery element gives the primary keys of
    the current entity which have changes since the last
    index time. These primary keys will be used by the
    deltaImportQuery.

•   The deltaImportQuery element gives the data needed
    to populate fields when running a delta-import .
DIH basic commands
•   Full import example:

    •   http://localhost:8983/solr/dataimport?command=full-import

•   Delta import example:

    •   http://localhost:8983/solr/dataimport?command=delta-import

•   The "rows" parameter can be used to limit the amount of input:

    •   http://localhost:8983/solr/dataimport?command=full-import&rows=10

•   The "commit" parameter defaults to "true" if not explicitly set:

    •   http://localhost:8983/solr/dataimport?command=full-
        import&rows=10&commit=false
DIH "clean" param
•   Be careful with the "clean" parameter.

•   clean=true will delete everything from the index – all
    documents will be deleted.

•   clean=true is the default!

•   Get in the habit of always setting the clean parameter
    so you are not surprised with unexpected data loss.

    •   http://localhost:8983/solr/dataimport?
        command=full-import&clean=false
DIH Admin Console
• There is an admin console page for the
  DIH, but there is no link to it from the
  main admin page.
 • http://localhost:8983/solr/admin/
    dataimport.jsp
 • The link brings up a list of all DIH
    configurations (there can be more than
    one.)
Using Solr’s Data
        Import Handler
•   DataImportHandler Admin Console

•   The main section shows the configuration and a few
    commands:
DIH console
                commands
    •   At the bottom of the page there are options for
        running various operations such as full-imports
        and delta-imports:




Note that all of these commands can also be
executed from the command line using curl or wget.
DIH status
• The display to the right
  shows the XML output
  of commands that are
  run from the console.
• This example shows
  the response after a
  delta-import.
DIH experimenting
•   You can also view the status of an ongoing process (for example a
    long import) by going directory to the URL for the handler:

    •   http://localhost:8983/solr/dataimport

•   curl can also be used with the DIH:

    •   curl 'http://localhost:8983/solr/dataimport?command=full-
        import&rows=10’

    •   Setting rows=10 is a good way to limit the indexing during
        development.
Other DIH capabilities

• TikaEntityProcessor
• SolrEntityProcessor (see SOLR-1499)
• Multi-threaded capabilities
Web crawl


• Solr is not a crawler
• Options: Nutch, droids, or LucidWorks
  Enterprise
Committing
curl http://localhost:8983/solr/update
-H "Content-Type: text/xml"
--data-binary "<commit/>"
API Indexing

• Solr XML
• Solr JSON
• SolrJ - javabin format, streaming/multithread
Solr APIs

• SolrJ can use an internal javabin format (or
  XML)
• Most other Solr APIs ride on Solr XML or
  Solr JSON formats
Ruby indexing example
SolrJ searching example
SolrServer solrServer = new CommonsHttpSolrServer(
                                   "http://localhost:8983/solr");
SolrQuery query = new SolrQuery();
query.setQuery(userQuery);
query.setFacet(true);
query.setFacetMinCount(1);
query.addFacetField("category");

QueryResponse queryResponse = solrServer.query(query);
Updating documents
•   Solr uses the "uniqueKey" to determine a the "identity" of a
    document.

•   Adding a document to the index with the same uniqueKey as an
    existing document means the new document will replace the original.

•   An "update" is actually two steps, internally:

    •   Delete the document with that id.

    •   Add the new document.

    •   So documents are, more accurately, "replaced", not deleted.

    •   No field-level updating – a whole document has to be replaced
Deleting documents
•   Documents can be deleted:

    •   Using a delete by id.

        •   <delete><id>05991</id></delete>

    •   Using a delete by query.

        •   <delete><query>category:music</query></delete>

•   When a document is deleted it still exists in an index segment until
    that segment is merged.

•   Rollback: <rollback/>

    •   All adds and deletes since the last commit are rolled back.
Fields

• data analysis / exploration
• character mapping
• tokenizing/filtering
• copyField
Field Types: "primitives"
•   field types entirely specified in schema.xml,
    but... keep the standard (non TextField ones)
    as-is from Solr's provided example schema.
•   string, boolean, binary, int, float, long, double,
    date
•   numeric types for faster range queries (and
    bigger index): tint, tfloat, tlong, tdouble, tdate
TextField
          • TextField "analyzes" field value
<fieldType name="text_general" class="solr.TextField" positionIncrementGap="100">
  <analyzer type="index">
    <tokenizer class="solr.StandardTokenizerFactory"/>
    <filter class="solr.StopFilterFactory" ignoreCase="true" words="stopwords.txt"
             enablePositionIncrements="true" />
    <filter class="solr.LowerCaseFilterFactory"/>
  </analyzer>
  <analyzer type="query">
    <tokenizer class="solr.StandardTokenizerFactory"/>
    <filter class="solr.StopFilterFactory" ignoreCase="true" words="stopwords.txt"
             enablePositionIncrements="true" />
    <filter class="solr.SynonymFilterFactory" synonyms="synonyms.txt"
             ignoreCase="true" expand="true"/>
    <filter class="solr.LowerCaseFilterFactory"/>
  </analyzer>
</fieldType>
Character Filters
He went to
 the café
   <fieldType name="text_ws" class="solr.TextField">
     <analyzer>
       <charFilter
        class="solr.MappingCharFilterFactory"
            mapping="mapping-ISOLatin1Accent.txt"/>
       <tokenizer class="solr.WhitespaceTokenizerFactory"/>
       <filter class="solr.LowerCaseFilterFactory"/>
     </analyzer>
   </fieldType>
                                               he went to the
                                                    cafe
copyField
• Clones the exact field value to another
  field
• destination field controls handling of cloned
  value
• Useful when same field value needs to be
  indexed/stored in several different ways
  • e.g. sorting
Schema Deep Dive


• DEMO: Let's look at schema.xml
  interactively, and discuss other features
Searching

• The basic parameters
• Filtering
• Query parsing
Searching Basics


• http://localhost:8983/solr/select?q=*:*
Basic Search Params
• q - main query
• rows - maximum number of "hits" to
  return
• start - zero-based hit starting point
• fl - comma-separated field list
 • * for all stored fields
 • score for computed Lucene score
Other Common Search
     Parameters
• sort - specify sort criteria either by field(s)
  or function(s) in ascending or descending
  order
• fq - filter queries, multiple values supported
• wt - writer type - format of Solr response
• debugQuery - adds debugging info to
  response
Filtering results
• Use fq to filter results in addition to main
  query constraints
• fq results are independently cached in Solr's
  filterCache
• filter queries do not contribute to ranking
  scores
• Commonly used for filtering on facets
Richer Solr Request

• http://localhost:8983/solr/select
  ?q=ipod
  &facet=on
  &facet.field=cat
  &fq=cat:electronics
Query Parsing
• String -> org.apache.lucene.search.Query
• Several built-in query parser choices, including
 • "lucene" - Solr-savvy version of Lucene's
    standard query parser
  • "dismax" - most commonly used, currently
  • "edismax" - extended dismax
Defaults for query
 "lucene" and "(e)dismax"

• schema.xml
 • <defaultSearchField>field</defaultSearchField>
 • <solrQueryParser defaultOperator="AND|OR"/>
Selecting Query Parser

• defType=lucene|dismax|edismax|....
 • Sets query parser for q parameter only
• Or via {!local_params} syntax
 • q={!dismax}query expression
 • only way to set query parser for fq's
"lucene" query parser
• Solr subclass of Lucene's QueryParser
 • schema-aware, for range queries, etc
 • special handling of wildcarded clauses
 • back-door special "fields"
   • _val_ - for function queries
   • _query_ - for nested queries
"lucene" parser
         examples
• search AND (lucene OR solr)
• rating:[7 TO 10]
• +required -prohibited
• wild?card OR prefix* AND fuzzy~
• "phrases for proximity"
"dismax" query parser

• disjunction-maximum
• enables spreading query terms across
  multiple fields with individual field-specific
  boosts
• many parameters
"dismax" params
Parameter   Description

q           Defines the raw input strings for the query.
q.alt       Calls the Lucene query parser and defines query input strings when the q parameter is
            not used. (useful for getting facet counts when no query specified)
qf          Query Fields: Specifies the fields to be searched.
pf          Phrase Fields: Fields will be queried using the terms entered as a phrase query.

ps          Phrase Slop: How close to one another the terms within a phrase query must be.

mm          Minimum "Should" Match: Number of fields that must match a query

tie         Tie Breaker: A float value to use as a tie breaker
bq          Boost Query: An optional query that can be used to boost and refine results

bf          Boost Functions: Functions that can be used to tune relevance
"dismax" config example
"edismax" query parser
•   Extended dismax

•   Supports full lucene query syntax in the absence of
    syntax errors.

•   Improved proximity boosting via word bigrams.

•   Supports the "boost" parameter like the dismax bf
    param, but multiplies the function query instead of
    adding it in for better scoring integration.

•   Allows for wildcard searches, which dismax does not
    do.
"term" query parser

• {!term f=field_name}value
• Very useful for fq parameters where field
  value may contain Lucene query parser
  special characters!
Nested queries


• q=_query_:"{!dismax qf='author coauthor'}
  bob" AND _query_:"{!dismax qf='title
  subtitle'}testing"
Faceting
• field
• query
• range, numeric and date
• multi-select
• pivot
• cache impact
Field faceting


• facet.field=field_name
Query faceting
•   facet.query=some query expression

•   Default query parser: "lucene"

•   Use {!parser ...} syntax to select different parser

•   Use {!key=whatever} to have a nicer output key

•   Example:

    •   facet.query={!key=cheapest}price:[0 TO 10]
Range faceting
•   Works for date and numeric field types

•   Range facets divide a range into equal sized
    buckets.

•   facet.range.start=100

•   facet.range.end=900

•   facet.range.gap=200

•   facet.range.other=before

•   facet.range.other=after
Multi-select faceting
• Traditional faceting/filtering
  (facet.field=cat&fq=cat:electr
  onics) narrows facet values
  to only those in result set
• Sometimes you want to
  allow multiple values and
  counts across all facet values
 &fq={!tag=myTag}project:solr
 &facet=on&facet.field={!ex=myTag}project
Pivot faceting

• Currently only available on trunk (Solr
  "4.0")
• facet.pivot=field1,field2,...
• facet counts within results of parent facet
Cache impact of
         faceting
• Faceting supports different internal
  algorithms / data structures, controlled
  through facet.method parameter
  • enum - enumerates all terms in a field,
    uses Solr's filterCache
  • fc - uses Lucene's FieldCache
Integration
• Prototyping
• Solr from ...
 • PHP
 • Ruby / RoR
 • Java
 • Ajax
Prototyping
•   See earlier presentation(s)

•   Don't overplan/overthink data ingestion and proving
    Solr out in your environment

•   Just Do It

    •   ingest your data in simplest possible way

    •   fire up quick and not-so-dirty prototypical UI

    •   iterate on config/ingestion/UI tweaks

    •   go to scale: collection size, ingestion rate, query load
Solr from PHP

• There are wt=php|phps options
 • phps = serialized PHP structure
• Just use JSON though, why not?
Solr on Rails
•   Blacklight - http://www.projectblacklight.org

•   Flare

    •   old school and dusty, but still got the right idea ;)

•   Roll your own using Solr + Ruby APIs

    •   solr-ruby

    •   RSolr

    •   Sunspot

    •   and likely others

•   Personal pet project: Prism -

    •   https://github.com/lucidimagination/Prism - Solr with Sinatra,
        including JRuby/Velocity support!
SolrJ
• When on the JVM, use SolrJ
• SolrServer abstraction
 • CommonsHttpSolrServer
 • StreamingUpdateSolrServer
 • LBHttpSolrServer
 • EmbeddedSolrServer
Ajax
• Careful!  Generally you don't want Solr
  exposed to end users
  (<delete><query>*:*</query></delete> or
  worse !!!)
• wt=json
• But also consider remoting in partials
  generated from Velocity templates - keeps
  code out of UI
Ajax-Solr
• http://evolvingweb.github.com/ajax-solr/
Extras

• Highlighting
• More-like-this
• Spell-checking / suggest
• Grouping
• Clustering
Highlighting

•   Also known as keyword-in-context (KWIC)

•   The highlighting feature adds pre/post highlight tags to the
    query terms found in stored document fields

•   Note: because of stemming & synonyms, the words
    emphasized may not be what you typed into the search box.
    ‘change’ and ‘changing’ both stem to ‘chang’. If you type
    ‘change’ you might find documents with ‘changing’. The word
    ‘changing’ will be emphasized.
Highlighting example
• http://localhost:8983/solr/select/?
  q=text:chinese&hl=true&hl.fl=text&fl
  =id,score
MoreLikeThis
•   More Like This is used to find similar documents. It might be used for
    suggestions: "If you liked this, then you may like that".

•   Can be configured as either a component, or a request handler.

•   Request handler is generally recommended because:

    •   You don’t usually want to do this for every query.

    •   You have a bit more control.	


    •   Minimum configuration:

        •   <requestHandler name="/mlt" class="solr.MoreLikeThisHandler"/>
MLT params
•   &mlt.fl – The field or fields to use for similarity (can’t be *)

•   termVectors should be included for this field, but it’s not
    necessary.

•   &mlt.mintf - Minimum Term Frequency - the frequency below
    which terms will be ignored in the source doc.

•   Use mlt.mintf=1 for smaller fields, since the terms may not occur
    as much.

•   &mlt.interestingTerms - will show what "interesting" terms are
    used for the MLT query.
MLT source terms
•   &q=id:1234 – Will build a term list from terms
    in this document.

•   &stream.body=lucene+scoring+algorithms –
    Will build a term list from the body streamed
    in.

•   &stream.url=http://lucidimagination.com – Will
    build a term list from the content found at this
    URL.
Spell checking
•   Common feature often included with search
    applications.

•   Did You Mean ...

•   Takes a word and returns a set of similar words from a
    dictionary, searching for letter rearrangements.

•   The N-Gram technique creates a set of (letter
    sequence -> term) pairs. The term with the most
    matching letter sequences is the most likely term.

•   A separate "spelling dictionary" index must be created.
Spell checking
               dictionary
•   The tools can use various sources as the spelling dictionary:

•   File-based: A standard dictionary text file.

•   Indexed data from the main index: A collection of common words
    harvested from the index via walking the terms for a field.

•   The time for this process is linear with the size of the index.

•   The terms must not be stemmed.

•   The spell checking component must be configured in
    solrconfig.xml, which is where we specify whether to create the
    spelling index from a dictionary file or from terms in our main
    index.
Spell check config
Spell check schema
Spell check integration
Spell check requests
•   Sending requests to the SpellCheckComponent

•   Some of the common parameters used for spell
    checking:

    •   &spellcheck=true

    •   &spellcheck.count=2

    •   &spellcheck.onlyMorePopular=true

    •   &spellcheck.collate=true
Suggest
•   Various techniques:

    •   TermsComponent

        •   The following URL will display the top 20 terms for the
            title field:

        •   http://localhost:8983/solr/terms/?
            terms.fl=title&terms=true&terms.limit=20

        •   For auto-suggest add the param: &terms.prefix=at (where
            "at" are the two characters entered by the user.)

    •   Use spell checking or facet.field/facet.prefix
Grouping
     •   Field Collapsing collapses a group of results with the same
         field value down to a single (or fixed number) of entries. For
         example, most search engines such as Google collapse on
         site so only one or two entries are shown. Field collapsing
         can also be used to suppress duplicate documents.

     •   Result Grouping groups documents with a common field
         value into groups, returning the top documents per group,
         and the top groups based on what documents are in the
         groups. One example is a search at Best Buy for a common
         term such as DVD, that shows the top 3 results for each
         category ("TVs & Video","Movies","Computers", etc)

http://wiki.apache.org/solr/FieldCollapsing
Clustering
                                 search for "computer"
•   A Solr contrib module, the
    ClusteringComponent can
    cluster search results or
    documents in the index.

•   Built with code from the
    Carrot2 open source
    project

•   A way to group together
    results or documents.
Scoring / relevance

• Explaining
• Scoring formula
• Boosting
• Function queries
Tools


• Solr Admin Console
• Luke
Testing


• Solr testing infrastructure
• SolrMeter
Solr's built-in test base


• AbstractSolrTestCase
• SolrTestCaseJ4
SolrMeter
• http://code.google.com/p/solrmeter/
For more information...
•   http://www.lucidimagination.com

•   LucidFind

    •   search Lucene ecosystem: mailing lists, wikis, JIRA, etc

    •   http://search.lucidimagination.com

•   Getting started with LucidWorks Enterprise:

    •   http://www.lucidimagination.com/products/
        lucidworks-search-platform/enterprise

•   http://lucene.apache.org/solr - wiki, e-mail lists
Thank You!

More Related Content

PDF
Solr Black Belt Pre-conference
PDF
Solr Application Development Tutorial
PDF
Rapid Prototyping with Solr
PDF
Apache Solr Workshop
PDF
Rapid Prototyping with Solr
PDF
Integrating the Solr search engine
PDF
Lucene's Latest (for Libraries)
PPTX
Apache Solr
Solr Black Belt Pre-conference
Solr Application Development Tutorial
Rapid Prototyping with Solr
Apache Solr Workshop
Rapid Prototyping with Solr
Integrating the Solr search engine
Lucene's Latest (for Libraries)
Apache Solr

What's hot (20)

PDF
Apache Solr crash course
PDF
Rapid Prototyping with Solr
PPTX
Rebuilding Solr 6 examples - layer by layer (LuceneSolrRevolution 2016)
PDF
Introduction to Solr
PDF
Solr Recipes
PDF
Lucene for Solr Developers
PDF
Using Apache Solr
PPTX
Solr 6 Feature Preview
PPT
Building Intelligent Search Applications with Apache Solr and PHP5
PDF
Solr 4
PDF
code4lib 2011 preconference: What's New in Solr (since 1.4.1)
PPTX
20130310 solr tuorial
PDF
Apache Solr! Enterprise Search Solutions at your Fingertips!
PDF
Get the most out of Solr search with PHP
PDF
Solr Powered Lucene
PDF
New-Age Search through Apache Solr
PDF
Lucene for Solr Developers
PPT
Enterprise Search Solution: Apache SOLR. What's available and why it's so cool
PDF
Introduction to Apache Solr
PDF
Beyond full-text searches with Lucene and Solr
Apache Solr crash course
Rapid Prototyping with Solr
Rebuilding Solr 6 examples - layer by layer (LuceneSolrRevolution 2016)
Introduction to Solr
Solr Recipes
Lucene for Solr Developers
Using Apache Solr
Solr 6 Feature Preview
Building Intelligent Search Applications with Apache Solr and PHP5
Solr 4
code4lib 2011 preconference: What's New in Solr (since 1.4.1)
20130310 solr tuorial
Apache Solr! Enterprise Search Solutions at your Fingertips!
Get the most out of Solr search with PHP
Solr Powered Lucene
New-Age Search through Apache Solr
Lucene for Solr Developers
Enterprise Search Solution: Apache SOLR. What's available and why it's so cool
Introduction to Apache Solr
Beyond full-text searches with Lucene and Solr
Ad

Viewers also liked (20)

PDF
Tips and tricks for getting the best out of solr on windows azure
PPTX
Solr vs. Elasticsearch - Case by Case
PDF
6 scikit-learn - Data Tuesday 26 fev 2013
PPTX
E commerce Search using Apache Solr
PDF
Ansible meetup-0915
PDF
Lucene for Solr Developers
PDF
Deep Data at Macy's - Searching Hierarchichal Documents for eCommerce Merchan...
PDF
Multi-language Content Discovery Through Entity Driven Search: Presented by A...
PDF
Introduction to Solr
PPTX
T3UNI12 : SOLR workshop
PDF
PDF
Solr Distributed Indexing in WalmartLabs: Presented by Shengua Wan, WalmartLabs
PDF
Couchbase live 2016
PDF
Secure Search - Using Apache Sentry to Add Authentication and Authorization S...
PDF
Lucene/Solr Revolution 2015 Opening Keynote with Lucidworks CEO Will Hayes
PDF
Search Analytics Component: Presented by Steven Bower, Bloomberg L.P.
PPTX
Big Data Analytics Proposal #1
PDF
Galene - LinkedIn's Search Architecture: Presented by Diego Buthay & Sriram S...
PPTX
Big Data Analysis Patterns with Hadoop, Mahout and Solr
PPTX
Big Data Airline Project at UAEU
Tips and tricks for getting the best out of solr on windows azure
Solr vs. Elasticsearch - Case by Case
6 scikit-learn - Data Tuesday 26 fev 2013
E commerce Search using Apache Solr
Ansible meetup-0915
Lucene for Solr Developers
Deep Data at Macy's - Searching Hierarchichal Documents for eCommerce Merchan...
Multi-language Content Discovery Through Entity Driven Search: Presented by A...
Introduction to Solr
T3UNI12 : SOLR workshop
Solr Distributed Indexing in WalmartLabs: Presented by Shengua Wan, WalmartLabs
Couchbase live 2016
Secure Search - Using Apache Sentry to Add Authentication and Authorization S...
Lucene/Solr Revolution 2015 Opening Keynote with Lucidworks CEO Will Hayes
Search Analytics Component: Presented by Steven Bower, Bloomberg L.P.
Big Data Analytics Proposal #1
Galene - LinkedIn's Search Architecture: Presented by Diego Buthay & Sriram S...
Big Data Analysis Patterns with Hadoop, Mahout and Solr
Big Data Airline Project at UAEU
Ad

Similar to Solr Recipes Workshop (20)

PDF
Introduction to Solr
PPS
Introduction to Solr
PPTX
Apache Solr Workshop
PPTX
Apache solr
KEY
Apache Solr - Enterprise search platform
PPTX
DSpace 4.2 Transmission: Import/Export
PDF
Information Retrieval - Data Science Bootcamp
PPTX
Introduction to Apache Lucene/Solr
KEY
QueryPath, Mash-ups, and Web Services
PDF
Basics of Solr and Solr Integration with AEM6
PDF
Challenges of Simple Documents: When Basic isn't so Basic - Cassandra Targett...
PPTX
The Apache Solr Smart Data Ecosystem
PDF
Full Text Search with Lucene
PDF
Hortonworks Technical Workshop - HDP Search
PPTX
Introduction to Lucene & Solr and Usecases
PDF
Let's Build an Inverted Index: Introduction to Apache Lucene/Solr
PPTX
Laravel ppt
PDF
Intro apache
PPTX
PPT
Corporate-informatica-training-in-mumbai
Introduction to Solr
Introduction to Solr
Apache Solr Workshop
Apache solr
Apache Solr - Enterprise search platform
DSpace 4.2 Transmission: Import/Export
Information Retrieval - Data Science Bootcamp
Introduction to Apache Lucene/Solr
QueryPath, Mash-ups, and Web Services
Basics of Solr and Solr Integration with AEM6
Challenges of Simple Documents: When Basic isn't so Basic - Cassandra Targett...
The Apache Solr Smart Data Ecosystem
Full Text Search with Lucene
Hortonworks Technical Workshop - HDP Search
Introduction to Lucene & Solr and Usecases
Let's Build an Inverted Index: Introduction to Apache Lucene/Solr
Laravel ppt
Intro apache
Corporate-informatica-training-in-mumbai

More from Erik Hatcher (14)

PDF
Ted Talk
PDF
Solr Payloads
PDF
it's just search
PDF
Solr Indexing and Analysis Tricks
PDF
Solr Powered Libraries
PDF
Solr Query Parsing
PDF
"Solr Update" at code4lib '13 - Chicago
PDF
Query Parsing - Tips and Tricks
PDF
Lucene for Solr Developers
PDF
Solr Flair
PDF
What's New in Solr 3.x / 4.0
PDF
Rapid Prototyping with Solr
PDF
Solr Flair: Search User Interfaces Powered by Apache Solr (ApacheCon US 2009,...
PDF
Solr Flair: Search User Interfaces Powered by Apache Solr
Ted Talk
Solr Payloads
it's just search
Solr Indexing and Analysis Tricks
Solr Powered Libraries
Solr Query Parsing
"Solr Update" at code4lib '13 - Chicago
Query Parsing - Tips and Tricks
Lucene for Solr Developers
Solr Flair
What's New in Solr 3.x / 4.0
Rapid Prototyping with Solr
Solr Flair: Search User Interfaces Powered by Apache Solr (ApacheCon US 2009,...
Solr Flair: Search User Interfaces Powered by Apache Solr

Recently uploaded (20)

PDF
Machine learning based COVID-19 study performance prediction
PDF
TokAI - TikTok AI Agent : The First AI Application That Analyzes 10,000+ Vira...
PDF
Build a system with the filesystem maintained by OSTree @ COSCUP 2025
PDF
7 ChatGPT Prompts to Help You Define Your Ideal Customer Profile.pdf
PDF
Network Security Unit 5.pdf for BCA BBA.
PPTX
VMware vSphere Foundation How to Sell Presentation-Ver1.4-2-14-2024.pptx
PPT
Teaching material agriculture food technology
PDF
The Rise and Fall of 3GPP – Time for a Sabbatical?
PDF
Empathic Computing: Creating Shared Understanding
PDF
Encapsulation theory and applications.pdf
PDF
Dropbox Q2 2025 Financial Results & Investor Presentation
PDF
Spectral efficient network and resource selection model in 5G networks
PDF
CIFDAQ's Market Insight: SEC Turns Pro Crypto
PDF
cuic standard and advanced reporting.pdf
PDF
Reach Out and Touch Someone: Haptics and Empathic Computing
PDF
Building Integrated photovoltaic BIPV_UPV.pdf
PDF
Agricultural_Statistics_at_a_Glance_2022_0.pdf
PPTX
A Presentation on Artificial Intelligence
PDF
Unlocking AI with Model Context Protocol (MCP)
PDF
Electronic commerce courselecture one. Pdf
Machine learning based COVID-19 study performance prediction
TokAI - TikTok AI Agent : The First AI Application That Analyzes 10,000+ Vira...
Build a system with the filesystem maintained by OSTree @ COSCUP 2025
7 ChatGPT Prompts to Help You Define Your Ideal Customer Profile.pdf
Network Security Unit 5.pdf for BCA BBA.
VMware vSphere Foundation How to Sell Presentation-Ver1.4-2-14-2024.pptx
Teaching material agriculture food technology
The Rise and Fall of 3GPP – Time for a Sabbatical?
Empathic Computing: Creating Shared Understanding
Encapsulation theory and applications.pdf
Dropbox Q2 2025 Financial Results & Investor Presentation
Spectral efficient network and resource selection model in 5G networks
CIFDAQ's Market Insight: SEC Turns Pro Crypto
cuic standard and advanced reporting.pdf
Reach Out and Touch Someone: Haptics and Empathic Computing
Building Integrated photovoltaic BIPV_UPV.pdf
Agricultural_Statistics_at_a_Glance_2022_0.pdf
A Presentation on Artificial Intelligence
Unlocking AI with Model Context Protocol (MCP)
Electronic commerce courselecture one. Pdf

Solr Recipes Workshop

  • 1. Solr Recipes Workshop uberconf - July 14, 2011 Presented by Erik Hatcher erik.hatcher@lucidimagination.com Lucid Imagination http://www.lucidimagination.com
  • 2. About me... • Co-author, “Lucene in Action” • Commiter, Lucene and Solr • Lucene PMC and ASF member • Member of Technical Staff / co-founder, Lucid Imagination
  • 3. About Lucid Imagination... • Lucid Imagination provides commercial-grade support, training, high-level consulting and value- added software for Lucene and Solr. • We make Lucene ‘enterprise-ready’ by offering: • Free, certified, distributions and downloads. • Support, training, and consulting. • LucidWorks Enterprise, a commercial search platform built on top of Solr.
  • 4. What is Lucene? • An open source Java-based IR library with best practice indexing and query capabilities, fast and lightweight search and indexing. • 100% Java (.NET, Perl and other versions too). • Stable, mature API. • Continuously improved and tuned over more than 10 years. • Cleanly implemented, easy to embed in an application. • Compact, portable index representation. • Programmable text analyzers, spell checking and highlighting. • Not a crawler or a text extraction tool.
  • 5. Lucene's History • Created by Doug Cutting in 1999 • built on ideas from search projects Doug created at Xerox PARC and Apple. • Donated to the Apache Software Foundation (ASF) in 2001. • Became an Apache top-level project in 2005. • Has grown and morphed through the years and is now both: • A search library. • An ASF Top-Level Project (TLP) encompassing several sub-projects. • Lucene and Solr "merged" development in early 2010.
  • 6. What is Solr? • An open source search engine. • Indexes content sources, processes query requests, returns search results. • Uses Lucene as the "engine", but adds full enterprise search server features and capabilities. • A web-based application that processes HTTP requests and returns HTTP responses. • Initially started in 2004 and developed by CNET as an in-house project to add search capability for the company website. • Donated to ASF in 2006.
  • 7. What Version of Solr? • There’s more than one answer! • The current, released, stable version is 3.3 • The development release is referred to as “trunk”. • This is where the new, less tested work goes on • Also referred to as 4.0 • LucidWorks Enterprise is built on a trunk snapshot + additional features.
  • 8. Who uses Lucene/Solr? And many many many many more...!
  • 9. Ingestion • CSV • Relational databases • File system • Web crawl • API / Solr XML, JSON, and javabin/SolrJ • Others - XML feeds (e.g. RSS/Atom), e-mail
  • 11. Solr XML POST to /update <add> <doc> <field name="id">rawxml1</field> <field name="content_type">text/xml</field> <field name="category">index example</field> <field name="title">Simple Example</field> <field name="filename">addExample.xml</field> <field name="text">A very simple example of adding a document to the index.</field> </doc> </add>
  • 12. CSV indexing • http://localhost:8983/solr/update/csv • Files can be sent over HTTP: • curl http://localhost:8983/solr/update/csv --data-binary @data.csv -H 'Content-type:text/plain; charset=utf-8’ • or streamed from the file system: • curl http://localhost:8983/solr/update/csv? stream.file=exampledocs/ data.csv&stream.contentType=text/plain;charset=utf-8
  • 13. CSV indexing params • header: Default is true. Indicates that the first line of the file contains field names. • fieldnames: A comma-separated list of fieldnames which will override the header parameter. • separator: Defaults to a comma, but other characters can be used. • trim: If true, remove whitespace before and after separator. • Full parameter list: http://wiki.apache.org/solr/UpdateCSV • Yes, tab-delimited files are supported too: • &separator=%09
  • 14. Rich documents • Tika is a toolkit for detecting and extracting metadata and structured text content from various document formats using existing parser libraries. • Tika identifies MIME types and then uses the appropriate parser to extract text. • The ExtractingRequestHandler uses Tika to identify types and extract text, and then indexes the extracted text. • The ExtractingRequestHandler is sometimes called "Solr Cell", which stands for Content Extraction Library. • File formats include MS Office, Adobe PDF, XML, HTML, MPEG and many more.
  • 15. Solr Cell basics • defaultField: If uprefix is not set, and a field cannot be determined, the default field is used. • Full list of parameters: http://wiki.apache.org/ solr/ExtractingRequestHandler
  • 17. Solr Cell parameters • The literal parameter is very important. • A way to add other fields not indexed using Tika to documents. • &literal.id=12345 • &literal.category=sports • Using curl to index a file on the file system: • curl 'http://localhost:8983/solr/update/extract? literal.id=doc1&commit=true' -F myfile=@tutorial.html • Streaming a file from the file system: • curl "http://localhost:8983/solr/update/extract?stream.file=/some/path/ news.doc&stream.contentType=application/msword&literal.id=12345"
  • 18. Streaming remote docs • Streaming a file from a URL: • curl http://localhost:8983/solr/update/ extract?literal.id=123&stream.url=http:// www.solr.com/content/goodContent.pdf -H 'Content-type:application/pdf’
  • 19. Indexing from RDBMS • Techniques • DIH • Custom script • Hurdles • Flattening • Performance
  • 20. DataImportHandler • The DataImportHandler (DIH): • An "in-process" module that can be used to index data directly from relational databases and other data sources. • Configuration driven. • A tool that can aggregate data from multiple database tables, or even multiple data sources to be indexed as a single Solr document. • Provides powerful and customizable data transformation tools. • Can do full import or delta import. • Pluggable to allow indexing of any type of data source.
  • 21. Using Solr’s Data Import Handler • One or more configuration files can be created for DIH instances. • All DIH configuration files must be declared in a request handler in solrconfig.xml and given a unique name: <requestHandler class="org.apache.solr.handler.dataimport.DataImportHandler” name="/dataimport"> <lst name="defaults"> <str name="config">db-config.xml</str> </lst> </requestHandler>
  • 22. Enabling the DataImportHandler • The jar files for DIH must be included on the path • apache-solr-dataimporthandler-3.3.0.jar • apache-solr-dataimporthandler-extras-3.3.0.jar • This is a change since version 1.4.1 • The example solrconfig file include a “lib” command to include these files.
  • 23. DIH Components • Data sources: • Provide access to relational databases, plain files, XML, etc. • Entity processors: • Configuration elements that work with data sources and do most of the work. • Can be nested. • Transformers: • Modify data in many different ways. • Can be chained together.
  • 24. DIH Capabilities • From a database. (SQL entity processor, Jdbc datasource) • An RSS or Atom feed. (XPath entity processor, URL datasource) • XML files. (Xpath entity processor, File datasource) • Plain text files. (Plaintext entity processor, File datasource) • From a mail server. (Mail entity processor)
  • 25. DIH with database • Create a document with database fields title, ISBN mapped to Solr fields title, id • No EntityProcessor is included so the default SqlEntityProcessor is used.
  • 26. DIH with RSS • Using the XPathEntityProcessor to map data to index fields.
  • 27. DIH with email • Mail Input: Example DIH Configuration File • Using the MailEntityProcessor to index email data.
  • 28. DIH - richer example
  • 29. DIH DataSources • JdbcDataSource: Default if none is specified. Iterates rows of a database one by one. • URLDataSource: Used to fetch content from file:// or http:// locations. • FileDataSource: Similar to URLDataSource, but locations are specified with a "basePath" parameter. • The class org.apache.solr.handler.dataimport.DataSource can be extended to create custom data sources.
  • 30. DIH EntityProcessors • SqlEntityProcessor: Default if none is specified. works with a JdbcDataSource to index database tables. • XPathEntityProcessor: Implements a streaming parser which supports a subset of xpath syntax. Complete xpath syntax is not yet supported. • FileListEntityProcessor: Does not use a DataSource. Enumerates a list of files. Typically used as an "outer" entity. • CachedSqlEntityProcessor: An extension of the SqlEntityProcessor reduces the number of queries executed by caching rows. (Only for inner nested entities.) • PlainTextEntityProcessor: Reads text into a "plainText" field.
  • 31. DIH transforming • Fields that are processed can either be indexed directly or transformed and modified. • New fields can be created. • Transformers can be chained.
  • 32. DIH Transformers • RegexTransformer: Manipulates field values using regular expressions. • DateFormatTransformer: Parses date/time strings into java.util.Date instances. • NumberFormatTransformer: Parses numbers from a string. • TemplateTransformer: Explicitly sets a text value. Optionally can use variable names. • HTMLStringTransformer: Removes HTML markup. • ClobTransformer: Creates a string from a CLOB data type. • ScriptTransformer: Write custom transformers in JavaScript or other scripting languages.
  • 33. DIH Full and Delta Imports • The DIH can be used for both full imports and delta imports. • The query element is used for a full import. • The deltaQuery element gives the primary keys of the current entity which have changes since the last index time. These primary keys will be used by the deltaImportQuery. • The deltaImportQuery element gives the data needed to populate fields when running a delta-import .
  • 34. DIH basic commands • Full import example: • http://localhost:8983/solr/dataimport?command=full-import • Delta import example: • http://localhost:8983/solr/dataimport?command=delta-import • The "rows" parameter can be used to limit the amount of input: • http://localhost:8983/solr/dataimport?command=full-import&rows=10 • The "commit" parameter defaults to "true" if not explicitly set: • http://localhost:8983/solr/dataimport?command=full- import&rows=10&commit=false
  • 35. DIH "clean" param • Be careful with the "clean" parameter. • clean=true will delete everything from the index – all documents will be deleted. • clean=true is the default! • Get in the habit of always setting the clean parameter so you are not surprised with unexpected data loss. • http://localhost:8983/solr/dataimport? command=full-import&clean=false
  • 36. DIH Admin Console • There is an admin console page for the DIH, but there is no link to it from the main admin page. • http://localhost:8983/solr/admin/ dataimport.jsp • The link brings up a list of all DIH configurations (there can be more than one.)
  • 37. Using Solr’s Data Import Handler • DataImportHandler Admin Console • The main section shows the configuration and a few commands:
  • 38. DIH console commands • At the bottom of the page there are options for running various operations such as full-imports and delta-imports: Note that all of these commands can also be executed from the command line using curl or wget.
  • 39. DIH status • The display to the right shows the XML output of commands that are run from the console. • This example shows the response after a delta-import.
  • 40. DIH experimenting • You can also view the status of an ongoing process (for example a long import) by going directory to the URL for the handler: • http://localhost:8983/solr/dataimport • curl can also be used with the DIH: • curl 'http://localhost:8983/solr/dataimport?command=full- import&rows=10’ • Setting rows=10 is a good way to limit the indexing during development.
  • 41. Other DIH capabilities • TikaEntityProcessor • SolrEntityProcessor (see SOLR-1499) • Multi-threaded capabilities
  • 42. Web crawl • Solr is not a crawler • Options: Nutch, droids, or LucidWorks Enterprise
  • 44. API Indexing • Solr XML • Solr JSON • SolrJ - javabin format, streaming/multithread
  • 45. Solr APIs • SolrJ can use an internal javabin format (or XML) • Most other Solr APIs ride on Solr XML or Solr JSON formats
  • 47. SolrJ searching example SolrServer solrServer = new CommonsHttpSolrServer( "http://localhost:8983/solr"); SolrQuery query = new SolrQuery(); query.setQuery(userQuery); query.setFacet(true); query.setFacetMinCount(1); query.addFacetField("category"); QueryResponse queryResponse = solrServer.query(query);
  • 48. Updating documents • Solr uses the "uniqueKey" to determine a the "identity" of a document. • Adding a document to the index with the same uniqueKey as an existing document means the new document will replace the original. • An "update" is actually two steps, internally: • Delete the document with that id. • Add the new document. • So documents are, more accurately, "replaced", not deleted. • No field-level updating – a whole document has to be replaced
  • 49. Deleting documents • Documents can be deleted: • Using a delete by id. • <delete><id>05991</id></delete> • Using a delete by query. • <delete><query>category:music</query></delete> • When a document is deleted it still exists in an index segment until that segment is merged. • Rollback: <rollback/> • All adds and deletes since the last commit are rolled back.
  • 50. Fields • data analysis / exploration • character mapping • tokenizing/filtering • copyField
  • 51. Field Types: "primitives" • field types entirely specified in schema.xml, but... keep the standard (non TextField ones) as-is from Solr's provided example schema. • string, boolean, binary, int, float, long, double, date • numeric types for faster range queries (and bigger index): tint, tfloat, tlong, tdouble, tdate
  • 52. TextField • TextField "analyzes" field value <fieldType name="text_general" class="solr.TextField" positionIncrementGap="100"> <analyzer type="index"> <tokenizer class="solr.StandardTokenizerFactory"/> <filter class="solr.StopFilterFactory" ignoreCase="true" words="stopwords.txt" enablePositionIncrements="true" /> <filter class="solr.LowerCaseFilterFactory"/> </analyzer> <analyzer type="query"> <tokenizer class="solr.StandardTokenizerFactory"/> <filter class="solr.StopFilterFactory" ignoreCase="true" words="stopwords.txt" enablePositionIncrements="true" /> <filter class="solr.SynonymFilterFactory" synonyms="synonyms.txt" ignoreCase="true" expand="true"/> <filter class="solr.LowerCaseFilterFactory"/> </analyzer> </fieldType>
  • 53. Character Filters He went to the café <fieldType name="text_ws" class="solr.TextField"> <analyzer> <charFilter class="solr.MappingCharFilterFactory" mapping="mapping-ISOLatin1Accent.txt"/> <tokenizer class="solr.WhitespaceTokenizerFactory"/> <filter class="solr.LowerCaseFilterFactory"/> </analyzer> </fieldType> he went to the cafe
  • 54. copyField • Clones the exact field value to another field • destination field controls handling of cloned value • Useful when same field value needs to be indexed/stored in several different ways • e.g. sorting
  • 55. Schema Deep Dive • DEMO: Let's look at schema.xml interactively, and discuss other features
  • 56. Searching • The basic parameters • Filtering • Query parsing
  • 58. Basic Search Params • q - main query • rows - maximum number of "hits" to return • start - zero-based hit starting point • fl - comma-separated field list • * for all stored fields • score for computed Lucene score
  • 59. Other Common Search Parameters • sort - specify sort criteria either by field(s) or function(s) in ascending or descending order • fq - filter queries, multiple values supported • wt - writer type - format of Solr response • debugQuery - adds debugging info to response
  • 60. Filtering results • Use fq to filter results in addition to main query constraints • fq results are independently cached in Solr's filterCache • filter queries do not contribute to ranking scores • Commonly used for filtering on facets
  • 61. Richer Solr Request • http://localhost:8983/solr/select ?q=ipod &facet=on &facet.field=cat &fq=cat:electronics
  • 62. Query Parsing • String -> org.apache.lucene.search.Query • Several built-in query parser choices, including • "lucene" - Solr-savvy version of Lucene's standard query parser • "dismax" - most commonly used, currently • "edismax" - extended dismax
  • 63. Defaults for query "lucene" and "(e)dismax" • schema.xml • <defaultSearchField>field</defaultSearchField> • <solrQueryParser defaultOperator="AND|OR"/>
  • 64. Selecting Query Parser • defType=lucene|dismax|edismax|.... • Sets query parser for q parameter only • Or via {!local_params} syntax • q={!dismax}query expression • only way to set query parser for fq's
  • 65. "lucene" query parser • Solr subclass of Lucene's QueryParser • schema-aware, for range queries, etc • special handling of wildcarded clauses • back-door special "fields" • _val_ - for function queries • _query_ - for nested queries
  • 66. "lucene" parser examples • search AND (lucene OR solr) • rating:[7 TO 10] • +required -prohibited • wild?card OR prefix* AND fuzzy~ • "phrases for proximity"
  • 67. "dismax" query parser • disjunction-maximum • enables spreading query terms across multiple fields with individual field-specific boosts • many parameters
  • 68. "dismax" params Parameter Description q Defines the raw input strings for the query. q.alt Calls the Lucene query parser and defines query input strings when the q parameter is not used. (useful for getting facet counts when no query specified) qf Query Fields: Specifies the fields to be searched. pf Phrase Fields: Fields will be queried using the terms entered as a phrase query. ps Phrase Slop: How close to one another the terms within a phrase query must be. mm Minimum "Should" Match: Number of fields that must match a query tie Tie Breaker: A float value to use as a tie breaker bq Boost Query: An optional query that can be used to boost and refine results bf Boost Functions: Functions that can be used to tune relevance
  • 70. "edismax" query parser • Extended dismax • Supports full lucene query syntax in the absence of syntax errors. • Improved proximity boosting via word bigrams. • Supports the "boost" parameter like the dismax bf param, but multiplies the function query instead of adding it in for better scoring integration. • Allows for wildcard searches, which dismax does not do.
  • 71. "term" query parser • {!term f=field_name}value • Very useful for fq parameters where field value may contain Lucene query parser special characters!
  • 72. Nested queries • q=_query_:"{!dismax qf='author coauthor'} bob" AND _query_:"{!dismax qf='title subtitle'}testing"
  • 73. Faceting • field • query • range, numeric and date • multi-select • pivot • cache impact
  • 75. Query faceting • facet.query=some query expression • Default query parser: "lucene" • Use {!parser ...} syntax to select different parser • Use {!key=whatever} to have a nicer output key • Example: • facet.query={!key=cheapest}price:[0 TO 10]
  • 76. Range faceting • Works for date and numeric field types • Range facets divide a range into equal sized buckets. • facet.range.start=100 • facet.range.end=900 • facet.range.gap=200 • facet.range.other=before • facet.range.other=after
  • 77. Multi-select faceting • Traditional faceting/filtering (facet.field=cat&fq=cat:electr onics) narrows facet values to only those in result set • Sometimes you want to allow multiple values and counts across all facet values &fq={!tag=myTag}project:solr &facet=on&facet.field={!ex=myTag}project
  • 78. Pivot faceting • Currently only available on trunk (Solr "4.0") • facet.pivot=field1,field2,... • facet counts within results of parent facet
  • 79. Cache impact of faceting • Faceting supports different internal algorithms / data structures, controlled through facet.method parameter • enum - enumerates all terms in a field, uses Solr's filterCache • fc - uses Lucene's FieldCache
  • 80. Integration • Prototyping • Solr from ... • PHP • Ruby / RoR • Java • Ajax
  • 81. Prototyping • See earlier presentation(s) • Don't overplan/overthink data ingestion and proving Solr out in your environment • Just Do It • ingest your data in simplest possible way • fire up quick and not-so-dirty prototypical UI • iterate on config/ingestion/UI tweaks • go to scale: collection size, ingestion rate, query load
  • 82. Solr from PHP • There are wt=php|phps options • phps = serialized PHP structure • Just use JSON though, why not?
  • 83. Solr on Rails • Blacklight - http://www.projectblacklight.org • Flare • old school and dusty, but still got the right idea ;) • Roll your own using Solr + Ruby APIs • solr-ruby • RSolr • Sunspot • and likely others • Personal pet project: Prism - • https://github.com/lucidimagination/Prism - Solr with Sinatra, including JRuby/Velocity support!
  • 84. SolrJ • When on the JVM, use SolrJ • SolrServer abstraction • CommonsHttpSolrServer • StreamingUpdateSolrServer • LBHttpSolrServer • EmbeddedSolrServer
  • 85. Ajax • Careful! Generally you don't want Solr exposed to end users (<delete><query>*:*</query></delete> or worse !!!) • wt=json • But also consider remoting in partials generated from Velocity templates - keeps code out of UI
  • 87. Extras • Highlighting • More-like-this • Spell-checking / suggest • Grouping • Clustering
  • 88. Highlighting • Also known as keyword-in-context (KWIC) • The highlighting feature adds pre/post highlight tags to the query terms found in stored document fields • Note: because of stemming & synonyms, the words emphasized may not be what you typed into the search box. ‘change’ and ‘changing’ both stem to ‘chang’. If you type ‘change’ you might find documents with ‘changing’. The word ‘changing’ will be emphasized.
  • 89. Highlighting example • http://localhost:8983/solr/select/? q=text:chinese&hl=true&hl.fl=text&fl =id,score
  • 90. MoreLikeThis • More Like This is used to find similar documents. It might be used for suggestions: "If you liked this, then you may like that". • Can be configured as either a component, or a request handler. • Request handler is generally recommended because: • You don’t usually want to do this for every query. • You have a bit more control. • Minimum configuration: • <requestHandler name="/mlt" class="solr.MoreLikeThisHandler"/>
  • 91. MLT params • &mlt.fl – The field or fields to use for similarity (can’t be *) • termVectors should be included for this field, but it’s not necessary. • &mlt.mintf - Minimum Term Frequency - the frequency below which terms will be ignored in the source doc. • Use mlt.mintf=1 for smaller fields, since the terms may not occur as much. • &mlt.interestingTerms - will show what "interesting" terms are used for the MLT query.
  • 92. MLT source terms • &q=id:1234 – Will build a term list from terms in this document. • &stream.body=lucene+scoring+algorithms – Will build a term list from the body streamed in. • &stream.url=http://lucidimagination.com – Will build a term list from the content found at this URL.
  • 93. Spell checking • Common feature often included with search applications. • Did You Mean ... • Takes a word and returns a set of similar words from a dictionary, searching for letter rearrangements. • The N-Gram technique creates a set of (letter sequence -> term) pairs. The term with the most matching letter sequences is the most likely term. • A separate "spelling dictionary" index must be created.
  • 94. Spell checking dictionary • The tools can use various sources as the spelling dictionary: • File-based: A standard dictionary text file. • Indexed data from the main index: A collection of common words harvested from the index via walking the terms for a field. • The time for this process is linear with the size of the index. • The terms must not be stemmed. • The spell checking component must be configured in solrconfig.xml, which is where we specify whether to create the spelling index from a dictionary file or from terms in our main index.
  • 98. Spell check requests • Sending requests to the SpellCheckComponent • Some of the common parameters used for spell checking: • &spellcheck=true • &spellcheck.count=2 • &spellcheck.onlyMorePopular=true • &spellcheck.collate=true
  • 99. Suggest • Various techniques: • TermsComponent • The following URL will display the top 20 terms for the title field: • http://localhost:8983/solr/terms/? terms.fl=title&terms=true&terms.limit=20 • For auto-suggest add the param: &terms.prefix=at (where "at" are the two characters entered by the user.) • Use spell checking or facet.field/facet.prefix
  • 100. Grouping • Field Collapsing collapses a group of results with the same field value down to a single (or fixed number) of entries. For example, most search engines such as Google collapse on site so only one or two entries are shown. Field collapsing can also be used to suppress duplicate documents. • Result Grouping groups documents with a common field value into groups, returning the top documents per group, and the top groups based on what documents are in the groups. One example is a search at Best Buy for a common term such as DVD, that shows the top 3 results for each category ("TVs & Video","Movies","Computers", etc) http://wiki.apache.org/solr/FieldCollapsing
  • 101. Clustering search for "computer" • A Solr contrib module, the ClusteringComponent can cluster search results or documents in the index. • Built with code from the Carrot2 open source project • A way to group together results or documents.
  • 102. Scoring / relevance • Explaining • Scoring formula • Boosting • Function queries
  • 103. Tools • Solr Admin Console • Luke
  • 104. Testing • Solr testing infrastructure • SolrMeter
  • 105. Solr's built-in test base • AbstractSolrTestCase • SolrTestCaseJ4
  • 107. For more information... • http://www.lucidimagination.com • LucidFind • search Lucene ecosystem: mailing lists, wikis, JIRA, etc • http://search.lucidimagination.com • Getting started with LucidWorks Enterprise: • http://www.lucidimagination.com/products/ lucidworks-search-platform/enterprise • http://lucene.apache.org/solr - wiki, e-mail lists