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