3b0c7ff34ceed8e664fdf479641ed4796648407e
[lui-solr.git] / solr-conf / solrconfig.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!--
3  Licensed to the Apache Software Foundation (ASF) under one or more
4  contributor license agreements.  See the NOTICE file distributed with
5  this work for additional information regarding copyright ownership.
6  The ASF licenses this file to You under the Apache License, Version 2.0
7  (the "License"); you may not use this file except in compliance with
8  the License.  You may obtain a copy of the License at
9
10      http://www.apache.org/licenses/LICENSE-2.0
11
12  Unless required by applicable law or agreed to in writing, software
13  distributed under the License is distributed on an "AS IS" BASIS,
14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  See the License for the specific language governing permissions and
16  limitations under the License.
17 -->
18 <!-- 
19      For more details about configurations options that may appear in this 
20      file, see http://wiki.apache.org/solr/SolrConfigXml.
21
22      Specifically, the Solr Config can support XInclude, which may make it easier to manage
23      the configuration.  See https://issues.apache.org/jira/browse/SOLR-1167
24 -->
25 <config>
26   <!-- Set this to 'false' if you want solr to continue working after it has 
27        encountered an severe configuration error.  In a production environment, 
28        you may want solr to keep working even if one handler is mis-configured.
29
30        You may also set this to false using by setting the system property:
31          -Dsolr.abortOnConfigurationError=false
32      -->
33   <abortOnConfigurationError>${solr.abortOnConfigurationError:true}</abortOnConfigurationError>
34
35   <!-- lib directives can be used to instruct Solr to load an Jars identified
36        and use them to resolve any "plugins" specified in your solrconfig.xml or
37        schema.xml (ie: Analyzers, Request Handlers, etc...).
38
39        All directories and paths are resolved relative the instanceDir.
40
41        If a "./lib" directory exists in your instanceDir, all files found in it
42        are included as if you had used the following syntax...
43        
44               <lib dir="./lib" />
45     -->
46   <!-- A dir option by itself adds any files found in the directory to the
47        classpath, this is useful for including all jars in a directory.
48     -->
49   <lib dir="../../contrib/extraction/lib" />
50   <!-- When a regex is specified in addition to a directory, only the files in that
51        directory which completely match the regex (anchored on both ends)
52        will be included.
53     -->
54   <lib dir="../../dist/" regex="apache-solr-cell-\d.*\.jar" />
55   <lib dir="../../dist/" regex="apache-solr-clustering-\d.*\.jar" />
56   <!-- If a dir option (with or without a regex) is used and nothing is found
57        that matches, it will be ignored
58     -->
59   <lib dir="../../contrib/clustering/lib/downloads/" />
60   <lib dir="../../contrib/clustering/lib/" />
61   <lib dir="/total/crap/dir/ignored" /> 
62   <!-- an exact path can be used to specify a specific file.  This will cause
63        a serious error to be logged if it can't be loaded.
64   <lib path="../a-jar-that-does-not-exist.jar" /> 
65   -->
66
67   
68   <!-- Used to specify an alternate directory to hold all index data
69        other than the default ./data under the Solr home.
70        If replication is in use, this should match the replication configuration. -->
71   <dataDir>${solr.data.dir:/Users/dennis/solr/solr/data}</dataDir>
72
73
74   <!-- WARNING: this <indexDefaults> section only provides defaults for index writers
75        in general. See also the <mainIndex> section after that when changing parameters
76        for Solr's main Lucene index. -->
77   <indexDefaults>
78    <!-- Values here affect all index writers and act as a default unless overridden. -->
79     <useCompoundFile>false</useCompoundFile>
80
81     <mergeFactor>10</mergeFactor>
82     <!-- If both ramBufferSizeMB and maxBufferedDocs is set, then Lucene will flush
83      based on whichever limit is hit first.  -->
84     <!--<maxBufferedDocs>1000</maxBufferedDocs>-->
85
86     <!-- Sets the amount of RAM that may be used by Lucene indexing
87       for buffering added documents and deletions before they are
88       flushed to the Directory.  -->
89     <ramBufferSizeMB>32</ramBufferSizeMB>
90     <!-- <maxMergeDocs>2147483647</maxMergeDocs> -->
91     <maxFieldLength>10000</maxFieldLength>
92     <writeLockTimeout>1000</writeLockTimeout>
93     <commitLockTimeout>10000</commitLockTimeout>
94
95     <!--
96      Expert: Turn on Lucene's auto commit capability.  This causes intermediate
97      segment flushes to write a new lucene index descriptor, enabling it to be
98      opened by an external IndexReader.  This can greatly slow down indexing
99      speed.  NOTE: Despite the name, this value does not have any relation to
100      Solr's autoCommit functionality
101      -->
102     <!--<luceneAutoCommit>false</luceneAutoCommit>-->
103
104     <!--
105      Expert: The Merge Policy in Lucene controls how merging is handled by
106      Lucene.  The default in 2.3 is the LogByteSizeMergePolicy, previous
107      versions used LogDocMergePolicy.
108
109      LogByteSizeMergePolicy chooses segments to merge based on their size.  The
110      Lucene 2.2 default, LogDocMergePolicy chose when to merge based on number
111      of documents
112
113      Other implementations of MergePolicy must have a no-argument constructor
114      -->
115     <!--<mergePolicy class="org.apache.lucene.index.LogByteSizeMergePolicy"/>-->
116
117     <!--
118      Expert:
119      The Merge Scheduler in Lucene controls how merges are performed.  The
120      ConcurrentMergeScheduler (Lucene 2.3 default) can perform merges in the
121      background using separate threads.  The SerialMergeScheduler (Lucene 2.2
122      default) does not.
123      -->
124     <!--<mergeScheduler class="org.apache.lucene.index.ConcurrentMergeScheduler"/>-->
125
126           
127     <!--
128       This option specifies which Lucene LockFactory implementation to use.
129       
130       single = SingleInstanceLockFactory - suggested for a read-only index
131                or when there is no possibility of another process trying
132                to modify the index.
133       native = NativeFSLockFactory  - uses OS native file locking
134       simple = SimpleFSLockFactory  - uses a plain file for locking
135
136       (For backwards compatibility with Solr 1.2, 'simple' is the default
137        if not specified.)
138     -->
139     <lockType>native</lockType>
140     <!--
141      Expert:
142     Controls how often Lucene loads terms into memory -->
143     <!--<termIndexInterval>256</termIndexInterval>-->
144   </indexDefaults>
145
146   <mainIndex>
147     <!-- options specific to the main on-disk lucene index -->
148     <useCompoundFile>false</useCompoundFile>
149     <ramBufferSizeMB>32</ramBufferSizeMB>
150     <mergeFactor>10</mergeFactor>
151     <!-- Deprecated -->
152     <!--<maxBufferedDocs>1000</maxBufferedDocs>-->
153     <!--<maxMergeDocs>2147483647</maxMergeDocs>-->
154
155     <!-- inherit from indexDefaults <maxFieldLength>10000</maxFieldLength> -->
156
157     <!-- If true, unlock any held write or commit locks on startup. 
158          This defeats the locking mechanism that allows multiple
159          processes to safely access a lucene index, and should be
160          used with care.
161          This is not needed if lock type is 'none' or 'single'
162      -->
163     <unlockOnStartup>false</unlockOnStartup>
164     
165     <!-- If true, IndexReaders will be reopened (often more efficient) instead
166          of closed and then opened.  -->
167     <reopenReaders>true</reopenReaders>
168
169     <!--
170      Expert:
171     Controls how often Lucene loads terms into memory.  Default is 128 and is likely good for most everyone. -->
172     <!--<termIndexInterval>256</termIndexInterval>-->
173
174     <!--
175         Custom deletion policies can specified here. The class must
176         implement org.apache.lucene.index.IndexDeletionPolicy.
177
178         http://lucene.apache.org/java/2_3_2/api/org/apache/lucene/index/IndexDeletionPolicy.html
179
180         The standard Solr IndexDeletionPolicy implementation supports deleting
181         index commit points on number of commits, age of commit point and
182         optimized status.
183
184         The latest commit point should always be preserved regardless
185         of the criteria.
186     -->
187     <deletionPolicy class="solr.SolrDeletionPolicy">
188       <!-- The number of commit points to be kept -->
189       <str name="maxCommitsToKeep">1</str>
190       <!-- The number of optimized commit points to be kept -->
191       <str name="maxOptimizedCommitsToKeep">0</str>
192       <!--
193           Delete all commit points once they have reached the given age.
194           Supports DateMathParser syntax e.g.
195           
196           <str name="maxCommitAge">30MINUTES</str>
197           <str name="maxCommitAge">1DAY</str>
198       -->
199     </deletionPolicy>
200
201     <!--  To aid in advanced debugging, you may turn on IndexWriter debug logging.
202       Setting to true will set the file that the underlying Lucene IndexWriter
203       will write its debug infostream to.  -->
204      <infoStream file="INFOSTREAM.txt">false</infoStream> 
205
206   </mainIndex>
207
208   <!--  Enables JMX if and only if an existing MBeanServer is found, use this
209     if you want to configure JMX through JVM parameters. Remove this to disable
210     exposing Solr configuration and statistics to JMX.
211
212                 If you want to connect to a particular server, specify the agentId
213                 e.g. <jmx agentId="myAgent" />
214
215                 If you want to start a new MBeanServer, specify the serviceUrl
216                 e.g <jmx serviceUrl="service:jmx:rmi:///jndi/rmi://localhost:9999/solr"/>
217
218                 For more details see http://wiki.apache.org/solr/SolrJmx
219   -->
220   <jmx />
221
222   <!-- the default high-performance update handler -->
223   <updateHandler class="solr.DirectUpdateHandler2">
224     <!-- A prefix of "solr." for class names is an alias that
225          causes solr to search appropriate packages, including
226          org.apache.solr.(search|update|request|core|analysis)
227      -->
228
229     <!-- Perform a <commit/> automatically under certain conditions:
230          maxDocs - number of updates since last commit is greater than this
231          maxTime - oldest uncommited update (in ms) is this long ago
232          Instead of enabling autoCommit, consider using "commitWithin"
233          when adding documents. http://wiki.apache.org/solr/UpdateXmlMessages
234     <autoCommit> 
235       <maxDocs>10000</maxDocs>
236       <maxTime>1000</maxTime> 
237     </autoCommit>
238     -->
239
240
241     <!-- The RunExecutableListener executes an external command from a
242       hook such as postCommit or postOptimize.
243          exe - the name of the executable to run
244          dir - dir to use as the current working directory. default="."
245          wait - the calling thread waits until the executable returns. default="true"
246          args - the arguments to pass to the program.  default=nothing
247          env - environment variables to set.  default=nothing
248       -->
249     <!-- A postCommit event is fired after every commit or optimize command
250     <listener event="postCommit" class="solr.RunExecutableListener">
251       <str name="exe">solr/bin/snapshooter</str>
252       <str name="dir">.</str>
253       <bool name="wait">true</bool>
254       <arr name="args"> <str>arg1</str> <str>arg2</str> </arr>
255       <arr name="env"> <str>MYVAR=val1</str> </arr>
256     </listener>
257     -->
258     <!-- A postOptimize event is fired only after every optimize command
259     <listener event="postOptimize" class="solr.RunExecutableListener">
260       <str name="exe">snapshooter</str>
261       <str name="dir">solr/bin</str>
262       <bool name="wait">true</bool>
263     </listener>
264     -->
265
266   </updateHandler>
267   
268   <!-- Use the following format to specify a custom IndexReaderFactory - allows for alternate
269        IndexReader implementations.
270
271        ** Experimental Feature **
272        Please note - Using a custom IndexReaderFactory may prevent certain other features
273        from working. The API to IndexReaderFactory may change without warning or may even
274        be removed from future releases if the problems cannot be resolved.
275
276        ** Features that may not work with custom IndexReaderFactory **
277        The ReplicationHandler assumes a disk-resident index. Using a custom
278        IndexReader implementation may cause incompatibility with ReplicationHandler and
279        may cause replication to not work correctly. See SOLR-1366 for details.
280
281   <indexReaderFactory name="IndexReaderFactory" class="package.class">
282     Parameters as required by the implementation
283   </indexReaderFactory >
284   -->
285   <!-- To set the termInfosIndexDivisor, do this: -->
286
287   <indexReaderFactory name="IndexReaderFactory" class="org.apache.solr.core.StandardIndexReaderFactory">
288     <int name="termInfosIndexDivisor">2</int>
289   </indexReaderFactory>
290
291
292   <query>
293     <!-- Maximum number of clauses in a boolean query... in the past, this affected
294         range or prefix queries that expanded to big boolean queries - built in Solr 
295         query parsers no longer create queries with this limitation. 
296         An exception is thrown if exceeded.  -->
297     <maxBooleanClauses>1024</maxBooleanClauses>
298
299
300     <!-- There are two implementations of cache available for Solr,
301          LRUCache, based on a synchronized LinkedHashMap, and
302          FastLRUCache, based on a ConcurrentHashMap.  FastLRUCache has faster gets
303          and slower puts in single threaded operation and thus is generally faster
304          than LRUCache when the hit ratio of the cache is high (> 75%), and may be
305          faster under other scenarios on multi-cpu systems. -->
306     <!-- Cache used by SolrIndexSearcher for filters (DocSets),
307          unordered sets of *all* documents that match a query.
308          When a new searcher is opened, its caches may be prepopulated
309          or "autowarmed" using data from caches in the old searcher.
310          autowarmCount is the number of items to prepopulate.  For LRUCache,
311          the autowarmed items will be the most recently accessed items.
312        Parameters:
313          class - the SolrCache implementation LRUCache or FastLRUCache
314          size - the maximum number of entries in the cache
315          initialSize - the initial capacity (number of entries) of
316            the cache.  (seel java.util.HashMap)
317          autowarmCount - the number of entries to prepopulate from
318            and old cache.
319          -->
320     <filterCache
321       class="solr.FastLRUCache"
322       size="512"
323       initialSize="512"
324       autowarmCount="0"/>
325
326     <!-- Cache used to hold field values that are quickly accessible
327          by document id.  The fieldValueCache is created by default
328          even if not configured here.
329       <fieldValueCache
330         class="solr.FastLRUCache"
331         size="512"
332         autowarmCount="128"
333         showItems="32"
334       />
335     -->
336
337    <!-- queryResultCache caches results of searches - ordered lists of
338          document ids (DocList) based on a query, a sort, and the range
339          of documents requested.  -->
340     <queryResultCache
341       class="solr.LRUCache"
342       size="512"
343       initialSize="512"
344       autowarmCount="0"/>
345
346   <!-- documentCache caches Lucene Document objects (the stored fields for each document).
347        Since Lucene internal document ids are transient, this cache will not be autowarmed.  -->
348     <documentCache
349       class="solr.LRUCache"
350       size="512"
351       initialSize="512"
352       autowarmCount="0"/>
353
354     <!-- If true, stored fields that are not requested will be loaded lazily.
355       This can result in a significant speed improvement if the usual case is to
356       not load all stored fields, especially if the skipped fields are large
357       compressed text fields.
358     -->
359     <enableLazyFieldLoading>true</enableLazyFieldLoading>
360
361     <!-- Example of a generic cache.  These caches may be accessed by name
362          through SolrIndexSearcher.getCache(),cacheLookup(), and cacheInsert().
363          The purpose is to enable easy caching of user/application level data.
364          The regenerator argument should be specified as an implementation
365          of solr.search.CacheRegenerator if autowarming is desired.  -->
366     <!--
367     <cache name="myUserCache"
368       class="solr.LRUCache"
369       size="4096"
370       initialSize="1024"
371       autowarmCount="1024"
372       regenerator="org.mycompany.mypackage.MyRegenerator"
373       />
374     -->
375
376    <!-- An optimization that attempts to use a filter to satisfy a search.
377          If the requested sort does not include score, then the filterCache
378          will be checked for a filter matching the query. If found, the filter
379          will be used as the source of document ids, and then the sort will be
380          applied to that.
381     <useFilterForSortedQuery>true</useFilterForSortedQuery>
382    -->
383
384    <!-- An optimization for use with the queryResultCache.  When a search
385          is requested, a superset of the requested number of document ids
386          are collected.  For example, if a search for a particular query
387          requests matching documents 10 through 19, and queryWindowSize is 50,
388          then documents 0 through 49 will be collected and cached.  Any further
389          requests in that range can be satisfied via the cache.  -->
390     <queryResultWindowSize>20</queryResultWindowSize>
391
392     <!-- Maximum number of documents to cache for any entry in the
393          queryResultCache. -->
394     <queryResultMaxDocsCached>200</queryResultMaxDocsCached>
395
396     <!-- a newSearcher event is fired whenever a new searcher is being prepared
397       and there is a current searcher handling requests (aka registered).
398       It can be used to prime certain caches to prevent long request times for
399       certain requests.
400     -->
401     <!-- QuerySenderListener takes an array of NamedList and executes a
402          local query request for each NamedList in sequence. -->
403     <listener event="newSearcher" class="solr.QuerySenderListener">
404       <arr name="queries">
405         <!--
406         <lst> <str name="q">solr</str> <str name="start">0</str> <str name="rows">10</str> </lst>
407         <lst> <str name="q">rocks</str> <str name="start">0</str> <str name="rows">10</str> </lst>
408         <lst><str name="q">static newSearcher warming query from solrconfig.xml</str></lst>
409         -->
410       </arr>
411     </listener>
412
413     <!-- a firstSearcher event is fired whenever a new searcher is being
414          prepared but there is no current registered searcher to handle
415          requests or to gain autowarming data from. -->
416     <listener event="firstSearcher" class="solr.QuerySenderListener">
417       <arr name="queries">
418         <lst>
419           <str name="q">water</str>
420           <str name="start">0</str>
421           <str name="rows">10</str>
422           <str name="facet">true</str>
423           <str name="facet.mincount">1</str>
424           <str name="facet.field">date</str>
425           <str name="f.date.facet.limit">10</str>
426           <str name="facet.field">subject_exact</str>
427           <str name="f.subject_exact.facet.limit">10</str>
428           <str name="facet.field">author_exact</str>
429           <str name="f.author_exact.facet.limit">10</str>
430           <str name="facet.field">medium_exact</str>
431         </lst>
432         <lst><str name="q">static firstSearcher warming query from solrconfig.xml</str></lst>
433       </arr>
434     </listener>
435
436     <!-- If a search request comes in and there is no current registered searcher,
437          then immediately register the still warming searcher and use it.  If
438          "false" then all requests will block until the first searcher is done
439          warming. -->
440     <useColdSearcher>false</useColdSearcher>
441
442     <!-- Maximum number of searchers that may be warming in the background
443       concurrently.  An error is returned if this limit is exceeded. Recommend
444       1-2 for read-only slaves, higher for masters w/o cache warming. -->
445     <maxWarmingSearchers>2</maxWarmingSearchers>
446
447   </query>
448
449   <!-- 
450     Let the dispatch filter handler /select?qt=XXX
451     handleSelect=true will use consistent error handling for /select and /update
452     handleSelect=false will use solr1.1 style error formatting
453     -->
454   <requestDispatcher handleSelect="true" >
455     <!--Make sure your system has some authentication before enabling remote streaming!  -->
456     <requestParsers enableRemoteStreaming="true" multipartUploadLimitInKB="2048000" />
457
458     <!-- Set HTTP caching related parameters (for proxy caches and clients).
459           
460          To get the behaviour of Solr 1.2 (ie: no caching related headers)
461          use the never304="true" option and do not specify a value for
462          <cacheControl>
463     -->
464     <!-- <httpCaching never304="true"> -->
465     <httpCaching lastModifiedFrom="openTime"
466                  etagSeed="Solr">
467        <!-- lastModFrom="openTime" is the default, the Last-Modified value
468             (and validation against If-Modified-Since requests) will all be
469             relative to when the current Searcher was opened.
470             You can change it to lastModFrom="dirLastMod" if you want the
471             value to exactly corrispond to when the physical index was last
472             modified.
473
474             etagSeed="..." is an option you can change to force the ETag
475             header (and validation against If-None-Match requests) to be
476             differnet even if the index has not changed (ie: when making
477             significant changes to your config file)
478
479             lastModifiedFrom and etagSeed are both ignored if you use the
480             never304="true" option.
481        -->
482        <!-- If you include a <cacheControl> directive, it will be used to
483             generate a Cache-Control header, as well as an Expires header
484             if the value contains "max-age="
485
486             By default, no Cache-Control header is generated.
487
488             You can use the <cacheControl> option even if you have set
489             never304="true"
490        -->
491        <!-- <cacheControl>max-age=30, public</cacheControl> -->
492     </httpCaching>
493   </requestDispatcher>
494
495
496   <!-- requestHandler plugins... incoming queries will be dispatched to the
497      correct handler based on the path or the qt (query type) param.
498      Names starting with a '/' are accessed with the a path equal to the 
499      registered name.  Names without a leading '/' are accessed with:
500       http://host/app/select?qt=name
501      If no qt is defined, the requestHandler that declares default="true"
502      will be used.
503   -->
504   <requestHandler name="standard" class="solr.SearchHandler" default="true">
505     <!-- default values for query parameters -->
506      <lst name="defaults">
507        <str name="echoParams">explicit</str>
508        <!--
509        <int name="rows">10</int>
510        <str name="fl">*</str>
511        <str name="version">2.1</str>
512         -->
513      </lst>
514   </requestHandler>
515
516 <!-- Please refer to http://wiki.apache.org/solr/SolrReplication for details on configuring replication -->
517 <!-- remove the <lst name="master"> section if this is just a slave -->
518 <!-- remove  the <lst name="slave"> section if this is just a master -->
519 <!--
520 <requestHandler name="/replication" class="solr.ReplicationHandler" >
521     <lst name="master">
522       <str name="replicateAfter">commit</str>
523       <str name="replicateAfter">startup</str>
524       <str name="confFiles">schema.xml,stopwords.txt</str>
525     </lst>
526     <lst name="slave">
527       <str name="masterUrl">http://localhost:8983/solr/replication</str>
528       <str name="pollInterval">00:00:60</str>
529     </lst>
530 </requestHandler>-->
531
532   <!-- DisMaxRequestHandler allows easy searching across multiple fields
533        for simple user-entered phrases.  It's implementation is now
534        just the standard SearchHandler with a default query type
535        of "dismax". 
536        see http://wiki.apache.org/solr/DisMaxRequestHandler
537    -->
538   <requestHandler name="dismax" class="solr.SearchHandler" >
539     <lst name="defaults">
540      <str name="defType">dismax</str>
541      <str name="echoParams">explicit</str>
542      <float name="tie">0.01</float>
543      <str name="qf">
544         text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0 manu^1.1 cat^1.4
545      </str>
546      <str name="pf">
547         text^0.2 features^1.1 name^1.5 manu^1.4 manu_exact^1.9
548      </str>
549      <str name="bf">
550         popularity^0.5 recip(price,1,1000,1000)^0.3
551      </str>
552      <str name="fl">
553         id,name,price,score
554      </str>
555      <str name="mm">
556         2&lt;-1 5&lt;-2 6&lt;90%
557      </str>
558      <int name="ps">100</int>
559      <str name="q.alt">*:*</str>
560      <!-- example highlighter config, enable per-query with hl=true -->
561      <str name="hl.fl">text features name</str>
562      <!-- for this field, we want no fragmenting, just highlighting -->
563      <str name="f.name.hl.fragsize">0</str>
564      <!-- instructs Solr to return the field itself if no query terms are
565           found -->
566      <str name="f.name.hl.alternateField">name</str>
567      <str name="f.text.hl.fragmenter">regex</str> <!-- defined below -->
568     </lst>
569   </requestHandler>
570
571   <!-- Note how you can register the same handler multiple times with
572        different names (and different init parameters)
573     -->
574   <requestHandler name="partitioned" class="solr.SearchHandler" >
575     <lst name="defaults">
576      <str name="defType">dismax</str>
577      <str name="echoParams">explicit</str>
578      <str name="qf">text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0</str>
579      <str name="mm">2&lt;-1 5&lt;-2 6&lt;90%</str>
580      <!-- This is an example of using Date Math to specify a constantly
581           moving date range in a config...
582        -->
583      <str name="bq">incubationdate_dt:[* TO NOW/DAY-1MONTH]^2.2</str>
584     </lst>
585     <!-- In addition to defaults, "appends" params can be specified
586          to identify values which should be appended to the list of
587          multi-val params from the query (or the existing "defaults").
588
589          In this example, the param "fq=instock:true" will be appended to
590          any query time fq params the user may specify, as a mechanism for
591          partitioning the index, independent of any user selected filtering
592          that may also be desired (perhaps as a result of faceted searching).
593
594          NOTE: there is *absolutely* nothing a client can do to prevent these
595          "appends" values from being used, so don't use this mechanism
596          unless you are sure you always want it.
597       -->
598     <lst name="appends">
599       <str name="fq">inStock:true</str>
600     </lst>
601     <!-- "invariants" are a way of letting the Solr maintainer lock down
602          the options available to Solr clients.  Any params values
603          specified here are used regardless of what values may be specified
604          in either the query, the "defaults", or the "appends" params.
605
606          In this example, the facet.field and facet.query params are fixed,
607          limiting the facets clients can use.  Faceting is not turned on by
608          default - but if the client does specify facet=true in the request,
609          these are the only facets they will be able to see counts for;
610          regardless of what other facet.field or facet.query params they
611          may specify.
612
613          NOTE: there is *absolutely* nothing a client can do to prevent these
614          "invariants" values from being used, so don't use this mechanism
615          unless you are sure you always want it.
616       -->
617     <lst name="invariants">
618       <str name="facet.field">cat</str>
619       <str name="facet.field">manu_exact</str>
620       <str name="facet.query">price:[* TO 500]</str>
621       <str name="facet.query">price:[500 TO *]</str>
622     </lst>
623   </requestHandler>
624
625
626   <!--
627    Search components are registered to SolrCore and used by Search Handlers
628    
629    By default, the following components are avaliable:
630     
631    <searchComponent name="query"     class="org.apache.solr.handler.component.QueryComponent" />
632    <searchComponent name="facet"     class="org.apache.solr.handler.component.FacetComponent" />
633    <searchComponent name="mlt"       class="org.apache.solr.handler.component.MoreLikeThisComponent" />
634    <searchComponent name="highlight" class="org.apache.solr.handler.component.HighlightComponent" />
635    <searchComponent name="stats"     class="org.apache.solr.handler.component.StatsComponent" />
636    <searchComponent name="debug"     class="org.apache.solr.handler.component.DebugComponent" />
637    
638    Default configuration in a requestHandler would look like:
639     <arr name="components">
640       <str>query</str>
641       <str>facet</str>
642       <str>mlt</str>
643       <str>highlight</str>
644       <str>stats</str>
645       <str>debug</str>
646     </arr>
647
648     If you register a searchComponent to one of the standard names, that will be used instead.
649     To insert components before or after the 'standard' components, use:
650     
651     <arr name="first-components">
652       <str>myFirstComponentName</str>
653     </arr>
654     
655     <arr name="last-components">
656       <str>myLastComponentName</str>
657     </arr>
658   -->
659
660    <!-- The spell check component can return a list of alternative spelling
661   suggestions.  -->
662   <searchComponent name="spellcheck" class="solr.SpellCheckComponent">
663
664     <str name="queryAnalyzerFieldType">textSpell</str>
665
666     <lst name="spellchecker">
667       <str name="name">default</str>
668       <str name="field">name</str>
669       <str name="spellcheckIndexDir">./spellchecker</str>
670     </lst>
671
672     <!-- a spellchecker that uses a different distance measure
673     <lst name="spellchecker">
674       <str name="name">jarowinkler</str>
675       <str name="field">spell</str>
676       <str name="distanceMeasure">org.apache.lucene.search.spell.JaroWinklerDistance</str>
677       <str name="spellcheckIndexDir">./spellchecker2</str>
678     </lst>
679      -->
680
681     <!-- a file based spell checker
682     <lst name="spellchecker">
683       <str name="classname">solr.FileBasedSpellChecker</str>
684       <str name="name">file</str>
685       <str name="sourceLocation">spellings.txt</str>
686       <str name="characterEncoding">UTF-8</str>
687       <str name="spellcheckIndexDir">./spellcheckerFile</str>
688     </lst>
689     -->
690   </searchComponent>
691
692   <!-- A request handler utilizing the spellcheck component.  
693   #############################################################################
694   NOTE: This is purely as an example.  The whole purpose of the
695   SpellCheckComponent is to hook it into the request handler that handles (i.e.
696   the standard or dismax SearchHandler) queries such that a separate request is
697   not needed to get suggestions.
698
699   IN OTHER WORDS, THERE IS REALLY GOOD CHANCE THE SETUP BELOW IS NOT WHAT YOU
700   WANT FOR YOUR PRODUCTION SYSTEM!
701   #############################################################################
702   -->
703   <requestHandler name="/spell" class="solr.SearchHandler" lazy="true">
704     <lst name="defaults">
705       <!-- omp = Only More Popular -->
706       <str name="spellcheck.onlyMorePopular">false</str>
707       <!-- exr = Extended Results -->
708       <str name="spellcheck.extendedResults">false</str>
709       <!--  The number of suggestions to return -->
710       <str name="spellcheck.count">1</str>
711     </lst>
712     <arr name="last-components">
713       <str>spellcheck</str>
714     </arr>
715   </requestHandler>
716
717   <searchComponent name="tvComponent" class="org.apache.solr.handler.component.TermVectorComponent"/>
718   <!-- A Req Handler for working with the tvComponent.  This is purely as an example.
719   You will likely want to add the component to your already specified request handlers. -->
720   <requestHandler name="tvrh" class="org.apache.solr.handler.component.SearchHandler">
721     <lst name="defaults">
722       <bool name="tv">true</bool>
723     </lst>
724     <arr name="last-components">
725       <str>tvComponent</str>
726     </arr>
727   </requestHandler>
728
729   <!-- Clustering Component
730        http://wiki.apache.org/solr/ClusteringComponent
731        This relies on third party jars which are not included in the release.
732        To use this component (and the "/clustering" handler)
733        Those jars will need to be downloaded, and you'll need to set the
734        solr.cluster.enabled system property when running solr...
735           java -Dsolr.clustering.enabled=true -jar start.jar
736     -->
737   <searchComponent
738     name="clusteringComponent"
739     enable="${solr.clustering.enabled:false}"
740     class="org.apache.solr.handler.clustering.ClusteringComponent" >
741     <!-- Declare an engine -->
742     <lst name="engine">
743       <!-- The name, only one can be named "default" -->
744       <str name="name">default</str>
745       <!-- 
746            Class name of Carrot2 clustering algorithm. Currently available algorithms are:
747            
748            * org.carrot2.clustering.lingo.LingoClusteringAlgorithm
749            * org.carrot2.clustering.stc.STCClusteringAlgorithm
750            
751            See http://project.carrot2.org/algorithms.html for the algorithm's characteristics.
752         -->
753       <str name="carrot.algorithm">org.carrot2.clustering.lingo.LingoClusteringAlgorithm</str>
754       <!-- 
755            Overriding values for Carrot2 default algorithm attributes. For a description
756            of all available attributes, see: http://download.carrot2.org/stable/manual/#chapter.components.
757            Use attribute key as name attribute of str elements below. These can be further
758            overridden for individual requests by specifying attribute key as request
759            parameter name and attribute value as parameter value.
760         -->
761       <str name="LingoClusteringAlgorithm.desiredClusterCountBase">20</str>
762     </lst>
763     <lst name="engine">
764       <str name="name">stc</str>
765       <str name="carrot.algorithm">org.carrot2.clustering.stc.STCClusteringAlgorithm</str>
766     </lst>
767   </searchComponent>
768   <requestHandler name="/clustering"
769                   enable="${solr.clustering.enabled:false}"
770                   class="solr.SearchHandler">
771      <lst name="defaults">
772        <bool name="clustering">true</bool>
773        <str name="clustering.engine">default</str>
774        <bool name="clustering.results">true</bool>
775        <!-- The title field -->
776        <str name="carrot.title">name</str>
777        <str name="carrot.url">id</str>
778        <!-- The field to cluster on -->
779        <str name="carrot.snippet">features</str>
780        <!-- produce summaries -->
781        <bool name="carrot.produceSummary">true</bool>
782        <!-- the maximum number of labels per cluster -->
783        <!--<int name="carrot.numDescriptions">5</int>-->
784        <!-- produce sub clusters -->
785        <bool name="carrot.outputSubClusters">false</bool>
786     </lst>     
787     <arr name="last-components">
788       <str>clusteringComponent</str>
789     </arr>
790   </requestHandler>
791   
792   <!-- Solr Cell: http://wiki.apache.org/solr/ExtractingRequestHandler -->
793   <requestHandler name="/update/extract" class="org.apache.solr.handler.extraction.ExtractingRequestHandler" startup="lazy">
794     <lst name="defaults">
795       <!-- All the main content goes into "text"... if you need to return
796            the extracted text or do highlighting, use a stored field. -->
797       <str name="fmap.content">text</str>
798       <str name="lowernames">true</str>
799       <str name="uprefix">ignored_</str>
800
801       <!-- capture link hrefs but ignore div attributes -->
802       <str name="captureAttr">true</str>
803       <str name="fmap.a">links</str>
804       <str name="fmap.div">ignored_</str>
805     </lst>
806   </requestHandler>
807
808
809   <!-- A component to return terms and document frequency of those terms.
810        This component does not yet support distributed search. -->
811   <searchComponent name="termsComponent" class="org.apache.solr.handler.component.TermsComponent"/>
812
813   <requestHandler name="/terms" class="org.apache.solr.handler.component.SearchHandler">
814      <lst name="defaults">
815       <bool name="terms">true</bool>
816     </lst>     
817     <arr name="components">
818       <str>termsComponent</str>
819     </arr>
820   </requestHandler>
821
822
823   <!-- a search component that enables you to configure the top results for
824        a given query regardless of the normal lucene scoring.-->
825   <searchComponent name="elevator" class="solr.QueryElevationComponent" >
826     <!-- pick a fieldType to analyze queries -->
827     <str name="queryFieldType">string</str>
828     <str name="config-file">elevate.xml</str>
829   </searchComponent>
830
831   <!-- a request handler utilizing the elevator component -->
832   <requestHandler name="/elevate" class="solr.SearchHandler" startup="lazy">
833     <lst name="defaults">
834       <str name="echoParams">explicit</str>
835     </lst>
836     <arr name="last-components">
837       <str>elevator</str>
838     </arr>
839   </requestHandler>
840
841
842   <!-- Update request handler.  
843
844        Note: Since solr1.1 requestHandlers requires a valid content type header if posted in
845        the body. For example, curl now requires: -H 'Content-type:text/xml; charset=utf-8'
846        The response format differs from solr1.1 formatting and returns a standard error code.
847        To enable solr1.1 behavior, remove the /update handler or change its path
848     -->
849   <requestHandler name="/update" class="solr.XmlUpdateRequestHandler" />
850
851
852   <requestHandler name="/update/javabin" class="solr.BinaryUpdateRequestHandler" />
853
854   <!--
855    Analysis request handler.  Since Solr 1.3.  Use to return how a document is analyzed.  Useful
856    for debugging and as a token server for other types of applications.
857
858    This is deprecated in favor of the improved DocumentAnalysisRequestHandler and FieldAnalysisRequestHandler
859
860    <requestHandler name="/analysis" class="solr.AnalysisRequestHandler" />
861    -->
862
863   <!--
864     An analysis handler that provides a breakdown of the analysis process of provided docuemnts. This handler expects a
865     (single) content stream with the following format:
866
867     <docs>
868       <doc>
869         <field name="id">1</field>
870         <field name="name">The Name</field>
871         <field name="text">The Text Value</field>
872       <doc>
873       <doc>...</doc>
874       <doc>...</doc>
875       ...
876     </docs>
877
878     Note: Each document must contain a field which serves as the unique key. This key is used in the returned
879     response to assoicate an analysis breakdown to the analyzed document.
880
881     Like the FieldAnalysisRequestHandler, this handler also supports query analysis by
882     sending either an "analysis.query" or "q" request paraemter that holds the query text to be analyized. It also
883     supports the "analysis.showmatch" parameter which when set to true, all field tokens that match the query
884     tokens will be marked as a "match".
885   -->
886   <requestHandler name="/analysis/document" class="solr.DocumentAnalysisRequestHandler" />
887
888   <!--
889     RequestHandler that provides much the same functionality as analysis.jsp. Provides the ability
890     to specify multiple field types and field names in the same request and outputs index-time and
891     query-time analysis for each of them.
892
893     Request parameters are:
894     analysis.fieldname - The field name whose analyzers are to be used
895     analysis.fieldtype - The field type whose analyzers are to be used
896     analysis.fieldvalue - The text for index-time analysis
897     q (or analysis.q) - The text for query time analysis
898     analysis.showmatch (true|false) - When set to true and when query analysis is performed, the produced
899                                       tokens of the field value analysis will be marked as "matched" for every
900                                       token that is produces by the query analysis
901    -->
902   <requestHandler name="/analysis/field" class="solr.FieldAnalysisRequestHandler" />
903
904
905   <!-- CSV update handler, loaded on demand -->
906   <requestHandler name="/update/csv" class="solr.CSVRequestHandler" startup="lazy" />
907
908
909   <!-- 
910    Admin Handlers - This will register all the standard admin RequestHandlers.  Adding 
911    this single handler is equivalent to registering:
912    
913   <requestHandler name="/admin/luke"       class="org.apache.solr.handler.admin.LukeRequestHandler" />
914   <requestHandler name="/admin/system"     class="org.apache.solr.handler.admin.SystemInfoHandler" />
915   <requestHandler name="/admin/plugins"    class="org.apache.solr.handler.admin.PluginInfoHandler" />
916   <requestHandler name="/admin/threads"    class="org.apache.solr.handler.admin.ThreadDumpHandler" />
917   <requestHandler name="/admin/properties" class="org.apache.solr.handler.admin.PropertiesRequestHandler" />
918   <requestHandler name="/admin/file"       class="org.apache.solr.handler.admin.ShowFileRequestHandler" >
919   
920   If you wish to hide files under ${solr.home}/conf, explicitly register the ShowFileRequestHandler using:
921   <requestHandler name="/admin/file" class="org.apache.solr.handler.admin.ShowFileRequestHandler" >
922     <lst name="invariants">
923      <str name="hidden">synonyms.txt</str> 
924      <str name="hidden">anotherfile.txt</str> 
925     </lst>
926   </requestHandler>
927   -->
928   <requestHandler name="/admin/" class="org.apache.solr.handler.admin.AdminHandlers" />
929
930   <!-- ping/healthcheck -->
931   <requestHandler name="/admin/ping" class="PingRequestHandler">
932     <lst name="defaults">
933       <str name="qt">standard</str>
934       <str name="q">solrpingquery</str>
935       <str name="echoParams">all</str>
936     </lst>
937   </requestHandler>
938
939   <!-- Echo the request contents back to the client -->
940   <requestHandler name="/debug/dump" class="solr.DumpRequestHandler" >
941     <lst name="defaults">
942      <str name="echoParams">explicit</str> <!-- for all params (including the default etc) use: 'all' -->
943      <str name="echoHandler">true</str>
944     </lst>
945   </requestHandler>
946
947   <highlighting>
948    <!-- Configure the standard fragmenter -->
949    <!-- This could most likely be commented out in the "default" case -->
950    <fragmenter name="gap" class="org.apache.solr.highlight.GapFragmenter" default="true">
951     <lst name="defaults">
952      <int name="hl.fragsize">100</int>
953     </lst>
954    </fragmenter>
955
956    <!-- A regular-expression-based fragmenter (f.i., for sentence extraction) -->
957    <fragmenter name="regex" class="org.apache.solr.highlight.RegexFragmenter">
958     <lst name="defaults">
959       <!-- slightly smaller fragsizes work better because of slop -->
960       <int name="hl.fragsize">70</int>
961       <!-- allow 50% slop on fragment sizes -->
962       <float name="hl.regex.slop">0.5</float>
963       <!-- a basic sentence pattern -->
964       <str name="hl.regex.pattern">[-\w ,/\n\"']{20,200}</str>
965     </lst>
966    </fragmenter>
967
968    <!-- Configure the standard formatter -->
969    <formatter name="html" class="org.apache.solr.highlight.HtmlFormatter" default="true">
970     <lst name="defaults">
971      <str name="hl.simple.pre"><![CDATA[<em>]]></str>
972      <str name="hl.simple.post"><![CDATA[</em>]]></str>
973     </lst>
974    </formatter>
975   </highlighting>
976
977   <!-- An example dedup update processor that creates the "id" field on the fly
978        based on the hash code of some other fields.  This example has overwriteDupes
979        set to false since we are using the id field as the signatureField and Solr
980        will maintain uniqueness based on that anyway. 
981        
982        You have to link the chain to an update handler above to use it ie:
983          <requestHandler name="/update "class="solr.XmlUpdateRequestHandler">
984            <lst name="defaults">
985              <str name="update.processor">dedupe</str>
986            </lst>
987          </requestHandler>  
988   -->
989   <!--
990   <updateRequestProcessorChain name="dedupe">
991     <processor class="org.apache.solr.update.processor.SignatureUpdateProcessorFactory">
992       <bool name="enabled">true</bool>
993       <str name="signatureField">id</str>
994       <bool name="overwriteDupes">false</bool>
995       <str name="fields">name,features,cat</str>
996       <str name="signatureClass">org.apache.solr.update.processor.Lookup3Signature</str>
997     </processor>
998     <processor class="solr.LogUpdateProcessorFactory" />
999     <processor class="solr.RunUpdateProcessorFactory" />
1000   </updateRequestProcessorChain>
1001   -->
1002
1003
1004   <!-- queryResponseWriter plugins... query responses will be written using the
1005     writer specified by the 'wt' request parameter matching the name of a registered
1006     writer.
1007     The "default" writer is the default and will be used if 'wt' is not specified 
1008     in the request. XMLResponseWriter will be used if nothing is specified here.
1009     The json, python, and ruby writers are also available by default.
1010
1011     <queryResponseWriter name="xml" class="org.apache.solr.request.XMLResponseWriter" default="true"/>
1012     <queryResponseWriter name="json" class="org.apache.solr.request.JSONResponseWriter"/>
1013     <queryResponseWriter name="python" class="org.apache.solr.request.PythonResponseWriter"/>
1014     <queryResponseWriter name="ruby" class="org.apache.solr.request.RubyResponseWriter"/>
1015     <queryResponseWriter name="php" class="org.apache.solr.request.PHPResponseWriter"/>
1016     <queryResponseWriter name="phps" class="org.apache.solr.request.PHPSerializedResponseWriter"/>
1017
1018     <queryResponseWriter name="custom" class="com.example.MyResponseWriter"/>
1019   -->
1020
1021   <!-- XSLT response writer transforms the XML output by any xslt file found
1022        in Solr's conf/xslt directory.  Changes to xslt files are checked for
1023        every xsltCacheLifetimeSeconds.  
1024    -->
1025   <queryResponseWriter name="xslt" class="org.apache.solr.request.XSLTResponseWriter">
1026     <int name="xsltCacheLifetimeSeconds">5</int>
1027   </queryResponseWriter>
1028
1029
1030   <!-- example of registering a query parser
1031   <queryParser name="lucene" class="org.apache.solr.search.LuceneQParserPlugin"/>
1032   -->
1033
1034   <!-- example of registering a custom function parser 
1035   <valueSourceParser name="myfunc" class="com.mycompany.MyValueSourceParser" />
1036   -->
1037
1038   <!-- config for the admin interface -->
1039   <admin>
1040     <defaultQuery>solr</defaultQuery>
1041
1042     <!-- configure a healthcheck file for servers behind a loadbalancer
1043     <healthcheck type="file">server-enabled</healthcheck>
1044     -->
1045   </admin>
1046
1047 </config>