elasticsearch-store / interfaces

interfaces

Interfaces

Interface	Description
BulkResponse	-
BulkResponseItem	-
DataSchema	Data Schema and Version
IndexConfig	A versioned Index Configuration
IndexModelOptions	A list of options that are configured during run time and will always override the config
IndexModelRecord	-
IndexSchema	Elasticsearch Index Schema, Mapping and Version
MigrateIndexOptions	-

Type Aliases

AsyncFn()

AsyncFn<T> = () => Promise<T>

Defined in: interfaces.ts:172

Type Parameters

Type Parameter
T

Returns

Promise<T>

---

BulkAction

BulkAction = "index" | "create" | "delete" | "update"

Defined in: interfaces.ts:174

---

BulkResponseItems

BulkResponseItems = { [key in BulkAction]?: BulkResponseItem }

Defined in: interfaces.ts:188

---

CreateRecordInput

CreateRecordInput<T> = Omit<T, keyof IndexModelRecord> & object

Defined in: interfaces.ts:225

Type Declaration

client_id

client_id: number

Type Parameters

Type Parameter
T extends IndexModelRecord

---

FindOneOptions

FindOneOptions<T> = object

Defined in: interfaces.ts:301

Type Parameters

Type Parameter
T

Properties

excludes?

optional excludes: keyof T[]

Defined in: interfaces.ts:303

includes?

optional includes: keyof T[]

Defined in: interfaces.ts:302

variables?

optional variables: xLuceneVariables

Defined in: interfaces.ts:304

---

FindOptions

FindOptions<T> = object

Defined in: interfaces.ts:292

Type Parameters

Type Parameter
T

Properties

excludes?

optional excludes: keyof T[]

Defined in: interfaces.ts:294

from?

optional from: number

Defined in: interfaces.ts:295

includes?

optional includes: keyof T[]

Defined in: interfaces.ts:293

size?

optional size: number

Defined in: interfaces.ts:297

sort?

optional sort: string

Defined in: interfaces.ts:296

variables?

optional variables: xLuceneVariables

Defined in: interfaces.ts:298

---

IndexModelConfig

IndexModelConfig<T> = Omit<IndexConfig<T>, "namespace" | "id_field" | "index_schema" | "data_schema" | "default_query_access" | "enable_index_mutations"> & object

Defined in: interfaces.ts:235

Type Declaration

sanitize_fields?

optional sanitize_fields: SanitizeFields<T>

Sanitize / cleanup fields mapping, like trim or trimAndToLower

schema

schema: any

JSON Schema

strict_mode?

optional strict_mode: boolean

Specify whether the data should be strictly validated, defaults to true

timeseries?

optional timeseries: boolean

Use a Timeseries Index

unique_fields?

optional unique_fields: keyof T[]

Unique fields across on Index

version

version: number

Schema Version

Type Parameters

Type Parameter
T extends IndexModelRecord

---

MigrateIndexStoreOptions

MigrateIndexStoreOptions = Omit<MigrateIndexOptions, "config">

Defined in: interfaces.ts:315

---

SanitizeFields

SanitizeFields<T> = { [field in string & keyof T]: "trimAndToLower" | "trim" | "toSafeString" }

Defined in: interfaces.ts:260

Type Parameters

Type Parameter
T

---

SearchResult

SearchResult<T> = object

Defined in: interfaces.ts:317

Type Parameters

Type Parameter
T

Properties

_fetched

_fetched: number

Defined in: interfaces.ts:319

_total

_total: number

Defined in: interfaces.ts:318

results

results: T[]

Defined in: interfaces.ts:320

---

Shard

Shard = object

Defined in: interfaces.ts:196

Properties

primary

primary: boolean

Defined in: interfaces.ts:196

stage

stage: string

Defined in: interfaces.ts:196

---

TimeSeriesFormat

TimeSeriesFormat = "daily" | "monthly" | "yearly"

Defined in: interfaces.ts:133

---

UpdateRecordInput

UpdateRecordInput<T> = Partial<Omit<T, keyof IndexModelRecord>> & object

Defined in: interfaces.ts:229

Type Declaration

client_id?

optional client_id: number

Type Parameters

Type Parameter
T extends IndexModelRecord