Home
Vendure Framework
DefaultSearchPlugin
SearchStrategy

SearchStrategy

This interface defines the contract that any database-specific search implementations should follow.

Info

This is configured via the searchStrategy property of the DefaultSearchPluginInitOptions.

Signature

interface SearchStrategy extends InjectableStrategy {    getSearchResults(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<SearchResult[]>;    getTotalCount(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<number>;    getFacetValueIds(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<Map<ID, number>>;    getCollectionIds(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<Map<ID, number>>;}

Extends: InjectableStrategy

getSearchResults

method(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>

getTotalCount

method(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<number>

getFacetValueIds

method(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<Map<ID, number>>

getCollectionIds

method(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<Map<ID, number>>

Was this chapter helpful?

Report Issue

PreviousPostgresSearchStrategy NextSqliteSearchStrategy

Edited Jan 28, 2026·View source

Past the docs?

Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.

Talk to the team

SearchStrategy

@vendure/core Source

This interface defines the contract that any database-specific search implementations should follow.

Info

This is configured via the searchStrategy property of the DefaultSearchPluginInitOptions.

Signature

interface SearchStrategy extends InjectableStrategy {    getSearchResults(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<SearchResult[]>;    getTotalCount(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<number>;    getFacetValueIds(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<Map<ID, number>>;    getCollectionIds(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<Map<ID, number>>;}

Extends: InjectableStrategy

getSearchResults

method(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>

getTotalCount

method(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<number>

getFacetValueIds

method(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<Map<ID, number>>

getCollectionIds

method(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<Map<ID, number>>

Was this chapter helpful?

Report Issue

PreviousPostgresSearchStrategy NextSqliteSearchStrategy

Edited Jan 28, 2026·View source

Past the docs?

Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.

Talk to the team