org.elasticsearch.index.mapper.AllFieldMapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.index.mapper;
import org.apache.lucene.document.FieldType;
import org.apache.lucene.index.IndexOptions;
import org.apache.lucene.search.MatchNoDocsQuery;
import org.apache.lucene.search.Query;
import org.elasticsearch.common.Explicit;
import org.elasticsearch.index.query.SearchExecutionContext;
import java.util.Collections;
import java.util.List;
/**
* Noop mapper that ensures that mappings created in 6x that explicitly disable the _all field
* can be restored in this version.
*
* TODO: Remove in 8
*/
public class AllFieldMapper extends MetadataFieldMapper {
public static final String NAME = "_all";
public static final String CONTENT_TYPE = "_all";
public static class Defaults {
public static final FieldType FIELD_TYPE = new FieldType();
static {
FIELD_TYPE.setIndexOptions(IndexOptions.DOCS_AND_FREQS_AND_POSITIONS);
FIELD_TYPE.setTokenized(true);
FIELD_TYPE.freeze();
}
}
private static AllFieldMapper toType(FieldMapper in) {
return (AllFieldMapper) in;
}
public static class Builder extends MetadataFieldMapper.Builder {
private final Parameter> enabled = updateableBoolParam("enabled", m -> toType(m).enabled, false);
public Builder() {
super(NAME);
}
@Override
protected List> getParameters() {
return Collections.singletonList(enabled);
}
@Override
public AllFieldMapper build() {
if (enabled.getValue().value()) {
throw new IllegalArgumentException("[_all] is disabled in this version.");
}
return new AllFieldMapper(enabled.getValue());
}
}
public static final TypeParser PARSER = new ConfigurableTypeParser(
c -> new AllFieldMapper(new Explicit<>(false, false)),
c -> new Builder()
);
static final class AllFieldType extends StringFieldType {
AllFieldType() {
super(NAME, false, false, false, TextSearchInfo.NONE, Collections.emptyMap());
}
@Override
public ValueFetcher valueFetcher(SearchExecutionContext context, String format) {
throw new UnsupportedOperationException();
}
@Override
public String typeName() {
return CONTENT_TYPE;
}
@Override
public Query existsQuery(SearchExecutionContext context) {
return new MatchNoDocsQuery();
}
}
private final Explicit enabled;
private AllFieldMapper(Explicit enabled) {
super(new AllFieldType());
this.enabled = enabled;
}
@Override
protected String contentType() {
return CONTENT_TYPE;
}
@Override
public FieldMapper.Builder getMergeBuilder() {
return new Builder().init(this);
}
}