Skip to content
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.

Sign up for GitHub

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

Elastic 7.x compatibility #5

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Elastic 7.x compatibility #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a203f9b
Migrated the code to support latest e.s - 7.3.1
jpvelsamy Nov 14, 2019
d146efa
upgrade to elastic 7.x
Mar 26, 2020
cd6dd6a
fixup! upgrade to elastic 7.x mappings only have one type remove _parent
Mar 26, 2020
bd3b68d
add default analyser on ElasticTokenCountField
Mar 26, 2020
568020b
remove _all
Mar 26, 2020
19bbd15
remove includeInAll
Mar 26, 2020
e5997dc
remove nullValue from Numeric
Mar 26, 2020
c562f88
remove nullValue from Numeric from README.md
Mar 26, 2020
37b0482
MappingBuilderTest build2 is valid against elasticsearch
Mar 26, 2020
9402923
remove ElasticDocument
Mar 26, 2020
8dbb1b3
update README.md
Mar 26, 2020
2263e17
update README.md
Mar 26, 2020
88d8518
add example usage with scala
Mar 26, 2020
5f183ce
reduce dependencies to org.elasticsearch:elasticsearch-x-content inst…
Apr 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 61 additions & 86 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,28 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/778eee87938f43ca92a94b7b613a0891)](https://www.codacy.com/app/frekele/elasticsearch-mapping-builder?utm_source=github.com&utm_medium=referral&utm_content=frekele/elasticsearch-mapping-builder&utm_campaign=Badge_Coverage)


Built-based on the documentation: [https://www.elastic.co/guide/en/elasticsearch/reference/5.x/mapping.html](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/mapping.html)
Built-based on the documentation: [https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html)

#### Compatibility:

| Elasticsearch Mapping Builder | Elasticsearch |
| ------------------------------| ---------------------- |
| Version: 1.0.7 | Version: 5.x.x |
| Elasticsearch Mapping Builder | Elasticsearch |
| ------------------------------| ---------------------------------------------------------------------------------------- |
| Version: 1.0.7 | Version: [5.x](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/mapping.html) |
| Version: 1.1.0 | Version: [7.x](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/mapping.html) |


#### Maven dependency:
```xml
<dependency>
<groupId>org.frekele.elasticsearch</groupId>
<artifactId>elasticsearch-mapping-builder</artifactId>
<version>1.0.7</version>
<version>1.1.0</version>
</dependency>
```

#### Gradle dependency:
```gradle
implementation 'org.frekele.elasticsearch:elasticsearch-mapping-builder:1.0.7'
implementation 'org.frekele.elasticsearch:elasticsearch-mapping-builder:1.1.0'
```

#### Build
Expand Down Expand Up @@ -60,7 +61,6 @@ public String getMapping() {
```

```java
@ElasticDocument("book")
public class BookEntity {

@ElasticKeywordField
Expand Down Expand Up @@ -89,7 +89,6 @@ public class BookEntity {
.........
}

@ElasticDocument(value = "author")
public class AuthorEntity {

@ElasticLongField
Expand All @@ -106,13 +105,13 @@ public class AuthorEntity {
}
```

**Person parent and Employee:**
**Employee:**
```java
@Inject
MappingBuilder mappingBuilder;

public String getMapping() {
return mappingBuilder.build(PersonEntity.class, EmployeeEntity.class).getContentAsString();
return mappingBuilder.build(EmployeeEntity.class).getContentAsString();
}
```

Expand All @@ -133,32 +132,6 @@ public class AddressEntity {
.........
}

public class PersonEntity {

@ElasticLongField
private Long id;

@ElasticTextField
@ElasticKeywordField
private String name;

@ElasticTextField
@ElasticKeywordField
private String fullName;

@ElasticTextField(copyTo = {"name", "fullName"})
private String fistName;

@ElasticTextField(copyTo = {"fullName"})
private String lastName;

@ElasticObjectField
private List<AddressEntity> multipleAddress;

.........
}

@ElasticDocument(value = "employee", parent = "person")
public class EmployeeEntity {

@ElasticLongField
Expand All @@ -177,26 +150,6 @@ public class EmployeeEntity {

#### Annotations parameters:

###### ElasticDocument
```java
@ElasticDocument(
value = "my_doc_type",
dynamic = @BoolValue(true),
includeInAll = @BoolValue(true),
parent = "my_parent_doc_type",
//add eager_global_ordinals into _parent
eagerGlobalOrdinalsParent = @BoolValue(true),
enabledAll = @BoolValue(true),
//add store into _all
storeAll = @BoolValue(true),
//add required into _routing
requiredRouting = @BoolValue(true)
)
public class MyDocumentEntity {
.........
```


###### ElasticBinaryField
```java
@ElasticBinaryField(
Expand All @@ -212,7 +165,6 @@ private String binaryValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true))
private Boolean booleanValue;
```
Expand All @@ -225,9 +177,7 @@ private Boolean booleanValue;
boost = @FloatValue(0.2f),
docValues = @BoolValue(true),
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
)
private Byte byteValue;
Expand Down Expand Up @@ -255,7 +205,6 @@ private String completionValue;
format = "basic_date_time",
locale = "en-US",
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
Expand All @@ -272,7 +221,6 @@ private Date dateValue;
format = "basic_date_time",
locale = "en-US",
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
Expand All @@ -288,9 +236,7 @@ private Date dateRangeValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
)
private Double doubleValue;
Expand All @@ -302,7 +248,6 @@ private Double doubleValue;
suffixName = "doubleRange",
coerce = @BoolValue(true),
boost = @FloatValue(1),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
store = @BoolValue(true)
)
Expand All @@ -317,9 +262,7 @@ private Double doubleRangeValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
)
private Float floatValue;
Expand All @@ -331,7 +274,6 @@ private Float floatValue;
suffixName = "floatRange",
coerce = @BoolValue(true),
boost = @FloatValue(1),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
store = @BoolValue(true)
)
Expand Down Expand Up @@ -370,9 +312,7 @@ private String geoShapeValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
)
private Float halfFloatValue;
Expand All @@ -386,9 +326,7 @@ private Float halfFloatValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
)
private Integer integerValue;
Expand All @@ -400,7 +338,6 @@ private Integer integerValue;
suffixName = "integerRange",
coerce = @BoolValue(true),
boost = @FloatValue(1),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
store = @BoolValue(true)
)
Expand All @@ -413,7 +350,6 @@ private Integer integerRangeValue;
suffixName = "ip",
boost = @FloatValue(1),
docValues = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
Expand All @@ -427,7 +363,6 @@ private String ipValue;
suffixName = "ipRange",
coerce = @BoolValue(true),
boost = @FloatValue(1),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
store = @BoolValue(true)
)
Expand All @@ -443,7 +378,6 @@ private String ipRangeValue;
docValues = @BoolValue(true),
eagerGlobalOrdinals = @BoolValue(true),
ignoreAbove = @IntValue(350),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
indexOptions = "docs",
norms = @BoolValue(true),
Expand All @@ -463,9 +397,7 @@ private String keywordValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
)
private Long longValue;
Expand All @@ -477,7 +409,6 @@ private Long longValue;
suffixName = "longRange",
coerce = @BoolValue(true),
boost = @FloatValue(1),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
store = @BoolValue(true)
)
Expand All @@ -500,9 +431,7 @@ private String percolatorValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true),
scalingFactor = @IntValue(100)
)
Expand All @@ -517,9 +446,7 @@ private Float scaledFloatValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
ignoreMalformed = @BoolValue(true),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
)
private Short shortValue;
Expand All @@ -538,7 +465,6 @@ private Short shortValue;
max = @FloatValue(0.1f),
minSegmentSize = @IntValue(500)
),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
indexOptions = "",
norms = @BoolValue(true),
Expand All @@ -562,7 +488,6 @@ private String textValue;
boost = @FloatValue(1),
docValues = @BoolValue(true),
index = @BoolValue(true),
includeInAll = @BoolValue(true),
nullValue = "NULL",
store = @BoolValue(true)
)
Expand Down Expand Up @@ -609,7 +534,6 @@ private String customValue;
max = @FloatValue(0.1f),
minSegmentSize = @IntValue(500)
),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
indexOptions = "",
norms = @BoolValue(true),
Expand All @@ -628,7 +552,6 @@ private String customValue;
docValues = @BoolValue(true),
eagerGlobalOrdinals = @BoolValue(true),
ignoreAbove = @IntValue(350),
includeInAll = @BoolValue(true),
index = @BoolValue(true),
indexOptions = "docs",
norms = @BoolValue(true),
Expand All @@ -648,6 +571,58 @@ private String customValue;
private String multiFieldValue;
```

#### Example usage with Scala:
```scala
import java.time.OffsetDateTime

import org.frekele.elasticsearch.mapping.MappingBuilderImpl
import org.frekele.elasticsearch.mapping.annotations._
import org.frekele.elasticsearch.mapping.annotations.values.IntValue

import scala.annotation.meta.field

case class BookEntity(
@(ElasticKeywordField@field)
isbn: String,

@(ElasticTextField@field)
@(ElasticKeywordField@field)(ignoreAbove = new IntValue(256))
@(ElasticCompletionField@field)
name: String,

@(ElasticTextField@field)
description: String,

@(ElasticDateField@field)
releaseDate: OffsetDateTime,

@(ElasticBooleanField@field)
active: Boolean,

@(ElasticBinaryField@field)
imageBlob: String,

@(ElasticObjectField@field)
author: AuthorEntity
)

case class AuthorEntity(
@(ElasticLongField@field)
id: Long,

@(ElasticTextField@field)
name: String,

@(ElasticTextField@field)
@(ElasticKeywordField@field)
artisticName: String
)

object Main extends App {
println(new MappingBuilderImpl().build(true, classOf[BookEntity]).getContentAsString)
}
```

## License
```
Copyright © 2017-2019 - @frekele<Leandro Kersting de Freitas>
Expand Down
Loading