Skip to content

Commit b2fa5f5

Browse files
committed
[MODEL] Tweak STI deprecation description
1 parent f188c65 commit b2fa5f5

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

elasticsearch-model/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -745,13 +745,14 @@ SERVER=start TEST_CLUSTER_COMMAND=$PWD/tmp/elasticsearch-1.0.0.RC1/bin/elasticse
745745

746746
### Single Table Inheritance deprecation
747747

748-
`Single Table Inheritance` has been supported until the 6.x series of this gem. With this feature,
749-
settings on a parent model could be inherited by a child model leading to different model documents being indexed
750-
into the same Elasticsearch index. This feature depended on the ability to set a `type` for a document in Elasticsearch.
751-
The Elasticsearch team has deprecated support for `types`, as is described [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html)
752-
This gem will also remove support for types and Single Table Inheritance in version 7.0 as it encourages an anti-pattern.
753-
Please save different model documents in separate indices or implement an artificial `type` field manually in each
754-
document.
748+
`Single Table Inheritance` has been supported through the 6.x series of this gem. With this feature,
749+
elasticsearch settings (index mappings, etc) on a parent model could be inherited by a child model leading to different
750+
model documents being indexed into the same Elasticsearch index. This feature depended on the ability to set a `type`
751+
for a document in Elasticsearch. The Elasticsearch team has deprecated support for `types`, as is described
752+
[here.](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html)
753+
This gem will also remove support for types and `Single Table Inheritance` in version 7.0 as it enables an anti-pattern.
754+
Please save different model documents in separate indices. If you want to use STI, you can include an artificial
755+
`type` field manually in each document and use it in other operations.
755756

756757
## License
757758

0 commit comments

Comments
 (0)