-
Notifications
You must be signed in to change notification settings - Fork 24.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add match_only_text
, a space-efficient variant of text
.
#66172
Changes from 2 commits
0bfd387
6b0cb21
7525e4f
e57699e
9ec31c6
7a03a0f
5774bc9
c0be502
feaf2f8
d51db6c
71adb75
4f33106
24b345e
34743ef
efdb3ba
7114fdc
2030545
96f668b
3a85af4
448eb28
f3e77f8
c5f4f04
4818edc
339c8dc
e652aa4
31a5bba
3783f18
edaa5b0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
[role="xpack"] | ||
[testenv="basic"] | ||
|
||
[discrete] | ||
[[match-only-text]] | ||
=== Match-only text field type | ||
|
||
A variant of <<text,`text`>> that trades scoring and efficiency of positional | ||
queries for space efficiency. This field effectively stores data the same way as | ||
a `text` field that only indexes documents (`index_options: docs`) and disables | ||
norms (`norms: false`). Term queries perform as fast if not faster as on `text` | ||
fields, however queries that need positions such as the | ||
<<query-dsl-match-query-phrase,`match_phrase` query>> perform slower as they | ||
need to look at the `_source` document to verify whether a phrase matches. All | ||
queries return constant scores that are equal to 1.0. | ||
|
||
[source,console] | ||
-------------------------------- | ||
PUT logs | ||
{ | ||
"mappings": { | ||
"properties": { | ||
"@timestamp": { | ||
"type": "date" | ||
}, | ||
"message": { | ||
"type": "match_only_text" | ||
} | ||
} | ||
} | ||
} | ||
-------------------------------- | ||
|
||
`match_only_text` supports the same queries as `text`. And like `text`, it | ||
doesn't support sorting or aggregating. | ||
|
||
[discrete] | ||
[[match-only-text-params]] | ||
==== Parameters for match-only text fields | ||
|
||
The following mapping parameters are accepted: | ||
|
||
[horizontal] | ||
|
||
<<analyzer,`analyzer`>>:: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. One thought I had since reviewing: if this is just targeted at log lines, would it make sense to cut down on analysis config options? For example, not allowing for a different search analyzer or search quote analyzers. Or even removing the option configuring the analyzer, just using a default that targets log lines. This could make it simpler to maintain long BWC for the field type. (This is a rough idea, and I am not sure it makes sense... maybe many users in fact tweak analyzers for log lines.) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Actually I think it's a good call, e.g. as far as I know, ECS doesn't configure analyzers. It would be much easier to add it in the future if it proves needed than to remove it when we want to ease backward compatibility. |
||
|
||
The <<analysis,analyzer>> which should be used for | ||
the `text` field, both at index-time and at | ||
search-time (unless overridden by the <<search-analyzer,`search_analyzer`>>). | ||
Defaults to the default index analyzer, or the | ||
<<analysis-standard-analyzer,`standard` analyzer>>. | ||
|
||
<<multi-fields,`fields`>>:: | ||
|
||
Multi-fields allow the same string value to be indexed in multiple ways for | ||
different purposes, such as one field for search and a multi-field for | ||
sorting and aggregations, or the same string value analyzed by different | ||
analyzers. | ||
|
||
<<mapping-field-meta,`meta`>>:: | ||
|
||
Metadata about the field. | ||
|
||
<<search-analyzer,`search_analyzer`>>:: | ||
|
||
The <<analyzer,`analyzer`>> that should be used at search time on | ||
the `text` field. Defaults to the `analyzer` setting. | ||
|
||
<<search-quote-analyzer,`search_quote_analyzer`>>:: | ||
|
||
The <<analyzer,`analyzer`>> that should be used at search time when a | ||
phrase is encountered. Defaults to the `search_analyzer` setting. | ||
|
||
<<mapping-store,`store`>>:: | ||
|
||
Whether the field value should be stored and retrievable separately from | ||
the <<mapping-source-field,`_source`>> field. Accepts `true` or `false` | ||
(default). | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package org.elasticsearch.common; | ||
|
||
@FunctionalInterface | ||
public interface CheckedIntFunction<T, E extends Exception> { | ||
T apply(int input) throws E; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
apply plugin: 'elasticsearch.esplugin' | ||
apply plugin: 'elasticsearch.internal-cluster-test' | ||
|
||
esplugin { | ||
name 'match-only-text' | ||
description 'Module for the match-only-text field type, which is a specialization of text field for the case when scoring is not needed and space efficiency is important.' | ||
classname 'org.elasticsearch.xpack.matchonlytext.MatchOnlyTextMapperPlugin' | ||
extendedPlugins = ['x-pack-core'] | ||
} | ||
archivesBaseName = 'x-pack-match-only-text' | ||
|
||
dependencies { | ||
compileOnly project(path: xpackModule('core'), configuration: 'default') | ||
internalClusterTestImplementation project(path: xpackModule('core'), configuration: 'testArtifacts') | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We decided to make a single page for the
keyword
type family, so that users could easily compare the trade-offs between each type. It'd be nice to do the same for the new 'text' family'.