Package org.apache.solr.common.params
Interface CommonParams
public interface CommonParams
Parameters used across many handlers
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumvalid values for:echoParams -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String"action" parameter for SolrPing/admin paths which don't require a target collectionstatic final Stringstatic final Stringstatic final Stringstatic final StringUsed as a local parameter on queries.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringUsed as a local param on filter queries in conjunction with cache=false.static final StringMaximum query CPU usage value in milliseconds.static final StringWhether to provide debug info for specific items.static final Stringwhether to include debug data for all components pieces, including doing explainsstatic final Stringdefault query fieldstatic final String"disable" value for SolrPing actionstatic final StringDeprecated.this was replaced by the auto-generated trace idsstatic final Stringdistrib stringstatic final StringParameter to control the distributed term statistics request for current query when distributed IDF is enabled in solrconfigstatic final String"enable" value for SolrPing actionstatic final Stringstatic final Stringanother query to explain againststatic final Stringboolean indicating whether score explanations should be structured (true), or plain text (false)static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringquery and init param for field liststatic final StringLucene query string(s) for filtering the results without affecting scoringstatic final String'true' if the header should include the handler namestatic final Stringinclude the parameters in the header *static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringIs the query cancellable?static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringwhich parameters to log (if not supplied all parameters will be logged) *static final StringThe max hits to be collected per shard.static final StringMax query memory allocation value in mebibytes (float).static final Stringstatic final StringThe number of hits that need to be counted accurately.static final StringWhether the search may use the multi-threaded logicstatic final Stringstatic final StringOverride for the concept of "NOW" to be used throughout this request, expressed as milliseconds since epoch.static final Stringstatic final Stringinclude header in the responsestatic final Stringstatic final StringIf true then allow returning partial results.static final Stringstatic final String"ping" value for SolrPing actionstatic final Stringhandler value for SolrPingstatic final Stringquery stringstatic final StringDeprecated.route requests by path instead, not using this parameterstatic final StringDEBUGvalue indicating an interest in debug output related to the Query (parsing, etc.)static final StringCustom query UUID if provided.static final StringDeprecated.this was replaced by the auto-generated trace idsstatic final StringRequest Purpose parameter added to each internal shard request when using debug=trackstatic final StringDEBUGvalue indicating an interest in debug output related to the results (explains)static final Stringnumber of documents to return starting at "start"static final intstatic final Stringrank querystatic final StringWhether the search may be terminated early within a segment.static final booleanstatic final Stringstatic final Stringstatic final Stringsort orderstatic final Stringzero based offset of matching documents to retrievestatic final intstatic final Stringstatic final Stringstatic final Stringstatic final StringUUID of the task whose status is to be checkedstatic final Stringstatic final Stringstatic final StringTimeout value in milliseconds.static final StringDEBUGvalue indicating an interest in debug output related to timingstatic final StringDEBUGvalue indicating an interest in debug output related to the distributed trackingstatic final Stringstatic final StringSpecifies the TimeZone used by the client for the purposes of any DateMath rounding that may take place when executing the requeststatic final Stringstatic final Stringstatic final Stringstatic final Stringthe response writer type - the format of the responsestatic final Stringstylesheet to apply to XML resultsstatic final Stringstatic final String
-
Field Details
-
NOW
Override for the concept of "NOW" to be used throughout this request, expressed as milliseconds since epoch. This is primarily used in distributed search to ensure consistent time values are used across multiple sub-requests.- See Also:
-
TZ
Specifies the TimeZone used by the client for the purposes of any DateMath rounding that may take place when executing the request- See Also:
-
QT
Deprecated.route requests by path instead, not using this parameterthe Request Handler (formerly known as the Query Type) - which Request Handler should handle the request.- See Also:
-
WT
the response writer type - the format of the response- See Also:
-
Q
query string- See Also:
-
RQ
rank query- See Also:
-
DISTRIB
distrib string- See Also:
-
SORT
sort order- See Also:
-
FQ
Lucene query string(s) for filtering the results without affecting scoring- See Also:
-
START
zero based offset of matching documents to retrieve- See Also:
-
START_DEFAULT
static final int START_DEFAULT- See Also:
-
ROWS
number of documents to return starting at "start"- See Also:
-
ROWS_DEFAULT
static final int ROWS_DEFAULT- See Also:
-
INDENT
- See Also:
-
PING_HANDLER
handler value for SolrPing- See Also:
-
ACTION
"action" parameter for SolrPing- See Also:
-
DISABLE
"disable" value for SolrPing action- See Also:
-
ENABLE
"enable" value for SolrPing action- See Also:
-
PING
"ping" value for SolrPing action- See Also:
-
XSL
stylesheet to apply to XML results- See Also:
-
FL
query and init param for field list- See Also:
-
DF
default query field- See Also:
-
DEBUG_QUERY
whether to include debug data for all components pieces, including doing explains- See Also:
-
DEBUG
Whether to provide debug info for specific items.- See Also:
-
TIMING
DEBUGvalue indicating an interest in debug output related to timing- See Also:
-
RESULTS
DEBUGvalue indicating an interest in debug output related to the results (explains)- See Also:
-
QUERY
DEBUGvalue indicating an interest in debug output related to the Query (parsing, etc.)- See Also:
-
TRACK
DEBUGvalue indicating an interest in debug output related to the distributed tracking- See Also:
-
EXPLAIN_STRUCT
boolean indicating whether score explanations should be structured (true), or plain text (false)- See Also:
-
EXPLAIN_OTHER
another query to explain against- See Also:
-
SEGMENT_TERMINATE_EARLY
Whether the search may be terminated early within a segment.- See Also:
-
SEGMENT_TERMINATE_EARLY_DEFAULT
static final boolean SEGMENT_TERMINATE_EARLY_DEFAULT- See Also:
-
PARTIAL_RESULTS
If true then allow returning partial results. If false and full results can't be produced return no results / error.- See Also:
-
TIME_ALLOWED
Timeout value in milliseconds. If not set, or the value is < 0, there is no timeout.- See Also:
-
MULTI_THREADED
Whether the search may use the multi-threaded logic- See Also:
-
CPU_ALLOWED
Maximum query CPU usage value in milliseconds. If not set, or the value is < 0, there is no timeout.- See Also:
-
MEM_ALLOWED
Max query memory allocation value in mebibytes (float). If not set, or the value is <= 0.0, there is no limit.- See Also:
-
MAX_HITS_ALLOWED
The max hits to be collected per shard.- See Also:
-
IS_QUERY_CANCELLABLE
Is the query cancellable?- See Also:
-
QUERY_UUID
Custom query UUID if provided.- See Also:
-
TASK_CHECK_UUID
UUID of the task whose status is to be checked- See Also:
-
MIN_EXACT_COUNT
The number of hits that need to be counted accurately. If more thanMIN_EXACT_COUNTdocuments match a query, then the value in "numFound" may be an estimate to speedup search.- See Also:
-
HEADER_ECHO_HANDLER
'true' if the header should include the handler name- See Also:
-
HEADER_ECHO_PARAMS
include the parameters in the header *- See Also:
-
OMIT_HEADER
include header in the response- See Also:
-
CORES_HANDLER_PATH
- See Also:
-
COLLECTIONS_HANDLER_PATH
- See Also:
-
INFO_HANDLER_PATH
- See Also:
-
HEALTH_CHECK_HANDLER_PATH
- See Also:
-
CONFIGSETS_HANDLER_PATH
- See Also:
-
AUTHZ_PATH
- See Also:
-
AUTHC_PATH
- See Also:
-
ZK_PATH
- See Also:
-
ZK_STATUS_PATH
- See Also:
-
SYSTEM_INFO_PATH
- See Also:
-
METRICS_PATH
- See Also:
-
STATUS
- See Also:
-
OK
- See Also:
-
FAILURE
- See Also:
-
ADMIN_PATHS
/admin paths which don't require a target collection -
APISPEC_LOCATION
- See Also:
-
INTROSPECT
- See Also:
-
LOG_PARAMS_LIST
which parameters to log (if not supplied all parameters will be logged) *- See Also:
-
EXCLUDE
- See Also:
-
TAG
- See Also:
-
TERMS
- See Also:
-
OUTPUT_KEY
- See Also:
-
FIELD
- See Also:
-
VALUE
- See Also:
-
THREADS
- See Also:
-
TRUE
-
FALSE
-
CACHE
Used as a local parameter on queries. cache=false means don't check any query or filter caches. cache=true is the default.- See Also:
-
COST
Used as a local param on filter queries in conjunction with cache=false. Filters are checked in order, from the smallest cost to largest. If cost>=100 and the query implements PostFilter, then that interface will be used to do post query filtering.- See Also:
-
REQUEST_ID
Deprecated.this was replaced by the auto-generated trace idsRequest ID parameter added to all distributed queries (that do not opt out)- See Also:
-
DISABLE_REQUEST_ID
Deprecated.this was replaced by the auto-generated trace idsAn opt-out flag to prevent the addition ofREQUEST_IDtracing on distributed queriesDefaults to 'false' if not specified.
- See Also:
-
DISTRIB_STATS_CACHE
Parameter to control the distributed term statistics request for current query when distributed IDF is enabled in solrconfigDefaults to 'true' if not specified. Distributed stats request will be disabled by setting to 'false'
- See Also:
-
REQUEST_PURPOSE
Request Purpose parameter added to each internal shard request when using debug=track- See Also:
-
JAVABIN
- See Also:
-
JSON
- See Also:
-
PATH
- See Also:
-
NAME
- See Also:
-
VALUE_LONG
- See Also:
-
SOLR_REQUEST_CONTEXT_PARAM
- See Also:
-
SOLR_REQUEST_TYPE_PARAM
- See Also:
-
VERSION_FIELD
- See Also:
-
FAIL_ON_VERSION_CONFLICTS
- See Also:
-
ID
- See Also:
-
JSON_MIME
- See Also:
-
JAVABIN_MIME
- See Also:
-
FILE
- See Also:
-
FILES
- See Also:
-
CHILDDOC
- See Also:
-