Skip to content

Fuzzy Search Rank by Relevance #2861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MattSchur wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fuzzy Search Rank by Relevance #2861

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b36b7f
Fuzzy Search
MattSchur Sep 7, 2026
6a4d556
cosmetics
smahati Sep 7, 2026
2836b02
node specific config options
johannes-vogel Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions guides/services/served-ootb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,16 +312,19 @@ To illustrate the above:

### Fuzzy Search on SAP HANA Cloud {#fuzzy-search}

> Prerequisite: For CAP Java, you need to run in [`HEX` optimization mode](../../java/cqn-services/persistence-services#sql-optimization-mode) on SAP HANA Cloud and enable <Config java keyOnly>cds.sql.hana.search.fuzzy = true</Config>

Fuzzy search is a fault-tolerant search feature of SAP HANA Cloud, which returns records even if the search term contains additional characters, is missing characters, or has typographical errors.
Fuzzy search is a fault-tolerant search feature of SAP HANA Cloud, which returns records even if the search term contains additional characters, is missing characters, or has typographical errors. CAP automatically sorts fuzzy search results by relevance (match score), if no explicit `$orderby` is specified.

You can configure the fuzziness in the range `[0.0, 1.0]`. The value 1.0 enforces exact search.

- Java: <Config java keyOnly>cds.sql.hana.search.fuzzinessThreshold = 0.8</Config>
- Node.js:<Config keyOnly>cds.hana.fuzzy = 0.7</Config><sup>(1)</sup>

<sup>(1)</sup> If set to `false`, fuzzy search is disabled and falls back to a case insensitive substring search.
- Node.js:
|Property|Effect|
|---|---|
|<Config keyOnly>cds.hana.fuzzy = 0.7</Config> | global fuzziness threshold<sup>(1)</sup> |
|<Config keyOnly>cds.hana.fuzzy.ranked_search = false</Config>| opt-out of ranked search |
|<Config keyOnly>cds.hana.fuzzy.score = 0.7</Config>| global fuzziness threshold |

<sup>(1)</sup> If set to `false`, fuzzy search is disabled and falls back to a case insensitive substring search.

Override the fuzziness for elements, using the `@Search.fuzzinessThreshold` annotation:

Expand Down Expand Up @@ -349,7 +352,13 @@ When using wildcards in search terms, an *exact pattern search* is performed.
Supported wildcards are '*' matching zero or more characters and '?' matching a single character. You can escape wildcards using '\\'.
:::

::: tip Enable Fuzzy Search in CAP Java `4.9`
CAP Java `5.x` comes with fuzzy search enabled by default, in CAP Java `4.9` it can be enabled by first enabling [`HEX` optimization mode](../../java/cqn-services/persistence-services#sql-optimization-mode) on SAP HANA Cloud and then setting <Config java keyOnly>cds.sql.hana.search.fuzzy = true</Config>.
:::

::: info Relevance sorting doesn't consider to-many associations
Elements from to-many associated entities don't contribute to the sort order. Strong matches from them appear after weaker matches directly from the searched entity.
:::

## Pagination & Sorting

Expand Down
Loading