Skip to content

basalt / search-postgres/src / PostgresSearchOptions

Interface: PostgresSearchOptions ​

Defined in: search-postgres/src/index.ts:31

Properties ​

client ​

> client: PgClientLike

Defined in: search-postgres/src/index.ts:33

A connected pg Pool or Client.


language? ​

> optional language?: string

Defined in: search-postgres/src/index.ts:37

Text-search configuration (stemming/stop-words). Default english.


searchFunction? ​

> optional searchFunction?: string | PostgresSearchFunctionOptions

Defined in: search-postgres/src/index.ts:43

Name of a SECURITY DEFINER search function to route text queries through — required when the search table is under Postgres RLS, otherwise the GIN index is not used. See PostgresSearchFunctionOptions.


table? ​

> optional table?: string

Defined in: search-postgres/src/index.ts:35

Table that holds every index (created by register). Default basalt_search.

Released under the MIT License.