Skip to content

Commit eda9755

Browse files
not: rename doc values sparse index to doc values skipper
1 parent 3015eb2 commit eda9755

File tree

5 files changed

+52
-49
lines changed

5 files changed

+52
-49
lines changed

server/src/main/java/org/elasticsearch/common/settings/IndexScopedSettings.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,8 @@ public final class IndexScopedSettings extends AbstractScopedSettings {
235235
)
236236
);
237237

238-
if (IndexSettings.DOC_VALUES_SPARSE_INDEX.isEnabled()) {
239-
settings.add(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX);
238+
if (IndexSettings.DOC_VALUES_SKIPPER.isEnabled()) {
239+
settings.add(IndexSettings.USE_DOC_VALUES_SKIPPER);
240240
}
241241
BUILT_IN_INDEX_SETTINGS = Collections.unmodifiableSet(settings);
242242
};

server/src/main/java/org/elasticsearch/index/IndexSettings.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -685,10 +685,10 @@ public boolean isES87TSDBCodecEnabled() {
685685
Property.Final
686686
);
687687

688-
public static final FeatureFlag DOC_VALUES_SPARSE_INDEX = new FeatureFlag("doc_values_sparse_index");
689-
public static final Setting<Boolean> USE_DOC_VALUES_SPARSE_INDEX = Setting.boolSetting(
690-
"index.mapping.use_doc_values_sparse_index",
691-
IndexSettings.DOC_VALUES_SPARSE_INDEX.isEnabled(),
688+
public static final FeatureFlag DOC_VALUES_SKIPPER = new FeatureFlag("doc_values_skipper");
689+
public static final Setting<Boolean> USE_DOC_VALUES_SKIPPER = Setting.boolSetting(
690+
"index.mapping.use_doc_values_skipper",
691+
IndexSettings.DOC_VALUES_SKIPPER.isEnabled(),
692692
Property.IndexScope,
693693
Property.Final
694694
);
@@ -930,7 +930,7 @@ private void setRetentionLeaseMillis(final TimeValue retentionLease) {
930930
private final SourceFieldMapper.Mode indexMappingSourceMode;
931931
private final boolean recoverySourceEnabled;
932932
private final boolean recoverySourceSyntheticEnabled;
933-
private final boolean useDocValuesSparseIndex;
933+
private final boolean useDocValuesSkipper;
934934

935935
/**
936936
* The maximum number of refresh listeners allows on this shard.
@@ -1112,7 +1112,7 @@ public IndexSettings(final IndexMetadata indexMetadata, final Settings nodeSetti
11121112
recoverySourceEnabled = RecoverySettings.INDICES_RECOVERY_SOURCE_ENABLED_SETTING.get(nodeSettings);
11131113
recoverySourceSyntheticEnabled = DiscoveryNode.isStateless(nodeSettings) == false
11141114
&& scopedSettings.get(RECOVERY_USE_SYNTHETIC_SOURCE_SETTING);
1115-
useDocValuesSparseIndex = DOC_VALUES_SPARSE_INDEX.isEnabled() && scopedSettings.get(USE_DOC_VALUES_SPARSE_INDEX);
1115+
useDocValuesSkipper = DOC_VALUES_SKIPPER.isEnabled() && scopedSettings.get(USE_DOC_VALUES_SKIPPER);
11161116
if (recoverySourceSyntheticEnabled) {
11171117
if (DiscoveryNode.isStateless(settings)) {
11181118
throw new IllegalArgumentException("synthetic recovery source is only allowed in stateful");
@@ -1832,8 +1832,8 @@ public boolean isRecoverySourceSyntheticEnabled() {
18321832
return recoverySourceSyntheticEnabled;
18331833
}
18341834

1835-
public boolean useDocValuesSparseIndex() {
1836-
return useDocValuesSparseIndex;
1835+
public boolean useDocValuesSkipper() {
1836+
return useDocValuesSkipper;
18371837
}
18381838

18391839
/**

server/src/main/java/org/elasticsearch/index/mapper/KeywordFieldMapper.java

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484
import static org.apache.lucene.index.IndexWriter.MAX_TERM_LENGTH;
8585
import static org.elasticsearch.core.Strings.format;
8686
import static org.elasticsearch.index.IndexSettings.IGNORE_ABOVE_SETTING;
87-
import static org.elasticsearch.index.IndexSettings.USE_DOC_VALUES_SPARSE_INDEX;
87+
import static org.elasticsearch.index.IndexSettings.USE_DOC_VALUES_SKIPPER;
8888

8989
/**
9090
* A field mapper for keywords. This mapper accepts strings and indexes them as-is.
@@ -202,7 +202,7 @@ public static final class Builder extends FieldMapper.DimensionBuilder {
202202
private final IndexAnalyzers indexAnalyzers;
203203
private final ScriptCompiler scriptCompiler;
204204
private final IndexVersion indexCreatedVersion;
205-
private final boolean useDocValuesSparseIndex;
205+
private final boolean useDocValuesSkipper;
206206

207207
public Builder(final String name, final MappingParserContext mappingParserContext) {
208208
this(
@@ -213,7 +213,7 @@ public Builder(final String name, final MappingParserContext mappingParserContex
213213
mappingParserContext.getIndexSettings().getIndexVersionCreated(),
214214
mappingParserContext.getIndexSettings().getMode(),
215215
mappingParserContext.getIndexSettings().getIndexSortConfig(),
216-
USE_DOC_VALUES_SPARSE_INDEX.get(mappingParserContext.getSettings())
216+
USE_DOC_VALUES_SKIPPER.get(mappingParserContext.getSettings())
217217
);
218218
}
219219

@@ -235,7 +235,7 @@ private Builder(
235235
IndexVersion indexCreatedVersion,
236236
IndexMode indexMode,
237237
IndexSortConfig indexSortConfig,
238-
boolean useDocValuesSparseIndex
238+
boolean useDocValuesSkipper
239239
) {
240240
super(name);
241241
this.indexAnalyzers = indexAnalyzers;
@@ -272,7 +272,7 @@ private Builder(
272272
});
273273
this.indexSortConfig = indexSortConfig;
274274
this.indexMode = indexMode;
275-
this.useDocValuesSparseIndex = useDocValuesSparseIndex;
275+
this.useDocValuesSkipper = useDocValuesSkipper;
276276
}
277277

278278
public Builder(String name, IndexVersion indexCreatedVersion) {
@@ -400,7 +400,7 @@ private KeywordFieldType buildFieldType(MapperBuilderContext context, FieldType
400400
@Override
401401
public KeywordFieldMapper build(MapperBuilderContext context) {
402402
FieldType fieldtype = resolveFieldType(
403-
useDocValuesSparseIndex,
403+
useDocValuesSkipper,
404404
indexCreatedVersion,
405405
indexSortConfig,
406406
indexMode,
@@ -428,27 +428,27 @@ public KeywordFieldMapper build(MapperBuilderContext context) {
428428
buildFieldType(context, fieldtype),
429429
builderParams(this, context),
430430
context.isSourceSynthetic(),
431-
useDocValuesSparseIndex,
431+
useDocValuesSkipper,
432432
this
433433
);
434434
}
435435

436436
private FieldType resolveFieldType(
437-
final boolean useDocValuesSparseIndex,
437+
final boolean useDocValuesSkipper,
438438
final IndexVersion indexCreatedVersion,
439439
final IndexSortConfig indexSortConfig,
440440
final IndexMode indexMode,
441441
final String fullFieldName
442442
) {
443-
if (useDocValuesSparseIndex
443+
if (useDocValuesSkipper
444444
&& indexCreatedVersion.onOrAfter(IndexVersions.HOSTNAME_DOC_VALUES_SPARSE_INDEX)
445-
&& shouldUseDocValuesSparseIndex(hasDocValues.getValue(), indexSortConfig, indexMode, fullFieldName)) {
445+
&& shouldUseDocValuesSkipper(hasDocValues.getValue(), indexSortConfig, indexMode, fullFieldName)) {
446446
return new FieldType(Defaults.FIELD_TYPE_WITH_SKIP_DOC_VALUES);
447447
}
448448
return new FieldType(Defaults.FIELD_TYPE);
449449
}
450450

451-
private static boolean shouldUseDocValuesSparseIndex(
451+
private static boolean shouldUseDocValuesSkipper(
452452
final boolean hasDocValues,
453453
final IndexSortConfig indexSortConfig,
454454
final IndexMode indexMode,
@@ -478,7 +478,7 @@ public static final class KeywordFieldType extends StringFieldType {
478478
private final boolean isSyntheticSource;
479479
private final IndexMode indexMode;
480480
private final IndexSortConfig indexSortConfig;
481-
private final boolean hasDocValuesSparseIndex;
481+
private final boolean hasDocValuesSkipper;
482482

483483
public KeywordFieldType(
484484
String name,
@@ -506,7 +506,7 @@ public KeywordFieldType(
506506
this.isSyntheticSource = isSyntheticSource;
507507
this.indexMode = builder.indexMode;
508508
this.indexSortConfig = builder.indexSortConfig;
509-
this.hasDocValuesSparseIndex = DocValuesSkipIndexType.NONE.equals(fieldType.docValuesSkipIndexType()) == false;
509+
this.hasDocValuesSkipper = DocValuesSkipIndexType.NONE.equals(fieldType.docValuesSkipIndexType()) == false;
510510
}
511511

512512
public KeywordFieldType(String name, boolean isIndexed, boolean hasDocValues, Map<String, String> meta) {
@@ -520,7 +520,7 @@ public KeywordFieldType(String name, boolean isIndexed, boolean hasDocValues, Ma
520520
this.isSyntheticSource = false;
521521
this.indexMode = IndexMode.STANDARD;
522522
this.indexSortConfig = null;
523-
this.hasDocValuesSparseIndex = false;
523+
this.hasDocValuesSkipper = false;
524524
}
525525

526526
public KeywordFieldType(String name) {
@@ -545,7 +545,7 @@ public KeywordFieldType(String name, FieldType fieldType) {
545545
this.isSyntheticSource = false;
546546
this.indexMode = IndexMode.STANDARD;
547547
this.indexSortConfig = null;
548-
this.hasDocValuesSparseIndex = DocValuesSkipIndexType.NONE.equals(fieldType.docValuesSkipIndexType()) == false;
548+
this.hasDocValuesSkipper = DocValuesSkipIndexType.NONE.equals(fieldType.docValuesSkipIndexType()) == false;
549549
}
550550

551551
public KeywordFieldType(String name, NamedAnalyzer analyzer) {
@@ -559,7 +559,7 @@ public KeywordFieldType(String name, NamedAnalyzer analyzer) {
559559
this.isSyntheticSource = false;
560560
this.indexMode = IndexMode.STANDARD;
561561
this.indexSortConfig = null;
562-
this.hasDocValuesSparseIndex = false;
562+
this.hasDocValuesSkipper = false;
563563
}
564564

565565
@Override
@@ -1007,8 +1007,8 @@ public IndexSortConfig getIndexSortConfig() {
10071007
return indexSortConfig;
10081008
}
10091009

1010-
public boolean hasDocValuesSparseIndex() {
1011-
return hasDocValuesSparseIndex;
1010+
public boolean hasDocValuesSkipper() {
1011+
return hasDocValuesSkipper;
10121012
}
10131013
}
10141014

@@ -1027,15 +1027,15 @@ public boolean hasDocValuesSparseIndex() {
10271027
private final int ignoreAboveDefault;
10281028
private final IndexMode indexMode;
10291029
private final IndexSortConfig indexSortConfig;
1030-
private final boolean useDocValuesSParseIndex;
1030+
private final boolean useDocValuesSkipper;
10311031

10321032
private KeywordFieldMapper(
10331033
String simpleName,
10341034
FieldType fieldType,
10351035
KeywordFieldType mappedFieldType,
10361036
BuilderParams builderParams,
10371037
boolean isSyntheticSource,
1038-
boolean useDocValuesSParseIndex,
1038+
boolean useDocValuesSkipper,
10391039
Builder builder
10401040
) {
10411041
super(simpleName, mappedFieldType, builderParams);
@@ -1054,7 +1054,7 @@ private KeywordFieldMapper(
10541054
this.ignoreAboveDefault = builder.ignoreAboveDefault;
10551055
this.indexMode = builder.indexMode;
10561056
this.indexSortConfig = builder.indexSortConfig;
1057-
this.useDocValuesSParseIndex = useDocValuesSParseIndex;
1057+
this.useDocValuesSkipper = useDocValuesSkipper;
10581058
}
10591059

10601060
@Override
@@ -1180,7 +1180,7 @@ public FieldMapper.Builder getMergeBuilder() {
11801180
indexCreatedVersion,
11811181
indexMode,
11821182
indexSortConfig,
1183-
useDocValuesSParseIndex
1183+
useDocValuesSkipper
11841184
).dimension(fieldType().isDimension()).init(this);
11851185
}
11861186

server/src/test/java/org/elasticsearch/index/mapper/KeywordFieldMapperTests.java

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,7 @@ public void testFieldTypeWithSkipDocValues_LogsDbModeDisabledSetting() throws IO
777777
Settings.builder()
778778
.put(IndexSettings.MODE.getKey(), IndexMode.LOGSDB.name())
779779
.put(IndexSortConfig.INDEX_SORT_FIELD_SETTING.getKey(), "host.name")
780-
.put(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.getKey(), false)
780+
.put(IndexSettings.USE_DOC_VALUES_SKIPPER.getKey(), false)
781781
.build(),
782782
mapping(b -> {
783783
b.startObject("host.name");
@@ -789,7 +789,7 @@ public void testFieldTypeWithSkipDocValues_LogsDbModeDisabledSetting() throws IO
789789
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
790790
assertTrue(mapper.fieldType().hasDocValues());
791791
assertTrue(mapper.fieldType().isIndexed());
792-
assertFalse(mapper.fieldType().hasDocValuesSparseIndex());
792+
assertFalse(mapper.fieldType().hasDocValuesSkipper());
793793
}
794794

795795
public void testFieldTypeWithSkipDocValues_LogsDbMode() throws IOException {
@@ -805,8 +805,8 @@ public void testFieldTypeWithSkipDocValues_LogsDbMode() throws IOException {
805805

806806
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
807807
assertTrue(mapper.fieldType().hasDocValues());
808-
assertFalse(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings) && mapper.fieldType().isIndexed());
809-
assertEquals(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings), mapper.fieldType().hasDocValuesSparseIndex());
808+
assertFalse(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings) && mapper.fieldType().isIndexed());
809+
assertEquals(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings), mapper.fieldType().hasDocValuesSkipper());
810810
}
811811

812812
public void testFieldTypeDefault_StandardMode() throws IOException {
@@ -823,7 +823,7 @@ public void testFieldTypeDefault_StandardMode() throws IOException {
823823
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
824824
assertTrue(mapper.fieldType().hasDocValues());
825825
assertTrue(mapper.fieldType().isIndexed());
826-
assertFalse(mapper.fieldType().hasDocValuesSparseIndex());
826+
assertFalse(mapper.fieldType().hasDocValuesSkipper());
827827
}
828828

829829
public void testFieldTypeDefault_NonMatchingFieldName() throws IOException {
@@ -840,7 +840,7 @@ public void testFieldTypeDefault_NonMatchingFieldName() throws IOException {
840840
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("hostname");
841841
assertTrue(mapper.fieldType().hasDocValues());
842842
assertTrue(mapper.fieldType().isIndexed());
843-
assertFalse(mapper.fieldType().hasDocValuesSparseIndex());
843+
assertFalse(mapper.fieldType().hasDocValuesSkipper());
844844
}
845845

846846
public void testFieldTypeDefault_ConfiguredIndexedWithSettingOverride() throws IOException {
@@ -857,8 +857,8 @@ public void testFieldTypeDefault_ConfiguredIndexedWithSettingOverride() throws I
857857

858858
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
859859
assertTrue(mapper.fieldType().hasDocValues());
860-
assertFalse(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings) && mapper.fieldType().isIndexed());
861-
assertEquals(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings), mapper.fieldType().hasDocValuesSparseIndex());
860+
assertFalse(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings) && mapper.fieldType().isIndexed());
861+
assertEquals(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings), mapper.fieldType().hasDocValuesSkipper());
862862
}
863863

864864
public void testFieldTypeDefault_ConfiguredIndexedWithoutSettingOverride() throws IOException {
@@ -875,8 +875,8 @@ public void testFieldTypeDefault_ConfiguredIndexedWithoutSettingOverride() throw
875875

876876
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
877877
assertTrue(mapper.fieldType().hasDocValues());
878-
assertFalse(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings) && mapper.fieldType().isIndexed());
879-
assertEquals(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings), mapper.fieldType().hasDocValuesSparseIndex());
878+
assertFalse(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings) && mapper.fieldType().isIndexed());
879+
assertEquals(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings), mapper.fieldType().hasDocValuesSkipper());
880880
}
881881

882882
public void testFieldTypeDefault_ConfiguredDocValues() throws IOException {
@@ -893,14 +893,14 @@ public void testFieldTypeDefault_ConfiguredDocValues() throws IOException {
893893

894894
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
895895
assertTrue(mapper.fieldType().hasDocValues());
896-
assertFalse(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings) && mapper.fieldType().isIndexed());
897-
assertEquals(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings), mapper.fieldType().hasDocValuesSparseIndex());
896+
assertFalse(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings) && mapper.fieldType().isIndexed());
897+
assertEquals(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings), mapper.fieldType().hasDocValuesSkipper());
898898
}
899899

900900
public void testFieldTypeDefault_LogsDbMode_NonSortField() throws IOException {
901901
final Settings settings = Settings.builder()
902902
.put(IndexSettings.MODE.getKey(), IndexMode.LOGSDB.name())
903-
.put(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.getKey(), true)
903+
.put(IndexSettings.USE_DOC_VALUES_SKIPPER.getKey(), true)
904904
.build();
905905
final MapperService mapperService = createMapperService(settings, mapping(b -> {
906906
b.startObject("host.name");
@@ -911,7 +911,7 @@ public void testFieldTypeDefault_LogsDbMode_NonSortField() throws IOException {
911911
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
912912
assertTrue(mapper.fieldType().hasDocValues());
913913
assertTrue(mapper.fieldType().isIndexed());
914-
assertFalse(mapper.fieldType().hasDocValuesSparseIndex());
914+
assertFalse(mapper.fieldType().hasDocValuesSkipper());
915915
}
916916

917917
public void testFieldTypeWithSkipDocValues_IndexedFalseDocValuesTrue() throws IOException {
@@ -929,8 +929,8 @@ public void testFieldTypeWithSkipDocValues_IndexedFalseDocValuesTrue() throws IO
929929

930930
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
931931
assertTrue(mapper.fieldType().hasDocValues());
932-
assertFalse(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings) && mapper.fieldType().isIndexed());
933-
assertEquals(IndexSettings.USE_DOC_VALUES_SPARSE_INDEX.get(settings), mapper.fieldType().hasDocValuesSparseIndex());
932+
assertFalse(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings) && mapper.fieldType().isIndexed());
933+
assertEquals(IndexSettings.USE_DOC_VALUES_SKIPPER.get(settings), mapper.fieldType().hasDocValuesSkipper());
934934
}
935935

936936
public void testFieldTypeDefault_IndexedFalseDocValuesFalse() throws IOException {
@@ -949,6 +949,6 @@ public void testFieldTypeDefault_IndexedFalseDocValuesFalse() throws IOException
949949
final KeywordFieldMapper mapper = (KeywordFieldMapper) mapperService.documentMapper().mappers().getMapper("host.name");
950950
assertFalse(mapper.fieldType().hasDocValues());
951951
assertFalse(mapper.fieldType().isIndexed());
952-
assertFalse(mapper.fieldType().hasDocValuesSparseIndex());
952+
assertFalse(mapper.fieldType().hasDocValuesSkipper());
953953
}
954954
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
package org.elasticsearch.xpack.logsdb;
2+
3+
public class KeywordFieldMapperTests {}

0 commit comments

Comments
 (0)