Skip to content

Commit f37dec2

Browse files
committed
docs: add --enable-lazy-filter to server configuration
Document the --enable-lazy-filter server parameter across all versions where it exists (26.0 through 30.1). This parameter was introduced in v26.0 (commit 4328ee35) but was never documented in the server configuration page, even though the per-query search parameter (enable_lazy_filter) was already documented in the search API docs.
1 parent e482d7f commit f37dec2

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 | Evaluate filter clauses lazily during search instead of upfront. Set this to `true` when you are potentially filtering on large values but the tokens in the query are expected to match very few documents. Can also be overridden on a per-query basis via the `enable_lazy_filter` search parameter. Default: `false` |
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 | Evaluate filter clauses lazily during search instead of upfront. Set this to `true` when you are potentially filtering on large values but the tokens in the query are expected to match very few documents. Can also be overridden on a per-query basis via the `enable_lazy_filter` search parameter. Default: `false` |
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 | Evaluate filter clauses lazily during search instead of upfront. Set this to `true` when you are potentially filtering on large values but the tokens in the query are expected to match very few documents. Can also be overridden on a per-query basis via the `enable_lazy_filter` search parameter. Default: `false` |
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 | Evaluate filter clauses lazily during search instead of upfront. Set this to `true` when you are potentially filtering on large values but the tokens in the query are expected to match very few documents. Can also be overridden on a per-query basis via the `enable_lazy_filter` search parameter. Default: `false` |
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 | Evaluate filter clauses lazily during search instead of upfront. Set this to `true` when you are potentially filtering on large values but the tokens in the query are expected to match very few documents. Can also be overridden on a per-query basis via the `enable_lazy_filter` search parameter. Default: `false` |
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 | Evaluate filter clauses lazily during search instead of upfront. Set this to `true` when you are potentially filtering on large values but the tokens in the query are expected to match very few documents. Can also be overridden on a per-query basis via the `enable_lazy_filter` search parameter. Default: `false` |
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 | Evaluate filter clauses lazily during search instead of upfront. Set this to `true` when you are potentially filtering on large values but the tokens in the query are expected to match very few documents. Can also be overridden on a per-query basis via the `enable_lazy_filter` search parameter. Default: `false` |
105106

106107
### On-Disk DB Fine Tuning
107108

0 commit comments

Comments
 (0)