IndexParameter

@webda/elasticsearch

---

Interface: IndexParameter

Defined in: packages/elasticsearch/src/elasticsearch.service.ts:17

Index definition

Properties

dateSplit?

optional dateSplit?: object

Defined in: packages/elasticsearch/src/elasticsearch.service.ts:31

Split index by date

Following Grafana convention

attribute

attribute: string

That contains the date field

frequency?

optional frequency?: "yearly" | "monthly" | "weekly" | "daily" | "hourly"

If index key is stats yearly: stats-YYYY monthly: stats-YYYY.MM weekly: stats-GGGG.WW daily: stats-YYYY.MM.DD hourly: stats-YYYY.MM.DD.HH

With dateSplit enable some synchronization features won't be available To get the right index of the document the attribute need to be known, therefore the PartialUpdate and PatchUpdate will likely require to reload the original object

Default

"monthly"

---

model

model: string

Defined in: packages/elasticsearch/src/elasticsearch.service.ts:21

Model to duplicate in elasticsearch

---

url?

optional url?: string

Defined in: packages/elasticsearch/src/elasticsearch.service.ts:25

To expose the index in the API