doc/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 <!--
  20      For more details about configurations options that may appear in
  21      this file, see http://wiki.apache.org/solr/SolrConfigXml.
  22 -->
  23 <config>
  24   <!-- In all configuration below, a prefix of "solr." for class names
  25        is an alias that causes solr to search appropriate packages,
  26        including org.apache.solr.(search|update|request|core|analysis)
  27
  28        You may also specify a fully qualified Java classname if you
  29        have your own custom plugins.
  30     -->
  31
  32   <!-- Controls what version of Lucene various components of Solr
  33        adhere to.  Generally, you want to use the latest version to
  34        get all bug fixes and improvements. It is highly recommended
  35        that you fully re-index after changing this setting as it can
  36        affect both how text is indexed and queried.
  37   -->
  38   <luceneMatchVersion>LUCENE_40</luceneMatchVersion>
  39
  40   <!-- lib directives can be used to instruct Solr to load an Jars
  41        identified and use them to resolve any "plugins" specified in
  42        your solrconfig.xml or schema.xml (ie: Analyzers, Request
  43        Handlers, etc...).
  44
  45        All directories and paths are resolved relative to the
  46        instanceDir.
  47
  48        If a "./lib" directory exists in your instanceDir, all files
  49        found in it are included as if you had used the following
  50        syntax...
  51
  52               <lib dir="./lib" />
  53     -->
  54
  55   <!-- A 'dir' option by itself adds any files found in the directory
  56        to the classpath, this is useful for including all jars in a
  57        directory.
  58     -->
  59   <!--
  60      <lib dir="../add-everything-found-in-this-dir-to-the-classpath" />
  61   -->
  62
  63   <!-- When a 'regex' is specified in addition to a 'dir', only the
  64        files in that directory which completely match the regex
  65        (anchored on both ends) will be included.
  66     -->
  67   <lib dir="../../../dist/" regex="apache-solr-cell-\d.*\.jar" />
  68   <lib dir="../../../contrib/extraction/lib" regex=".*\.jar" />
  69
  70   <lib dir="../../../dist/" regex="apache-solr-clustering-\d.*\.jar" />
  71   <lib dir="../../../contrib/clustering/lib/" regex=".*\.jar" />
  72
  73   <lib dir="../../../dist/" regex="apache-solr-langid-\d.*\.jar" />
  74   <lib dir="../../../contrib/langid/lib/" regex=".*\.jar" />
  75
  76   <lib dir="../../../dist/" regex="apache-solr-velocity-\d.*\.jar" />
  77   <lib dir="../../../contrib/velocity/lib" regex=".*\.jar" />
  78
  79   <!-- If a 'dir' option (with or without a regex) is used and nothing
  80        is found that matches, it will be ignored
  81     -->
  82   <lib dir="/total/crap/dir/ignored" />
  83
  84   <!-- an exact 'path' can be used instead of a 'dir' to specify a
  85        specific file.  This will cause a serious error to be logged if
  86        it can't be loaded.
  87     -->
  88   <!--
  89      <lib path="../a-jar-that-does-not-exist.jar" />
  90   -->
  91
  92   <!-- Data Directory
  93
  94        Used to specify an alternate directory to hold all index data
  95        other than the default ./data under the Solr home.  If
  96        replication is in use, this should match the replication
  97        configuration.
  98     -->
  99   <dataDir>${solr.data.dir:}</dataDir>
 100
 101
 102   <!-- The DirectoryFactory to use for indexes.
 103
 104        solr.StandardDirectoryFactory is filesystem
 105        based and tries to pick the best implementation for the current
 106        JVM and platform.  solr.NRTCachingDirectoryFactory, the default,
 107        wraps solr.StandardDirectoryFactory and caches small files in memory
 108        for better NRT performance.
 109
 110        One can force a particular implementation via solr.MMapDirectoryFactory,
 111        solr.NIOFSDirectoryFactory, or solr.SimpleFSDirectoryFactory.
 112
 113        solr.RAMDirectoryFactory is memory based, not
 114        persistent, and doesn't work with replication.
 115     -->
 116   <directoryFactory name="DirectoryFactory"
 117                     class="${solr.directoryFactory:solr.NRTCachingDirectoryFactory}"/>
 118
 119   <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 120        Index Config - These settings control low-level behavior of indexing
 121        Most example settings here show the default value, but are commented
 122        out, to more easily see where customizations have been made.
 123
 124        Note: This replaces <indexDefaults> and <mainIndex> from older versions
 125        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
 126   <indexConfig>
 127     <!-- maxFieldLength was removed in 4.0. To get similar behavior, include a
 128          LimitTokenCountFilterFactory in your fieldType definition. E.g.
 129      <filter class="solr.LimitTokenCountFilterFactory" maxTokenCount="10000"/>
 130     -->
 131     <!-- Maximum time to wait for a write lock (ms) for an IndexWriter. Default: 1000 -->
 132     <!-- <writeLockTimeout>1000</writeLockTimeout>  -->
 133
 134     <!-- Expert: Enabling compound file will use less files for the index,
 135          using fewer file descriptors on the expense of performance decrease.
 136          Default in Lucene is "true". Default in Solr is "false" (since 3.6) -->
 137     <!-- <useCompoundFile>false</useCompoundFile> -->
 138
 139     <!-- ramBufferSizeMB sets the amount of RAM that may be used by Lucene
 140          indexing for buffering added documents and deletions before they are
 141          flushed to the Directory.
 142          maxBufferedDocs sets a limit on the number of documents buffered
 143          before flushing.
 144          If both ramBufferSizeMB and maxBufferedDocs is set, then
 145          Lucene will flush based on whichever limit is hit first.  -->
 146     <!-- <ramBufferSizeMB>32</ramBufferSizeMB> -->
 147     <!-- <maxBufferedDocs>1000</maxBufferedDocs> -->
 148
 149     <!-- Expert: Merge Policy
 150          The Merge Policy in Lucene controls how merging of segments is done.
 151          The default since Solr/Lucene 3.3 is TieredMergePolicy.
 152          The default since Lucene 2.3 was the LogByteSizeMergePolicy,
 153          Even older versions of Lucene used LogDocMergePolicy.
 154       -->
 155     <!--
 156         <mergePolicy class="org.apache.lucene.index.TieredMergePolicy">
 157           <int name="maxMergeAtOnce">10</int>
 158           <int name="segmentsPerTier">10</int>
 159         </mergePolicy>
 160       -->
 161
 162     <!-- Merge Factor
 163          The merge factor controls how many segments will get merged at a time.
 164          For TieredMergePolicy, mergeFactor is a convenience parameter which
 165          will set both MaxMergeAtOnce and SegmentsPerTier at once.
 166          For LogByteSizeMergePolicy, mergeFactor decides how many new segments
 167          will be allowed before they are merged into one.
 168          Default is 10 for both merge policies.
 169       -->
 170     <!--
 171     <mergeFactor>10</mergeFactor>
 172       -->
 173
 174     <!-- Expert: Merge Scheduler
 175          The Merge Scheduler in Lucene controls how merges are
 176          performed.  The ConcurrentMergeScheduler (Lucene 2.3 default)
 177          can perform merges in the background using separate threads.
 178          The SerialMergeScheduler (Lucene 2.2 default) does not.
 179      -->
 180     <!--
 181        <mergeScheduler class="org.apache.lucene.index.ConcurrentMergeScheduler"/>
 182        -->
 183
 184     <!-- LockFactory
 185
 186          This option specifies which Lucene LockFactory implementation
 187          to use.
 188
 189          single = SingleInstanceLockFactory - suggested for a
 190                   read-only index or when there is no possibility of
 191                   another process trying to modify the index.
 192          native = NativeFSLockFactory - uses OS native file locking.
 193                   Do not use when multiple solr webapps in the same
 194                   JVM are attempting to share a single index.
 195          simple = SimpleFSLockFactory  - uses a plain file for locking
 196
 197          Defaults: 'native' is default for Solr3.6 and later, otherwise
 198                    'simple' is the default
 199
 200          More details on the nuances of each LockFactory...
 201          http://wiki.apache.org/lucene-java/AvailableLockFactories
 202     -->
 203     <!-- <lockType>native</lockType> -->
 204
 205     <!-- Unlock On Startup
 206
 207          If true, unlock any held write or commit locks on startup.
 208          This defeats the locking mechanism that allows multiple
 209          processes to safely access a lucene index, and should be used
 210          with care. Default is "false".
 211
 212          This is not needed if lock type is 'none' or 'single'
 213      -->
 214     <!--
 215     <unlockOnStartup>false</unlockOnStartup>
 216       -->
 217
 218     <!-- Expert: Controls how often Lucene loads terms into memory
 219          Default is 128 and is likely good for most everyone.
 220       -->
 221     <!-- <termIndexInterval>128</termIndexInterval> -->
 222
 223     <!-- If true, IndexReaders will be reopened (often more efficient)
 224          instead of closed and then opened. Default: true
 225       -->
 226     <!--
 227     <reopenReaders>true</reopenReaders>
 228       -->
 229
 230     <!-- Commit Deletion Policy
 231
 232          Custom deletion policies can be specified here. The class must
 233          implement org.apache.lucene.index.IndexDeletionPolicy.
 234
 235          http://lucene.apache.org/java/3_5_0/api/core/org/apache/lucene/index/IndexDeletionPolicy.html
 236
 237          The default Solr IndexDeletionPolicy implementation supports
 238          deleting index commit points on number of commits, age of
 239          commit point and optimized status.
 240
 241          The latest commit point should always be preserved regardless
 242          of the criteria.
 243     -->
 244     <!--
 245     <deletionPolicy class="solr.SolrDeletionPolicy">
 246     -->
 247       <!-- The number of commit points to be kept -->
 248       <!-- <str name="maxCommitsToKeep">1</str> -->
 249       <!-- The number of optimized commit points to be kept -->
 250       <!-- <str name="maxOptimizedCommitsToKeep">0</str> -->
 251       <!--
 252           Delete all commit points once they have reached the given age.
 253           Supports DateMathParser syntax e.g.
 254         -->
 255       <!--
 256          <str name="maxCommitAge">30MINUTES</str>
 257          <str name="maxCommitAge">1DAY</str>
 258       -->
 259     <!--
 260     </deletionPolicy>
 261     -->
 262
 263     <!-- Lucene Infostream
 264
 265          To aid in advanced debugging, Lucene provides an "InfoStream"
 266          of detailed information when indexing.
 267
 268          Setting The value to true will instruct the underlying Lucene
 269          IndexWriter to write its debugging info the specified file
 270       -->
 271      <!-- <infoStream file="INFOSTREAM.txt">false</infoStream> -->
 272   </indexConfig>
 273
 274
 275   <!-- JMX
 276
 277        This example enables JMX if and only if an existing MBeanServer
 278        is found, use this if you want to configure JMX through JVM
 279        parameters. Remove this to disable exposing Solr configuration
 280        and statistics to JMX.
 281
 282        For more details see http://wiki.apache.org/solr/SolrJmx
 283     -->
 284   <jmx />
 285   <!-- If you want to connect to a particular server, specify the
 286        agentId
 287     -->
 288   <!-- <jmx agentId="myAgent" /> -->
 289   <!-- If you want to start a new MBeanServer, specify the serviceUrl -->
 290   <!-- <jmx serviceUrl="service:jmx:rmi:///jndi/rmi://localhost:9999/solr"/>
 291     -->
 292
 293   <!-- The default high-performance update handler -->
 294   <updateHandler class="solr.DirectUpdateHandler2">
 295
 296     <!-- AutoCommit
 297
 298          Perform a hard commit automatically under certain conditions.
 299          Instead of enabling autoCommit, consider using "commitWithin"
 300          when adding documents.
 301
 302          http://wiki.apache.org/solr/UpdateXmlMessages
 303
 304          maxDocs - Maximum number of documents to add since the last
 305                    commit before automatically triggering a new commit.
 306
 307          maxTime - Maximum amount of time in ms that is allowed to pass
 308                    since a document was added before automaticly
 309                    triggering a new commit.
 310          openSearcher - if false, the commit causes recent index changes
 311          to be flushed to stable storage, but does not cause a new
 312          searcher to be opened to make those changes visible.
 313       -->
 314      <autoCommit>
 315        <maxTime>15000</maxTime>
 316        <openSearcher>false</openSearcher>
 317      </autoCommit>
 318
 319     <!-- softAutoCommit is like autoCommit except it causes a
 320          'soft' commit which only ensures that changes are visible
 321          but does not ensure that data is synced to disk.  This is
 322          faster and more near-realtime friendly than a hard commit.
 323       -->
 324      <!--
 325        <autoSoftCommit>
 326          <maxTime>1000</maxTime>
 327        </autoSoftCommit>
 328       -->
 329
 330     <!-- Update Related Event Listeners
 331
 332          Various IndexWriter related events can trigger Listeners to
 333          take actions.
 334
 335          postCommit - fired after every commit or optimize command
 336          postOptimize - fired after every optimize command
 337       -->
 338     <!-- The RunExecutableListener executes an external command from a
 339          hook such as postCommit or postOptimize.
 340
 341          exe - the name of the executable to run
 342          dir - dir to use as the current working directory. (default=".")
 343          wait - the calling thread waits until the executable returns.
 344                 (default="true")
 345          args - the arguments to pass to the program.  (default is none)
 346          env - environment variables to set.  (default is none)
 347       -->
 348     <!-- This example shows how RunExecutableListener could be used
 349          with the script based replication...
 350          http://wiki.apache.org/solr/CollectionDistribution
 351       -->
 352     <!--
 353        <listener event="postCommit" class="solr.RunExecutableListener">
 354          <str name="exe">solr/bin/snapshooter</str>
 355          <str name="dir">.</str>
 356          <bool name="wait">true</bool>
 357          <arr name="args"> <str>arg1</str> <str>arg2</str> </arr>
 358          <arr name="env"> <str>MYVAR=val1</str> </arr>
 359        </listener>
 360       -->
 361
 362     <!-- Enables a transaction log, currently used for real-time get.
 363          "dir" - the target directory for transaction logs, defaults to the
 364             solr data directory.  -->
 365     <updateLog>
 366       <str name="dir">${solr.data.dir:}</str>
 367     </updateLog>
 368
 369
 370   </updateHandler>
 371
 372   <!-- IndexReaderFactory
 373
 374        Use the following format to specify a custom IndexReaderFactory,
 375        which allows for alternate IndexReader implementations.
 376
 377        ** Experimental Feature **
 378
 379        Please note - Using a custom IndexReaderFactory may prevent
 380        certain other features from working. The API to
 381        IndexReaderFactory may change without warning or may even be
 382        removed from future releases if the problems cannot be
 383        resolved.
 384
 385
 386        ** Features that may not work with custom IndexReaderFactory **
 387
 388        The ReplicationHandler assumes a disk-resident index. Using a
 389        custom IndexReader implementation may cause incompatibility
 390        with ReplicationHandler and may cause replication to not work
 391        correctly. See SOLR-1366 for details.
 392
 393     -->
 394   <!--
 395   <indexReaderFactory name="IndexReaderFactory" class="package.class">
 396     <str name="someArg">Some Value</str>
 397   </indexReaderFactory >
 398   -->
 399   <!-- By explicitly declaring the Factory, the termIndexDivisor can
 400        be specified.
 401     -->
 402   <!--
 403      <indexReaderFactory name="IndexReaderFactory"
 404                          class="solr.StandardIndexReaderFactory">
 405        <int name="setTermIndexDivisor">12</int>
 406      </indexReaderFactory >
 407     -->
 408
 409   <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 410        Query section - these settings control query time things like caches
 411        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
 412   <query>
 413     <!-- Max Boolean Clauses
 414
 415          Maximum number of clauses in each BooleanQuery,  an exception
 416          is thrown if exceeded.
 417
 418          ** WARNING **
 419
 420          This option actually modifies a global Lucene property that
 421          will affect all SolrCores.  If multiple solrconfig.xml files
 422          disagree on this property, the value at any given moment will
 423          be based on the last SolrCore to be initialized.
 424
 425       -->
 426     <maxBooleanClauses>1024</maxBooleanClauses>
 427
 428
 429     <!-- Solr Internal Query Caches
 430
 431          There are two implementations of cache available for Solr,
 432          LRUCache, based on a synchronized LinkedHashMap, and
 433          FastLRUCache, based on a ConcurrentHashMap.
 434
 435          FastLRUCache has faster gets and slower puts in single
 436          threaded operation and thus is generally faster than LRUCache
 437          when the hit ratio of the cache is high (> 75%), and may be
 438          faster under other scenarios on multi-cpu systems.
 439     -->
 440
 441     <!-- Filter Cache
 442
 443          Cache used by SolrIndexSearcher for filters (DocSets),
 444          unordered sets of *all* documents that match a query.  When a
 445          new searcher is opened, its caches may be prepopulated or
 446          "autowarmed" using data from caches in the old searcher.
 447          autowarmCount is the number of items to prepopulate.  For
 448          LRUCache, the autowarmed items will be the most recently
 449          accessed items.
 450
 451          Parameters:
 452            class - the SolrCache implementation LRUCache or
 453                (LRUCache or FastLRUCache)
 454            size - the maximum number of entries in the cache
 455            initialSize - the initial capacity (number of entries) of
 456                the cache.  (see java.util.HashMap)
 457            autowarmCount - the number of entries to prepopulate from
 458                and old cache.
 459       -->
 460     <filterCache class="solr.FastLRUCache"
 461                  size="512"
 462                  initialSize="512"
 463                  autowarmCount="0"/>
 464
 465     <!-- Query Result Cache
 466
 467          Caches results of searches - ordered lists of document ids
 468          (DocList) based on a query, a sort, and the range of documents requested.
 469       -->
 470     <queryResultCache class="solr.LRUCache"
 471                      size="512"
 472                      initialSize="512"
 473                      autowarmCount="0"/>
 474
 475     <!-- Document Cache
 476
 477          Caches Lucene Document objects (the stored fields for each
 478          document).  Since Lucene internal document ids are transient,
 479          this cache will not be autowarmed.
 480       -->
 481     <documentCache class="solr.LRUCache"
 482                    size="512"
 483                    initialSize="512"
 484                    autowarmCount="0"/>
 485
 486     <!-- Field Value Cache
 487
 488          Cache used to hold field values that are quickly accessible
 489          by document id.  The fieldValueCache is created by default
 490          even if not configured here.
 491       -->
 492     <!--
 493        <fieldValueCache class="solr.FastLRUCache"
 494                         size="512"
 495                         autowarmCount="128"
 496                         showItems="32" />
 497       -->
 498
 499     <!-- Custom Cache
 500
 501          Example of a generic cache.  These caches may be accessed by
 502          name through SolrIndexSearcher.getCache(),cacheLookup(), and
 503          cacheInsert().  The purpose is to enable easy caching of
 504          user/application level data.  The regenerator argument should
 505          be specified as an implementation of solr.CacheRegenerator
 506          if autowarming is desired.
 507       -->
 508     <!--
 509        <cache name="myUserCache"
 510               class="solr.LRUCache"
 511               size="4096"
 512               initialSize="1024"
 513               autowarmCount="1024"
 514               regenerator="com.mycompany.MyRegenerator"
 515               />
 516       -->
 517
 518
 519     <!-- Lazy Field Loading
 520
 521          If true, stored fields that are not requested will be loaded
 522          lazily.  This can result in a significant speed improvement
 523          if the usual case is to not load all stored fields,
 524          especially if the skipped fields are large compressed text
 525          fields.
 526     -->
 527     <enableLazyFieldLoading>true</enableLazyFieldLoading>
 528
 529    <!-- Use Filter For Sorted Query
 530
 531         A possible optimization that attempts to use a filter to
 532         satisfy a search.  If the requested sort does not include
 533         score, then the filterCache will be checked for a filter
 534         matching the query. If found, the filter will be used as the
 535         source of document ids, and then the sort will be applied to
 536         that.
 537
 538         For most situations, this will not be useful unless you
 539         frequently get the same search repeatedly with different sort
 540         options, and none of them ever use "score"
 541      -->
 542    <!--
 543       <useFilterForSortedQuery>true</useFilterForSortedQuery>
 544      -->
 545
 546    <!-- Result Window Size
 547
 548         An optimization for use with the queryResultCache.  When a search
 549         is requested, a superset of the requested number of document ids
 550         are collected.  For example, if a search for a particular query
 551         requests matching documents 10 through 19, and queryWindowSize is 50,
 552         then documents 0 through 49 will be collected and cached.  Any further
 553         requests in that range can be satisfied via the cache.
 554      -->
 555    <queryResultWindowSize>20</queryResultWindowSize>
 556
 557    <!-- Maximum number of documents to cache for any entry in the
 558         queryResultCache.
 559      -->
 560    <queryResultMaxDocsCached>200</queryResultMaxDocsCached>
 561
 562    <!-- Query Related Event Listeners
 563
 564         Various IndexSearcher related events can trigger Listeners to
 565         take actions.
 566
 567         newSearcher - fired whenever a new searcher is being prepared
 568         and there is a current searcher handling requests (aka
 569         registered).  It can be used to prime certain caches to
 570         prevent long request times for certain requests.
 571
 572         firstSearcher - fired whenever a new searcher is being
 573         prepared but there is no current registered searcher to handle
 574         requests or to gain autowarming data from.
 575
 576
 577      -->
 578     <!-- QuerySenderListener takes an array of NamedList and executes a
 579          local query request for each NamedList in sequence.
 580       -->
 581     <listener event="newSearcher" class="solr.QuerySenderListener">
 582       <arr name="queries">
 583         <!--
 584            <lst><str name="q">solr</str><str name="sort">price asc</str></lst>
 585            <lst><str name="q">rocks</str><str name="sort">weight asc</str></lst>
 586           -->
 587       </arr>
 588     </listener>
 589     <listener event="firstSearcher" class="solr.QuerySenderListener">
 590       <arr name="queries">
 591         <lst>
 592           <str name="q">static firstSearcher warming in solrconfig.xml</str>
 593         </lst>
 594       </arr>
 595     </listener>
 596
 597     <!-- Use Cold Searcher
 598
 599          If a search request comes in and there is no current
 600          registered searcher, then immediately register the still
 601          warming searcher and use it.  If "false" then all requests
 602          will block until the first searcher is done warming.
 603       -->
 604     <useColdSearcher>false</useColdSearcher>
 605
 606     <!-- Max Warming Searchers
 607
 608          Maximum number of searchers that may be warming in the
 609          background concurrently.  An error is returned if this limit
 610          is exceeded.
 611
 612          Recommend values of 1-2 for read-only slaves, higher for
 613          masters w/o cache warming.
 614       -->
 615     <maxWarmingSearchers>2</maxWarmingSearchers>
 616
 617   </query>
 618
 619
 620   <!-- Request Dispatcher
 621
 622        This section contains instructions for how the SolrDispatchFilter
 623        should behave when processing requests for this SolrCore.
 624
 625        handleSelect is a legacy option that affects the behavior of requests
 626        such as /select?qt=XXX
 627
 628        handleSelect="true" will cause the SolrDispatchFilter to process
 629        the request and dispatch the query to a handler specified by the
 630        "qt" param, assuming "/select" isn't already registered.
 631
 632        handleSelect="false" will cause the SolrDispatchFilter to
 633        ignore "/select" requests, resulting in a 404 unless a handler
 634        is explicitly registered with the name "/select"
 635
 636        handleSelect="true" is not recommended for new users, but is the default
 637        for backwards compatibility
 638     -->
 639   <requestDispatcher handleSelect="false" >
 640     <!-- Request Parsing
 641
 642          These settings indicate how Solr Requests may be parsed, and
 643          what restrictions may be placed on the ContentStreams from
 644          those requests
 645
 646          enableRemoteStreaming - enables use of the stream.file
 647          and stream.url parameters for specifying remote streams.
 648
 649          multipartUploadLimitInKB - specifies the max size of
 650          Multipart File Uploads that Solr will allow in a Request.
 651
 652          *** WARNING ***
 653          The settings below authorize Solr to fetch remote files, You
 654          should make sure your system has some authentication before
 655          using enableRemoteStreaming="true"
 656
 657       -->
 658     <requestParsers enableRemoteStreaming="true"
 659                     multipartUploadLimitInKB="2048000" />
 660
 661     <!-- HTTP Caching
 662
 663          Set HTTP caching related parameters (for proxy caches and clients).
 664
 665          The options below instruct Solr not to output any HTTP Caching
 666          related headers
 667       -->
 668     <httpCaching never304="true" />
 669     <!-- If you include a <cacheControl> directive, it will be used to
 670          generate a Cache-Control header (as well as an Expires header
 671          if the value contains "max-age=")
 672
 673          By default, no Cache-Control header is generated.
 674
 675          You can use the <cacheControl> option even if you have set
 676          never304="true"
 677       -->
 678     <!--
 679        <httpCaching never304="true" >
 680          <cacheControl>max-age=30, public</cacheControl>
 681        </httpCaching>
 682       -->
 683     <!-- To enable Solr to respond with automatically generated HTTP
 684          Caching headers, and to response to Cache Validation requests
 685          correctly, set the value of never304="false"
 686
 687          This will cause Solr to generate Last-Modified and ETag
 688          headers based on the properties of the Index.
 689
 690          The following options can also be specified to affect the
 691          values of these headers...
 692
 693          lastModFrom - the default value is "openTime" which means the
 694          Last-Modified value (and validation against If-Modified-Since
 695          requests) will all be relative to when the current Searcher
 696          was opened.  You can change it to lastModFrom="dirLastMod" if
 697          you want the value to exactly correspond to when the physical
 698          index was last modified.
 699
 700          etagSeed="..." is an option you can change to force the ETag
 701          header (and validation against If-None-Match requests) to be
 702          different even if the index has not changed (ie: when making
 703          significant changes to your config file)
 704
 705          (lastModifiedFrom and etagSeed are both ignored if you use
 706          the never304="true" option)
 707       -->
 708     <!--
 709        <httpCaching lastModifiedFrom="openTime"
 710                     etagSeed="Solr">
 711          <cacheControl>max-age=30, public</cacheControl>
 712        </httpCaching>
 713       -->
 714   </requestDispatcher>
 715
 716   <!-- Request Handlers
 717
 718        http://wiki.apache.org/solr/SolrRequestHandler
 719
 720        Incoming queries will be dispatched to a specific handler by name
 721        based on the path specified in the request.
 722
 723        Legacy behavior: If the request path uses "/select" but no Request
 724        Handler has that name, and if handleSelect="true" has been specified in
 725        the requestDispatcher, then the Request Handler is dispatched based on
 726        the qt parameter.  Handlers without a leading '/' are accessed this way
 727        like so: http://host/app/[core/]select?qt=name  If no qt is
 728        given, then the requestHandler that declares default="true" will be
 729        used or the one named "standard".
 730
 731        If a Request Handler is declared with startup="lazy", then it will
 732        not be initialized until the first request that uses it.
 733
 734     -->
 735   <!-- SearchHandler
 736
 737        http://wiki.apache.org/solr/SearchHandler
 738
 739        For processing Search Queries, the primary Request Handler
 740        provided with Solr is "SearchHandler" It delegates to a sequent
 741        of SearchComponents (see below) and supports distributed
 742        queries across multiple shards
 743     -->
 744   <requestHandler name="/select" class="solr.SearchHandler">
 745     <!-- default values for query parameters can be specified, these
 746          will be overridden by parameters in the request
 747       -->
 748      <lst name="defaults">
 749        <str name="echoParams">explicit</str>
 750        <int name="rows">50</int>
 751        <str name="df">text</str>
 752       <bool name="tv">true</bool>
 753      </lst>
 754     <!-- In addition to defaults, "appends" params can be specified
 755          to identify values which should be appended to the list of
 756          multi-val params from the query (or the existing "defaults").
 757       -->
 758     <!-- In this example, the param "fq=instock:true" would be appended to
 759          any query time fq params the user may specify, as a mechanism for
 760          partitioning the index, independent of any user selected filtering
 761          that may also be desired (perhaps as a result of faceted searching).
 762
 763          NOTE: there is *absolutely* nothing a client can do to prevent these
 764          "appends" values from being used, so don't use this mechanism
 765          unless you are sure you always want it.
 766       -->
 767     <!--
 768        <lst name="appends">
 769          <str name="fq">inStock:true</str>
 770        </lst>
 771       -->
 772     <!-- "invariants" are a way of letting the Solr maintainer lock down
 773          the options available to Solr clients.  Any params values
 774          specified here are used regardless of what values may be specified
 775          in either the query, the "defaults", or the "appends" params.
 776
 777          In this example, the facet.field and facet.query params would
 778          be fixed, limiting the facets clients can use.  Faceting is
 779          not turned on by default - but if the client does specify
 780          facet=true in the request, these are the only facets they
 781          will be able to see counts for; regardless of what other
 782          facet.field or facet.query params they may specify.
 783
 784          NOTE: there is *absolutely* nothing a client can do to prevent these
 785          "invariants" values from being used, so don't use this mechanism
 786          unless you are sure you always want it.
 787       -->
 788     <!--
 789        <lst name="invariants">
 790          <str name="facet.field">cat</str>
 791          <str name="facet.field">manu_exact</str>
 792          <str name="facet.query">price:[* TO 500]</str>
 793          <str name="facet.query">price:[500 TO *]</str>
 794        </lst>
 795       -->
 796     <!-- If the default list of SearchComponents is not desired, that
 797          list can either be overridden completely, or components can be
 798          prepended or appended to the default list.  (see below)
 799       -->
 800     <!--
 801        <arr name="components">
 802          <str>nameOfCustomComponent1</str>
 803          <str>nameOfCustomComponent2</str>
 804        </arr>
 805       -->
 806     <arr name="last-components">
 807       <str>tvComponent</str>
 808     </arr>
 809     </requestHandler>
 810
 811   <!-- A request handler that returns indented JSON by default -->
 812   <requestHandler name="/query" class="solr.SearchHandler">
 813      <lst name="defaults">
 814        <str name="echoParams">explicit</str>
 815        <str name="wt">json</str>
 816        <str name="indent">true</str>
 817        <str name="df">text</str>
 818      </lst>
 819   </requestHandler>
 820
 821
 822   <!-- realtime get handler, guaranteed to return the latest stored fields of
 823        any document, without the need to commit or open a new searcher.  The
 824        current implementation relies on the updateLog feature being enabled. -->
 825   <requestHandler name="/get" class="solr.RealTimeGetHandler">
 826      <lst name="defaults">
 827        <str name="omitHeader">true</str>
 828        <str name="wt">json</str>
 829        <str name="indent">true</str>
 830      </lst>
 831   </requestHandler>
 832
 833
 834   <!-- A Robust Example
 835
 836        This example SearchHandler declaration shows off usage of the
 837        SearchHandler with many defaults declared
 838
 839        Note that multiple instances of the same Request Handler
 840        (SearchHandler) can be registered multiple times with different
 841        names (and different init parameters)
 842     -->
 843   <requestHandler name="/browse" class="solr.SearchHandler">
 844      <lst name="defaults">
 845        <str name="echoParams">explicit</str>
 846
 847        <!-- VelocityResponseWriter settings -->
 848        <str name="wt">velocity</str>
 849        <str name="v.template">browse</str>
 850        <str name="v.layout">layout</str>
 851        <str name="title">Solritas</str>
 852
 853        <!-- Query settings -->
 854        <str name="defType">edismax</str>
 855        <str name="qf">
 856           text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0 manu^1.1 cat^1.4
 857           title^10.0 description^5.0 keywords^5.0 author^2.0 resourcename^1.0
 858        </str>
 859        <str name="df">text</str>
 860        <str name="mm">100%</str>
 861        <str name="q.alt">*:*</str>
 862        <str name="rows">10</str>
 863        <str name="fl">*,score</str>
 864
 865        <str name="mlt.qf">
 866          text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0 manu^1.1 cat^1.4
 867          title^10.0 description^5.0 keywords^5.0 author^2.0 resourcename^1.0
 868        </str>
 869        <str name="mlt.fl">text,features,name,sku,id,manu,cat,title,description,keywords,author,resourcename</str>
 870        <int name="mlt.count">3</int>
 871
 872        <!-- Faceting defaults -->
 873        <str name="facet">on</str>
 874        <str name="facet.field">cat</str>
 875        <str name="facet.field">manu_exact</str>
 876        <str name="facet.field">content_type</str>
 877        <str name="facet.field">author_s</str>
 878        <str name="facet.query">ipod</str>
 879        <str name="facet.query">GB</str>
 880        <str name="facet.mincount">1</str>
 881        <str name="facet.pivot">cat,inStock</str>
 882        <str name="facet.range.other">after</str>
 883        <str name="facet.range">price</str>
 884        <int name="f.price.facet.range.start">0</int>
 885        <int name="f.price.facet.range.end">600</int>
 886        <int name="f.price.facet.range.gap">50</int>
 887        <str name="facet.range">popularity</str>
 888        <int name="f.popularity.facet.range.start">0</int>
 889        <int name="f.popularity.facet.range.end">10</int>
 890        <int name="f.popularity.facet.range.gap">3</int>
 891        <str name="facet.range">manufacturedate_dt</str>
 892        <str name="f.manufacturedate_dt.facet.range.start">NOW/YEAR-10YEARS</str>
 893        <str name="f.manufacturedate_dt.facet.range.end">NOW</str>
 894        <str name="f.manufacturedate_dt.facet.range.gap">+1YEAR</str>
 895        <str name="f.manufacturedate_dt.facet.range.other">before</str>
 896        <str name="f.manufacturedate_dt.facet.range.other">after</str>
 897
 898        <!-- Highlighting defaults -->
 899        <str name="hl">on</str>
 900        <str name="hl.fl">content features title name</str>
 901        <str name="hl.encoder">html</str>
 902        <str name="hl.simple.pre">&lt;b&gt;</str>
 903        <str name="hl.simple.post">&lt;/b&gt;</str>
 904        <str name="f.title.hl.fragsize">0</str>
 905        <str name="f.title.hl.alternateField">title</str>
 906        <str name="f.name.hl.fragsize">0</str>
 907        <str name="f.name.hl.alternateField">name</str>
 908        <str name="f.content.hl.snippets">3</str>
 909        <str name="f.content.hl.fragsize">200</str>
 910        <str name="f.content.hl.alternateField">content</str>
 911        <str name="f.content.hl.maxAlternateFieldLength">750</str>
 912
 913        <!-- Spell checking defaults -->
 914        <str name="spellcheck">on</str>
 915        <str name="spellcheck.extendedResults">false</str>
 916        <str name="spellcheck.count">5</str>
 917        <str name="spellcheck.alternativeTermCount">2</str>
 918        <str name="spellcheck.maxResultsForSuggest">5</str>
 919        <str name="spellcheck.collate">true</str>
 920        <str name="spellcheck.collateExtendedResults">true</str>
 921        <str name="spellcheck.maxCollationTries">5</str>
 922        <str name="spellcheck.maxCollations">3</str>
 923      </lst>
 924
 925      <!-- append spellchecking to our list of components -->
 926      <arr name="last-components">
 927        <str>spellcheck</str>
 928      </arr>
 929   </requestHandler>
 930
 931
 932   <!-- Update Request Handler.
 933
 934        http://wiki.apache.org/solr/UpdateXmlMessages
 935
 936        The canonical Request Handler for Modifying the Index through
 937        commands specified using XML, JSON, CSV, or JAVABIN
 938
 939        Note: Since solr1.1 requestHandlers requires a valid content
 940        type header if posted in the body. For example, curl now
 941        requires: -H 'Content-type:text/xml; charset=utf-8'
 942
 943        To override the request content type and force a specific
 944        Content-type, use the request parameter:
 945          ?update.contentType=text/csv
 946
 947        This handler will pick a response format to match the input
 948        if the 'wt' parameter is not explicit
 949     -->
 950   <requestHandler name="/update" class="solr.UpdateRequestHandler">
 951     <!-- See below for information on defining
 952          updateRequestProcessorChains that can be used by name
 953          on each Update Request
 954       -->
 955     <!--
 956        <lst name="defaults">
 957          <str name="update.chain">dedupe</str>
 958        </lst>
 959        -->
 960   </requestHandler>
 961
 962
 963   <!-- Solr Cell Update Request Handler
 964
 965        http://wiki.apache.org/solr/ExtractingRequestHandler
 966
 967     -->
 968   <requestHandler name="/update/extract"
 969                   startup="lazy"
 970                   class="solr.extraction.ExtractingRequestHandler" >
 971     <lst name="defaults">
 972       <str name="lowernames">true</str>
 973       <str name="uprefix">ignored_</str>
 974
 975       <!-- capture link hrefs but ignore div attributes -->
 976       <str name="captureAttr">true</str>
 977       <str name="fmap.a">links</str>
 978       <str name="fmap.div">ignored_</str>
 979     </lst>
 980   </requestHandler>
 981
 982
 983   <!-- Field Analysis Request Handler
 984
 985        RequestHandler that provides much the same functionality as
 986        analysis.jsp. Provides the ability to specify multiple field
 987        types and field names in the same request and outputs
 988        index-time and query-time analysis for each of them.
 989
 990        Request parameters are:
 991        analysis.fieldname - field name whose analyzers are to be used
 992
 993        analysis.fieldtype - field type whose analyzers are to be used
 994        analysis.fieldvalue - text for index-time analysis
 995        q (or analysis.q) - text for query time analysis
 996        analysis.showmatch (true|false) - When set to true and when
 997            query analysis is performed, the produced tokens of the
 998            field value analysis will be marked as "matched" for every
 999            token that is produces by the query analysis
