Searching | Apache Solr Reference Guide 8.8.2

<!DOCTYPE html> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content=""> <meta name="keywords" content=" "> <title>Searching | Apache Solr Reference Guide 8.8.2</title> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous"> <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css"> <link rel="stylesheet" href="css/navs.css "> <link rel="stylesheet" href="css/ref-guide.css"> <link rel="stylesheet" href="css/decoration.css"> <link rel="stylesheet" href="css/search.css">  <script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha384-ZvpUoO/+PpLXR1lu4jmpXWu80pZlYUAfxl5NsBMWOEPSjUn/6Z/hRTt8+pR6L4N2" crossorigin="anonymous"></script>  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/malihu-custom-scrollbar-plugin/3.1.5/jquery.mCustomScrollbar.min.css" crossorigin="anonymous"> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js" crossorigin="anonymous"></script> <script src="js/jquery.navgoco.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.0/anchor.min.js" crossorigin="anonymous"></script> <link rel="shortcut icon" href="images/icons/favicon.ico">    <script> $(document).ready(function() { // Initialize navgoco with default options $("#mysidebar").navgoco({ caretHtml: '', accordion: true, openClass: 'active', // open save: false, // we do *NOT* want cookies used to save the current stage of the sidebar // instead the code in sidebar.html will ensure that the current page // (and it's ancestors) are "active" on page load slide: { duration: 400, easing: 'swing' } }); $("#collapseAll").click(function(e) { e.preventDefault(); $("#mysidebar").navgoco('toggle', false); }); $("#expandAll").click(function(e) { e.preventDefault(); $("#mysidebar").navgoco('toggle', true); }); }); </script> </head> <body class="" id="searching"> <div class="container-fluid"> <div class="row"> <nav id="sidebar" class="col-2 d-none d-md-block"> <div class="sidebar-header"> <div class="sidebarTitle text-center">Apache Solr Reference Guide</div>   <div id="search-demo-container"> <input type="text" id="search-input" class="form-control" placeholder="Page title lookup..."> <ul id="results-container"></ul> </div> <script src="js/jekyll-search.js" type="text/javascript"></script> <script type="text/javascript"> SimpleJekyllSearch.init({ searchInput: document.getElementById('search-input'), resultsContainer: document.getElementById('results-container'), dataSource: 'search.json', searchResultTemplate: '<li><a href="{url}" title="Searching">{title}</a></li>', noResultsText: 'No results found.', limit: 10, fuzzy: true, }) </script>  </div> <ul class="nav" id="mysidebar"> <li class="sb-level1"> <a href="about-this-guide.html">About This Guide</a> </li> <li class="sb-level1"> <a href="getting-started.html">Getting Started</a> <ul> <li class="sb-level2"> <a href="solr-tutorial.html">Solr Tutorial</a> </li> <li class="sb-level2"> <a href="a-quick-overview.html">A Quick Overview</a> </li> <li class="sb-level2"> <a href="solr-system-requirements.html">Solr System Requirements</a> </li> <li class="sb-level2"> <a href="installing-solr.html">Installing Solr</a> </li> </ul> </li> <li class="sb-level1"> <a href="deployment-and-operations.html">Deployment and Operations</a> <ul> <li class="sb-level2"> <a href="solr-control-script-reference.html">Solr Control Script Reference</a> </li> <li class="sb-level2"> <a href="solr-configuration-files.html">Solr Configuration Files</a> </li> <li class="sb-level2"> <a href="taking-solr-to-production.html">Taking Solr to Production</a> </li> <li class="sb-level2"> <a href="making-and-restoring-backups.html">Making and Restoring Backups</a> </li> <li class="sb-level2"> <a href="running-solr-on-hdfs.html">Running Solr on HDFS</a> </li> <li class="sb-level2"> <a href="aws-solrcloud-tutorial.html">SolrCloud on AWS EC2</a> </li> <li class="sb-level2"> <a href="upgrading-a-solr-cluster.html">Upgrading a Solr Cluster</a> <ul> <li class="sb-level3"> <a href="indexupgrader-tool.html">IndexUpgraderTool</a> </li> </ul> </li> <li class="sb-level2"> <a href="solr-upgrade-notes.html">Solr Upgrade Notes</a> <ul> <li class="sb-level3"> <a href="major-changes-in-solr-8.html">Major Changes in Solr 8</a> </li> <li class="sb-level3"> <a href="major-changes-in-solr-7.html">Major Changes in Solr 7</a> </li> <li class="sb-level3"> <a href="major-changes-from-solr-5-to-solr-6.html">Major Changes from Solr 5 to Solr 6</a> </li> </ul> </li> </ul> </li> <li class="sb-level1"> <a href="using-the-solr-administration-user-interface.html">Using the Solr Administration User Interface</a> <ul> <li class="sb-level2"> <a href="overview-of-the-solr-admin-ui.html">Overview of the Solr Admin UI</a> </li> <li class="sb-level2"> <a href="logging.html">Logging</a> </li> <li class="sb-level2"> <a href="cloud-screens.html">Cloud Screens</a> </li> <li class="sb-level2"> <a href="collections-core-admin.html">Collections / Core Admin</a> </li> <li class="sb-level2"> <a href="java-properties.html">Java Properties</a> </li> <li class="sb-level2"> <a href="thread-dump.html">Thread Dump</a> </li> <li class="sb-level2"> <a href="suggestions-screen.html">Suggestions Screen</a> </li> <li class="sb-level2"> <a href="collection-specific-tools.html">Collection-Specific Tools</a> <ul> <li class="sb-level3"> <a href="analysis-screen.html">Analysis Screen</a> </li> <li class="sb-level3"> <a href="dataimport-screen.html">Dataimport Screen</a> </li> <li class="sb-level3"> <a href="documents-screen.html">Documents Screen</a> </li> <li class="sb-level3"> <a href="files-screen.html">Files Screen</a> </li> <li class="sb-level3"> <a href="query-screen.html">Query Screen</a> </li> <li class="sb-level3"> <a href="stream-screen.html">Stream Screen</a> </li> <li class="sb-level3"> <a href="schema-browser-screen.html">Schema Browser Screen</a> </li> </ul> </li> <li class="sb-level2"> <a href="core-specific-tools.html">Core-Specific Tools</a> <ul> <li class="sb-level3"> <a href="ping.html">Ping</a> </li> <li class="sb-level3"> <a href="plugins-stats-screen.html">Plugins & Stats Screen</a> </li> <li class="sb-level3"> <a href="replication-screen.html">Replication Screen</a> </li> <li class="sb-level3"> <a href="segments-info.html">Segments Info</a> </li> </ul> </li> </ul> </li> <li class="sb-level1"> <a href="documents-fields-and-schema-design.html">Documents, Fields, and Schema Design</a> <ul> <li class="sb-level2"> <a href="overview-of-documents-fields-and-schema-design.html">Overview of Documents, Fields, and Schema Design</a> </li> <li class="sb-level2"> <a href="solr-field-types.html">Solr Field Types</a> <ul> <li class="sb-level3"> <a href="field-type-definitions-and-properties.html">Field Type Definitions and Properties</a> </li> <li class="sb-level3"> <a href="field-types-included-with-solr.html">Field Types Included with Solr</a> </li> <li class="sb-level3"> <a href="working-with-currencies-and-exchange-rates.html">Working with Currencies and Exchange Rates</a> </li> <li class="sb-level3"> <a href="working-with-dates.html">Working with Dates</a> </li> <li class="sb-level3"> <a href="working-with-enum-fields.html">Working with Enum Fields</a> </li> <li class="sb-level3"> <a href="working-with-external-files-and-processes.html">Working with External Files and Processes</a> </li> <li class="sb-level3"> <a href="field-properties-by-use-case.html">Field Properties by Use Case</a> </li> </ul> </li> <li class="sb-level2"> <a href="defining-fields.html">Defining Fields</a> </li> <li class="sb-level2"> <a href="copying-fields.html">Copying Fields</a> </li> <li class="sb-level2"> <a href="dynamic-fields.html">Dynamic Fields</a> </li> <li class="sb-level2"> <a href="other-schema-elements.html">Other Schema Elements</a> </li> <li class="sb-level2"> <a href="schema-api.html">Schema API</a> </li> <li class="sb-level2"> <a href="putting-the-pieces-together.html">Putting the Pieces Together</a> </li> <li class="sb-level2"> <a href="docvalues.html">DocValues</a> </li> <li class="sb-level2"> <a href="schemaless-mode.html">Schemaless Mode</a> </li> <li class="sb-level2"> <a href="luke-request-handler.html">Luke Request Handler</a> </li> </ul> </li> <li class="sb-level1"> <a href="understanding-analyzers-tokenizers-and-filters.html">Understanding Analyzers, Tokenizers, and Filters</a> <ul> <li class="sb-level2"> <a href="analyzers.html">Analyzers</a> </li> <li class="sb-level2"> <a href="about-tokenizers.html">About Tokenizers</a> </li> <li class="sb-level2"> <a href="about-filters.html">About Filters</a> </li> <li class="sb-level2"> <a href="tokenizers.html">Tokenizers</a> </li> <li class="sb-level2"> <a href="filter-descriptions.html">Filter Descriptions</a> </li> <li class="sb-level2"> <a href="charfilterfactories.html">CharFilterFactories</a> </li> <li class="sb-level2"> <a href="language-analysis.html">Language Analysis</a> </li> <li class="sb-level2"> <a href="phonetic-matching.html">Phonetic Matching</a> </li> <li class="sb-level2"> <a href="running-your-analyzer.html">Running Your Analyzer</a> </li> </ul> </li> <li class="sb-level1"> <a href="indexing-and-basic-data-operations.html">Indexing and Basic Data Operations</a> <ul> <li class="sb-level2"> <a href="introduction-to-solr-indexing.html">Introduction to Solr Indexing</a> </li> <li class="sb-level2"> <a href="post-tool.html">Post Tool</a> </li> <li class="sb-level2"> <a href="uploading-data-with-index-handlers.html">Uploading Data with Index Handlers</a> <ul> <li class="sb-level3"> <a href="transforming-and-indexing-custom-json.html">Transforming and Indexing Custom JSON</a> </li> </ul> </li> <li class="sb-level2"> <a href="indexing-nested-documents.html">Indexing Nested Child Documents</a> </li> <li class="sb-level2"> <a href="uploading-data-with-solr-cell-using-apache-tika.html">Uploading Data with Solr Cell using Apache Tika</a> </li> <li class="sb-level2"> <a href="uploading-structured-data-store-data-with-the-data-import-handler.html">Uploading Structured Data Store Data with the Data Import Handler</a> </li> <li class="sb-level2"> <a href="updating-parts-of-documents.html">Updating Parts of Documents</a> </li> <li class="sb-level2"> <a href="detecting-languages-during-indexing.html">Detecting Languages During Indexing</a> </li> <li class="sb-level2"> <a href="de-duplication.html">De-Duplication</a> </li> <li class="sb-level2"> <a href="content-streams.html">Content Streams</a> </li> <li class="sb-level2"> <a href="reindexing.html">Reindexing</a> </li> </ul> </li> <li class="sb-level1"> <a href="searching.html">Searching</a> <ul> <li class="sb-level2"> <a href="overview-of-searching-in-solr.html">Overview of Searching in Solr</a> </li> <li class="sb-level2"> <a href="velocity-search-ui.html">Velocity Search UI</a> </li> <li class="sb-level2"> <a href="relevance.html">Relevance</a> </li> <li class="sb-level2"> <a href="query-syntax-and-parsing.html">Query Syntax and Parsing</a> <ul> <li class="sb-level3"> <a href="common-query-parameters.html">Common Query Parameters</a> </li> <li class="sb-level3"> <a href="the-standard-query-parser.html">The Standard Query Parser</a> </li> <li class="sb-level3"> <a href="the-dismax-query-parser.html">The DisMax Query Parser</a> </li> <li class="sb-level3"> <a href="the-extended-dismax-query-parser.html">The Extended DisMax (eDismax) Query Parser</a> </li> <li class="sb-level3"> <a href="function-queries.html">Function Queries</a> </li> <li class="sb-level3"> <a href="local-parameters-in-queries.html">Local Parameters in Queries</a> </li> <li class="sb-level3"> <a href="other-parsers.html">Other Parsers</a> </li> </ul> </li> <li class="sb-level2"> <a href="json-request-api.html">JSON Request API</a> <ul> <li class="sb-level3"> <a href="json-query-dsl.html">JSON Query DSL</a> </li> </ul> </li> <li class="sb-level2"> <a href="json-facet-api.html">JSON Facet API</a> <ul> <li class="sb-level3"> <a href="json-faceting-domain-changes.html">JSON Faceting Domain Changes</a> </li> </ul> </li> <li class="sb-level2"> <a href="faceting.html">Faceting</a> <ul> <li class="sb-level3"> <a href="blockjoin-faceting.html">BlockJoin Faceting</a> </li> </ul> </li> <li class="sb-level2"> <a href="highlighting.html">Highlighting</a> </li> <li class="sb-level2"> <a href="spell-checking.html">Spell Checking</a> </li> <li class="sb-level2"> <a href="query-re-ranking.html">Query Re-Ranking</a> <ul> <li class="sb-level3"> <a href="learning-to-rank.html">Learning To Rank</a> </li> </ul> </li> <li class="sb-level2"> <a href="transforming-result-documents.html">Transforming Result Documents</a> </li> <li class="sb-level2"> <a href="searching-nested-documents.html">Searching Nested Child Documents</a> </li> <li class="sb-level2"> <a href="suggester.html">Suggester</a> </li> <li class="sb-level2"> <a href="morelikethis.html">MoreLikeThis</a> </li> <li class="sb-level2"> <a href="pagination-of-results.html">Pagination of Results</a> </li> <li class="sb-level2"> <a href="collapse-and-expand-results.html">Collapse and Expand Results</a> </li> <li class="sb-level2"> <a href="result-grouping.html">Result Grouping</a> </li> <li class="sb-level2"> <a href="spatial-search.html">Spatial Search</a> </li> <li class="sb-level2"> <a href="the-terms-component.html">The Terms Component</a> </li> <li class="sb-level2"> <a href="the-term-vector-component.html">The Term Vector Component</a> </li> <li class="sb-level2"> <a href="the-stats-component.html">The Stats Component</a> </li> <li class="sb-level2"> <a href="the-query-elevation-component.html">The Query Elevation Component</a> </li> <li class="sb-level2"> <a href="the-tagger-handler.html">The Tagger Handler</a> </li> <li class="sb-level2"> <a href="response-writers.html">Response Writers</a> <ul> <li class="sb-level3"> <a href="velocity-response-writer.html">Velocity Response Writer</a> </li> </ul> </li> <li class="sb-level2"> <a href="near-real-time-searching.html">Near Real Time Searching</a> </li> <li class="sb-level2"> <a href="realtime-get.html">RealTime Get</a> </li> <li class="sb-level2"> <a href="exporting-result-sets.html">Exporting Result Sets</a> </li> <li class="sb-level2"> <a href="parallel-sql-interface.html">Parallel SQL Interface</a> <ul> <li class="sb-level3"> <a href="solr-jdbc-dbvisualizer.html">Solr JDBC - DbVisualizer</a> </li> <li class="sb-level3"> <a href="solr-jdbc-squirrel-sql.html">Solr JDBC - SQuirreL SQL</a> </li> <li class="sb-level3"> <a href="solr-jdbc-apache-zeppelin.html">Solr JDBC - Apache Zeppelin</a> </li> <li class="sb-level3"> <a href="solr-jdbc-python-jython.html">Solr JDBC - Python/Jython</a> </li> <li class="sb-level3"> <a href="solr-jdbc-r.html">Solr JDBC - R</a> </li> </ul> </li> <li class="sb-level2"> <a href="analytics.html">Analytics Component</a> <ul> <li class="sb-level3"> <a href="analytics-expression-sources.html">Analytics Expression Sources</a> </li> <li class="sb-level3"> <a href="analytics-mapping-functions.html">Analytics Mapping Functions</a> </li> <li class="sb-level3"> <a href="analytics-reduction-functions.html">Analytics Reduction Functions</a> </li> </ul> </li> </ul> </li> <li class="sb-level1"> <a href="streaming-expressions.html">Streaming Expressions</a> <ul> <li class="sb-level2"> <a href="stream-source-reference.html">Stream Source Reference</a> </li> <li class="sb-level2"> <a href="stream-decorator-reference.html">Stream Decorator Reference</a> </li> <li class="sb-level2"> <a href="stream-evaluator-reference.html">Stream Evaluator Reference</a> </li> <li class="sb-level2"> <a href="math-expressions.html">Streaming Expressions and Math Expressions</a> <ul> <li class="sb-level3"> <a href="visualization.html">Visualization</a> </li> <li class="sb-level3"> <a href="math-start.html">Getting Started</a> </li> <li class="sb-level3"> <a href="loading.html">Loading Data</a> </li> <li class="sb-level3"> <a href="search-sample.html">Searching, Sampling and Aggregation</a> </li> <li class="sb-level3"> <a href="transform.html">Transforming Data</a> </li> <li class="sb-level3"> <a href="scalar-math.html">Scalar Math</a> </li> <li class="sb-level3"> <a href="vector-math.html">Vector Math</a> </li> <li class="sb-level3"> <a href="variables.html">Variables</a> </li> <li class="sb-level3"> <a href="matrix-math.html">Matrices and Matrix Math</a> </li> <li class="sb-level3"> <a href="term-vectors.html">Text Analysis and Term Vectors</a> </li> <li class="sb-level3"> <a href="probability-distributions.html">Probability Distributions</a> </li> <li class="sb-level3"> <a href="statistics.html">Statistics</a> </li> <li class="sb-level3"> <a href="regression.html">Linear Regression</a> </li> <li class="sb-level3"> <a href="curve-fitting.html">Curve Fitting</a> </li> <li class="sb-level3"> <a href="time-series.html">Time Series</a> </li> <li class="sb-level3"> <a href="numerical-analysis.html">Interpolation, Derivatives and Integrals</a> </li> <li class="sb-level3"> <a href="dsp.html">Digital Signal Processing</a> </li> <li class="sb-level3"> <a href="simulations.html">Monte Carlo Simulations</a> </li> <li class="sb-level3"> <a href="machine-learning.html">Machine Learning</a> </li> <li class="sb-level3"> <a href="computational-geometry.html">Computational Geometry</a> </li> <li class="sb-level3"> <a href="logs.html">Log Analytics</a> </li> </ul> </li> <li class="sb-level2"> <a href="graph-traversal.html">Graph Traversal</a> </li> <li class="sb-level2"> <a href="stream-api.html">Stream Request Handler API</a> </li> </ul> </li> <li class="sb-level1"> <a href="solrcloud.html">SolrCloud</a> <ul> <li class="sb-level2"> <a href="getting-started-with-solrcloud.html">Getting Started with SolrCloud</a> </li> <li class="sb-level2"> <a href="how-solrcloud-works.html">How SolrCloud Works</a> <ul> <li class="sb-level3"> <a href="shards-and-indexing-data-in-solrcloud.html">Shards and Indexing Data in SolrCloud</a> </li> <li class="sb-level3"> <a href="distributed-requests.html">Distributed Requests</a> </li> <li class="sb-level3"> <a href="aliases.html">Aliases</a> </li> </ul> </li> <li class="sb-level2"> <a href="solrcloud-resilience.html">SolrCloud Resilience</a> <ul> <li class="sb-level3"> <a href="solrcloud-recoveries-and-write-tolerance.html">SolrCloud Recoveries and Write Tolerance</a> </li> <li class="sb-level3"> <a href="solrcloud-query-routing-and-read-tolerance.html">SolrCloud Query Routing And Read Tolerance</a> </li> </ul> </li> <li class="sb-level2"> <a href="solrcloud-configuration-and-parameters.html">SolrCloud Configuration and Parameters</a> <ul> <li class="sb-level3"> <a href="setting-up-an-external-zookeeper-ensemble.html">Setting Up an External ZooKeeper Ensemble</a> </li> <li class="sb-level3"> <a href="using-zookeeper-to-manage-configuration-files.html">Using ZooKeeper to Manage Configuration Files</a> </li> <li class="sb-level3"> <a href="collections-api.html">Collections API</a> <ul> <li class="sb-level4"> <a href="cluster-node-management.html">Cluster and Node Managment Commands</a> </li> <li class="sb-level4"> <a href="collection-management.html">Collection Management Commands</a> </li> <li class="sb-level4"> <a href="collection-aliasing.html">Collection Aliasing</a> </li> <li class="sb-level4"> <a href="shard-management.html">Shard Management Commands</a> </li> <li class="sb-level4"> <a href="replica-management.html">Replica Management Commands</a> </li> </ul> </li> <li class="sb-level3"> <a href="parameter-reference.html">Parameter Reference</a> </li> <li class="sb-level3"> <a href="command-line-utilities.html">Command Line Utilities</a> </li> <li class="sb-level3"> <a href="solrcloud-with-legacy-configuration-files.html">SolrCloud with Legacy Configuration Files</a> </li> <li class="sb-level3"> <a href="configsets-api.html">Configsets API</a> </li> </ul> </li> <li class="sb-level2"> <a href="rule-based-replica-placement.html">Rule-based Replica Placement</a> </li> <li class="sb-level2"> <a href="cross-data-center-replication-cdcr.html">Cross Data Center Replication (CDCR)</a> <ul> <li class="sb-level3"> <a href="cdcr-architecture.html">CDCR Architecture</a> </li> <li class="sb-level3"> <a href="cdcr-config.html">CDCR Configuration</a> </li> <li class="sb-level3"> <a href="cdcr-operations.html">Cross Data Center Replication Operations</a> </li> <li class="sb-level3"> <a href="cdcr-api.html">CDCR API</a> </li> </ul> </li> <li class="sb-level2"> <a href="solrcloud-autoscaling.html">SolrCloud Autoscaling</a> <ul> <li class="sb-level3"> <a href="solrcloud-autoscaling-overview.html">Overview of SolrCloud Autoscaling</a> </li> <li class="sb-level3"> <a href="solrcloud-autoscaling-policy-preferences.html">Autoscaling Policy and Preferences</a> </li> <li class="sb-level3"> <a href="solrcloud-autoscaling-triggers.html">SolrCloud Autoscaling Triggers</a> </li> <li class="sb-level3"> <a href="solrcloud-autoscaling-trigger-actions.html">SolrCloud Autoscaling Trigger Actions</a> </li> <li class="sb-level3"> <a href="solrcloud-autoscaling-listeners.html">SolrCloud Autoscaling Listeners</a> </li> <li class="sb-level3"> <a href="solrcloud-autoscaling-auto-add-replicas.html">SolrCloud Autoscaling Automatically Adding Replicas</a> </li> <li class="sb-level3"> <a href="solrcloud-autoscaling-fault-tolerance.html">SolrCloud Autoscaling Fault Tolerance</a> </li> <li class="sb-level3"> <a href="solrcloud-autoscaling-api.html">Autoscaling API</a> </li> <li class="sb-level3"> <a href="migrate-to-policy-rule.html">Migrating Rule-Based Replica Rules to Autoscaling Policies</a> </li> </ul> </li> <li class="sb-level2"> <a href="colocating-collections.html">Colocating Collections</a> </li> </ul> </li> <li class="sb-level1"> <a href="legacy-scaling-and-distribution.html">Legacy Scaling and Distribution</a> <ul> <li class="sb-level2"> <a href="introduction-to-scaling-and-distribution.html">Introduction to Scaling and Distribution</a> </li> <li class="sb-level2"> <a href="distributed-search-with-index-sharding.html">Distributed Search with Index Sharding</a> </li> <li class="sb-level2"> <a href="index-replication.html">Index Replication</a> </li> <li class="sb-level2"> <a href="combining-distribution-and-replication.html">Combining Distribution and Replication</a> </li> <li class="sb-level2"> <a href="merging-indexes.html">Merging Indexes</a> </li> </ul> </li> <li class="sb-level1"> <a href="circuit-breakers.html">Circuit Breakers</a> </li> <li class="sb-level1"> <a href="solr-plugins.html">Solr Plugins</a> <ul> <li class="sb-level2"> <a href="libs.html">Lib Directories and Directives</a> </li> <li class="sb-level2"> <a href="package-manager.html">Package Management</a> <ul> <li class="sb-level3"> <a href="package-manager-internals.html">Package Manager Internals</a> </li> </ul> </li> <li class="sb-level2"> <a href="adding-custom-plugins-in-solrcloud-mode.html">Adding Custom Plugins in SolrCloud Mode</a> </li> </ul> </li> <li class="sb-level1"> <a href="the-well-configured-solr-instance.html">The Well-Configured Solr Instance</a> <ul> <li class="sb-level2"> <a href="configuring-solrconfig-xml.html">Configuring solrconfig.xml</a> <ul> <li class="sb-level3"> <a href="datadir-and-directoryfactory-in-solrconfig.html">DataDir and DirectoryFactory in SolrConfig</a> </li> <li class="sb-level3"> <a href="schema-factory-definition-in-solrconfig.html">Schema Factory Definition in SolrConfig</a> </li> <li class="sb-level3"> <a href="indexconfig-in-solrconfig.html">IndexConfig in SolrConfig</a> </li> <li class="sb-level3"> <a href="requesthandlers-and-searchcomponents-in-solrconfig.html">RequestHandlers and SearchComponents in SolrConfig</a> </li> <li class="sb-level3"> <a href="initparams-in-solrconfig.html">InitParams in SolrConfig</a> </li> <li class="sb-level3"> <a href="updatehandlers-in-solrconfig.html">UpdateHandlers in SolrConfig</a> </li> <li class="sb-level3"> <a href="query-settings-in-solrconfig.html">Query Settings in SolrConfig</a> </li> <li class="sb-level3"> <a href="requestdispatcher-in-solrconfig.html">RequestDispatcher in SolrConfig</a> </li> <li class="sb-level3"> <a href="update-request-processors.html">Update Request Processors</a> </li> <li class="sb-level3"> <a href="codec-factory.html">Codec Factory</a> </li> </ul> </li> <li class="sb-level2"> <a href="solr-cores-and-solr-xml.html">Solr Cores and solr.xml</a> <ul> <li class="sb-level3"> <a href="format-of-solr-xml.html">Format of solr.xml</a> </li> <li class="sb-level3"> <a href="defining-core-properties.html">Defining core.properties</a> </li> <li class="sb-level3"> <a href="coreadmin-api.html">CoreAdmin API</a> </li> <li class="sb-level3"> <a href="config-sets.html">Configsets</a> </li> </ul> </li> <li class="sb-level2"> <a href="resource-loading.html">Resource Loading</a> </li> <li class="sb-level2"> <a href="configuration-apis.html">Configuration APIs</a> <ul> <li class="sb-level3"> <a href="blob-store-api.html">Blob Store API</a> </li> <li class="sb-level3"> <a href="config-api.html">Config API</a> </li> <li class="sb-level3"> <a href="request-parameters-api.html">Request Parameters API</a> </li> <li class="sb-level3"> <a href="managed-resources.html">Managed Resources</a> </li> </ul> </li> <li class="sb-level2"> <a href="implicit-requesthandlers.html">Implicit RequestHandlers</a> </li> <li class="sb-level2"> <a href="jvm-settings.html">JVM Settings</a> </li> <li class="sb-level2"> <a href="v2-api.html">v2 API</a> </li> </ul> </li> <li class="sb-level1"> <a href="monitoring-solr.html">Monitoring Solr</a> <ul> <li class="sb-level2"> <a href="metrics-reporting.html">Metrics Reporting</a> </li> <li class="sb-level2"> <a href="metrics-history.html">Metrics History</a> </li> <li class="sb-level2"> <a href="mbean-request-handler.html">MBean Request Handler</a> </li> <li class="sb-level2"> <a href="configuring-logging.html">Configuring Logging</a> </li> <li class="sb-level2"> <a href="using-jmx-with-solr.html">Using JMX with Solr</a> </li> <li class="sb-level2"> <a href="monitoring-solr-with-prometheus-and-grafana.html">Monitoring Solr with Prometheus and Grafana</a> </li> <li class="sb-level2"> <a href="performance-statistics-reference.html">Performance Statistics Reference</a> </li> <li class="sb-level2"> <a href="solr-tracing.html">Distributed Solr Tracing</a> </li> </ul> </li> <li class="sb-level1"> <a href="securing-solr.html">Securing Solr</a> <ul> <li class="sb-level2"> <a href="authentication-and-authorization-plugins.html">Configuring Authentication, Authorization and Audit Logging</a> <ul> <li class="sb-level3"> <a href="basic-authentication-plugin.html">Basic Authentication Plugin</a> </li> <li class="sb-level3"> <a href="hadoop-authentication-plugin.html">Hadoop Authentication Plugin</a> </li> <li class="sb-level3"> <a href="kerberos-authentication-plugin.html">Kerberos Authentication Plugin</a> </li> <li class="sb-level3"> <a href="rule-based-authorization-plugin.html">Rule-Based Authorization Plugins</a> </li> <li class="sb-level3"> <a href="jwt-authentication-plugin.html">JWT Authentication Plugin</a> </li> </ul> </li> <li class="sb-level2"> <a href="enabling-ssl.html">Enabling SSL</a> </li> <li class="sb-level2"> <a href="audit-logging.html">Audit Logging</a> </li> <li class="sb-level2"> <a href="zookeeper-access-control.html">ZooKeeper Access Control</a> </li> </ul> </li> <li class="sb-level1"> <a href="client-apis.html">Client APIs</a> <ul> <li class="sb-level2"> <a href="introduction-to-client-apis.html">Introduction to Client APIs</a> </li> <li class="sb-level2"> <a href="choosing-an-output-format.html">Choosing an Output Format</a> </li> <li class="sb-level2"> <a href="using-solrj.html">Using SolrJ</a> </li> <li class="sb-level2"> <a href="using-javascript.html">Using JavaScript</a> </li> <li class="sb-level2"> <a href="using-python.html">Using Python</a> </li> <li class="sb-level2"> <a href="using-solr-from-ruby.html">Using Solr From Ruby</a> </li> <li class="sb-level2"> <a href="client-api-lineup.html">Other Clients</a> </li> </ul> </li> <li class="sb-level1"> <a href="further-assistance.html">Further Assistance</a> </li> <li class="sb-level1"> <a href="solr-glossary.html">Solr Glossary</a> </li> <li class="sb-level1"> <a href="errata.html">Errata</a> </li> <li class="sb-level1"> <a href="how-to-contribute.html">How to Contribute to Solr Documentation</a> </li> </ul>   <script>$("#mysidebar a[href='searching.html']").parents('li').toggleClass("active", true);</script>   <script> $("#mysidebar a[href='searching.html']").parent('li').toggleClass("current", true); $("#mysidebar a[href='searching.html']").parents('li').toggleClass("current-tree", true); </script> </nav> <div id="content" class="col-10">  <nav id="topnav" class="navbar navbar-expand-md fixed-top bg-light flex-nowrap col-10"> <div class="container-fluid"> <div class="navbar-header"> <img src="images/solr-sunOnly-small.png" width="30" height="30"> <a class="navbar-brand" href="index.html"> <span class="projectTitle">Solr 8.8</span> </a> </div> <div class="collapse navbar-collapse justify-content-end" id="bs-example-navbar-collapse-1"> <ul class="nav navbar-nav navbar-right">  <li><a href="https://solr.apache.org/" target="_blank">Solr Website</a></li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Other Formats<b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://archive.apache.org/dist/lucene/solr/ref-guide/" target="_blank">Archived PDFs</a></li> <li><a href="https://solr.apache.org/guide/" target="_blank">Other Versions Online</a></li> </ul> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Solr Resources<b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://solr.apache.org/docs/8_8_0//solr-core/index.html" target="_blank">Solr Javadocs</a></li> <li><a href="https://solr.apache.org/community.html#version-control" target="_blank">Lucene/Solr Source Code</a></li> <li><a href="https://solr.apache.org/community.html" target="_blank">Solr Community Links</a></li> </ul> </li> </ul> </div> </div>  </nav> <article class="post-content"> <header class="header"> <h1 class="title-main">Searching</h1> </header> <div class="container-fluid">  <nav class="toc float-right justify-content-end"> </nav> <section class="content"> <p>This section describes how Solr works with search requests. It covers the following topics:</p> <div class="ulist"><ul><li><p><a href="overview-of-searching-in-solr.html#overview-of-searching-in-solr">Overview of Searching in Solr</a>: An introduction to searching with Solr.</p></li><li><p><a href="velocity-search-ui.html#velocity-search-ui">Velocity Search UI</a>: A simple search UI using the VelocityResponseWriter.</p></li><li><p><a href="relevance.html#relevance">Relevance</a>: Conceptual information about understanding relevance in search results.</p></li><li><p><a href="query-syntax-and-parsing.html#query-syntax-and-parsing">Query Syntax and Parsing</a>: A brief conceptual overview of query syntax and parsing. It also contains the following sub-sections:<ul><li><p><a href="common-query-parameters.html#common-query-parameters">Common Query Parameters</a>: No matter the query parser, there are several parameters that are common to all of them.</p></li><li><p><a href="the-standard-query-parser.html#the-standard-query-parser">The Standard Query Parser</a>: Detailed information about the standard Lucene query parser.</p></li><li><p><a href="the-dismax-query-parser.html#the-dismax-query-parser">The DisMax Query Parser</a>: Detailed information about Solr’s DisMax query parser.</p></li><li><p><a href="the-extended-dismax-query-parser.html#the-extended-dismax-query-parser">The Extended DisMax Query Parser</a>: Detailed information about Solr’s Extended DisMax (eDisMax) Query Parser.</p></li><li><p><a href="function-queries.html#function-queries">Function Queries</a>: Detailed information about parameters for generating relevancy scores using values from one or more numeric fields.</p></li><li><p><a href="local-parameters-in-queries.html#local-parameters-in-queries">Local Parameters in Queries</a>: How to add local arguments to queries.</p></li><li><p><a href="other-parsers.html#other-parsers">Other Parsers</a>: More parsers designed for use in specific situations.</p></li></ul></p></li><li><p><a href="json-request-api.html#json-request-api">JSON Request API</a>: Overview of Solr’s JSON Request API.<ul><li><p><a href="json-query-dsl.html#json-query-dsl">JSON Query DSL</a>: Detailed information about a simple yet powerful query language for JSON Request API.</p></li></ul></p></li><li><p><a href="json-facet-api.html#facet-analytics-module">JSON Facet API</a>: Overview of Solr’s JSON Facet API.</p></li><li><p><a href="faceting.html#faceting">Faceting</a>: Detailed information about categorizing search results based on indexed terms.</p></li><li><p><a href="highlighting.html#highlighting">Highlighting</a>: Detailed information about Solr’s highlighting capabilities, including multiple underlying highlighter implementations.</p></li><li><p><a href="spell-checking.html#spell-checking">Spell Checking</a>: Detailed information about Solr’s spelling checker.</p></li><li><p><a href="query-re-ranking.html#query-re-ranking">Query Re-Ranking</a>: Detailed information about re-ranking top scoring documents from simple queries using more complex scores.<ul><li><p><a href="learning-to-rank.html#learning-to-rank">Learning To Rank</a>: How to use LTR to run machine learned ranking models in Solr.</p></li></ul></p></li><li><p><a href="transforming-result-documents.html#transforming-result-documents">Transforming Result Documents</a>: Detailed information about using <code>DocTransformers</code> to add computed information to individual documents</p></li><li><p><a href="searching-nested-documents.html#searching-nested-documents">Searching Nested Documents</a>: Detailed information about constructing nested and hierarchical queries.</p></li><li><p><a href="suggester.html#suggester">Suggester</a>: Detailed information about Solr’s powerful autosuggest component.</p></li><li><p><a href="morelikethis.html#morelikethis">MoreLikeThis</a>: Detailed information about Solr’s similar results query component.</p></li><li><p><a href="pagination-of-results.html#pagination-of-results">Pagination of Results</a>: Detailed information about fetching paginated results for display in a UI, or for fetching all documents matching a query.</p></li><li><p><a href="result-grouping.html#result-grouping">Result Grouping</a>: Detailed information about grouping results based on common field values.</p></li><li><p><a href="spatial-search.html#spatial-search">Spatial Search</a>: How to use Solr’s spatial search capabilities.</p></li><li><p><a href="the-terms-component.html#the-terms-component">The Terms Component</a>: Detailed information about accessing indexed terms and the documents that include them.</p></li><li><p><a href="the-term-vector-component.html#the-term-vector-component">The Term Vector Component</a>: How to get term information about specific documents.</p></li><li><p><a href="the-stats-component.html#the-stats-component">The Stats Component</a>: How to return information from numeric fields within a document set.</p></li><li><p><a href="the-query-elevation-component.html#the-query-elevation-component">The Query Elevation Component</a>: How to force documents to the top of the results for certain queries.</p></li><li><p><a href="the-tagger-handler.html#the-tagger-handler">The Tagger Handler</a>: The SolrTextTagger, for basic named entity tagging in text.</p></li><li><p><a href="response-writers.html#response-writers">Response Writers</a>: Detailed information about configuring and using Solr’s response writers.</p></li><li><p><a href="near-real-time-searching.html#near-real-time-searching">Near Real Time Searching</a>: How to include documents in search results nearly immediately after they are indexed.</p></li><li><p><a href="realtime-get.html#realtime-get">RealTime Get</a>: How to get the latest version of a document without opening a searcher.</p></li><li><p><a href="exporting-result-sets.html#exporting-result-sets">Exporting Result Sets</a>: Functionality to export large result sets out of Solr.</p></li><li><p><a href="parallel-sql-interface.html#parallel-sql-interface">Parallel SQL Interface</a>: An interface for sending SQL statements to Solr, and using advanced parallel query processing and relational algebra for complex data analysis.</p></li><li><p><a href="analytics.html#analytics">The Analytics Component</a>: A framework to compute complex analytics over a result set.</p></li></ul></div> </section>  <div class="tags"> </div>  <nav class="scrollnav row"> <div class="col-lg-12"> <a class="btn btn-primary prev float-left" href="reindexing.html">Reindexing</a> <a class="btn btn-primary next float-right" href="overview-of-searching-in-solr.html">Overview of Searching in Solr</a> </div> </nav> </div> </article> <footer> <div class="row"> <div class="col-lg-12 footer"> ©2021 Apache Software Foundation. All rights reserved. <br /> Site Version: 8.8.2 <br />Site last generated: 2021-04-12 <br /> <p><img src="images/solr-sunOnly-small.png" alt="Apache Solr"/></p> </div> </div> </footer> </div> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/malihu-custom-scrollbar-plugin/3.1.5/jquery.mCustomScrollbar.concat.min.js" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script> <script src="js/customscripts.js"></script> <script type="text/x-mathjax-config"> MathJax.Hub.Config({ messageStyle: "none", tex2jax: { inlineMath: [["\$","\$"]], displayMath: [["\\[","\\]"]], ignoreClass: "nostem|nolatexmath" }, asciimath2jax: { delimiters: [["\\$","\\$"]], ignoreClass: "nostem|noasciimath" }, TeX: { equationNumbers: { autoNumber: "none" } } }); </script> <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_HTMLorMML"></script> </body> </html>

CINXE.COM

Searching | Apache Solr Reference Guide 8.8.2