docs: add design note on foreign rel tables - #842
Open
adsharma wants to merge 1 commit into
Open
Conversation
Document how foreign SQL databases represent graph elements: the node_*/rel_*/csr_rel_* naming convention, the two-pass catalog initialization order, and the alternatives considered (Arrow scan, shadow entries + ForeignRelTable, SQL transpilation, attach-time CSR materialization), plus the rowid challenges per backend (DuckDB, Postgres, ADBC).
adsharma
force-pushed
the
docs-foreign-rel-tables
branch
from
August 27, 2026 16:33
0fdd58d to
64b38a3
Compare
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
1 participant
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.
Adds
docs/foreign_rel_table.md, the design reference for representing graphs in foreign SQL databases (DuckDB / PostgreSQL / ADBC):node_*/rel_*/csr_rel_*naming convention and how catalog extensions classify tables by prefixNodeTableCatalogEntry+ForeignRelTable(shipped design), SQL join transpilation, attach-time CSR materializationCompanion code PR: LadybugDB/extensions#65