Skip to content

Docs: graph_batch docstrings name the churn limitation - #98

Merged
tae898 merged 1 commit into
mainfrom
docs/graph-batch-churn-docstring
Oct 26, 2026
Merged

tae898 merged 1 commit into
mainfrom
docs/graph-batch-churn-docstring

Conversation

@tae898

@tae898 tae898 commented Oct 26, 2026

Copy link
Copy Markdown
Collaborator

The graph_batch() docstrings still called the batch "the recommended path for bulk graph loading" with no caveat. PR #97 added the section "Known limitation: graph batches next to deletes" to the bulk-loads page: each graph_batch() flush writes its edge records onto new pages and never reuses the space that deletes freed, so the edge bucket grows when a workload calls graph_batch() again and again on a type that also sees deletes (ArcadeData/arcadedb#10746). One-off bulk loads are not affected.

This adds the same short Note: paragraph to the graph_batch() docstring of both backends: Database.graph_batch in src/arcadedb/core.py (JVM) and NativeDatabase.graph_batch in src/arcadedb/_native/database.py (native). The note says the batch is recommended for bulk loads, names the growth under repeated flushes next to deletes, points to SQL CREATE EDGE or Vertex.new_edge inside db.transaction() for that workload, and points to the bulk-loads docs page.

Docstrings only, no behaviour change. The edit sits in the graph_batch docstring and nowhere else in core.py, so it does not touch the lookup_by_key docstrings that #96 edits.

Checked locally: black --check (26.10.1) and isort --profile black --check-only on both files, and python3 scripts/check_no_embedded_name.py --root ..

🤖 Generated with Claude Code

Both backends' graph_batch() docstrings now carry the same short Note: graph_batch() is recommended for bulk loads, but when it is called again and again on types that also see deletes, each flush writes its edge records onto new pages and never reuses freed space, so the edge bucket grows (ArcadeData/arcadedb#10746). For that workload write the edges with SQL CREATE EDGE or Vertex.new_edge inside db.transaction(). The Note points to the bulk-loads docs page (section "Known limitation: graph batches next to deletes", PR #97). Docstrings only, no behaviour change.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@tae898
tae898 merged commit 3363f7f into main Oct 26, 2026
32 checks passed
@tae898
tae898 deleted the docs/graph-batch-churn-docstring branch October 26, 2026 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant