Lucene for Solr  Developers      uberconf - July 14, 2011     Presented by Erik Hatchererik.hatcher@lucidimagination.com  ...
Lucene Core• IndexWriter• Directory• IndexReader, IndexSearcher• analysis: Analyzer, TokenStream,  Tokenizer,TokenFilter• ...
Solr Architecture
Customizing - Dont do it!•   Unless you need to.•   In other words... ensure youve given the built-in    capabilities a tr...
But first...•   Look at Lucene and/or Solr source code as    appropriate•   Carefully read javadocs and wiki pages - lots o...
Extension points•   Tokenizer, TokenFilter,   •   QParser    CharFilter                              •   DataImportHandler...
Factories• FooFactory (most) everywhere.  Sometimes theres BarPlugin style• for sake of discussion... lets just skip the  ...
"Installing" plugins• Compile .java to .class, JAR it up• Put JAR files in either: • <solr-home>/lib • a shared lib when us...
Multicore sharedLib<solr sharedLib="/usr/local/solr/customlib"       persistent="true">   <cores adminPath="/admin/cores">...
Plugins via        solrconfig.xml• <lib dir="/path/to/your/custom/jars" />
Analysis• CharFilter• Tokenizer• TokenFilter
Primer• Tokens, Terms• Attributes: Type, Payloads, Offsets,  Positions, Term Vectors• part of the picture:
Version• enum: • Version.LUCENE_31,    Version.LUCENE_32, etc• Version.onOrAfter(Version other)
CharFilter• extend BaseCharFilter• enables pre-tokenization filtering/morphing  of incoming field value• only affects tokeni...
Tokenizer•   common to extend CharTokenizer•   implement -    •   protected abstract boolean isTokenChar(int c);•   option...
TokenFilter• a TokenStream whose input is another  TokenStream• Popular TokenFilters include:  LowerCaseFilter, CommonGram...
Lucenes analysis APIs• tricky business, what with Attributes  (Source/Factorys), State, characters, code  points,Version, ...
Solrs Analysis Tools• Admin analysis tool• Field analysis request handler• DEMO
Query Parsing• String -> org.apache.lucene.search.Query
QParserPluginpublic abstract class QParserPlugin    implements NamedListInitializedPlugin {    public abstract QParser cre...
QParserpublic abstract class QParser {    public abstract Query parse()              throws ParseException;}
Built-in QParsersfrom QParserPlugin.java  /** internal use - name to class mappings of builtin parsers */  public static f...
Local Parameters• {!qparser_name param=value}expression • or• {!qparser_name param=value v=expression}• Can substitute $re...
Param Substitutionsolrconfig.xml<requestHandler name="/document"                class="solr.SearchHandler">  <lst name="in...
Custom QParser• Implement a QParserPlugin that creates your  custom QParser• Register in solrconfig.xml • <queryParser name...
Update Processor• Responsible for handling these commands: • add/update • delete • commit • merge indexes
Built-in Update            Processors•   RunUpdateProcessor    •   Actually performs the operations, such as        adding...
UIMA Update           Processor•   UIMA - Unstructured Information Management    Architecture - http://uima.apache.org/•  ...
Update Processor         Chain• UpdateProcessors sequence into a chain• Each processor can abort the entire update  or han...
Default update            processor chainFrom SolrCore.java// construct the default chainUpdateRequestProcessorFactory[] f...
Example Update           Processor•   What are the best facets to show for a particular    query? Wouldnt it be nice to se...
Config for custom           update processor<updateRequestProcessorChain name="fields_used" default="true"> <processor class...
FieldsUsedUpdateProcessorFactorypublic class FieldsUsedUpdateProcessorFactory extends UpdateRequestProcessorFactory { priv...
FieldsUsedUpdateProcessorFactory @Override public void init(NamedList args) {  if (args == null) return;     SolrParams pa...
class FieldsUsedUpdateProcessor extends UpdateRequestProcessor {  public FieldsUsedUpdateProcessor(SolrQueryRequest req,  ...
FieldsUsedUpdateProcessor          in actionschema.xml  <dynamicField name="*_attribute" type="string" indexed="true" stor...
Search Components• Built-in: Clustering, Debug, Facet, Highlight,  MoreLikeThis, Query, QueryElevation,  SpellCheck, Stats...
Example - auto facet          select•   It sure would be nice if you could have Solr automatically    select field(s) for f...
AutoFacetSelection       Component•   Too much code for a slide, lets take a look in    an IDE...•   Basically -    •   pr...
SearchComponent              config<searchComponent name="autofacet"     class="solr.AutoFacetSelectionComponent"/><request...
autofacet successhttp://localhost:8983/solr/searchplus?q=*:*&facet=on&autofacet.field=attribute_fields&wt=json&indent=on{ ...
Distributed-aware    SearchComponents•   SearchComponent has a few distributed mode    methods:    •   distributedProcess(...
Testing• AbstractSolrTestCase• SolrTestCaseJ4• SolrMeter • http://code.google.com/p/solrmeter/
For more information...•   http://www.lucidimagination.com•   LucidFind    •   search Lucene ecosystem: mailing lists, wik...
Thank You!
Upcoming SlideShare
Loading in...5
×

Lucene for Solr Developers

3,041

Published on

Published in: Education, Technology
0 Comments
5 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
3,041
On Slideshare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
50
Comments
0
Likes
5
Embeds 0
No embeds

No notes for slide

Transcript of "Lucene for Solr Developers"

  1. 1. Lucene for Solr Developers uberconf - July 14, 2011 Presented by Erik Hatchererik.hatcher@lucidimagination.com Lucid Imagination http://www.lucidimagination.com
  2. 2. Lucene Core• IndexWriter• Directory• IndexReader, IndexSearcher• analysis: Analyzer, TokenStream, Tokenizer,TokenFilter• Query
  3. 3. Solr Architecture
  4. 4. Customizing - Dont do it!• Unless you need to.• In other words... ensure youve given the built-in capabilities a try, asked on the e-mail list, and spelunked into at least Solrs code a bit to make some sense of the situation.• But were here to roll up our sleeves, because we need to...
  5. 5. But first...• Look at Lucene and/or Solr source code as appropriate• Carefully read javadocs and wiki pages - lots of tips there• And, hey, search for what youre trying to do... • Google, of course • But try out LucidFind and other Lucene ecosystem specific search systems - http://www.lucidimagination.com/search/
  6. 6. Extension points• Tokenizer, TokenFilter, • QParser CharFilter • DataImportHandler• SearchComponent hooks• RequestHandler • data sources• ResponseWriter • entity processors• FieldType • transformers• Similarity • several others
  7. 7. Factories• FooFactory (most) everywhere. Sometimes theres BarPlugin style• for sake of discussion... lets just skip the "factory" part• In Solr, Factories and Plugins are used by configuration loading to parameterize and construct
  8. 8. "Installing" plugins• Compile .java to .class, JAR it up• Put JAR files in either: • <solr-home>/lib • a shared lib when using multicore • anywhere, and register location in solrconfig.xml• Hook in plugins as appropriate
  9. 9. Multicore sharedLib<solr sharedLib="/usr/local/solr/customlib" persistent="true"> <cores adminPath="/admin/cores"> <core instanceDir="core1" name="core1"/> <core instanceDir="core2" name="core2"/> </cores></solr>
  10. 10. Plugins via solrconfig.xml• <lib dir="/path/to/your/custom/jars" />
  11. 11. Analysis• CharFilter• Tokenizer• TokenFilter
  12. 12. Primer• Tokens, Terms• Attributes: Type, Payloads, Offsets, Positions, Term Vectors• part of the picture:
  13. 13. Version• enum: • Version.LUCENE_31, Version.LUCENE_32, etc• Version.onOrAfter(Version other)
  14. 14. CharFilter• extend BaseCharFilter• enables pre-tokenization filtering/morphing of incoming field value• only affects tokenization, not stored value• Built-in CharFilters: HTMLStripCharFilter, PatternReplaceCharFilter, and MappingCharFilter
  15. 15. Tokenizer• common to extend CharTokenizer• implement - • protected abstract boolean isTokenChar(int c);• optionally override - • protected int normalize(int c)• extend Tokenizer directly for finer control• Popular built-in Tokenizers include: WhitespaceTokenizer, StandardTokenizer, PatternTokenizer, KeywordTokenizer, ICUTokenizer
  16. 16. TokenFilter• a TokenStream whose input is another TokenStream• Popular TokenFilters include: LowerCaseFilter, CommonGramsFilter, SnowballFilter, StopFilter, WordDelimiterFilter
  17. 17. Lucenes analysis APIs• tricky business, what with Attributes (Source/Factorys), State, characters, code points,Version, etc...• Test!!! • BaseTokenStreamTestCase • Look at Lucene and Solrs test cases
  18. 18. Solrs Analysis Tools• Admin analysis tool• Field analysis request handler• DEMO
  19. 19. Query Parsing• String -> org.apache.lucene.search.Query
  20. 20. QParserPluginpublic abstract class QParserPlugin implements NamedListInitializedPlugin { public abstract QParser createParser( String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req);}
  21. 21. QParserpublic abstract class QParser { public abstract Query parse() throws ParseException;}
  22. 22. Built-in QParsersfrom QParserPlugin.java /** internal use - name to class mappings of builtin parsers */ public static final Object[] standardPlugins = { LuceneQParserPlugin.NAME, LuceneQParserPlugin.class, OldLuceneQParserPlugin.NAME, OldLuceneQParserPlugin.class, FunctionQParserPlugin.NAME, FunctionQParserPlugin.class, PrefixQParserPlugin.NAME, PrefixQParserPlugin.class, BoostQParserPlugin.NAME, BoostQParserPlugin.class, DisMaxQParserPlugin.NAME, DisMaxQParserPlugin.class, ExtendedDismaxQParserPlugin.NAME, ExtendedDismaxQParserPlugin.class, FieldQParserPlugin.NAME, FieldQParserPlugin.class, RawQParserPlugin.NAME, RawQParserPlugin.class, TermQParserPlugin.NAME, TermQParserPlugin.class, NestedQParserPlugin.NAME, NestedQParserPlugin.class, FunctionRangeQParserPlugin.NAME, FunctionRangeQParserPlugin.class, SpatialFilterQParserPlugin.NAME, SpatialFilterQParserPlugin.class, SpatialBoxQParserPlugin.NAME, SpatialBoxQParserPlugin.class, JoinQParserPlugin.NAME, JoinQParserPlugin.class, };
  23. 23. Local Parameters• {!qparser_name param=value}expression • or• {!qparser_name param=value v=expression}• Can substitute $references from request parameters
  24. 24. Param Substitutionsolrconfig.xml<requestHandler name="/document" class="solr.SearchHandler"> <lst name="invariants"> <str name="q">{!term f=id v=$id}</str> </lst></requestHandler>Solr requesthttp://localhost:8983/solr/document?id=FOO37
  25. 25. Custom QParser• Implement a QParserPlugin that creates your custom QParser• Register in solrconfig.xml • <queryParser name="myparser" class="com.mycompany.MyQParserPlugin"/>
  26. 26. Update Processor• Responsible for handling these commands: • add/update • delete • commit • merge indexes
  27. 27. Built-in Update Processors• RunUpdateProcessor • Actually performs the operations, such as adding the documents to the index• LogUpdateProcessor • Logs each operation• SignatureUpdateProcessor • duplicate detection and optionally rejection
  28. 28. UIMA Update Processor• UIMA - Unstructured Information Management Architecture - http://uima.apache.org/• Enables UIMA components to augment documents• Entity extraction, automated categorization, language detection, etc• "contrib" plugin• http://wiki.apache.org/solr/SolrUIMA
  29. 29. Update Processor Chain• UpdateProcessors sequence into a chain• Each processor can abort the entire update or hand processing to next processor in the chain• Chains, of update processor factories, are specified in solrconfig.xml• Update requests can specify an update.processor parameter
  30. 30. Default update processor chainFrom SolrCore.java// construct the default chainUpdateRequestProcessorFactory[] factories = new UpdateRequestProcessorFactory[]{ new RunUpdateProcessorFactory(), new LogUpdateProcessorFactory() }; Note: these steps have been swapped on trunk recently
  31. 31. Example Update Processor• What are the best facets to show for a particular query? Wouldnt it be nice to see the distribution of document "attributes" represented across a result set?• Learned this trick from the Smithsonian, who were doing it manually - add an indexed field containing the field names of the interesting other fields on the document.• Facet on that field "of field names" initially, then request facets on the top values returned.
  32. 32. Config for custom update processor<updateRequestProcessorChain name="fields_used" default="true"> <processor class="solr.processor.FieldsUsedUpdateProcessorFactory"> <str name="fieldsUsedFieldName">attribute_fields</str> <str name="fieldNameRegex">.*_attribute</str> </processor> <processor class="solr.LogUpdateProcessorFactory" /> <processor class="solr.RunUpdateProcessorFactory" /></updateRequestProcessorChain>
  33. 33. FieldsUsedUpdateProcessorFactorypublic class FieldsUsedUpdateProcessorFactory extends UpdateRequestProcessorFactory { private String fieldsUsedFieldName; private Pattern fieldNamePattern; public UpdateRequestProcessor getInstance(SolrQueryRequest req, SolrQueryResponse rsp, UpdateRequestProcessor next) { return new FieldsUsedUpdateProcessor(req, rsp, this, next); } // ... next slide ...}
  34. 34. FieldsUsedUpdateProcessorFactory @Override public void init(NamedList args) { if (args == null) return; SolrParams params = SolrParams.toSolrParams(args); fieldsUsedFieldName = params.get("fieldsUsedFieldName"); if (fieldsUsedFieldName == null) { throw new SolrException (SolrException.ErrorCode.SERVER_ERROR, "fieldsUsedFieldName must be specified"); } // TODO check that fieldsUsedFieldName is a valid field name and multiValued String fieldNameRegex = params.get("fieldNameRegex"); if (fieldNameRegex == null) { throw new SolrException (SolrException.ErrorCode.SERVER_ERROR, "fieldNameRegex must be specified"); } fieldNamePattern = Pattern.compile(fieldNameRegex); super.init(args); }
  35. 35. class FieldsUsedUpdateProcessor extends UpdateRequestProcessor { public FieldsUsedUpdateProcessor(SolrQueryRequest req, SolrQueryResponse rsp, FieldsUsedUpdateProcessorFactory factory, UpdateRequestProcessor next) { super(next); } @Override public void processAdd(AddUpdateCommand cmd) throws IOException { SolrInputDocument doc = cmd.getSolrInputDocument(); Collection<String> incomingFieldNames = doc.getFieldNames(); Iterator<String> iterator = incomingFieldNames.iterator(); ArrayList<String> usedFields = new ArrayList<String>(); while (iterator.hasNext()) { String f = iterator.next(); if (fieldNamePattern.matcher(f).matches()) { usedFields.add(f); } } doc.addField(fieldsUsedFieldName, usedFields.toArray()); super.processAdd(cmd); }}
  36. 36. FieldsUsedUpdateProcessor in actionschema.xml <dynamicField name="*_attribute" type="string" indexed="true" stored="true" multiValued="true"/>Add some documentssolr.add([{:id=>1, :name => "Big Blue Shoes", :size_attribute => L, :color_attribute => Blue}, {:id=>2, :name => "Cool Gizmo", :memory_attribute => "16GB", :color_attribute => White}])solr.commitFacet on attribute_fields - http://localhost:8983/solr/select?q=*:*&facet=on&facet.field=attribute_fields&wt=json&indent=on "facet_fields":{ "attribute_fields":[ "color_attribute",2, "memory_attribute",1, "size_attribute",1]}
  37. 37. Search Components• Built-in: Clustering, Debug, Facet, Highlight, MoreLikeThis, Query, QueryElevation, SpellCheck, Stats, TermVector, Terms• Non-distributed API: • prepare(ResponseBuilder rb) • process(ResponseBuilder rb)
  38. 38. Example - auto facet select• It sure would be nice if you could have Solr automatically select field(s) for faceting based dynamically off the profile of the results. For example, youre indexing disparate types of products, all with varying attributes (color, size - like for apparel, memory_size - for electronics, subject - for books, etc), and a user searches for "ipod" where most products match products with color and memory_size attributes... lets automatically facet on those fields.• https://issues.apache.org/jira/browse/SOLR-2641
  39. 39. AutoFacetSelection Component• Too much code for a slide, lets take a look in an IDE...• Basically - • process() gets autofacet.field and autofacet.n request params, facets on field, takes top N values, sets those as facet.fields • Gotcha - need to call rb.setNeedDocSet (true) in prepare() as faceting needs it
  40. 40. SearchComponent config<searchComponent name="autofacet" class="solr.AutoFacetSelectionComponent"/><requestHandler name="/searchplus" class="solr.SearchHandler"> <arr name="components"> <str>query</str> <str>autofacet</str> <str>facet</str> <str>debug</str> </arr></requestHandler>
  41. 41. autofacet successhttp://localhost:8983/solr/searchplus?q=*:*&facet=on&autofacet.field=attribute_fields&wt=json&indent=on{ "response":{"numFound":2,"start":0,"docs":[ { "size_attribute":["L"], "color_attribute":["Blue"], "name":"Big Blue Shoes", "id":"1", "attribute_fields":["size_attribute", "color_attribute"]}, { "color_attribute":["White"], "name":"Cool Gizmo", "memory_attribute":["16GB"], "id":"2", "attribute_fields":["color_attribute", "memory_attribute"]}] }, "facet_counts":{ "facet_queries":{}, "facet_fields":{ "color_attribute":[ "Blue",1, "White",1], "memory_attribute":[ "16GB",1]}}}
  42. 42. Distributed-aware SearchComponents• SearchComponent has a few distributed mode methods: • distributedProcess(ResponseBuilder) • modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq) • handleResponses(ResponseBuilder rb, ShardRequest sreq) • finishStage(ResponseBuilder rb)
  43. 43. Testing• AbstractSolrTestCase• SolrTestCaseJ4• SolrMeter • http://code.google.com/p/solrmeter/
  44. 44. 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
  45. 45. Thank You!
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×