Skip to main content

elasticsearch-store / interfaces

interfaces

Interfaces​

InterfaceDescription
BulkResponse-
BulkResponseItem-
DataSchemaData Schema and Version
IndexConfigA versioned Index Configuration
IndexModelOptionsA list of options that are configured during run time and will always override the config
IndexModelRecord-
IndexSchemaElasticsearch Index Schema, Mapping and Version
MigrateIndexOptions-

Type Aliases​

AsyncFn()<T>​

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

Defined in: elasticsearch-store/src/interfaces.ts:171

Type Parameters​

Type Parameter
T

Returns​

Promise<T>

BulkAction​

BulkAction: "index" | "create" | "delete" | "update"

Defined in: elasticsearch-store/src/interfaces.ts:173

BulkResponseItems​

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

Defined in: elasticsearch-store/src/interfaces.ts:187

CreateRecordInput<T>​

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

Defined in: elasticsearch-store/src/interfaces.ts:224

Type declaration​

client_id​

client_id: number

Type Parameters​

Type Parameter
T extends IndexModelRecord

FindOneOptions<T>​

FindOneOptions<T>: object

Defined in: elasticsearch-store/src/interfaces.ts:300

Type Parameters​

Type Parameter
T

Type declaration​

excludes?​

optional excludes: keyof T[]

includes?​

optional includes: keyof T[]

variables?​

optional variables: xLuceneVariables

FindOptions<T>​

FindOptions<T>: object

Defined in: elasticsearch-store/src/interfaces.ts:291

Type Parameters​

Type Parameter
T

Type declaration​

excludes?​

optional excludes: keyof T[]

from?​

optional from: number

includes?​

optional includes: keyof T[]

size?​

optional size: number

sort?​

optional sort: string

variables?​

optional variables: xLuceneVariables

IndexModelConfig<T>​

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

Defined in: elasticsearch-store/src/interfaces.ts:234

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: elasticsearch-store/src/interfaces.ts:314

SanitizeFields<T>​

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

Defined in: elasticsearch-store/src/interfaces.ts:259

Type Parameters​

Type Parameter
T

SearchResult<T>​

SearchResult<T>: object

Defined in: elasticsearch-store/src/interfaces.ts:316

Type Parameters​

Type Parameter
T

Type declaration​

_fetched​

_fetched: number

_total​

_total: number

results​

results: T[]

Shard​

Shard: object

Defined in: elasticsearch-store/src/interfaces.ts:195

Type declaration​

primary​

primary: boolean

stage​

stage: string

TimeSeriesFormat​

TimeSeriesFormat: "daily" | "monthly" | "yearly"

Defined in: elasticsearch-store/src/interfaces.ts:132

UpdateRecordInput<T>​

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

Defined in: elasticsearch-store/src/interfaces.ts:228

Type declaration​

client_id?​

optional client_id: number

Type Parameters​

Type Parameter
T extends IndexModelRecord