Apache Solr Reference Guide
About This Guide
Getting Started
- Solr Tutorial
- A Quick Overview
- Solr System Requirements
- Installing Solr
Deployment and Operations
- Solr Control Script Reference
- Solr Configuration Files
- Taking Solr to Production
- Making and Restoring Backups
- Running Solr on HDFS
- SolrCloud on AWS EC2
- Upgrading a Solr Cluster
  - IndexUpgrader Tool
- Solr Upgrade Notes
  - Major Changes in Solr 7
  - Major Changes from Solr 5 to Solr 6
Using the Solr Administration User Interface
- Overview of the Solr Admin UI
- Getting Assistance
- Logging
- Cloud Screens
- Collections / Core Admin
- Java Properties
- Thread Dump
- Suggestions Screen
- Collection-Specific Tools
- Core-Specific Tools
Documents, Fields, and Schema Design
- Overview of Documents, Fields, and Schema Design
- Solr Field Types
- Defining Fields
- Copying Fields
- Dynamic Fields
- Other Schema Elements
- Schema API
- Putting the Pieces Together
- DocValues
- Schemaless Mode
Understanding Analyzers, Tokenizers, and Filters
- Analyzers
- About Tokenizers
- About Filters
- Tokenizers
- Filter Descriptions
- CharFilterFactories
- Language Analysis
- Phonetic Matching
- Running Your Analyzer
Indexing and Basic Data Operations
- Introduction to Solr Indexing
- Post Tool
- Uploading Data with Index Handlers
  - Transforming and Indexing Custom JSON
- Uploading Data with Solr Cell using Apache Tika
- Uploading Structured Data Store Data with the Data Import Handler
- Updating Parts of Documents
- Detecting Languages During Indexing
- De-Duplication
- Content Streams
Searching
- Overview of Searching in Solr
- Velocity Search UI
- Relevance
- Query Syntax and Parsing
  - Common Query Parameters
  - The Standard Query Parser
  - The DisMax Query Parser
  - The Extended DisMax (eDismax) Query Parser
  - Function Queries
  - Local Parameters in Queries
  - Other Parsers
- JSON Request API
  - JSON Query DSL
- JSON Facet API
- Faceting
  - BlockJoin Faceting
- Highlighting
- Spell Checking
- Query Re-Ranking
  - Learning To Rank
- Transforming Result Documents
- Suggester
- MoreLikeThis
- Pagination of Results
- Collapse and Expand Results
- Result Grouping
- Result Clustering
- Spatial Search
- The Terms Component
- The Term Vector Component
- The Stats Component
- The Query Elevation Component
- The Tagger Handler
- Response Writers
  - Velocity Response Writer
- Near Real Time Searching
- RealTime Get
- Exporting Result Sets
- Parallel SQL Interface
  - Solr JDBC - DbVisualizer
  - Solr JDBC - SQuirreL SQL
  - Solr JDBC - Apache Zeppelin
  - Solr JDBC - Python/Jython
  - Solr JDBC - R
- Analytics Component
  - Analytics Expression Sources
  - Analytics Mapping Functions
  - Analytics Reduction Functions
Streaming Expressions
- Stream Source Reference
- Stream Decorator Reference
- Stream Evaluator Reference
- Math Expressions
- Graph Traversal
SolrCloud
- Getting Started with SolrCloud
- How SolrCloud Works
- SolrCloud Resilience
  - SolrCloud Recoveries and Write Tolerance
  - SolrCloud Query Routing And Read Tolerance
- SolrCloud Configuration and Parameters
- Rule-based Replica Placement
- Cross Data Center Replication (CDCR)
- SolrCloud Autoscaling
- Colocating Collections
Legacy Scaling and Distribution
- Introduction to Scaling and Distribution
- Distributed Search with Index Sharding
- Index Replication
- Combining Distribution and Replication
- Merging Indexes
The Well-Configured Solr Instance
- Configuring solrconfig.xml
- Solr Cores and solr.xml
- Configuration APIs
- Implicit RequestHandlers
- Solr Plugins
  - Adding Custom Plugins in SolrCloud Mode
- JVM Settings
- v2 API
Monitoring Solr
- Metrics Reporting
- Metrics History
- MBean Request Handler
- Configuring Logging
- Using JMX with Solr
- Monitoring Solr with Prometheus and Grafana
- Performance Statistics Reference
Securing Solr
- Authentication and Authorization Plugins
- Enabling SSL
Client APIs
- Introduction to Client APIs
- Choosing an Output Format
- Client API Lineup
- Using JavaScript
- Using Python
- Using SolrJ
- Using Solr From Ruby
Further Assistance
Solr Glossary
Errata
How to Contribute to Solr Documentation

Parameter Reference

Cluster Parameters

numShards: Defaults to 1. The number of shards to hash documents to. There must be one leader per shard and each leader can have N replicas.

SolrCloud Instance Parameters

These are set in solr.xml, but by default the host and hostContext parameters are set up to also work with system properties.

host: Defaults to the first local host address found. If the wrong host address is found automatically, you can override the host address with this parameter.
hostPort: Defaults to the port specified via bin/solr -p <port>, or 8983 if not specified. The port that Solr is running on. This value is only used when -DzkRun is specified without a value (see below), to calculate the default port on which embedded ZooKeeper will run. In the solr.xml shipped with Solr, the hostPort system property is not referenced, and so is ignored. If you want to run Solr on a non-default port, use bin/solr -p <port> rather than specifying -DhostPort.
hostContext: Defaults to solr. The context path for the Solr web application.

SolrCloud Instance ZooKeeper Parameters

zkRun: Defaults to localhost:<hostPort+1000>. Causes Solr to run an embedded version of ZooKeeper. Set to the address of ZooKeeper on this node; this allows us to know who you are in the list of addresses in the zkHost connect string. Use -DzkRun (with no value) to get the default value.
zkHost: The host address for ZooKeeper. Usually this is a comma-separated list of addresses to each node in your ZooKeeper ensemble.
zkClientTimeout: Defaults to 15000. The time a client is allowed to not talk to ZooKeeper before its session expires.

zkRun and zkHost are set up using system properties. zkClientTimeout is set up in solr.xml by default, but can also be set using a system property.

SolrCloud Core Parameters

shard: Defaults to being automatically assigned based on numShards. Specifies which shard this core acts as a replica of. shard can be specified in the core.properties for each core.

Additional cloud related parameters are discussed in Format of solr.xml

Collections API Command Line Utilities