1000    -->
1001   <requestHandler name="/analysis/field"
1002                   startup="lazy"
1003                   class="solr.FieldAnalysisRequestHandler" />
1004
1005
1006   <!-- Document Analysis Handler
1007
1008        http://wiki.apache.org/solr/AnalysisRequestHandler
1009
1010        An analysis handler that provides a breakdown of the analysis
1011        process of provided documents. This handler expects a (single)
1012        content stream with the following format:
1013
1014        <docs>
1015          <doc>
1016            <field name="id">1</field>
1017            <field name="name">The Name</field>
1018            <field name="text">The Text Value</field>
1019          </doc>
1020          <doc>...</doc>
1021          <doc>...</doc>
1022          ...
1023        </docs>
1024
1025     Note: Each document must contain a field which serves as the
1026     unique key. This key is used in the returned response to associate
1027     an analysis breakdown to the analyzed document.
1028
1029     Like the FieldAnalysisRequestHandler, this handler also supports
1030     query analysis by sending either an "analysis.query" or "q"
1031     request parameter that holds the query text to be analyzed. It
1032     also supports the "analysis.showmatch" parameter which when set to
1033     true, all field tokens that match the query tokens will be marked
1034     as a "match".
1035   -->
1036   <requestHandler name="/analysis/document"
1037                   class="solr.DocumentAnalysisRequestHandler"
1038                   startup="lazy" />
1039
1040   <!-- Admin Handlers
1041
1042        Admin Handlers - This will register all the standard admin
1043        RequestHandlers.
1044     -->
1045   <requestHandler name="/admin/"
1046                   class="solr.admin.AdminHandlers" />
1047   <!-- This single handler is equivalent to the following... -->
1048   <!--
1049      <requestHandler name="/admin/luke"       class="solr.admin.LukeRequestHandler" />
1050      <requestHandler name="/admin/system"     class="solr.admin.SystemInfoHandler" />
1051      <requestHandler name="/admin/plugins"    class="solr.admin.PluginInfoHandler" />
1052      <requestHandler name="/admin/threads"    class="solr.admin.ThreadDumpHandler" />
1053      <requestHandler name="/admin/properties" class="solr.admin.PropertiesRequestHandler" />
1054      <requestHandler name="/admin/file"       class="solr.admin.ShowFileRequestHandler" >
1055     -->
1056   <!-- If you wish to hide files under ${solr.home}/conf, explicitly
1057        register the ShowFileRequestHandler using:
1058     -->
1059   <!--
1060      <requestHandler name="/admin/file"
1061                      class="solr.admin.ShowFileRequestHandler" >
1062        <lst name="invariants">
1063          <str name="hidden">synonyms.txt</str>
1064          <str name="hidden">anotherfile.txt</str>
1065        </lst>
1066      </requestHandler>
1067     -->
1068
1069   <!-- ping/healthcheck -->
1070   <requestHandler name="/admin/ping" class="solr.PingRequestHandler">
1071     <lst name="invariants">
1072       <str name="q">solrpingquery</str>
1073     </lst>
1074     <lst name="defaults">
1075       <str name="echoParams">all</str>
1076     </lst>
1077     <!-- An optional feature of the PingRequestHandler is to configure the
1078          handler with a "healthcheckFile" which can be used to enable/disable
1079          the PingRequestHandler.
1080          relative paths are resolved against the data dir
1081       -->
1082     <!-- <str name="healthcheckFile">server-enabled.txt</str> -->
1083   </requestHandler>
1084
1085   <!-- Echo the request contents back to the client -->
1086   <requestHandler name="/debug/dump" class="solr.DumpRequestHandler" >
1087     <lst name="defaults">
1088      <str name="echoParams">explicit</str>
1089      <str name="echoHandler">true</str>
1090     </lst>
1091   </requestHandler>
1092
1093   <!-- Solr Replication
1094
1095        The SolrReplicationHandler supports replicating indexes from a
1096        "master" used for indexing and "slaves" used for queries.
1097
1098        http://wiki.apache.org/solr/SolrReplication
1099
1100        In the example below, remove the <lst name="master"> section if
1101        this is just a slave and remove  the <lst name="slave"> section
1102        if this is just a master.
1103     -->
1104   <!--
1105      <requestHandler name="/replication" class="solr.ReplicationHandler" >
1106        <lst name="master">
1107          <str name="replicateAfter">commit</str>
1108          <str name="replicateAfter">startup</str>
1109          <str name="confFiles">schema.xml,stopwords.txt</str>
1110        </lst>
1111        <lst name="slave">
1112          <str name="masterUrl">http://localhost:8983/solr</str>
1113          <str name="pollInterval">00:00:60</str>
1114        </lst>
1115      </requestHandler>
1116     -->
1117
1118     <!-- Solr Replication for SolrCloud Recovery
1119
1120          This is the config need for SolrCloud's recovery replication.
1121     -->
1122         <requestHandler name="/replication" class="solr.ReplicationHandler" startup="lazy" />
1123
1124
1125   <!-- Search Components
1126
1127        Search components are registered to SolrCore and used by
1128        instances of SearchHandler (which can access them by name)
1129
1130        By default, the following components are available:
1131
1132        <searchComponent name="query"     class="solr.QueryComponent" />
1133        <searchComponent name="facet"     class="solr.FacetComponent" />
1134        <searchComponent name="mlt"       class="solr.MoreLikeThisComponent" />
1135        <searchComponent name="highlight" class="solr.HighlightComponent" />
1136        <searchComponent name="stats"     class="solr.StatsComponent" />
1137        <searchComponent name="debug"     class="solr.DebugComponent" />
1138
1139        Default configuration in a requestHandler would look like:
1140
1141        <arr name="components">
1142          <str>query</str>
1143          <str>facet</str>
1144          <str>mlt</str>
1145          <str>highlight</str>
1146          <str>stats</str>
1147          <str>debug</str>
1148        </arr>
1149
1150        If you register a searchComponent to one of the standard names,
1151        that will be used instead of the default.
1152
1153        To insert components before or after the 'standard' components, use:
1154
1155        <arr name="first-components">
1156          <str>myFirstComponentName</str>
1157        </arr>
1158
1159        <arr name="last-components">
1160          <str>myLastComponentName</str>
1161        </arr>
1162
1163        NOTE: The component registered with the name "debug" will
1164        always be executed after the "last-components"
1165
1166      -->
1167
1168    <!-- Spell Check
1169
1170         The spell check component can return a list of alternative spelling
1171         suggestions.
1172
1173         http://wiki.apache.org/solr/SpellCheckComponent
1174      -->
1175   <searchComponent name="spellcheck" class="solr.SpellCheckComponent">
1176
1177     <str name="queryAnalyzerFieldType">textSpell</str>
1178
1179     <!-- Multiple "Spell Checkers" can be declared and used by this
1180          component
1181       -->
1182
1183     <!-- a spellchecker built from a field of the main index -->
1184     <lst name="spellchecker">
1185       <str name="name">default</str>
1186       <str name="field">name</str>
1187       <str name="classname">solr.DirectSolrSpellChecker</str>
1188       <!-- the spellcheck distance measure used, the default is the internal levenshtein -->
1189       <str name="distanceMeasure">internal</str>
1190       <!-- minimum accuracy needed to be considered a valid spellcheck suggestion -->
1191       <float name="accuracy">0.5</float>
1192       <!-- the maximum #edits we consider when enumerating terms: can be 1 or 2 -->
1193       <int name="maxEdits">2</int>
1194       <!-- the minimum shared prefix when enumerating terms -->
1195       <int name="minPrefix">1</int>
1196       <!-- maximum number of inspections per result. -->
1197       <int name="maxInspections">5</int>
1198       <!-- minimum length of a query term to be considered for correction -->
1199       <int name="minQueryLength">4</int>
1200       <!-- maximum threshold of documents a query term can appear to be considered for correction -->
1201       <float name="maxQueryFrequency">0.01</float>
1202       <!-- uncomment this to require suggestions to occur in 1% of the documents
1203         <float name="thresholdTokenFrequency">.01</float>
1204       -->
1205     </lst>
1206
1207     <!-- a spellchecker that can break or combine words.  See "/spell" handler below for usage -->
1208     <lst name="spellchecker">
1209       <str name="name">wordbreak</str>
1210       <str name="classname">solr.WordBreakSolrSpellChecker</str>
1211       <str name="field">name</str>
1212       <str name="combineWords">true</str>
1213       <str name="breakWords">true</str>
1214       <int name="maxChanges">10</int>
1215     </lst>
1216
1217     <!-- a spellchecker that uses a different distance measure -->
1218     <!--
1219        <lst name="spellchecker">
1220          <str name="name">jarowinkler</str>
1221          <str name="field">spell</str>
1222          <str name="classname">solr.DirectSolrSpellChecker</str>
1223          <str name="distanceMeasure">
1224            org.apache.lucene.search.spell.JaroWinklerDistance
1225          </str>
1226        </lst>
1227      -->
1228
1229     <!-- a spellchecker that use an alternate comparator
1230
1231          comparatorClass be one of:
1232           1. score (default)
1233           2. freq (Frequency first, then score)
1234           3. A fully qualified class name
1235       -->
1236     <!--
1237        <lst name="spellchecker">
1238          <str name="name">freq</str>
1239          <str name="field">lowerfilt</str>
1240          <str name="classname">solr.DirectSolrSpellChecker</str>
1241          <str name="comparatorClass">freq</str>
1242       -->
1243
1244     <!-- A spellchecker that reads the list of words from a file -->
1245     <!--
1246        <lst name="spellchecker">
1247          <str name="classname">solr.FileBasedSpellChecker</str>
1248          <str name="name">file</str>
1249          <str name="sourceLocation">spellings.txt</str>
1250          <str name="characterEncoding">UTF-8</str>
1251          <str name="spellcheckIndexDir">spellcheckerFile</str>
1252        </lst>
1253       -->
1254   </searchComponent>
1255
1256   <!-- A request handler for demonstrating the spellcheck component.
1257
1258        NOTE: This is purely as an example.  The whole purpose of the
1259        SpellCheckComponent is to hook it into the request handler that
1260        handles your normal user queries so that a separate request is
1261        not needed to get suggestions.
1262
1263        IN OTHER WORDS, THERE IS REALLY GOOD CHANCE THE SETUP BELOW IS
1264        NOT WHAT YOU WANT FOR YOUR PRODUCTION SYSTEM!
1265
1266        See http://wiki.apache.org/solr/SpellCheckComponent for details
1267        on the request parameters.
1268     -->
1269   <requestHandler name="/spell" class="solr.SearchHandler" startup="lazy">
1270     <lst name="defaults">
1271       <str name="df">text</str>
1272       <!-- Solr will use suggestions from both the 'default' spellchecker
1273            and from the 'wordbreak' spellchecker and combine them.
1274            collations (re-written queries) can include a combination of
1275            corrections from both spellcheckers -->
1276       <str name="spellcheck.dictionary">default</str>
1277       <str name="spellcheck.dictionary">wordbreak</str>
1278       <str name="spellcheck">on</str>
1279       <str name="spellcheck.extendedResults">true</str>
1280       <str name="spellcheck.count">10</str>
1281       <str name="spellcheck.alternativeTermCount">5</str>
1282       <str name="spellcheck.maxResultsForSuggest">5</str>
1283       <str name="spellcheck.collate">true</str>
1284       <str name="spellcheck.collateExtendedResults">true</str>
1285       <str name="spellcheck.maxCollationTries">10</str>
1286       <str name="spellcheck.maxCollations">5</str>
1287     </lst>
1288     <arr name="last-components">
1289       <str>spellcheck</str>
1290     </arr>
1291   </requestHandler>
1292
1293   <!-- Term Vector Component
1294
1295        http://wiki.apache.org/solr/TermVectorComponent
1296     -->
1297   <searchComponent name="tvComponent" class="solr.TermVectorComponent"/>
1298
1299   <!-- A request handler for demonstrating the term vector component
1300
1301        This is purely as an example.
1302
1303        In reality you will likely want to add the component to your
1304        already specified request handlers.
1305     -->
1306   <requestHandler name="/tvrh" class="solr.SearchHandler" startup="lazy">
1307     <lst name="defaults">
1308       <str name="df">text</str>
1309       <bool name="tv">true</bool>
1310     </lst>
1311     <arr name="last-components">
1312       <str>tvComponent</str>
1313     </arr>
1314   </requestHandler>
1315
1316   <!-- Clustering Component
1317
1318        http://wiki.apache.org/solr/ClusteringComponent
1319
1320        You'll need to set the solr.cluster.enabled system property
1321        when running solr to run with clustering enabled:
1322
1323             java -Dsolr.clustering.enabled=true -jar start.jar
1324
1325     -->
1326   <searchComponent name="clustering"
1327                    enable="${solr.clustering.enabled:false}"
1328                    class="solr.clustering.ClusteringComponent" >
1329     <!-- Declare an engine -->
1330     <lst name="engine">
1331       <!-- The name, only one can be named "default" -->
1332       <str name="name">default</str>
1333
1334       <!-- Class name of Carrot2 clustering algorithm.
1335
1336            Currently available algorithms are:
1337
1338            * org.carrot2.clustering.lingo.LingoClusteringAlgorithm
1339            * org.carrot2.clustering.stc.STCClusteringAlgorithm
1340            * org.carrot2.clustering.kmeans.BisectingKMeansClusteringAlgorithm
1341
1342            See http://project.carrot2.org/algorithms.html for the
1343            algorithm's characteristics.
1344         -->
1345       <str name="carrot.algorithm">org.carrot2.clustering.lingo.LingoClusteringAlgorithm</str>
1346
1347       <!-- Overriding values for Carrot2 default algorithm attributes.
1348
1349            For a description of all available attributes, see:
1350            http://download.carrot2.org/stable/manual/#chapter.components.
1351            Use attribute key as name attribute of str elements
1352            below. These can be further overridden for individual
1353            requests by specifying attribute key as request parameter
1354            name and attribute value as parameter value.
1355         -->
1356       <str name="LingoClusteringAlgorithm.desiredClusterCountBase">20</str>
1357
1358       <!-- Location of Carrot2 lexical resources.
1359
1360            A directory from which to load Carrot2-specific stop words
1361            and stop labels. Absolute or relative to Solr config directory.
1362            If a specific resource (e.g. stopwords.en) is present in the
1363            specified dir, it will completely override the corresponding
1364            default one that ships with Carrot2.
1365
1366            For an overview of Carrot2 lexical resources, see:
1367            http://download.carrot2.org/head/manual/#chapter.lexical-resources
1368         -->
1369       <str name="carrot.lexicalResourcesDir">clustering/carrot2</str>
1370
1371       <!-- The language to assume for the documents.
1372
1373            For a list of allowed values, see:
1374            http://download.carrot2.org/stable/manual/#section.attribute.lingo.MultilingualClustering.defaultLanguage
1375        -->
1376       <str name="MultilingualClustering.defaultLanguage">ENGLISH</str>
1377     </lst>
1378     <lst name="engine">
1379       <str name="name">stc</str>
1380       <str name="carrot.algorithm">org.carrot2.clustering.stc.STCClusteringAlgorithm</str>
1381     </lst>
1382   </searchComponent>
1383
1384   <!-- A request handler for demonstrating the clustering component
1385
1386        This is purely as an example.
1387
1388        In reality you will likely want to add the component to your
1389        already specified request handlers.
1390     -->
1391   <requestHandler name="/clustering"
1392                   startup="lazy"
1393                   enable="${solr.clustering.enabled:false}"
1394                   class="solr.SearchHandler">
1395     <lst name="defaults">
1396       <bool name="clustering">true</bool>
1397       <str name="clustering.engine">default</str>
1398       <bool name="clustering.results">true</bool>
1399       <!-- The title field -->
1400       <str name="carrot.title">name</str>
1401       <str name="carrot.url">id</str>
1402       <!-- The field to cluster on -->
1403        <str name="carrot.snippet">features</str>
1404        <!-- produce summaries -->
1405        <bool name="carrot.produceSummary">true</bool>
1406        <!-- the maximum number of labels per cluster -->
1407        <!--<int name="carrot.numDescriptions">5</int>-->
1408        <!-- produce sub clusters -->
1409        <bool name="carrot.outputSubClusters">false</bool>
1410
1411        <str name="defType">edismax</str>
1412        <str name="qf">
1413          text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0 manu^1.1 cat^1.4
1414        </str>
1415        <str name="q.alt">*:*</str>
1416        <str name="rows">10</str>
1417        <str name="fl">*,score</str>
1418     </lst>
1419     <arr name="last-components">
1420       <str>clustering</str>
1421     </arr>
1422   </requestHandler>
1423
1424   <!-- Terms Component
1425
1426        http://wiki.apache.org/solr/TermsComponent
1427
1428        A component to return terms and document frequency of those
1429        terms
1430     -->
1431   <searchComponent name="terms" class="solr.TermsComponent"/>
1432
1433   <!-- A request handler for demonstrating the terms component -->
1434   <requestHandler name="/terms" class="solr.SearchHandler" startup="lazy">
1435      <lst name="defaults">
1436       <bool name="terms">true</bool>
1437     </lst>
1438     <arr name="components">
1439       <str>terms</str>
1440     </arr>
1441   </requestHandler>
1442
1443
1444   <!-- Query Elevation Component
1445
1446        http://wiki.apache.org/solr/QueryElevationComponent
1447
1448        a search component that enables you to configure the top
1449        results for a given query regardless of the normal lucene
1450        scoring.
1451     -->
1452 <!--  <searchComponent name="elevator" class="solr.QueryElevationComponent" >-->
1453     <!-- pick a fieldType to analyze queries -->
1454     <!--<str name="queryFieldType">string</str>
1455     <str name="config-file">elevate.xml</str>
1456   </searchComponent>-->
1457
1458   <!-- A request handler for demonstrating the elevator component -->
1459 <!--  <requestHandler name="/elevate" class="solr.SearchHandler" startup="lazy">
1460     <lst name="defaults">
1461       <str name="echoParams">explicit</str>
1462       <str name="df">text</str>
1463     </lst>
1464     <arr name="last-components">
1465       <str>elevator</str>
1466     </arr>
1467   </requestHandler>-->
1468
1469   <!-- Highlighting Component
1470
1471        http://wiki.apache.org/solr/HighlightingParameters
1472     -->
1473   <searchComponent class="solr.HighlightComponent" name="highlight">
1474     <highlighting>
1475       <!-- Configure the standard fragmenter -->
1476       <!-- This could most likely be commented out in the "default" case -->
1477       <fragmenter name="gap"
1478                   default="true"
1479                   class="solr.highlight.GapFragmenter">
1480         <lst name="defaults">
1481           <int name="hl.fragsize">100</int>
1482         </lst>
1483       </fragmenter>
1484
1485       <!-- A regular-expression-based fragmenter
1486            (for sentence extraction)
1487         -->
1488       <fragmenter name="regex"
1489                   class="solr.highlight.RegexFragmenter">
1490         <lst name="defaults">
1491           <!-- slightly smaller fragsizes work better because of slop -->
1492           <int name="hl.fragsize">70</int>
1493           <!-- allow 50% slop on fragment sizes -->
1494           <float name="hl.regex.slop">0.5</float>
1495           <!-- a basic sentence pattern -->
1496           <str name="hl.regex.pattern">[-\w ,/\n\&quot;&apos;]{20,200}</str>
1497         </lst>
1498       </fragmenter>
1499
1500       <!-- Configure the standard formatter -->
1501       <formatter name="html"
1502                  default="true"
1503                  class="solr.highlight.HtmlFormatter">
1504         <lst name="defaults">
1505           <str name="hl.simple.pre"><![CDATA[<em>]]></str>
1506           <str name="hl.simple.post"><![CDATA[</em>]]></str>
1507         </lst>
1508       </formatter>
1509
1510       <!-- Configure the standard encoder -->
1511       <encoder name="html"
1512                class="solr.highlight.HtmlEncoder" />
1513
1514       <!-- Configure the standard fragListBuilder -->
1515       <fragListBuilder name="simple"
1516                        class="solr.highlight.SimpleFragListBuilder"/>
1517
1518       <!-- Configure the single fragListBuilder -->
1519       <fragListBuilder name="single"
1520                        class="solr.highlight.SingleFragListBuilder"/>
1521
1522       <!-- Configure the weighted fragListBuilder -->
1523       <fragListBuilder name="weighted"
1524                        default="true"
1525                        class="solr.highlight.WeightedFragListBuilder"/>
1526
1527       <!-- default tag FragmentsBuilder -->
1528       <fragmentsBuilder name="default"
1529                         default="true"
1530                         class="solr.highlight.ScoreOrderFragmentsBuilder">
1531         <!--
1532         <lst name="defaults">
1533           <str name="hl.multiValuedSeparatorChar">/</str>
1534         </lst>
1535         -->
1536       </fragmentsBuilder>
1537
1538       <!-- multi-colored tag FragmentsBuilder -->
1539       <fragmentsBuilder name="colored"
1540                         class="solr.highlight.ScoreOrderFragmentsBuilder">
1541         <lst name="defaults">
1542           <str name="hl.tag.pre"><![CDATA[
1543                <b style="background:yellow">,<b style="background:lawgreen">,
1544                <b style="background:aquamarine">,<b style="background:magenta">,
1545                <b style="background:palegreen">,<b style="background:coral">,
1546                <b style="background:wheat">,<b style="background:khaki">,
1547                <b style="background:lime">,<b style="background:deepskyblue">]]></str>
1548           <str name="hl.tag.post"><![CDATA[</b>]]></str>
1549         </lst>
1550       </fragmentsBuilder>
1551
1552       <boundaryScanner name="default"
1553                        default="true"
1554                        class="solr.highlight.SimpleBoundaryScanner">
1555         <lst name="defaults">
1556           <str name="hl.bs.maxScan">10</str>
1557           <str name="hl.bs.chars">.,!? &#9;&#10;&#13;</str>
1558         </lst>
1559       </boundaryScanner>
1560
1561       <boundaryScanner name="breakIterator"
1562                        class="solr.highlight.BreakIteratorBoundaryScanner">
1563         <lst name="defaults">
1564           <!-- type should be one of CHARACTER, WORD(default), LINE and SENTENCE -->
1565           <str name="hl.bs.type">WORD</str>
1566           <!-- language and country are used when constructing Locale object.  -->
1567           <!-- And the Locale object will be used when getting instance of BreakIterator -->
1568           <str name="hl.bs.language">en</str>
1569           <str name="hl.bs.country">US</str>
1570         </lst>
1571       </boundaryScanner>
1572     </highlighting>
1573   </searchComponent>
1574
1575   <!-- Update Processors
1576
1577        Chains of Update Processor Factories for dealing with Update
1578        Requests can be declared, and then used by name in Update
1579        Request Processors
1580
1581        http://wiki.apache.org/solr/UpdateRequestProcessor
1582
1583     -->
1584   <!-- Deduplication
1585
1586        An example dedup update processor that creates the "id" field
1587        on the fly based on the hash code of some other fields.  This
1588        example has overwriteDupes set to false since we are using the
1589        id field as the signatureField and Solr will maintain
1590        uniqueness based on that anyway.
1591
1592     -->
1593   <!--
1594      <updateRequestProcessorChain name="dedupe">
1595        <processor class="solr.processor.SignatureUpdateProcessorFactory">
1596          <bool name="enabled">true</bool>
1597          <str name="signatureField">id</str>
1598          <bool name="overwriteDupes">false</bool>
1599          <str name="fields">name,features,cat</str>
1600          <str name="signatureClass">solr.processor.Lookup3Signature</str>
1601        </processor>
1602        <processor class="solr.LogUpdateProcessorFactory" />
1603        <processor class="solr.RunUpdateProcessorFactory" />
1604      </updateRequestProcessorChain>
1605     -->
1606
1607   <!-- Language identification
1608
1609        This example update chain identifies the language of the incoming
1610        documents using the langid contrib. The detected language is
1611        written to field language_s. No field name mapping is done.
1612        The fields used for detection are text, title, subject and description,
1613        making this example suitable for detecting languages form full-text
1614        rich documents injected via ExtractingRequestHandler.
1615        See more about langId at http://wiki.apache.org/solr/LanguageDetection
1616     -->
1617     <!--
1618      <updateRequestProcessorChain name="langid">
1619        <processor class="org.apache.solr.update.processor.TikaLanguageIdentifierUpdateProcessorFactory">
1620          <str name="langid.fl">text,title,subject,description</str>
1621          <str name="langid.langField">language_s</str>
1622          <str name="langid.fallback">en</str>
1623        </processor>
1624        <processor class="solr.LogUpdateProcessorFactory" />
1625        <processor class="solr.RunUpdateProcessorFactory" />
1626      </updateRequestProcessorChain>
1627     -->
1628
1629   <!-- Script update processor
1630
1631     This example hooks in an update processor implemented using JavaScript.
1632
1633     See more about the script update processor at http://wiki.apache.org/solr/ScriptUpdateProcessor
1634   -->
1635   <!--
1636     <updateRequestProcessorChain name="script">
1637       <processor class="solr.StatelessScriptUpdateProcessorFactory">
1638         <str name="script">update-script.js</str>
1639         <lst name="params">
1640           <str name="config_param">example config parameter</str>
1641         </lst>
1642       </processor>
1643       <processor class="solr.RunUpdateProcessorFactory" />
1644     </updateRequestProcessorChain>
1645   -->
1646
1647   <!-- Response Writers
1648
1649        http://wiki.apache.org/solr/QueryResponseWriter
1650
1651        Request responses will be written using the writer specified by
1652        the 'wt' request parameter matching the name of a registered
1653        writer.
1654
1655        The "default" writer is the default and will be used if 'wt' is
1656        not specified in the request.
1657     -->
1658   <!-- The following response writers are implicitly configured unless
1659        overridden...
1660     -->
1661   <!--
1662      <queryResponseWriter name="xml"
1663                           default="true"
1664                           class="solr.XMLResponseWriter" />
1665      <queryResponseWriter name="json" class="solr.JSONResponseWriter"/>
1666      <queryResponseWriter name="python" class="solr.PythonResponseWriter"/>
1667      <queryResponseWriter name="ruby" class="solr.RubyResponseWriter"/>
1668      <queryResponseWriter name="php" class="solr.PHPResponseWriter"/>
1669      <queryResponseWriter name="phps" class="solr.PHPSerializedResponseWriter"/>
1670      <queryResponseWriter name="csv" class="solr.CSVResponseWriter"/>
1671     -->
1672
1673   <queryResponseWriter name="json" class="solr.JSONResponseWriter">
1674      <!-- For the purposes of the tutorial, JSON responses are written as
1675       plain text so that they are easy to read in *any* browser.
1676       If you expect a MIME type of "application/json" just remove this override.
1677      -->
1678     <str name="content-type">text/plain; charset=UTF-8</str>
1679   </queryResponseWriter>
1680
1681   <!--
1682      Custom response writers can be declared as needed...
1683     -->
1684     <queryResponseWriter name="velocity" class="solr.VelocityResponseWriter" startup="lazy"/>
1685
1686
1687   <!-- XSLT response writer transforms the XML output by any xslt file found
1688        in Solr's conf/xslt directory.  Changes to xslt files are checked for
1689        every xsltCacheLifetimeSeconds.
1690     -->
1691   <queryResponseWriter name="xslt" class="solr.XSLTResponseWriter">
1692     <int name="xsltCacheLifetimeSeconds">5</int>
1693   </queryResponseWriter>
1694
1695   <!-- Query Parsers
1696
1697        http://wiki.apache.org/solr/SolrQuerySyntax
1698
1699        Multiple QParserPlugins can be registered by name, and then
1700        used in either the "defType" param for the QueryComponent (used
1701        by SearchHandler) or in LocalParams
1702     -->
1703   <!-- example of registering a query parser -->
1704   <!--
1705      <queryParser name="myparser" class="com.mycompany.MyQParserPlugin"/>
1706     -->
1707
1708   <!-- Function Parsers
1709
1710        http://wiki.apache.org/solr/FunctionQuery
1711
1712        Multiple ValueSourceParsers can be registered by name, and then
1713        used as function names when using the "func" QParser.
1714     -->
1715   <!-- example of registering a custom function parser  -->
1716   <!--
1717      <valueSourceParser name="myfunc"
1718                         class="com.mycompany.MyValueSourceParser" />
1719     -->
1720
1721
1722   <!-- Document Transformers
1723        http://wiki.apache.org/solr/DocTransformers
1724     -->
1725   <!--
1726      Could be something like:
1727      <transformer name="db" class="com.mycompany.LoadFromDatabaseTransformer" >
1728        <int name="connection">jdbc://....</int>
1729      </transformer>
1730
1731      To add a constant value to all docs, use:
1732      <transformer name="mytrans2" class="org.apache.solr.response.transform.ValueAugmenterFactory" >
1733        <int name="value">5</int>
1734      </transformer>
1735
1736      If you want the user to still be able to change it with _value:something_ use this:
1737      <transformer name="mytrans3" class="org.apache.solr.response.transform.ValueAugmenterFactory" >
1738        <double name="defaultValue">5</double>
1739      </transformer>
1740
1741       If you are using the QueryElevationComponent, you may wish to mark documents that get boosted.  The
1742       EditorialMarkerFactory will do exactly that:
1743      <transformer name="qecBooster" class="org.apache.solr.response.transform.EditorialMarkerFactory" />
1744     -->
1745
1746
1747   <!-- Legacy config for the admin interface -->
1748   <admin>
1749     <defaultQuery>*:*</defaultQuery>
1750   </admin>
1751
1752 </config>