sql/vtable: add package documentation for pg_catalog compatibility#167436
Open
rafiss wants to merge 1 commit intocockroachdb:masterfrom
Open
sql/vtable: add package documentation for pg_catalog compatibility#167436rafiss wants to merge 1 commit intocockroachdb:masterfrom
rafiss wants to merge 1 commit intocockroachdb:masterfrom
Conversation
Add a doc.go to the vtable package documenting: - The split between schema definitions (vtable/) and populate logic (pkg/sql/) - Why pg_catalog compatibility matters (ORM/tooling ecosystem) - The postgres matching strategy (PgServerVersion, undefinedTables, stub_catalog_tables, implementation tiers) - How virtual tables work (virtualSchema, virtualSchemaTable, populate vs generator) - Virtual indexes (complete vs incomplete, OID hashing) - The pg_catalog diff tool workflow (generate-metadata-tables, TestDiffTool, step-by-step for PG version bumps) - Key files reference Epic: CRDB-61382 Fixes: CRDB-61385 Release note: None Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>
Contributor
|
Merging to
After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here |
|
It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR? 🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf. |
Member
|
This change is |
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
2 participants
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.
Add a doc.go to the vtable package documenting:
Epic: CRDB-61382
Fixes: CRDB-61385
Release note: None