Skip to content

Remove mentions to stream api #5958

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

Merged
merged 1 commit into from
Oct 29, 2025
Merged

Remove mentions to stream api #5958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 0 additions & 9 deletions docs/overview/concepts/querying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: Querying
sidebar_position: 2
---

Quickwit provides two endpoints with full-text search queries identified by the `query` parameter:

- A search endpoint that returns a [JSON](../../reference/rest-api.md)
- A search stream endpoint that returns a stream of the requested [field values](../../reference/rest-api.md)

A search query received by a searcher will be executed using a map-reduce approach following these steps:

1. The Searcher identifies relevant splits based on the request’s [timestamp interval](#time-sharding) and [tags](#tag-pruning).
Expand Down Expand Up @@ -90,10 +85,6 @@ For instance, if tenant\_1,app\_1 and tenant\_2,app\_2 are both sent to partitio
still search inside the 1st partition as it will be tagged with tenant\_1,tenant\_2,app\_1 and app\_2. You should therefore prefer a partition key such as
`hash_mod(tenant_id, 10),hash_mod(app_id, 5)` which will generate as many splits, but with better tags.

### Search stream query limits

Search stream queries can take a huge amount of RAM. Quickwit limits the number of concurrent search streams per split to 100 by default. You can adjust this limit by setting the value of the searcher configuration property called `max_num_concurrent_split_streams` in the configuration file.

### Caching

Quickwit does caching in many places to deliver a highly performing query engine.
Expand Down
6 changes: 3 additions & 3 deletions quickwit/quickwit-search/src/cluster_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ const MAX_GET_KV_ATTEMPTS: usize = 6;
/// We attempt to store our KVs on two nodes.
const TARGET_NUM_REPLICATION: usize = 2;

/// Client that executes placed requests (Request, `SearchServiceClient`) and provides
/// retry policies for `FetchDocsRequest`, `LeafSearchRequest` and `LeafSearchStreamRequest`
/// to retry on other `SearchServiceClient`.
/// Client that executes placed requests (Request, `SearchServiceClient`) and
/// provides retry policies for `FetchDocsRequest` and `LeafSearchRequest` to
/// retry on other `SearchServiceClient`.
#[derive(Clone)]
pub struct ClusterClient {
pub(crate) search_job_placer: SearchJobPlacer,
Expand Down