Add client support for replication scale plans (GET/POST /v1/replication/scale)

Aperta
#2,259 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
api, backend

Direzione di ricerca

Read the existing client.cluster.replications methods (get, query and cancel), related models in weaviate.cluster.models, and the client’s version checks and stub generation workflow. Implement sync and async methods for retrieving and applying scale plans, with typed models, validation, and server version handling. Add unit, mock, and integration coverage; done means the scale plan can be retrieved and applied against a supported server, with the requested error and validation cases covered.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Summary

Weaviate has offered GET and POST /v1/replication/scale since v1.35. They compute and apply a plan to change a collection's replication factor. The Python client has no methods for them, so changing a collection's replication factor from Python means making raw REST calls and building the plan payload by hand.

Proposal

Add two methods to the existing client.cluster.replications namespace, next to get, query and cancel, for both the sync and async clients:

plan = client.cluster.replications.get_scale_plan(collection="Article", replication_factor=3)
# inspect plan.shard_scale_actions -> {shard: ShardScaleActions(remove_nodes=[...], add_nodes={target: source | None})}
result = client.cluster.replications.apply_scale_plan(plan=plan)
# result.operation_ids -> the started shard copy operations, trackable with replications.get(uuid=...)
  • New typed models in weaviate.cluster.models: ReplicationScalePlan, ShardScaleActions and ReplicationScaleApplyResult. They are exported from weaviate.outputs.replication.
  • A version check raises WeaviateUnsupportedFeatureError on servers older than 1.35, the same way tokenization and export do.
  • replication_factor is validated on the client (it must be an integer of at least 1), and the collection name's first letter is capitalised, as elsewhere in the client.
  • Additive only: no changes to existing signatures, overloads or dependencies. The stubs are regenerated with tools/stubs_regen.sh.
Validation done locally

I have a working implementation, tested against a local 3-node 1.40.5 cluster with REPLICA_MOVEMENT_ENABLED=true:

  • Scaling a 2-shard collection from 1 to 3 replicas started 4 copy operations, all of which reached READY, and all objects stayed readable.
  • Scaling back down produced a removal-only plan, applied with no copy operations.
  • Added unit and mock tests (sync and async, plan round-trip, invalid factor, old-server error) and an integration test in integration/test_replicate.py.
  • ruff, pyright 1.1.399 and the flake8 pre-commit hooks pass.

Would you accept a PR for this? I'm happy to adjust the method names or where they live, for example on client.cluster next to replicate() instead.

Lingua principale
Python
Stelle
230
Fork
173
Merge medio
4g 16h
PR unite (30g)
23

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di weaviate/weaviate-python-client

Tutte le issue di weaviate/weaviate-python-client

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.