mirror of https://github.com/apache/lucene.git
SOLR-14862: Update RefGuide page for support fied types (#1865)
Added mentions for BBoxField, NestPathField, RankField (and placehold for QParser, from SOLR-14590), RptWithGeometrySpatialField Moved Deprecated types into separate table to improve reading comprehension Added some cross-references for more in-depth reading.
This commit is contained in:
Alexandre Rafalovitch
GitHub
parent
97a4af6890
commit
7d62cad1a8
|
|
@ -16,21 +16,23 @@
|
|||
// specific language governing permissions and limitations
|
||||
// under the License.
|
||||
|
||||
The following table lists the field types that are available in Solr. The `org.apache.solr.schema` package includes all the classes listed in this table.
|
||||
The following table lists the field types that are available in Solr and are recommended. The page further down, lists all the deprecated types for those migrating from older version of Solr. The {solr-javadocs}/solr-core/org/apache/solr/schema/package-summary.html[`org.apache.solr.schema`] package includes all the classes listed in this table.
|
||||
|
||||
// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
|
||||
|
||||
== Recommended field types
|
||||
|
||||
[cols="25,75",options="header"]
|
||||
|===
|
||||
|Class |Description
|
||||
|BBoxField | Indexes a single rectangle (bounding box) per document field and supports searching via a bounding box. See the section <<spatial-search.adoc#spatial-search,Spatial Search>> for more information.
|
||||
|
||||
|BinaryField |Binary data.
|
||||
|
||||
|BoolField |Contains either true or false. Values of `1`, `t`, or `T` in the first character are interpreted as `true`. Any other values in the first character are interpreted as `false`.
|
||||
|
||||
|CollationField |Supports Unicode collation for sorting and range queries. The ICUCollationField is a better choice if you can use ICU4J. See the section <<language-analysis.adoc#unicode-collation,Unicode Collation>> for more information.
|
||||
|
||||
|CurrencyField |*Deprecated*. Use CurrencyFieldType instead.
|
||||
|
||||
|CurrencyFieldType |Supports currencies and exchange rates. See the section <<working-with-currencies-and-exchange-rates.adoc#working-with-currencies-and-exchange-rates,Working with Currencies and Exchange Rates>> for more information.
|
||||
|
||||
|DateRangeField |Supports indexing date ranges, to include point in time date instances as well (single-millisecond durations). See the section <<working-with-dates.adoc#working-with-dates,Working with Dates>> for more detail on using this field type. Consider using this field type even if it's just for date instances, particularly when the queries typically fall on UTC year/month/day/hour, etc., boundaries.
|
||||
|
|
@ -41,8 +43,6 @@ The following table lists the field types that are available in Solr. The `org.a
|
|||
|
||||
|ExternalFileField |Pulls values from a file on disk. See the section <<working-with-external-files-and-processes.adoc#working-with-external-files-and-processes,Working with External Files and Processes>> for more information.
|
||||
|
||||
|EnumField |*Deprecated*. Use EnumFieldType instead.
|
||||
|
||||
|EnumFieldType |Allows defining an enumerated set of values which may not be easily sorted by either alphabetic or numeric order (such as a list of severities, for example). This field type takes a configuration file, which lists the proper order of the field values. See the section <<working-with-enum-fields.adoc#working-with-enum-fields,Working with Enum Fields>> for more information.
|
||||
|
||||
|FloatPointField |Floating point field (32-bit IEEE floating point). This class encodes float values using a "Dimensional Points" based data structure that allows for very efficient searches for specific values, or ranges of values. For single valued fields, `docValues="true"` must be used to enable sorting.
|
||||
|
|
@ -53,10 +53,10 @@ The following table lists the field types that are available in Solr. The `org.a
|
|||
|
||||
|LatLonPointSpatialField |A latitude/longitude coordinate pair; possibly multi-valued for multiple points. Usually it's specified as "lat,lon" order with a comma. See the section <<spatial-search.adoc#spatial-search,Spatial Search>> for more information.
|
||||
|
||||
|LatLonType |*Deprecated*. Consider using the LatLonPointSpatialField instead. A single-valued latitude/longitude coordinate pair. Usually it's specified as "lat,lon" order with a comma. See the section <<spatial-search.adoc#spatial-search,Spatial Search>> for more information.
|
||||
|
||||
|LongPointField |Long field (64-bit signed integer). This class encodes foo values using a "Dimensional Points" based data structure that allows for very efficient searches for specific values, or ranges of values. For single valued fields, `docValues="true"` must be used to enable sorting.
|
||||
|
||||
|NestPathField | Specialized field type storing ehanced information, when <<indexing-nested-documents.adoc#schema-configuration,working with nested documents>>.
|
||||
|
||||
|PointType |A single-valued n-dimensional point. It's both for sorting spatial data that is _not_ lat-lon, and for some more rare use-cases. (NOTE: this is _not_ related to the "Point" based numeric fields). See <<spatial-search.adoc#spatial-search,Spatial Search>> for more information.
|
||||
|
||||
|PreAnalyzedField |Provides a way to send to Solr serialized token streams, optionally with independent stored values of a field, and have this information stored and indexed without any additional text processing.
|
||||
|
|
@ -65,32 +65,50 @@ Configuration and usage of PreAnalyzedField is documented in the section <<work
|
|||
|
||||
|RandomSortField |Does not contain a value. Queries that sort on this field type will return results in random order. Use a dynamic field to use this feature.
|
||||
|
||||
|RankField |Can be used to store scoring factors to improve document ranking. To be used in combination with <<other-parsers.adoc#ranking-query-parser,RankQParserPlugin>>
|
||||
|
||||
|RptWithGeometrySpatialField |A derivative of `SpatialRecursivePrefixTreeFieldType` that also stores the original geometry. See <<spatial-search.adoc#spatial-search,Spatial Search>> for more information and usage with geospatial results transformer.
|
||||
|
||||
|SortableTextField |A specialized version of TextField that allows (and defaults to) `docValues="true"` for sorting on the first 1024 characters of the original string prior to analysis. The number of characters used for sorting can be overridden with the `maxCharsForDocValues` attribute. See <<common-query-parameters.adoc#sort-parameter,sort parameter discussion>> for details.
|
||||
|
||||
|SpatialRecursivePrefixTreeFieldType |(RPT for short) Accepts latitude comma longitude strings or other shapes in WKT format. See <<spatial-search.adoc#spatial-search,Spatial Search>> for more information.
|
||||
|
||||
|StrField |String (UTF-8 encoded string or Unicode). Strings are intended for small fields and are _not_ tokenized or analyzed in any way. They have a hard limit of slightly less than 32K.
|
||||
|
||||
|SortableTextField |A specialized version of TextField that allows (and defaults to) `docValues="true"` for sorting on the first 1024 characters of the original string prior to analysis. The number of characters used for sorting can be overridden with the `maxCharsForDocValues` attribute.
|
||||
|
||||
|TextField |Text, usually multiple words or tokens.
|
||||
|
||||
|TrieDateField |*Deprecated*. Use DatePointField instead.
|
||||
|
||||
|TrieDoubleField |*Deprecated*. Use DoublePointField instead.
|
||||
|
||||
|TrieFloatField |*Deprecated*. Use FloatPointField instead.
|
||||
|
||||
|TrieIntField |*Deprecated*. Use IntPointField instead.
|
||||
|
||||
|TrieLongField |*Deprecated*. Use LongPointField instead.
|
||||
|
||||
|TrieField |*Deprecated*. This field takes a `type` parameter to define the specific class of Trie* field to use; Use an appropriate Point Field type instead.
|
||||
|TextField |Text, usually multiple words or tokens. In normal usage, only fields of type TextField or SortableTextField will specify an <<analyzers.adoc#analyzers,analyzer>>.
|
||||
|
||||
|UUIDField |Universally Unique Identifier (UUID). Pass in a value of `NEW` and Solr will create a new UUID.
|
||||
|
||||
*Note*: configuring a UUIDField instance with a default value of `NEW` is not advisable for most users when using SolrCloud (and not possible if the UUID value is configured as the unique key field) since the result will be that each replica of each document will get a unique UUID value. Using UUIDUpdateProcessorFactory to generate UUID values when documents are added is recommended instead.
|
||||
*Note*: configuring a UUIDField instance with a default value of `NEW` is not advisable for most users when using SolrCloud (and not possible if the UUID value is configured as the unique key field) since the result will be that each replica of each document will get a unique UUID value. Using <<update-request-processors.adoc#update-request-processors,UUIDUpdateProcessorFactory>> to generate UUID values when documents are added is recommended instead.
|
||||
|===
|
||||
|
||||
== Deprecated field types
|
||||
|
||||
NOTE: All Trie* numeric and date field types have been deprecated in favor of *Point field types.
|
||||
Point field types are better at range queries (speed, memory, disk), however simple field:value queries underperform
|
||||
relative to Trie. Either accept this, or continue to use Trie fields.
|
||||
This shortcoming may be addressed in a future release.
|
||||
|
||||
[cols="25,75",options="header"]
|
||||
|===
|
||||
|Class |Description
|
||||
|
||||
|CurrencyField |Use CurrencyFieldType instead.
|
||||
|
||||
|EnumField |Use EnumFieldType instead.
|
||||
|
||||
|LatLonType |Consider using the LatLonPointSpatialField instead. A single-valued latitude/longitude coordinate pair. Usually it's specified as "lat,lon" order with a comma. See the section <<spatial-search.adoc#spatial-search,Spatial Search>> for more information.
|
||||
|
||||
|TrieDateField |Use DatePointField instead.
|
||||
|
||||
|TrieDoubleField |Use DoublePointField instead.
|
||||
|
||||
|TrieFloatField |Use FloatPointField instead.
|
||||
|
||||
|TrieIntField |Use IntPointField instead.
|
||||
|
||||
|TrieLongField |Use LongPointField instead.
|
||||
|
||||
|TrieField |This field takes a `type` parameter to define the specific class of Trie* field to use; Use an appropriate Point Field type instead.
|
||||
|
||||
|===
|
||||
|
|
|
|||
|
|
@ -1067,6 +1067,17 @@ For easy filter construction to drill down in faceting, the <<Term Query Parser,
|
|||
|
||||
For full analysis on all fields, including text fields, you may want to use the <<Field Query Parser,FieldQParserPlugin>>.
|
||||
|
||||
== Ranking Query Parser
|
||||
|
||||
The `RankQParserPlugin` is a faster implementation of ranking-related features of `FunctionQParser` and can work together with specialized field of {solr-javadocs}/solr-core/org/apache/solr/schema/RankField.html[`RankFields`] type.
|
||||
|
||||
It allows queries like:
|
||||
|
||||
[source,text]
|
||||
----
|
||||
http://localhost:8983/solr/techproducts?q=memory _query_:{!rank f='pagerank', function='log' scalingFactor='1.2'}
|
||||
----
|
||||
|
||||
== Re-Ranking Query Parser
|
||||
|
||||
The `ReRankQParserPlugin` is a special purpose parser for Re-Ranking the top results of a simple query using a more complex ranking query.
|
||||
|
|
|
|||
Loading…
Reference in New Issue