elasticsearch-store / index-model / IndexModel

Class: abstract IndexModel<T>

Defined in: elasticsearch-store/src/index-model.ts:21

An high-level, opinionated, abstract class for an elasticsearch DataType, with a CRUD-like interface

Extends

• IndexStore<T>

Type Parameters

Type Parameter
T extends IndexModelRecord

Constructors

Constructor

new IndexModel<T>(client, options, modelConfig): IndexModel<T>

Defined in: elasticsearch-store/src/index-model.ts:28

Parameters

Parameter	Type
client	Client
options	IndexModelOptions
modelConfig	IndexModelConfig<T>

Returns

IndexModel<T>

Overrides

IndexStore.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
_defaultQueryAccess	protected	undefined | QueryAccess<T>	undefined	-	IndexStore._defaultQueryAccess	elasticsearch-store/src/index-store.ts:35
client	readonly	Client	undefined	-	IndexStore.client	elasticsearch-store/src/index-store.ts:29
clientMetadata	readonly	ClientMetadata	undefined	-	IndexStore.clientMetadata	elasticsearch-store/src/index-store.ts:34
config	readonly	IndexConfig<T>	undefined	-	IndexStore.config	elasticsearch-store/src/index-store.ts:30
logger	readonly	Logger	undefined	-	-	elasticsearch-store/src/index-model.ts:23
manager	readonly	IndexManager	undefined	-	IndexStore.manager	elasticsearch-store/src/index-store.ts:31
name	readonly	string	undefined	IndexStore.name	-	elasticsearch-store/src/index-model.ts:22
readHooks	readonly	Set<ReadHook<T>>	undefined	-	IndexStore.readHooks	elasticsearch-store/src/index-store.ts:39
refreshByDefault	public	boolean	true	-	IndexStore.refreshByDefault	elasticsearch-store/src/index-store.ts:33
writeHooks	readonly	Set<WriteHook<T>>	undefined	-	IndexStore.writeHooks	elasticsearch-store/src/index-store.ts:38
xLuceneTypeConfig	readonly	xLuceneTypeConfig	undefined	-	IndexStore.xLuceneTypeConfig	elasticsearch-store/src/index-store.ts:36

Accessors

searchIndex

Get Signature

get searchIndex(): string

Defined in: elasticsearch-store/src/index-store.ts:108

The index typically used for searching across all of the open indices

Returns

string

Inherited from

IndexStore.searchIndex

---

writeIndex

Get Signature

get writeIndex(): string

Defined in: elasticsearch-store/src/index-store.ts:101

The most current indexed used to write to

Returns

string

Inherited from

IndexStore.writeIndex

Methods

_ensureUnique()

protected _ensureUnique(record, existing?): Promise<void>

Defined in: elasticsearch-store/src/index-model.ts:263

Parameters

Parameter	Type
record	T
existing?	T

Returns

Promise<void>

---

_sanitizeRecord()

protected _sanitizeRecord(record): T

Defined in: elasticsearch-store/src/index-model.ts:225

Parameters

Parameter	Type
record	T

Returns

T

---

_search()

protected _search(params): Promise<SearchResponse<T>>

Defined in: elasticsearch-store/src/index-store.ts:744

A small abstraction on client.search with retry support

Parameters

Parameter	Type
params	PartialParam<ClientParams.SearchParams>

Returns

Promise<SearchResponse<T>>

Inherited from

IndexStore._search

---

_toRecord()

protected _toRecord(result, critical): T

Defined in: elasticsearch-store/src/index-store.ts:874

Parameters

Parameter	Type	Default value
result	SearchResult<T>	undefined
critical	boolean	true

Returns

T

Inherited from

IndexStore._toRecord

---

_toRecords()

protected _toRecords(results, critical): T[]

Defined in: elasticsearch-store/src/index-store.ts:886

Parameters

Parameter	Type	Default value
results	SearchResult<T>[]	undefined
critical	boolean	false

Returns

T[]

Inherited from

IndexStore._toRecords

---

aggregate()

aggregate<A>(query, params?): Promise<A>

Defined in: elasticsearch-store/src/index-store.ts:728

Run an aggregation using an Elasticsearch Query DSL

Type Parameters

Type Parameter	Default type
A	SearchAggregations

Parameters

Parameter	Type
query	Record<string, any>
params?	PartialParam<SearchParams, any>

Returns

Promise<A>

Inherited from

IndexStore.aggregate

---

appendToArray()

appendToArray(id, field, values): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:793

Append values from an array on a record. Use with caution, this may not work in all cases.

Parameters

Parameter	Type
id	string
field	keyof T
values	string | string[]

Returns

Promise<void>

Inherited from

