Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xrobert35/es-mapping-ts
Generate ES mapping through typescript decorator
https://github.com/xrobert35/es-mapping-ts
decorators elasticsearch mapping typescript
Last synced: 3 months ago
JSON representation
Generate ES mapping through typescript decorator
- Host: GitHub
- URL: https://github.com/xrobert35/es-mapping-ts
- Owner: xrobert35
- License: mit
- Created: 2018-03-21T08:25:56.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:38:17.000Z (about 2 years ago)
- Last Synced: 2024-09-29T05:20:40.955Z (3 months ago)
- Topics: decorators, elasticsearch, mapping, typescript
- Language: TypeScript
- Homepage:
- Size: 1.39 MB
- Stars: 23
- Watchers: 1
- Forks: 15
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Es Mapping TS
[](https://github.com/xrobert35/es-mapping-ts)
[](https://github.com/xrobert35/es-mapping-ts)
[](https://travis-ci.org/xrobert35/es-mapping-ts)
[](https://coveralls.io/github/xrobert35/es-mapping-ts)
This library is used to generate elasticsearch mapping through typescript decorators
## Installation
```sh
npm install es-mapping-ts --save
```
## Peer dependencies
This package only work with **@elastic/elasticsearch**
## Version
### tested with
* elasticsearch 7
* elasticsearch 6
* elasticsearch 5
## Examples
### Create the mapping
```typescript
import { EsEntity, EsField } from 'es-mapping-ts';
import { ObjectEntity } from './object.entity';
import { NestedEntity } from './nested.entity';
@EsEntity({
index: 'master',
type: 'masterType'
})
export class MasterEntity {
@EsField({
type : 'text'
})
name?: string;
@EsField({
type: 'text',
copy_to : 'name'
})
firstname: string;
@EsField({
type: 'text',
copy_to : 'name'
})
lastname: string;
@EsField({
type: 'join',
relations: { 'master': 'submaster' }
})
master: Array;
@EsField({
type: 'object',
fieldClass: ObjectEntity
})
objects: Array;
@EsField({
type: 'nested',
fieldClass: NestedEntity
})
nested: Array;
}
```
```typescript
import { EsEntity, EsField } from 'es-mapping-ts';
@EsEntity({
index: 'nested'
})
export class NestedEntity {
@EsField({
type: 'text',
})
name: string;
@EsField({
type: 'integer'
})
montant: number;
}
```
```typescript
import { EsEntity, EsField } from 'es-mapping-ts';
// This es entity is only here for field mapping,
// it's not supposed to have is own index
@EsEntity()
export class ObjectEntity {
@EsField({
type: 'text',
analyzer : 'whitespace'
})
name: string;
@EsField({
type: 'integer',
})
age: number;
}
```
### Get the generated mappings
#### Simply call the "uploadMappings" function
```typescript
import { EsMappingService } from 'es-mapping-ts';
import { Client } from '@elastic/elasticsearch';
const esClient = new Client({
host: 'http://localhost:9200',
log : 'info'
});
// Upload the mapping
const mappings = EsMappingService.getInstance().uploadMappings(esClient);
```
only none readonly entity will be uploaded
#### or do it yourself
```typescript
import { EsMappingService } from 'es-mapping-ts';
//List of ready to use generated mapping
const mappings = EsMappingService.getInstance().getMappings();
Bluebird.each(mappings, async (mapping) => {
//create index
await esclient.indices.create({ index: mapping.index });
//create mapping
await esclient.indices.putMapping(mapping);
});
```
### Inheritance
You can also extend EsMapping
```typescript
export class AbstractEntity {
@EsField({
type: 'text',
})
abstractName: string;
@EsField({
type: 'text',
})
overridableName: string;
}
```
```typescript
@EsEntity({
index: 'concret',
type: 'typeConcret'
})
export class ConcretEntity extends AbstractEntity {
@EsField({
type: 'text'
})
concretName: string;
@EsField({
type: 'text',
null_value : 'undefined'
})
overridableName: string;
}
```
### Using mixins
You can add mixins to your entities by declaring an entity like so:
```typescript
@EsEntity({ mixins: [BaseMixin] })
export class SomeEntity {
@EsField({
type: "text",
})
name: string;
}
```
The mixin class looks like:
```typescript
@EsEntity()
export class BaseMixin {
@EsField({
type: "keyword"
})
id: string;
@EsField({
name: "start_date",
type: "date"
})
startDate: Date;
@EsField({
name: "end_date",
type: "date"
})
endDate: Date;
}
```
`SomeClass` will now have a mapping like:
```json
{
"body": {
"properties": {
"name": {
"type": "text",
},
"id": {
"type": "keyword",
},
"start_date": {
"name": "start_date",
"type": "date",
},
"end_date": {
"name": "end_date",
"type": "date",
},
}
}
}
```
## Decorators
### @EsEntity
| Param | Type | Description |
| ------ | ------ | ------ |
| index | string | Allow you to define the index name |
| type | string | Allow you to define the index type |
| readonly | boolean | Define if the mapping must be uploaded when using uploadMappings function |
| mixins | Array | Allow you to compose with one or more EsEntities, see "Using mixins" |
### @EsField
| Param | Type | Description |
| ------ | ------ | ------ |
| type | string | Allow you to define the type of the index |
| name | string | Allow you to define the name of the property if different from the property name |
| dynamic | boolean | Allow you to define if the field can accept additional properties |
| analyzer | string | Allow you to define the elasticsearch analyzer |
| fields | string | Allow you to define the elasticsearch fields |
| format | string | Allow you to define the format (ie for date field) |
| enabled | boolean | Allow you to enable ou disable the field |
| null_value | string | Allow you to define the null value of the field |
| copy_to | string | Allow you to copy the field value into a group field for _search |
| relations | string | Define the releation for a join type |
| fieldClass | string | Class used to get the properties of the nested or object array type |
Additional properties are allowed, allowing you to manage other elasticsearch properties
## How to dev
### test en build
```shell
# launch unit testing
npm run test
# build
npm run build
```
This project is also managed by travis for CI
### release
```
npm run build
npm run test
mkdir release
cp -r dist release
cp LICENSE release
cp README.md release
cp package.json release #change version
cd relese
npm publish
```
## License
----
MIT