# Package org.apache.solr.common.params

package org.apache.solr.common.params
Parameter constants and enumerations.

Related Packages
Package
Description
org.apache.solr.common
Common classes reused on both clients & server for dealing with `documents to be indexed` and `result documents`.
org.apache.solr.common.annotation
Annotations mapping to Jackson
org.apache.solr.common.cloud
Common Solr Cloud and ZooKeeper related classes reused on both clients & server.
org.apache.solr.common.luke
Common constants used by the `LukeRequestHandler`.
org.apache.solr.common.util
Common utility classes reused on both clients & server.
Class
Description
AnalysisParams
Defines the request parameters used by all analysis request handlers.
AppendedSolrParams
SolrParams wrapper which acts similar to DefaultSolrParams except that it "appends" the values of multi-value params from both sub instances, so that all the values are returned.
CollectionAdminParams
CollectionParams
CollectionParams.CollectionAction
(Mostly) Collection API actions that can be sent by nodes to the Overseer over the `/overseer/collection-queue-work` ZooKeeper queue.
CollectionParams.LockLevel
CommonAdminParams
CommonParams
Parameters used across many handlers
CommonParams.EchoParamStyle
valid values for: `echoParams`
ConfigSetParams
ConfigSets API related parameters and actions.
ConfigSetParams.ConfigSetAction
CoreAdminParams
CoreAdminParams.CoreAdminAction
CursorMarkParams
Parameters and constants used when dealing with cursor based requests across large sorted result sets.
DefaultSolrParams
DisMaxParams
A collection of params used in DisMaxRequestHandler, both for Plugin initialization and for Requests.
EventParams
ExpandParams
Expand parameters
FacetParams
Facet parameters
FacetParams.FacetRangeInclude
An enumeration of the legal values for `FacetParams.FACET_DATE_INCLUDE` and `FacetParams.FACET_RANGE_INCLUDE`
lower = all gap based ranges include their lower bound upper = all gap based ranges include their upper bound edge = the first and last gap ranges include their edge bounds (ie: lower for the first one, upper for the last one) even if the corresponding upper/lower option is not specified outer = the BEFORE and AFTER ranges should be inclusive of their bounds, even if the first or last ranges already include those boundaries.
FacetParams.FacetRangeMethod
An enumeration of the legal values for `FacetParams.FACET_RANGE_METHOD` filter = dv =
FacetParams.FacetRangeOther
An enumeration of the legal values for `FacetParams.FACET_RANGE_OTHER` and `FacetParams.FACET_DATE_OTHER` ...
GroupParams
Group parameters
HighlightParams
MapSolrParams
`SolrParams` implementation that can be built from and is backed by a `Map`.
ModifiableSolrParams
This class is similar to `MultiMapSolrParams` except you can edit the parameters after it is initialized.
MoreLikeThisParams
Params for `MoreLikeThisHandler`.
MoreLikeThisParams.TermStyle
MultiMapSolrParams
QueryElevationParams
Parameters used with the QueryElevationComponent
RequiredSolrParams
This is a simple wrapper to SolrParams that will throw a 400 exception if you ask for a parameter that does not exist.
ShardParams
Parameters used for distributed search.
SimpleParams
Parameters used by the SimpleQParser.
SolrParams
SolrParams is designed to hold parameters to Solr, often from the request coming into Solr.
SpatialParams
SpellingParams
Parameters used for spellchecking
StatsParams
Stats Parameters
StreamParams
Streaming Expressions Parameters and Properties.
TermsParams
TermsParams.TermsRegexpFlag
TermVectorParams
UpdateParams
A collection of standard params used by Update handlers