IndexStore.appendToArray

---

bulk()

Call Signature

bulk(action, id): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:127

Safely add a create, index, or update requests to the bulk queue

This method will batch messages using the configured bulk max size and wait configuration.

Because using the upsert-with-script api since that can break depending on the underlying elasticsearch version and/or client library

Parameters

Parameter	Type
action	"delete"
id	string

Returns

Promise<void>

Todo

we need to add concurrency support for sending multiple bulk requests in flight and making sure they finish before shutdown

Inherited from

IndexStore.bulk

Call Signature

bulk(action, doc, id?, retryOnConflict?, onBulkQueueConflict?): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:128

Safely add a create, index, or update requests to the bulk queue

This method will batch messages using the configured bulk max size and wait configuration.

Because using the upsert-with-script api since that can break depending on the underlying elasticsearch version and/or client library

Parameters

Parameter	Type	Description
action	"index" | "create"	-
doc	Partial<T>	-
id?	string	-
retryOnConflict?	number	-
onBulkQueueConflict?	OnBulkConflictFn<T>	is used to detect and replace existing items in the bulk queue with the same name and action

Returns

Promise<void>

Todo

we need to add concurrency support for sending multiple bulk requests in flight and making sure they finish before shutdown

Inherited from

IndexStore.bulk

Call Signature

bulk(action, doc, id?, retryOnConflict?, onBulkQueueConflict?): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:129

Safely add a create, index, or update requests to the bulk queue

This method will batch messages using the configured bulk max size and wait configuration.

Because using the upsert-with-script api since that can break depending on the underlying elasticsearch version and/or client library

Parameters

Parameter	Type	Description
action	"update"	-
doc	Partial<T>	-
id?	string	-
retryOnConflict?	number	-
onBulkQueueConflict?	OnBulkConflictFn<T>	is used to detect and replace existing items in the bulk queue with the same name and action

Returns

Promise<void>

Todo

we need to add concurrency support for sending multiple bulk requests in flight and making sure they finish before shutdown

Inherited from

IndexStore.bulk

Call Signature

bulk(action, script, id?, retryOnConflict?, onBulkQueueConflict?): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:130

Safely add a create, index, or update requests to the bulk queue

This method will batch messages using the configured bulk max size and wait configuration.

Because using the upsert-with-script api since that can break depending on the underlying elasticsearch version and/or client library

Parameters

Parameter	Type	Description
action	"upsert-with-script"	-
script	UpsertWithScript<T>	-
id?	string	-
retryOnConflict?	number	-
onBulkQueueConflict?	OnBulkConflictFn<T>	is used to detect and replace existing items in the bulk queue with the same name and action

Returns

Promise<void>

Todo

we need to add concurrency support for sending multiple bulk requests in flight and making sure they finish before shutdown

Inherited from

IndexStore.bulk

---

bulkCreateRecords()

bulkCreateRecords(records, allowOverrides?): Promise<void>

Defined in: elasticsearch-store/src/index-model.ts:162

Create a bulk records and put it them into bulk request queue

Parameters

Parameter	Type
records	CreateRecordInput<T>[]
allowOverrides?	boolean

Returns

Promise<void>

---

count()

count(query?, options?, queryAccess?): Promise<number>

Defined in: elasticsearch-store/src/index-store.ts:218

Count records by a given Lucene Query

Parameters

Parameter	Type
query?	string
options?	RestrictOptions
queryAccess?	QueryAccess<T>

Returns

Promise<number>

Inherited from

IndexStore.count

---

countBy()

countBy(fields, joinBy?, options?, queryAccess?): Promise<number>

Defined in: elasticsearch-store/src/index-store.ts:527

Parameters

Parameter	Type
fields	AnyInput<T>
joinBy?	JoinBy
options?	RestrictOptions
queryAccess?	QueryAccess<T>

Returns

Promise<number>

Inherited from

IndexStore.countBy

---

countRecords()

countRecords(fields, clientId?, joinBy?, options?, queryAccess?): Promise<number>

Defined in: elasticsearch-store/src/index-model.ts:190

Parameters

Parameter	Type
fields	AnyInput<T>
clientId?	number
joinBy?	JoinBy
options?	RestrictOptions
queryAccess?	QueryAccess<T>

Returns

Promise<number>

---

countRequest()

countRequest(params): Promise<number>

Defined in: elasticsearch-store/src/index-store.ts:232

Count records by a given Elasticsearch Query DSL

Parameters

Parameter	Type
params	CountParams

Returns

Promise<number>

Inherited from

IndexStore.countRequest

---

create()

create(doc, params?): Promise<T>

Defined in: elasticsearch-store/src/index-store.ts:262

Create a document but will throw if doc already exists

