[C API] Versioned, documented compatibility for the save/load stream format

Aberta
  • Algo errado?
#426 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 5 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
18/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
c, cpp
Domínio
api, backend

Direção de pesquisa

Start with svs_get_version() in bindings/c/src/svs_c.cpp (line 69) and the save_version field in dynamic_index.h, which is currently 0.0.0. Trace svs_index_save_stream and svs_index_load_stream_dynamic to see where a format version would go in the stream header. Done means a format version is written and readable without loading the index, and a mismatched stream returns an error rather than crashing. The compatibility contract also needs a decision from maintainers before code work starts.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Summary

Please version the byte stream produced by svs_index_save_stream and consumed by svs_index_load_stream_dynamic, independently of the C API version, and document which versions a given release can load.

Why

valkey-search embeds the SVS stream in its RDB files. Users upgrade the module (and so SVS) in place, and replicas can briefly run a different build from the primary. Today the only version available to us is svs_get_version(), the C API version (bindings/c/src/svs_c.cpp:69); the serialized save_version in dynamic_index.h is 0.0.0. So we can't tell "same format, newer library" from "incompatible format", and have to either reject every RDB after any SVS bump or risk loading an incompatible stream.

Ask

  1. A format version in the stream header, and a C API call to read it from a stream without loading the index, or to report it from a handle.
  2. A compatibility contract: a release can load streams written by earlier releases within the same major format version, and fails cleanly (an error, not a crash) on a stream it can't load.
  3. Release notes that call out format version changes.

Consumer context

valkey-search (ALGORITHM SVS_VAMANA), C API submodule pinned at 8285340. Today vector_svs.cc rejects any svs_get_version() mismatch on load. With a format version we can accept compatible streams and rebuild from the keyspace otherwise.

Linguagem predominante
C++
Estrelas
241
Forks
48
Merge médio
4d 21h
PRs com merge (30d)
11

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de intel/ScalableVectorSearch

Todas as issues de intel/ScalableVectorSearch

Issues semelhantes

Mais issues de C++

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.