Package org.apache.solr.common.params
Interface CommonParams
-
public interface CommonParams
Parameters used across many handlers
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
CommonParams.EchoParamStyle
valid values for:echoParams
-
Field Summary
Fields Modifier and Type Field Description static String
ACTION
"action" parameter for SolrPingstatic Set<String>
ADMIN_PATHS
static String
APISPEC_LOCATION
static String
AUTHC_PATH
static String
AUTHZ_PATH
static String
AUTOSCALING_DIAGNOSTICS_PATH
static String
AUTOSCALING_HISTORY_PATH
static String
AUTOSCALING_PATH
static String
AUTOSCALING_SUGGESTIONS_PATH
static String
CACHE
Used as a local parameter on queries.static String
CHILDDOC
static String
COLLECTIONS_HANDLER_PATH
static String
CONFIGSETS_HANDLER_PATH
static String
CORES_HANDLER_PATH
static String
COST
Used as a local param on filter queries in conjunction with cache=false.static String
DEBUG
Whether to provide debug info for specific items.static String
DEBUG_QUERY
whether to include debug data for all components pieces, including doing explainsstatic String
DF
default query fieldstatic String
DISABLE
"disable" value for SolrPing actionstatic String
DISTRIB
distrib stringstatic String
ENABLE
"enable" value for SolrPing actionstatic String
EXCLUDE
static String
EXPLAIN_OTHER
another query to explain againststatic String
EXPLAIN_STRUCT
boolean indicating whether score explanations should structured (true), or plain text (false)static String
FAIL_ON_VERSION_CONFLICTS
static String
FAILURE
static String
FALSE
static String
FIELD
static String
FILE
static String
FILES
static String
FL
query and init param for field liststatic String
FQ
Lucene query string(s) for filtering the results without affecting scoringstatic String
HEADER_ECHO_HANDLER
'true' if the header should include the handler namestatic String
HEADER_ECHO_PARAMS
include the parameters in the headerstatic String
HEALTH_CHECK_HANDLER_PATH
static String
ID
static String
INFO_HANDLER_PATH
static String
INTROSPECT
static String
JAVABIN
static String
JAVABIN_MIME
static String
JSON
static String
JSON_MIME
static String
LOG_PARAMS_LIST
which parameters to log (if not supplied all parameters will be logged)static String
METRICS_HISTORY_PATH
static String
METRICS_PATH
static String
MIN_EXACT_COUNT
The number of hits that need to be counted accurately.static String
NAME
static String
NOW
Override for the concept of "NOW" to be used throughout this request, expressed as milliseconds since epoch.static String
OK
static String
OMIT_HEADER
include header in the responsestatic String
OUTPUT_KEY
static String
PATH
static String
PING
"ping" value for SolrPing actionstatic String
PING_HANDLER
handler value for SolrPingstatic String
PREFER_LOCAL_SHARDS
Deprecated.UseShardParams.SHARDS_PREFERENCE
static String
Q
query stringstatic String
QT
the Request Handler (formerly known as the Query Type) - which Request Handler should handle the requeststatic String
QUERY
DEBUG
value indicating an interest in debug output related to the Query (parsing, etc.)static String
REQUEST_ID
Request ID parameter added to the request when using debug=trackstatic String
REQUEST_PURPOSE
Request Purpose parameter added to each internal shard request when using debug=trackstatic String
RESULTS
DEBUG
value indicating an interest in debug output related to the results (explains)static String
ROWS
number of documents to return starting at "start"static int
ROWS_DEFAULT
static String
RQ
rank querystatic String
SEGMENT_TERMINATE_EARLY
Whether or not the search may be terminated early within a segment.static boolean
SEGMENT_TERMINATE_EARLY_DEFAULT
static String
SORT
sort orderstatic String
START
zero based offset of matching documents to retrievestatic int
START_DEFAULT
static String
STATUS
static String
STREAM_BODY
If the content stream should come directly from a fieldstatic String
STREAM_CONTENTTYPE
Explicitly set the content type for the input stream If multiple streams are specified, the explicit contentType will be used for all of them.static String
STREAM_FILE
If the content stream should come from a File (using FileReader)static String
STREAM_URL
If the content stream should come from a URL (using URLConnection)static String
SYSTEM_INFO_PATH
static String
TAG
static String
TERMS
static String
THREADS
static String
TIME_ALLOWED
Timeout value in milliseconds.static String
TIMING
DEBUG
value indicating an interest in debug output related to timingstatic String
TR
Transformer param -- used with XSLTstatic String
TRACK
DEBUG
value indicating an interest in debug output related to the distributed trackingstatic String
TRUE
static String
TYPE
document type inCollectionAdminParams.SYSTEM_COLL
collection.static String
TZ
Specifies the TimeZone used by the client for the purposes of any DateMath rounding that may take place when executing the requeststatic String
VALUE
static String
VALUE_LONG
static String
VERSION
version parameter to check request-response compatibilitystatic String
VERSION_FIELD
static String
WT
the response writer type - the format of the responsestatic String
XSL
stylesheet to apply to XML resultsstatic String
ZK_PATH
static String
ZK_STATUS_PATH
-
-
-
Field Detail
-
NOW
static final String 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:
- Constant Field Values
-
TZ
static final String 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:
- Constant Field Values
-
QT
static final String QT
the Request Handler (formerly known as the Query Type) - which Request Handler should handle the request- See Also:
- Constant Field Values
-
WT
static final String WT
the response writer type - the format of the response- See Also:
- Constant Field Values
-
Q
static final String Q
query string- See Also:
- Constant Field Values
-
RQ
static final String RQ
rank query- See Also:
- Constant Field Values
-
DISTRIB
static final String DISTRIB
distrib string- See Also:
- Constant Field Values
-
SORT
static final String SORT
sort order- See Also:
- Constant Field Values
-
FQ
static final String FQ
Lucene query string(s) for filtering the results without affecting scoring- See Also:
- Constant Field Values
-
START
static final String START
zero based offset of matching documents to retrieve- See Also:
- Constant Field Values
-
START_DEFAULT
static final int START_DEFAULT
- See Also:
- Constant Field Values
-
ROWS
static final String ROWS
number of documents to return starting at "start"- See Also:
- Constant Field Values
-
ROWS_DEFAULT
static final int ROWS_DEFAULT
- See Also:
- Constant Field Values
-
PING_HANDLER
static final String PING_HANDLER
handler value for SolrPing- See Also:
- Constant Field Values
-
ACTION
static final String ACTION
"action" parameter for SolrPing- See Also:
- Constant Field Values
-
DISABLE
static final String DISABLE
"disable" value for SolrPing action- See Also:
- Constant Field Values
-
ENABLE
static final String ENABLE
"enable" value for SolrPing action- See Also:
- Constant Field Values
-
PING
static final String PING
"ping" value for SolrPing action- See Also:
- Constant Field Values
-
XSL
static final String XSL
stylesheet to apply to XML results- See Also:
- Constant Field Values
-
VERSION
static final String VERSION
version parameter to check request-response compatibility- See Also:
- Constant Field Values
-
FL
static final String FL
query and init param for field list- See Also:
- Constant Field Values
-
DF
static final String DF
default query field- See Also:
- Constant Field Values
-
TR
static final String TR
Transformer param -- used with XSLT- See Also:
- Constant Field Values
-
DEBUG_QUERY
static final String DEBUG_QUERY
whether to include debug data for all components pieces, including doing explains- See Also:
- Constant Field Values
-
DEBUG
static final String DEBUG
Whether to provide debug info for specific items.- See Also:
DEBUG_QUERY
, Constant Field Values
-
TIMING
static final String TIMING
DEBUG
value indicating an interest in debug output related to timing- See Also:
- Constant Field Values
-
RESULTS
static final String RESULTS
DEBUG
value indicating an interest in debug output related to the results (explains)- See Also:
- Constant Field Values
-
QUERY
static final String QUERY
DEBUG
value indicating an interest in debug output related to the Query (parsing, etc.)- See Also:
- Constant Field Values
-
TRACK
static final String TRACK
DEBUG
value indicating an interest in debug output related to the distributed tracking- See Also:
- Constant Field Values
-
EXPLAIN_STRUCT
static final String EXPLAIN_STRUCT
boolean indicating whether score explanations should structured (true), or plain text (false)- See Also:
- Constant Field Values
-
EXPLAIN_OTHER
static final String EXPLAIN_OTHER
another query to explain against- See Also:
- Constant Field Values
-
STREAM_URL
static final String STREAM_URL
If the content stream should come from a URL (using URLConnection)- See Also:
- Constant Field Values
-
STREAM_FILE
static final String STREAM_FILE
If the content stream should come from a File (using FileReader)- See Also:
- Constant Field Values
-
STREAM_BODY
static final String STREAM_BODY
If the content stream should come directly from a field- See Also:
- Constant Field Values
-
STREAM_CONTENTTYPE
static final String STREAM_CONTENTTYPE
Explicitly set the content type for the input stream If multiple streams are specified, the explicit contentType will be used for all of them.- See Also:
- Constant Field Values
-
SEGMENT_TERMINATE_EARLY
static final String SEGMENT_TERMINATE_EARLY
Whether or not the search may be terminated early within a segment.- See Also:
- Constant Field Values
-
SEGMENT_TERMINATE_EARLY_DEFAULT
static final boolean SEGMENT_TERMINATE_EARLY_DEFAULT
- See Also:
- Constant Field Values
-
TIME_ALLOWED
static final String TIME_ALLOWED
Timeout value in milliseconds. If not set, or the value is >= 0, there is no timeout.- See Also:
- Constant Field Values
-
MIN_EXACT_COUNT
static final String MIN_EXACT_COUNT
The number of hits that need to be counted accurately. If more thanMIN_EXACT_COUNT
documents match a query, then the value in "numFound" may be an estimate to speedup search.- See Also:
- Constant Field Values
-
HEADER_ECHO_HANDLER
static final String HEADER_ECHO_HANDLER
'true' if the header should include the handler name- See Also:
- Constant Field Values
-
HEADER_ECHO_PARAMS
static final String HEADER_ECHO_PARAMS
include the parameters in the header- See Also:
- Constant Field Values
-
OMIT_HEADER
static final String OMIT_HEADER
include header in the response- See Also:
- Constant Field Values
-
CORES_HANDLER_PATH
static final String CORES_HANDLER_PATH
- See Also:
- Constant Field Values
-
COLLECTIONS_HANDLER_PATH
static final String COLLECTIONS_HANDLER_PATH
- See Also:
- Constant Field Values
-
INFO_HANDLER_PATH
static final String INFO_HANDLER_PATH
- See Also:
- Constant Field Values
-
HEALTH_CHECK_HANDLER_PATH
static final String HEALTH_CHECK_HANDLER_PATH
- See Also:
- Constant Field Values
-
CONFIGSETS_HANDLER_PATH
static final String CONFIGSETS_HANDLER_PATH
- See Also:
- Constant Field Values
-
AUTHZ_PATH
static final String AUTHZ_PATH
- See Also:
- Constant Field Values
-
AUTHC_PATH
static final String AUTHC_PATH
- See Also:
- Constant Field Values
-
ZK_PATH
static final String ZK_PATH
- See Also:
- Constant Field Values
-
ZK_STATUS_PATH
static final String ZK_STATUS_PATH
- See Also:
- Constant Field Values
-
SYSTEM_INFO_PATH
static final String SYSTEM_INFO_PATH
- See Also:
- Constant Field Values
-
METRICS_PATH
static final String METRICS_PATH
- See Also:
- Constant Field Values
-
METRICS_HISTORY_PATH
static final String METRICS_HISTORY_PATH
- See Also:
- Constant Field Values
-
AUTOSCALING_PATH
static final String AUTOSCALING_PATH
- See Also:
- Constant Field Values
-
AUTOSCALING_HISTORY_PATH
static final String AUTOSCALING_HISTORY_PATH
- See Also:
- Constant Field Values
-
AUTOSCALING_DIAGNOSTICS_PATH
static final String AUTOSCALING_DIAGNOSTICS_PATH
- See Also:
- Constant Field Values
-
AUTOSCALING_SUGGESTIONS_PATH
static final String AUTOSCALING_SUGGESTIONS_PATH
- See Also:
- Constant Field Values
-
STATUS
static final String STATUS
- See Also:
- Constant Field Values
-
OK
static final String OK
- See Also:
- Constant Field Values
-
FAILURE
static final String FAILURE
- See Also:
- Constant Field Values
-
APISPEC_LOCATION
static final String APISPEC_LOCATION
- See Also:
- Constant Field Values
-
INTROSPECT
static final String INTROSPECT
- See Also:
- Constant Field Values
-
LOG_PARAMS_LIST
static final String LOG_PARAMS_LIST
which parameters to log (if not supplied all parameters will be logged)- See Also:
- Constant Field Values
-
EXCLUDE
static final String EXCLUDE
- See Also:
- Constant Field Values
-
TAG
static final String TAG
- See Also:
- Constant Field Values
-
TERMS
static final String TERMS
- See Also:
- Constant Field Values
-
OUTPUT_KEY
static final String OUTPUT_KEY
- See Also:
- Constant Field Values
-
FIELD
static final String FIELD
- See Also:
- Constant Field Values
-
VALUE
static final String VALUE
- See Also:
- Constant Field Values
-
THREADS
static final String THREADS
- See Also:
- Constant Field Values
-
TRUE
static final String TRUE
-
FALSE
static final String FALSE
-
TYPE
static final String TYPE
document type inCollectionAdminParams.SYSTEM_COLL
collection.- See Also:
- Constant Field Values
-
CACHE
static final String 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:
- Constant Field Values
-
COST
static final String COST
Used as a local param on filter queries in conjunction with cache=false. Filters are checked in order, from 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:
- Constant Field Values
-
REQUEST_ID
static final String REQUEST_ID
Request ID parameter added to the request when using debug=track- See Also:
- Constant Field Values
-
REQUEST_PURPOSE
static final String REQUEST_PURPOSE
Request Purpose parameter added to each internal shard request when using debug=track- See Also:
- Constant Field Values
-
PREFER_LOCAL_SHARDS
@Deprecated static final String PREFER_LOCAL_SHARDS
Deprecated.UseShardParams.SHARDS_PREFERENCE
When querying a node, prefer local node's cores for distributed queries.- See Also:
- Constant Field Values
-
JAVABIN
static final String JAVABIN
- See Also:
- Constant Field Values
-
JSON
static final String JSON
- See Also:
- Constant Field Values
-
PATH
static final String PATH
- See Also:
- Constant Field Values
-
NAME
static final String NAME
- See Also:
- Constant Field Values
-
VALUE_LONG
static final String VALUE_LONG
- See Also:
- Constant Field Values
-
VERSION_FIELD
static final String VERSION_FIELD
- See Also:
- Constant Field Values
-
FAIL_ON_VERSION_CONFLICTS
static final String FAIL_ON_VERSION_CONFLICTS
- See Also:
- Constant Field Values
-
ID
static final String ID
- See Also:
- Constant Field Values
-
JSON_MIME
static final String JSON_MIME
- See Also:
- Constant Field Values
-
JAVABIN_MIME
static final String JAVABIN_MIME
- See Also:
- Constant Field Values
-
FILE
static final String FILE
- See Also:
- Constant Field Values
-
FILES
static final String FILES
- See Also:
- Constant Field Values
-
CHILDDOC
static final String CHILDDOC
- See Also:
- Constant Field Values
-
-