Parameters

Parameter	Type
doc	Partial<T>
params?	PartialParam<CreateParams<T>, "body">

Returns

Promise<T>

the created record

Inherited from

IndexStore.create

---

createById()

createById(id, doc, params?): Promise<T>

Defined in: elasticsearch-store/src/index-store.ts:250

Create a document with an id

Parameters

Parameter	Type
id	string
doc	Partial<T>
params?	PartialParam<CreateParams<T>, "body" | "id">

Returns

Promise<T>

the created record

Inherited from

IndexStore.createById

---

createJoinQuery()

createJoinQuery(fields, joinBy, variables): xLuceneQueryResult

Defined in: elasticsearch-store/src/index-store.ts:778

Parameters

Parameter	Type	Default value
fields	AnyInput<T>	undefined
joinBy	JoinBy	'AND'
variables	{ }	{}

Returns

xLuceneQueryResult

Inherited from

IndexStore.createJoinQuery

---

createRecord()

createRecord(record, allowOverrides?): Promise<T>

Defined in: elasticsearch-store/src/index-model.ts:116

Parameters

Parameter	Type
record	CreateRecordInput<T>
allowOverrides?	boolean

Returns

Promise<T>

---

deleteById()

deleteById(id, params?): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:408

Deletes a document for a given id

Parameters

Parameter	Type
id	string
params?	PartialParam<DeleteParams, any>

Returns

Promise<void>

Inherited from

IndexStore.deleteById

---

deleteRecord()

deleteRecord(id, clientId?): Promise<boolean>

Defined in: elasticsearch-store/src/index-model.ts:175

Soft deletes a record by ID

Parameters

Parameter	Type
id	string
clientId?	number

Returns

Promise<boolean>

---

exists()

exists(id, options?, queryAccess?): Promise<boolean>

Defined in: elasticsearch-store/src/index-store.ts:538

Parameters

Parameter	Type
id	string | string[]
options?	RestrictOptions
queryAccess?	QueryAccess<T>

Returns

Promise<boolean>

Inherited from

IndexStore.exists

---

fetchRecord()

fetchRecord(anyId, options?, queryAccess?): Promise<T>

Defined in: elasticsearch-store/src/index-model.ts:101

Fetch a record by any unique ID

Parameters

Parameter	Type
anyId	string
options?	FindOneOptions<T>
queryAccess?	QueryAccess<T>

Returns

Promise<T>

---

findAll()

findAll(ids, options?, queryAccess?): Promise<T[]>

Defined in: elasticsearch-store/src/index-store.ts:637

Parameters

Parameter	Type
ids	undefined | string | string[]
options?	FindOneOptions<T>
queryAccess?	QueryAccess<T>

Returns

Promise<T[]>

Inherited from

IndexStore.findAll

---

findAllBy()

findAllBy(fields, joinBy?, options?, queryAccess?): Promise<T[]>

Defined in: elasticsearch-store/src/index-store.ts:587

Parameters

Parameter	Type
fields	AnyInput<T>
joinBy?	JoinBy
options?	FindOptions<T>
queryAccess?	QueryAccess<T>

Returns

Promise<T[]>

Inherited from

IndexStore.findAllBy

---

findAndApply()

findAndApply(updates, options?, queryAccess?): Promise<Partial<T>>

Defined in: elasticsearch-store/src/index-store.ts:619

Parameters

Parameter	Type
updates	undefined | Partial<T>
options?	FindOneOptions<T>
queryAccess?	QueryAccess<T>

Returns

Promise<Partial<T>>

Inherited from

IndexStore.findAndApply

---

findBy()

findBy(fields, joinBy?, options?, queryAccess?): Promise<T>

Defined in: elasticsearch-store/src/index-store.ts:553

Parameters

Parameter	Type
fields	AnyInput<T>
joinBy?	JoinBy
options?	FindOneOptions<T>
queryAccess?	QueryAccess<T>

Returns

Promise<T>

Inherited from

IndexStore.findBy

---

findById()

findById(id, options?, queryAccess?): Promise<T>

Defined in: elasticsearch-store/src/index-store.ts:605

Parameters

Parameter	Type
id	string
options?	FindOneOptions<T>
queryAccess?	QueryAccess<T>

Returns

Promise<T>

Inherited from

IndexStore.findById

---

flush()

flush(flushAll): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:286

Parameters

Parameter	Type	Default value
flushAll	boolean	false

Returns

Promise<void>

Inherited from

IndexStore.flush

---

get()

get(id, params?): Promise<T>

Defined in: elasticsearch-store/src/index-store.ts:303

Get a single document

Parameters

Parameter	Type
id	string
params?	PartialParam<GetParams, any>

