Skip to content

RediSearch/BugBashApplications

Repository files navigation

Bug Bash Applications — Redis Search on Disk (MS2)

Example, customer-style applications built to exercise Redis Search on Disk (MS2) during the bug bash. Each application drives realistic ingestion and query patterns at scale against on-disk indexes, so we get broad coverage of the surface and shake out bugs.

Use-case catalog (source of truth): the internal design doc Redis Search on Disk — MS2 — Use-cases.

Guiding principle

On-disk indexes exist for datasets that don't fit in RAM, so lean on scale. The supported disk field types are TEXT, TAG, and VECTOR — build the applications around those.

Repository layout

<use-case>/                    one folder per use case
├── README.md                  describes the use case (domain, schema, queries, stress axes)
├── _TEMPLATE/                 starting point — copy it and rename to your GitHub username
│   └── README.md
└── <your-github-username>/    your implementation lives here — one folder per contributor
    └── ...
README.md                      this file

Several people can work the same use case — each contributor gets their own folder, so there are no collisions.

Use cases

# Use case Data type Folder
1 E-commerce product catalog HASH 01-ecommerce-product-catalog/
2 Semantic search / RAG knowledge base JSON 02-semantic-search-rag/
3 Log / observability archive HASH 03-log-observability-archive/
4 Image / media similarity JSON or HASH 04-image-media-similarity/
5 Multilingual news / article archive JSON 05-multilingual-news-archive/
6 Chat / messaging with retention HASH 06-chat-messaging-retention/
7 Marketplace / classifieds with churn HASH + JSON 07-marketplace-classifieds/

How to contribute an application

  1. Pick a use case below (or add a new one — mirror it in the use-case doc and add a folder here following the same layout).
  2. Claim it in the internal Redis Search on Disk — MS2 — Use-cases doc: add yourself as an Owner and flip the status to IN PROGRESS.
  3. Copy that use case's _TEMPLATE/ folder and rename the copy to your GitHub username.
  4. Build your app inside that folder and fill in its README.md.
  5. Log findings — link any bugs/tickets you open in your README, and flip your status in the use-case doc to DONE when you're finished.

About

Collection of applications for the bug bash

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors