Skip to content

Commit fdfa872

Browse files
committed
docs: add --enable-lazy-filter to server configuration with per-query recommendation
Document the --enable-lazy-filter server parameter across all versions where it exists (26.0 through 30.1). The parameter sets the server-wide default for lazy filter evaluation and has existed since v26.0. Each entry includes a NOTE recommending users set enable_lazy_filter as a per-query search parameter instead, since lazy filtering is only beneficial for specific query patterns.
1 parent e482d7f commit fdfa872

7 files changed

Lines changed: 11 additions & 0 deletions

File tree

docs-site/content/26.0/api/server-configuration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,11 @@ Command line arguments can be passed to the server as `--parameter=value`.
9393
| `--db-compaction-interval` | false | Frequency of automatic on-disk [database compaction](./cluster-operations.md#compacting-the-on-disk-database). Default: `604,800` (7 days)<br><br> If you do frequent collection drops and recreates, you want to considering setting this to say 24 hours. |
9494
| `--skip-writes` | false | Starts Typesense in a mode that does not read writes from the Raft log. This is useful when the server has crashed due to some recent bad writes that you want to skip over temporarily. |
9595

96+
### Search
97+
98+
| Parameter | Required | Description |
99+
|------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
100+
| `--enable-lazy-filter` | false | Sets the server-wide default for lazy evaluation of filter clauses. When enabled, filter clauses are evaluated incrementally during search instead of upfront. Default: `false`. <br><br>**NOTE**: We recommend setting `enable_lazy_filter` as a [search parameter](./search.md#search-parameters) on a per-query basis instead of enabling it server-wide, since it is only beneficial for specific query patterns (e.g. filtering on large value sets where the query tokens match very few documents). |
96101

97102
## Using a Configuration File
98103

docs-site/content/27.0/api/server-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ Command line arguments can be passed to the server as `--parameter=value`.
9494
| `--skip-writes` | false | Starts Typesense in a mode that does not read writes from the Raft log. This is useful when the server has crashed due to some recent bad writes that you want to skip over temporarily. |
9595
| `--filter-by-max-ops` | false | Maximum number of operators permitted in `filter_by` clause. Default: `100` |
9696
| `--max-per-page` | false | Max number of hits permitted per page. Default: `250` |
97+
| `--enable-lazy-filter` | false | Sets the server-wide default for lazy evaluation of filter clauses. When enabled, filter clauses are evaluated incrementally during search instead of upfront. Default: `false`. <br><br>**NOTE**: We recommend setting `enable_lazy_filter` as a [search parameter](./search.md#search-parameters) on a per-query basis instead of enabling it server-wide, since it is only beneficial for specific query patterns (e.g. filtering on large value sets where the query tokens match very few documents). |
9798

9899

99100
## Using a Configuration File

docs-site/content/27.1/api/server-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ Command line arguments can be passed to the server as `--parameter=value`.
9595
| `--skip-writes` | false | Starts Typesense in a mode that does not read writes from the Raft log. This is useful when the server has crashed due to some recent bad writes that you want to skip over temporarily. |
9696
| `--filter-by-max-ops` | false | Maximum number of operators permitted in `filter_by` clause. Default: `100` |
9797
| `--max-per-page` | false | Max number of hits permitted per page. Default: `250` |
98+
| `--enable-lazy-filter` | false | Sets the server-wide default for lazy evaluation of filter clauses. When enabled, filter clauses are evaluated incrementally during search instead of upfront. Default: `false`. <br><br>**NOTE**: We recommend setting `enable_lazy_filter` as a [search parameter](./search.md#search-parameters) on a per-query basis instead of enabling it server-wide, since it is only beneficial for specific query patterns (e.g. filtering on large value sets where the query tokens match very few documents). |
9899

99100

100101
## Using a Configuration File

docs-site/content/28.0/api/server-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ Command line arguments can be passed to the server as `--parameter=value`.
9595
| `--skip-writes` | false | Starts Typesense in a mode that does not read writes from the Raft log. This is useful when the server has crashed due to some recent bad writes that you want to skip over temporarily. |
9696
| `--filter-by-max-ops` | false | Maximum number of operators permitted in `filter_by` clause. Default: `100` |
9797
| `--max-per-page` | false | Max number of hits permitted per page. Default: `250` |
98+
| `--enable-lazy-filter` | false | Sets the server-wide default for lazy evaluation of filter clauses. When enabled, filter clauses are evaluated incrementally during search instead of upfront. Default: `false`. <br><br>**NOTE**: We recommend setting `enable_lazy_filter` as a [search parameter](./search.md#search-parameters) on a per-query basis instead of enabling it server-wide, since it is only beneficial for specific query patterns (e.g. filtering on large value sets where the query tokens match very few documents). |
9899

99100

100101
## Using a Configuration File

docs-site/content/29.0/api/server-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ Command line arguments can be passed to the server as `--parameter=value`.
102102
| `--filter-by-max-ops` | false | Maximum number of operators permitted in `filter_by` clause. Default: `100` |
103103
| `--max-per-page` | false | Max number of hits permitted per page. Default: `250` |
104104
| `--max-group-limit` | false | Max value of `group_limit` permitted when using `group_by`. Default: `99` |
105+
| `--enable-lazy-filter` | false | Sets the server-wide default for lazy evaluation of filter clauses. When enabled, filter clauses are evaluated incrementally during search instead of upfront. Default: `false`. <br><br>**NOTE**: We recommend setting `enable_lazy_filter` as a [search parameter](./search.md#search-parameters) on a per-query basis instead of enabling it server-wide, since it is only beneficial for specific query patterns (e.g. filtering on large value sets where the query tokens match very few documents). |
105106

106107
### On-Disk DB Fine Tuning
107108

docs-site/content/30.0/api/server-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ Command line arguments can be passed to the server as `--parameter=value`.
102102
| `--filter-by-max-ops` | false | Maximum number of operators permitted in `filter_by` clause. Default: `100` |
103103
| `--max-per-page` | false | Max number of hits permitted per page. Default: `250` |
104104
| `--max-group-limit` | false | Max value of `group_limit` permitted when using `group_by`. Default: `99` |
105+
| `--enable-lazy-filter` | false | Sets the server-wide default for lazy evaluation of filter clauses. When enabled, filter clauses are evaluated incrementally during search instead of upfront. Default: `false`. <br><br>**NOTE**: We recommend setting `enable_lazy_filter` as a [search parameter](./search.md#search-parameters) on a per-query basis instead of enabling it server-wide, since it is only beneficial for specific query patterns (e.g. filtering on large value sets where the query tokens match very few documents). |
105106

106107
### On-Disk DB Fine Tuning
107108

docs-site/content/30.1/api/server-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ Command line arguments can be passed to the server as `--parameter=value`.
102102
| `--filter-by-max-ops` | false | Maximum number of operators permitted in `filter_by` clause. Default: `100` |
103103
| `--max-per-page` | false | Max number of hits permitted per page. Default: `250` |
104104
| `--max-group-limit` | false | Max value of `group_limit` permitted when using `group_by`. Default: `99` |
105+
| `--enable-lazy-filter` | false | Sets the server-wide default for lazy evaluation of filter clauses. When enabled, filter clauses are evaluated incrementally during search instead of upfront. Default: `false`. <br><br>**NOTE**: We recommend setting `enable_lazy_filter` as a [search parameter](./search.md#search-parameters) on a per-query basis instead of enabling it server-wide, since it is only beneficial for specific query patterns (e.g. filtering on large value sets where the query tokens match very few documents). |
105106

106107
### On-Disk DB Fine Tuning
107108

0 commit comments

Comments
 (0)