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

未关闭
#2,259 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
python
领域
api, backend

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Python
星标
230
派生
173
平均合并
4 天 16 小时
30 天内合并 PR
23

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

weaviate/weaviate-python-client 的其他 Issue

查看 weaviate/weaviate-python-client 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。