Skip to content

Commit

Permalink
Allow _doc as a type. (#27816)
Browse files Browse the repository at this point in the history 
Allowing `_doc` as a type will enable users to make the transition to 7.0
smoother since the index APIs will be `PUT index/_doc/id` and `POST index/_doc`.
This also moves most of the documentation to `_doc` as a type name.

Closes #27750
Closes #27751
  • Loading branch information
@jpountz
jpountz committed Dec 19, 2017
1 parent 0807d12 commit 6113103
Show file tree
Hide file tree
Showing 163 changed files with 885 additions and 909 deletions.
4 changes: 3 additions & 1 deletion core/src/main/java/org/elasticsearch/cluster/metadata/MetaDataMappingService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,9 @@ private ClusterState applyRequest(ClusterState currentState, PutMappingClusterSt
}
assert mappingType != null;

if (!MapperService.DEFAULT_MAPPING.equals(mappingType) && mappingType.charAt(0) == '_') {
if (MapperService.DEFAULT_MAPPING.equals(mappingType) == false
&& MapperService.SINGLE_MAPPING_NAME.equals(mappingType) == false
&& mappingType.charAt(0) == '_') {
throw new InvalidTypeNameException("Document mapping type name can't start with '_', found: [" + mappingType + "]");
}
MetaData.Builder builder = MetaData.builder(metaData);
Expand Down
45 changes: 23 additions & 22 deletions core/src/main/java/org/elasticsearch/index/mapper/MapperService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public enum MergeReason {
}

public static final String DEFAULT_MAPPING = "_default_";
public static final String SINGLE_MAPPING_NAME = "_doc";
public static final Setting<Long> INDEX_MAPPING_NESTED_FIELDS_LIMIT_SETTING =
Setting.longSetting("index.mapping.nested_fields.limit", 50L, 0, Property.Dynamic, Property.IndexScope);
public static final Setting<Long> INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING =
Expand Down Expand Up @@ -352,6 +353,27 @@ private synchronized Map<String, DocumentMapper> internalMerge(Map<String, Compr
return internalMerge(defaultMapper, defaultMappingSource, documentMappers, reason, updateAllTypes);
}

static void validateTypeName(String type) {
if (type.length() == 0) {
throw new InvalidTypeNameException("mapping type name is empty");
}
if (type.length() > 255) {
throw new InvalidTypeNameException("mapping type name [" + type + "] is too long; limit is length 255 but was [" + type.length() + "]");
}
if (type.charAt(0) == '_' && SINGLE_MAPPING_NAME.equals(type) == false) {
throw new InvalidTypeNameException("mapping type name [" + type + "] can't start with '_' unless it is called [" + SINGLE_MAPPING_NAME + "]");
}
if (type.contains("#")) {
throw new InvalidTypeNameException("mapping type name [" + type + "] should not include '#' in it");
}
if (type.contains(",")) {
throw new InvalidTypeNameException("mapping type name [" + type + "] should not include ',' in it");
}
if (type.charAt(0) == '.') {
throw new IllegalArgumentException("mapping type name [" + type + "] must not start with a '.'");
}
}

private synchronized Map<String, DocumentMapper> internalMerge(@Nullable DocumentMapper defaultMapper, @Nullable String defaultMappingSource,
List<DocumentMapper> documentMappers, MergeReason reason, boolean updateAllTypes) {
boolean hasNested = this.hasNested;
Expand All @@ -376,27 +398,10 @@ private synchronized Map<String, DocumentMapper> internalMerge(@Nullable Documen

for (DocumentMapper mapper : documentMappers) {
// check naming
if (mapper.type().length() == 0) {
throw new InvalidTypeNameException("mapping type name is empty");
}
if (mapper.type().length() > 255) {
throw new InvalidTypeNameException("mapping type name [" + mapper.type() + "] is too long; limit is length 255 but was [" + mapper.type().length() + "]");
}
if (mapper.type().charAt(0) == '_') {
throw new InvalidTypeNameException("mapping type name [" + mapper.type() + "] can't start with '_'");
}
if (mapper.type().contains("#")) {
throw new InvalidTypeNameException("mapping type name [" + mapper.type() + "] should not include '#' in it");
}
if (mapper.type().contains(",")) {
throw new InvalidTypeNameException("mapping type name [" + mapper.type() + "] should not include ',' in it");
}
validateTypeName(mapper.type());
if (mapper.type().equals(mapper.parentFieldMapper().type())) {
throw new IllegalArgumentException("The [_parent.type] option can't point to the same type");
}
if (typeNameStartsWithIllegalDot(mapper)) {
throw new IllegalArgumentException("mapping type name [" + mapper.type() + "] must not start with a '.'");
}

// compute the merged DocumentMapper
DocumentMapper oldMapper = mappers.get(mapper.type());
Expand Down Expand Up @@ -539,10 +544,6 @@ private boolean assertMappersShareSameFieldType() {
return true;
}

private boolean typeNameStartsWithIllegalDot(DocumentMapper mapper) {
return mapper.type().startsWith(".");
}

private boolean assertSerialization(DocumentMapper mapper) {
// capture the source now, it may change due to concurrent parsing
final CompressedXContent mappingSource = mapper.mappingSource();
Expand Down
44 changes: 22 additions & 22 deletions core/src/test/java/org/elasticsearch/cluster/metadata/MetaDataTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,11 +241,11 @@ public void testFindMappings() throws IOException {
.put(IndexMetaData.builder("index1")
.settings(Settings.builder().put(IndexMetaData.SETTING_VERSION_CREATED, Version.CURRENT)
.put(IndexMetaData.SETTING_NUMBER_OF_SHARDS, 1).put(IndexMetaData.SETTING_NUMBER_OF_REPLICAS, 0))
.putMapping("doc", FIND_MAPPINGS_TEST_ITEM))
.putMapping("_doc", FIND_MAPPINGS_TEST_ITEM))
.put(IndexMetaData.builder("index2")
.settings(Settings.builder().put(IndexMetaData.SETTING_VERSION_CREATED, Version.CURRENT)
.put(IndexMetaData.SETTING_NUMBER_OF_SHARDS, 1).put(IndexMetaData.SETTING_NUMBER_OF_REPLICAS, 0))
.putMapping("doc", FIND_MAPPINGS_TEST_ITEM)).build();
.putMapping("_doc", FIND_MAPPINGS_TEST_ITEM)).build();

{
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(Strings.EMPTY_ARRAY,
Expand All @@ -266,15 +266,15 @@ public void testFindMappings() throws IOException {
{
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(
new String[]{"index1", "index2"},
new String[]{randomBoolean() ? "doc" : "_all"}, MapperPlugin.NOOP_FIELD_FILTER);
new String[]{randomBoolean() ? "_doc" : "_all"}, MapperPlugin.NOOP_FIELD_FILTER);
assertEquals(2, mappings.size());
assertIndexMappingsNotFiltered(mappings, "index1");
assertIndexMappingsNotFiltered(mappings, "index2");
}
}

public void testFindMappingsNoOpFilters() throws IOException {
MappingMetaData originalMappingMetaData = new MappingMetaData("doc",
MappingMetaData originalMappingMetaData = new MappingMetaData("_doc",
XContentHelper.convertToMap(JsonXContent.jsonXContent, FIND_MAPPINGS_TEST_ITEM, true));

MetaData metaData = MetaData.builder()
Expand All @@ -287,28 +287,28 @@ public void testFindMappingsNoOpFilters() throws IOException {
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(new String[]{"index1"},
randomBoolean() ? Strings.EMPTY_ARRAY : new String[]{"_all"}, MapperPlugin.NOOP_FIELD_FILTER);
ImmutableOpenMap<String, MappingMetaData> index1 = mappings.get("index1");
MappingMetaData mappingMetaData = index1.get("doc");
MappingMetaData mappingMetaData = index1.get("_doc");
assertSame(originalMappingMetaData, mappingMetaData);
}
{
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(new String[]{"index1"},
randomBoolean() ? Strings.EMPTY_ARRAY : new String[]{"_all"}, index -> field -> randomBoolean());
ImmutableOpenMap<String, MappingMetaData> index1 = mappings.get("index1");
MappingMetaData mappingMetaData = index1.get("doc");
MappingMetaData mappingMetaData = index1.get("_doc");
assertNotSame(originalMappingMetaData, mappingMetaData);
}
{
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(new String[]{"index1"},
new String[]{"doc"}, MapperPlugin.NOOP_FIELD_FILTER);
new String[]{"_doc"}, MapperPlugin.NOOP_FIELD_FILTER);
ImmutableOpenMap<String, MappingMetaData> index1 = mappings.get("index1");
MappingMetaData mappingMetaData = index1.get("doc");
MappingMetaData mappingMetaData = index1.get("_doc");
assertSame(originalMappingMetaData, mappingMetaData);
}
{
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(new String[]{"index1"},
new String[]{"doc"}, index -> field -> randomBoolean());
new String[]{"_doc"}, index -> field -> randomBoolean());
ImmutableOpenMap<String, MappingMetaData> index1 = mappings.get("index1");
MappingMetaData mappingMetaData = index1.get("doc");
MappingMetaData mappingMetaData = index1.get("_doc");
assertNotSame(originalMappingMetaData, mappingMetaData);
}
}
Expand All @@ -318,7 +318,7 @@ public void testFindMappingsWithFilters() throws IOException {
String mapping = FIND_MAPPINGS_TEST_ITEM;
if (randomBoolean()) {
Map<String, Object> stringObjectMap = XContentHelper.convertToMap(JsonXContent.jsonXContent, FIND_MAPPINGS_TEST_ITEM, false);
Map<String, Object> doc = (Map<String, Object>)stringObjectMap.get("doc");
Map<String, Object> doc = (Map<String, Object>)stringObjectMap.get("_doc");
try (XContentBuilder builder = JsonXContent.contentBuilder()) {
builder.map(doc);
mapping = builder.string();
Expand All @@ -329,20 +329,20 @@ public void testFindMappingsWithFilters() throws IOException {
.put(IndexMetaData.builder("index1")
.settings(Settings.builder().put(IndexMetaData.SETTING_VERSION_CREATED, Version.CURRENT)
.put(IndexMetaData.SETTING_NUMBER_OF_SHARDS, 1).put(IndexMetaData.SETTING_NUMBER_OF_REPLICAS, 0))
.putMapping("doc", mapping))
.putMapping("_doc", mapping))
.put(IndexMetaData.builder("index2")
.settings(Settings.builder().put(IndexMetaData.SETTING_VERSION_CREATED, Version.CURRENT)
.put(IndexMetaData.SETTING_NUMBER_OF_SHARDS, 1).put(IndexMetaData.SETTING_NUMBER_OF_REPLICAS, 0))
.putMapping("doc", mapping))
.putMapping("_doc", mapping))
.put(IndexMetaData.builder("index3")
.settings(Settings.builder().put(IndexMetaData.SETTING_VERSION_CREATED, Version.CURRENT)
.put(IndexMetaData.SETTING_NUMBER_OF_SHARDS, 1).put(IndexMetaData.SETTING_NUMBER_OF_REPLICAS, 0))
.putMapping("doc", mapping)).build();
.putMapping("_doc", mapping)).build();

{
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(
new String[]{"index1", "index2", "index3"},
new String[]{"doc"}, index -> {
new String[]{"_doc"}, index -> {
if (index.equals("index1")) {
return field -> field.startsWith("name.") == false && field.startsWith("properties.key.") == false
&& field.equals("age") == false && field.equals("address.location") == false;
Expand All @@ -362,7 +362,7 @@ public void testFindMappingsWithFilters() throws IOException {
assertNotNull(index1Mappings);

assertEquals(1, index1Mappings.size());
MappingMetaData docMapping = index1Mappings.get("doc");
MappingMetaData docMapping = index1Mappings.get("_doc");
assertNotNull(docMapping);

Map<String, Object> sourceAsMap = docMapping.getSourceAsMap();
Expand Down Expand Up @@ -406,13 +406,13 @@ public void testFindMappingsWithFilters() throws IOException {
{
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(
new String[]{"index1", "index2" , "index3"},
new String[]{"doc"}, index -> field -> (index.equals("index3") && field.endsWith("keyword")));
new String[]{"_doc"}, index -> field -> (index.equals("index3") && field.endsWith("keyword")));

assertIndexMappingsNoFields(mappings, "index1");
assertIndexMappingsNoFields(mappings, "index2");
ImmutableOpenMap<String, MappingMetaData> index3 = mappings.get("index3");
assertEquals(1, index3.size());
MappingMetaData mappingMetaData = index3.get("doc");
MappingMetaData mappingMetaData = index3.get("_doc");
Map<String, Object> sourceAsMap = mappingMetaData.getSourceAsMap();
assertEquals(3, sourceAsMap.size());
assertTrue(sourceAsMap.containsKey("_routing"));
Expand Down Expand Up @@ -442,7 +442,7 @@ public void testFindMappingsWithFilters() throws IOException {
{
ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = metaData.findMappings(
new String[]{"index1", "index2" , "index3"},
new String[]{"doc"}, index -> field -> (index.equals("index2")));
new String[]{"_doc"}, index -> field -> (index.equals("index2")));

assertIndexMappingsNoFields(mappings, "index1");
assertIndexMappingsNoFields(mappings, "index3");
Expand All @@ -456,7 +456,7 @@ private static void assertIndexMappingsNoFields(ImmutableOpenMap<String, Immutab
ImmutableOpenMap<String, MappingMetaData> indexMappings = mappings.get(index);
assertNotNull(indexMappings);
assertEquals(1, indexMappings.size());
MappingMetaData docMapping = indexMappings.get("doc");
MappingMetaData docMapping = indexMappings.get("_doc");
assertNotNull(docMapping);
Map<String, Object> sourceAsMap = docMapping.getSourceAsMap();
assertEquals(3, sourceAsMap.size());
Expand All @@ -473,7 +473,7 @@ private static void assertIndexMappingsNotFiltered(ImmutableOpenMap<String, Immu
assertNotNull(indexMappings);

assertEquals(1, indexMappings.size());
MappingMetaData docMapping = indexMappings.get("doc");
MappingMetaData docMapping = indexMappings.get("_doc");
assertNotNull(docMapping);

Map<String, Object> sourceAsMap = docMapping.getSourceAsMap();
Expand Down Expand Up @@ -540,7 +540,7 @@ public static void assertMultiField(Map<String, Object> properties, String field
}

private static final String FIND_MAPPINGS_TEST_ITEM = "{\n" +
" \"doc\": {\n" +
" \"_doc\": {\n" +
" \"_routing\": {\n" +
" \"required\":true\n" +
" }," +
Expand Down
6 changes: 3 additions & 3 deletions core/src/test/java/org/elasticsearch/discovery/ClusterDisruptionIT.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ public void testSearchWithRelocationAndSlowClusterStateProcessing() throws Excep
final String node_2 = internalCluster().startDataOnlyNode();
List<IndexRequestBuilder> indexRequestBuilderList = new ArrayList<>();
for (int i = 0; i < 100; i++) {
indexRequestBuilderList.add(client().prepareIndex().setIndex("test").setType("doc")
indexRequestBuilderList.add(client().prepareIndex().setIndex("test").setType("_doc")
.setSource("{\"int_field\":1}", XContentType.JSON));
}
indexRandom(true, indexRequestBuilderList);
Expand All @@ -398,7 +398,7 @@ public void testIndexImportedFromDataOnlyNodesIfMasterLostDataFolder() throws Ex

ensureStableCluster(2);
assertAcked(prepareCreate("index").setSettings(Settings.builder().put("index.number_of_replicas", 0)));
index("index", "doc", "1", jsonBuilder().startObject().field("text", "some text").endObject());
index("index", "_doc", "1", jsonBuilder().startObject().field("text", "some text").endObject());
ensureGreen();

internalCluster().restartNode(masterNode, new InternalTestCluster.RestartCallback() {
Expand All @@ -409,7 +409,7 @@ public boolean clearData(String nodeName) {
});

ensureGreen("index");
assertTrue(client().prepareGet("index", "doc", "1").get().isExists());
assertTrue(client().prepareGet("index", "_doc", "1").get().isExists());
}

/**
Expand Down
Loading

0 comments on commit 6113103

Please sign in to comment.