DOC-852 | Removed collection methods from JavaScript API

[Simran-B]

Description

• [COR-86] Remove Simple Queries arangodb#22203
• DOC-358 | JS API: Remove collection.range() arangodb#22511
• [COR-155] Remove collection load/unload endpoints arangodb#22237
• [COR-353] Removed deprecated js index functions arangodb#22524

Upstream PRs

• 3.10:
• 3.11:
• 3.12:
• 4.0:

Summary by CodeRabbit

• Documentation
  • Documented removal of multiple JavaScript collection methods in ArangoDB 4.0 (index helpers, query helpers, iteration/lifecycle, key/document helpers, and geo utilities)
  • Published release notes and incompatible-changes entry with migration guidance and AQL/alternative usage patterns for each removed method
  • Updated API docs to mark these methods as removed and point to supported alternatives

[arangodb-docs-automation]

Deploy Preview Available Via
https://deploy-preview-927--docs-hugo.netlify.app

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation-only updates: removed five lines from a collection reference comment and added a new "Removed collection methods" subsection in the 4.0 release notes listing multiple removed JavaScript collection methods with migration guidance. No code or public API declarations changed.

Changes

Cohort / File(s)	Summary
Release notes — API changes & incompatibilities site/content/arangodb/4.0/release-notes/version-4.0/api-changes-in-4-0.md, site/content/arangodb/4.0/release-notes/version-4.0/incompatible-changes-in-4-0.md	Added a new "Removed collection methods" subsection enumerating many removed _collection_ JavaScript methods (e.g., closedRange, documents, lookupByKeys, ensure* index/constraint helpers, fulltext, geo, iterate, load, unload, removeByKeys, near, within, withinRectangle) with suggested AQL/alternative API replacements.
JavaScript collection reference site/content/arangodb/4.0/develop/javascript-api/@arangodb/collection-object.md	Removed five lines from the "Undocumented on purpose" comment block that previously listed legacy/deprecated methods (MMFiles legacy, Simple Queries, deprecated iterator). No other document content changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

• nerpaula

Poem

🐰 I hopped through docs with a twitch and a grin,

Old collection whispers tucked quietly in.
With methods retired, the meadow feels new —
AQL sings softly, and the sky’s clearer blue. 🥕✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: documentation updates to remove references to deprecated collection methods from the JavaScript API across multiple release notes and API documentation files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch DOC-852_js-coll-methods

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (2)

site/content/arangodb/4.0/release-notes/version-4.0/api-changes-in-4-0.md (1)

56-58: Clarify this is client-side JavaScript API scope in 4.0.

To avoid confusion with 4.0’s removal of server-side JavaScript, consider explicitly stating these removed _collection_ methods are from client-side JavaScript usage (for example, arangosh context).

Based on learnings: In ArangoDB 4.0, server-side JavaScript execution has been removed entirely, so 4.0 docs should avoid ambiguity around JavaScript scope.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@site/content/arangodb/4.0/release-notes/version-4.0/api-changes-in-4-0.md`
around lines 56 - 58, Update the sentence about removed _collection_ methods to
explicitly state these removals apply to the client-side JavaScript API (e.g.,
arangosh/context) in ArangoDB 4.0; mention that server-side JavaScript execution
has been removed entirely in 4.0 so this list refers only to client-side usage
and won't affect server-side code, and ensure references like "_collection_
objects" and the linked JavaScript API docs reflect that client-side scope.

site/content/arangodb/4.0/release-notes/version-4.0/incompatible-changes-in-4-0.md (1)

30-33: Consider clarifying JavaScript scope for 4.0 in this incompatible-change summary.

A short qualifier (client-side JavaScript API) here would make this section consistent with 4.0’s server-side JavaScript removal and reduce reader confusion.

Based on learnings: In ArangoDB 4.0, server-side JavaScript execution has been removed entirely, so JavaScript references in 4.0 docs should be explicitly scoped when needed.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In
`@site/content/arangodb/4.0/release-notes/version-4.0/incompatible-changes-in-4-0.md`
around lines 30 - 33, Update the sentence "The following methods have been
removed from _collection_ objects" to explicitly scope it as client-side
JavaScript by adding a short qualifier such as "client-side JavaScript API"
(e.g., "The following methods have been removed from client-side JavaScript API
_collection_ objects") so readers don't confuse this with server-side JS
removals; ensure the qualifier appears near the phrase "_collection_ objects"
for clarity and consistency with other 4.0 notes.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@site/content/arangodb/4.0/release-notes/version-4.0/api-changes-in-4-0.md`:
- Around line 179-180: The fragment link to "#geojson-interpretation" is
unresolved; either add a corresponding heading/anchor titled "GeoJSON
interpretation" somewhere appropriate in this document (so the [GeoJSON
interpretation](`#geojson-interpretation`) link resolves), or change the link
target/text to point to an existing section (or remove the parenthetical
entirely). Update the sentence containing "Use an AQL query like this... (see
[GeoJSON interpretation](`#geojson-interpretation`))" accordingly and ensure the
new heading or link text uses the exact anchor name "geojson-interpretation" so
the fragment resolves.
- Around line 183-192: The AQL in the db._query call uses a value bind
`@collection` for the FOR ... IN clause which will fail; change the collection
bind inside the query string to a collection bind @@collection (double @) and
keep the bind parameter key in the parameter object as "collection" so the
db._query invocation (the db._query(`...`, { "@collection": "coll", ... }) call)
passes the collection via the @@collection placeholder; update the query string
in the db._query invocation shown (the GEO_POLYGON / FOR doc IN ... block) to
use @@collection instead of `@collection`.

---

Nitpick comments:
In `@site/content/arangodb/4.0/release-notes/version-4.0/api-changes-in-4-0.md`:
- Around line 56-58: Update the sentence about removed _collection_ methods to
explicitly state these removals apply to the client-side JavaScript API (e.g.,
arangosh/context) in ArangoDB 4.0; mention that server-side JavaScript execution
has been removed entirely in 4.0 so this list refers only to client-side usage
and won't affect server-side code, and ensure references like "_collection_
objects" and the linked JavaScript API docs reflect that client-side scope.

In
`@site/content/arangodb/4.0/release-notes/version-4.0/incompatible-changes-in-4-0.md`:
- Around line 30-33: Update the sentence "The following methods have been
removed from _collection_ objects" to explicitly scope it as client-side
JavaScript by adding a short qualifier such as "client-side JavaScript API"
(e.g., "The following methods have been removed from client-side JavaScript API
_collection_ objects") so readers don't confuse this with server-side JS
removals; ensure the qualifier appears near the phrase "_collection_ objects"
for clarity and consistency with other 4.0 notes.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5a50e3da-f9e2-445d-8f98-5572baab0ad5

📥 Commits

Reviewing files that changed from the base of the PR and between 707c362 and 2ae9011.

📒 Files selected for processing (3)

• site/content/arangodb/4.0/develop/javascript-api/@arangodb/collection-object.md
• site/content/arangodb/4.0/release-notes/version-4.0/api-changes-in-4-0.md
• site/content/arangodb/4.0/release-notes/version-4.0/incompatible-changes-in-4-0.md

💤 Files with no reviewable changes (1)

• site/content/arangodb/4.0/develop/javascript-api/@arangodb/collection-object.md