Repository navigation
docs(readme): document server-side batching, GA since Weaviate v1.36 - #633
Open
dudanogueira wants to merge 4 commits into
Open
dudanogueira wants to merge 4 commits into
dudanogueira wants to merge 4 commits into
Conversation
The README still said dynamic batching would come once server-side batching became GA (est. v1.34). It became GA in v1.36, and client6 already supports it through `collection.batch.start()`. The README now shows how to use it, how to read per-object results from TaskHandle, the builder settings, the reconnect behaviour, and tenants.
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
3 of 4 tasks
There was a problem hiding this comment.
🟡 Changes recommended
The README examples use a non-compiling WeaviateObject.of call and fail to clarify that close() waits for final per-object results and stream termination, not just queue acknowledgements.
2 open issues
What changed in this PR
Updates the Java client README to document server-side batching, generally available since Weaviate v1.36, replacing the outdated availability note.
Changes:
- Adds batching examples covering lifecycle and per-object results.
- Documents configuration, reconnection, tenant selection, and the fallback for older servers.
- Provides retry guidance and a collection-creation workaround for the auto-schema race described in #635.
| File | Description |
|---|---|
| README.md | Replaces the outdated batching note with usage examples, configuration guidance, and auto-schema race workarounds. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The README still said dynamic batching would come once server-side batching is GA. It has been GA since Weaviate
v1.36, and client6 supports it viacollection.batch.start().Changes
try (BatchContext ...)example and whatclose()waits for.TaskHandle.done(),numberOfErrors()).batchSize,maxReconnectRetries, reconnect behaviour andwithTenant(...); point toinsertManyfor servers beforev1.36.retryPolicyrecipe for the auto-schema race in Concurrent batches into an auto-schema-created collection lose objects #635 (a server-side issue).Breaking changes
None (README only).