Returns

Promise<T>

Inherited from

IndexStore.get

---

getDefaultParams()

getDefaultParams<P>(index, ...params): P

Defined in: elasticsearch-store/src/index-store.ts:510

Type Parameters

Type Parameter	Default type
P extends Record<string, any>	object

Parameters

Parameter	Type
index	string
...params	(undefined | Partial<P> & Record<string, any>)[]

Returns

P

Inherited from

IndexStore.getDefaultParams

---

index()

index(doc, params?): Promise<T>

Defined in: elasticsearch-store/src/index-store.ts:335

Index a document

Parameters

Parameter	Type
doc	T | Partial<T>
params?	PartialParam<IndexParams<T>, "body">

Returns

Promise<T>

Inherited from

IndexStore.index

---

indexById()

indexById(id, doc, params?): Promise<T>

Defined in: elasticsearch-store/src/index-store.ts:359

A convenience method for indexing a document with an ID

Parameters

Parameter	Type
id	string
doc	T | Partial<T>
params?	PartialParam<IndexParams<T>, "type" | "index" | "id">

Returns

Promise<T>

Inherited from

IndexStore.indexById

---

initialize()

initialize(): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:320

Connect and validate the index configuration.

Returns

Promise<void>

Inherited from

IndexStore.initialize

---

mget()

mget(body, params?): Promise<T[]>

Defined in: elasticsearch-store/src/index-store.ts:370

Get multiple documents at the same time

Parameters

Parameter	Type
body	MGetBody
params?	PartialParam<MGetParams, any>

Returns

Promise<T[]>

Inherited from

IndexStore.mget

---

migrateIndex()

migrateIndex(options): Promise<any>

Defined in: elasticsearch-store/src/index-store.ts:387

Parameters

Parameter	Type
options	MigrateIndexStoreOptions

Returns

Promise<any>

See

IndexManager#migrateIndex

Inherited from

IndexStore.migrateIndex

---

recordExists()

recordExists(id, clientId?): Promise<boolean>

Defined in: elasticsearch-store/src/index-model.ts:206

Parameters

Parameter	Type
id	string | string[]
clientId?	number

Returns

Promise<boolean>

---

refresh()

refresh(params?): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:394

Refreshes the current index

Parameters

Parameter	Type
params?	PartialParam<IndicesRefreshParams, any>

Returns

Promise<void>

Inherited from

IndexStore.refresh

---

removeFromArray()

removeFromArray(id, field, values): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:823

Remove values from an array on a record. Use with caution, this may not work in all cases.

Parameters

Parameter	Type
id	string
field	keyof T
values	string | string[]

Returns

Promise<void>

Inherited from

IndexStore.removeFromArray

---

search()

search(q?, options?, queryAccess?, critical?): Promise<SearchResult<T>>

Defined in: elasticsearch-store/src/index-store.ts:673

Search with a given Lucene Query

Parameters

Parameter	Type
q?	string
options?	FindOptions<T>
queryAccess?	QueryAccess<T>
critical?	boolean

Returns

Promise<SearchResult<T>>

Inherited from

IndexStore.search

---

searchRequest()

searchRequest(params, critical?): Promise<SearchResult<T>>

Defined in: elasticsearch-store/src/index-store.ts:708

Search using the underlying Elasticsearch Query DSL

Parameters

Parameter	Type
params	PartialParam<ClientParams.SearchParams>
critical?	boolean

Returns

Promise<SearchResult<T>>

Inherited from

IndexStore.searchRequest

---

shutdown()

shutdown(): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:429

Shutdown, flush any pending requests and cleanup

Returns

Promise<void>

Inherited from

IndexStore.shutdown

---

update()

update(id, body, params?): Promise<void>

Defined in: elasticsearch-store/src/index-store.ts:442

Update a document with a given id

Parameters

Parameter	Type
id	string
body	UpdateBody<T>
params?	PartialParam<UpdateParams<unknown, unknown>, "body" | "id">

Returns

Promise<void>

Inherited from

IndexStore.update

---

updatePartial()

updatePartial(id, applyChanges, retriesOnConflict): Promise<T>

Defined in: elasticsearch-store/src/index-store.ts:475

Safely apply updates to a document by applying the latest changes

Parameters

Parameter	Type	Default value
id	string	undefined
applyChanges	ApplyPartialUpdates<T>	undefined
retriesOnConflict	number	3

Returns

Promise<T>

Inherited from

IndexStore.updatePartial

---

updateRecord()

updateRecord(id, record): Promise<T>

Defined in: elasticsearch-store/src/index-model.ts:143

Parameters

Parameter	Type
id	string
record	UpdateRecordInput<T>

Returns

Promise<T>