quickwit-oss / quickwit-oss/quickwit

UUID support in search stream API endpoint

Open
#4,616 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
11.7k
Forks
597
Avg merge
2d 22h
Merged PRs (30d)
37

Description

Is your feature request related to a problem? Please describe.
I am using Quickwit to ingest logs, and would like to make use of the ClickHouse integration to find associated data in ClickHouse. However, the join field is a UUID, which is currently being stored as a string in Quickwit. The stream endpoint is limited to returning int64 or uin64 values, which means there isn't a way for us to use this with UUIDs.

Describe the solution you'd like
It would be ideal if either:

  • UUID was supported as a first class type in the index and allowed as a stream field, returned in ClickHouse native UUID format. (This is a binary format where the UUID is split into 2 uint64 values.)
  • or if strings were allowed as a stream field

Describe alternatives you've considered
I can't see any alternatives, as storing the UUID as an integer would require 128-bit integer support. The current workaround I am using is to use a custom HTTP server to emulate the stream endpoint and do paged requests to the search endpoint, which is obviously far less performant than using the stream endpoint would be.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the search stream API endpoint and its current int64/uint64 field handling, then review how the ClickHouse integration consumes stream values. The work is complete when a supported UUID representation, or string stream fields, is agreed on and returned in a format usable by the ClickHouse join.

Written by the indexing model from the issue text.

Assessment

Tech stack
clickhouse, rust
Domain
api, databases
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.