docs(#4882): update Bolt docs for driver compatibility certification#417
Conversation
Bring the Neo4j BOLT connectivity docs in line with the delivered state of epic #4882 (Bolt Driver Compatibility Certification). The existing page predated the epic and made claims that now contradict the shipped code. Corrections in how-to/connectivity/bolt.adoc: - TLS/SSL is supported (arcadedb.bolt.ssl = DISABLED/OPTIONAL/REQUIRED), no longer "unsupported, use a VPN"; troubleshooting fixed accordingly. - Protocol versions now include 5.0-5.4 (was 3.0/4.0/4.4 only). - Routing is HA-aware, not single-server only. - Added arcadedb.bolt.ssl config row. New sections: - Server Identity and Feature Envelope (advertised "Neo4j/5.26.0 compatible" contract + explicit "does not implement" list) -> closes #4884. - TLS/SSL setup, connection URI schemes, Go example, Data Type Mapping, Error Codes, Causal Consistency (bookmarks), Routing and High Availability, managed transactions with retry-on-transient. - Rewrote Current Limitations to the real ones (auth none, RID/UUID strings, BigDecimal precision, heterogeneous cluster ports). New page how-to/connectivity/bolt-compatibility.adoc -> closes #4892: - Summarizes certified feature areas + documented limitations, linking upstream to the CI-generated conformance artifacts (COMPATIBILITY.md, spec.yaml, driver-versions.md) as the authoritative source. Registered the new page in the sidebar via scripts/generate-nav.py. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Tick the box to add this pull request to the merge queue (same as
|
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for ArcadeDB's Neo4j BOLT protocol implementation. It introduces a new 'Driver Compatibility Matrix' page detailing certified features, limitations, and supported driver versions across Java, JavaScript, Python, .NET, and Go. Additionally, the main BOLT protocol documentation is expanded to cover TLS/SSL configuration, server identity/feature envelope, transaction styles (including managed transactions), causal consistency (bookmarks), data type mapping, error codes, and HA-aware routing, along with a new Go driver example. There are no review comments, so I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
What
Brings the Neo4j BOLT connectivity documentation in line with the delivered state of ArcadeData/arcadedb epic #4882 — Bolt Driver Compatibility Certification. The existing page predated the epic and contained claims that now contradict the shipped
boltmodule (verified against the module source andbolt/conformance/spec.yaml).Corrections in
how-to/connectivity/bolt.adocThese statements were factually wrong and would misconfigure users:
arcadedb.bolt.ssl=DISABLED/OPTIONAL/REQUIRED, reusing the HTTPS keystore/truststore) — the page previously said it was unsupported and told users to use a VPN/SSH tunnel. Troubleshooting guidance fixed accordingly.arcadedb.bolt.sslconfiguration row.New content
Neo4j/5.26.0 compatible (ArcadeDB ...)contract and the explicit "does not implement" list. Delivers child issue #4884.bolt:///bolt+s:///neo4j:///neo4j+s://), Go example, Data Type Mapping (native Node/Relationship/Path/temporal/Duration/Point), Error Codes, Causal Consistency (bookmarks), Routing & HA with the heterogeneous-ports caveat, and managed transactions with retry-on-transient.nonerejected,RID/UUIDas strings,BigDecimalprecision, heterogeneous cluster ports.New page:
how-to/connectivity/bolt-compatibility.adoc(delivers child #4892)Summarizes the certified feature areas and documented limitations, and links upstream to the CI-generated conformance artifacts (
COMPATIBILITY.md,spec.yaml,driver-versions.md) as the authoritative, always-current source rather than duplicating the matrix. Registered in the sidebar viascripts/generate-nav.py.Verification
bash scripts/migrate.sh && npm run buildboth run clean:build/site/.../bolt.html,bolt-compatibility.html).🤖 Generated with Claude Code