Class DatabaseDocumentStore

Implements

DatabaseStore

Index

Constructors

Methods

completeInsert getTransaction insertDocuments prepareInsert query transaction create supported

Constructors

constructor

new DatabaseDocumentStore(db: Knex): DatabaseDocumentStore
Parameters
- db: Knex
Returns DatabaseDocumentStore
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:80

Methods

completeInsert

completeInsert(tx: Transaction, type: string, truncate?: boolean): Promise<void>
Parameters
- tx: Transaction
- type: string
- truncate: boolean = false
Returns Promise<void>
Implementation of DatabaseStore.completeInsert
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:109

getTransaction

getTransaction(): Promise<Transaction<any, any[]>>
Returns Promise<Transaction<any, any[]>>
Implementation of DatabaseStore.getTransaction
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:88

insertDocuments

insertDocuments(
    tx: Transaction,
    type: string,
    documents: IndexableDocument[],
): Promise<void>
Parameters
- tx: Transaction
- type: string
- documents: IndexableDocument[]
Returns Promise<void>
Implementation of DatabaseStore.insertDocuments
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:147

prepareInsert

prepareInsert(tx: Transaction): Promise<void>
Parameters
- tx: Transaction
Returns Promise<void>
Implementation of DatabaseStore.prepareInsert
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:92

query

query(tx: Transaction, searchQuery: PgSearchQuery): Promise<DocumentResultRow[]>
Parameters
- tx: Transaction
- searchQuery: PgSearchQuery
Returns Promise<DocumentResultRow[]>
Implementation of DatabaseStore.query
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:164

transaction

transaction<T>(fn: (tx: Transaction) => Promise<T>): Promise<T>
Type Parameters
- T
Parameters
- fn: (tx: Transaction) => Promise<T>
Returns Promise<T>
Implementation of DatabaseStore.transaction
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:84

`Static`create

create(database: DatabaseService): Promise<DatabaseDocumentStore>
Parameters
- database: DatabaseService
Returns Promise<DatabaseDocumentStore>
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:37

`Static`supported

supported(knex: Knex): Promise<boolean>
Parameters
- knex: Knex
Returns Promise<boolean>
- Defined in plugins/search-backend-module-pg/src/database/DatabaseDocumentStore.ts:68