Skip to content

(New Feature) Introspect Table Comments #1368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
IggyMi opened this issue Feb 24, 2025 · 0 comments
Open

(New Feature) Introspect Table Comments #1368

IggyMi opened this issue Feb 24, 2025 · 0 comments
Labels
api Related to library's API built-in dialect Related to a built-in dialect custom dialect Related to a custom dialect enhancement New feature or request

Comments

@IggyMi
Copy link

IggyMi commented Feb 24, 2025 •
edited
Loading

What?

introspection.getTables already provides column comments but does not provide table comments.

Why?

Tools like kysely-codegen could use table comments to provide type-level comments for generated types, helping with consistent documentation across the stack.

I would be willing to implement this myself (already poked around the code) for databases that support table-level comments. However, I'd need some help as build:cjs is failing atop the master branch.
@igalklebanov igalklebanov added enhancement New feature or request custom dialect Related to a custom dialect built-in dialect Related to a built-in dialect api Related to library's API labels Mar 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
api Related to library's API built-in dialect Related to a built-in dialect custom dialect Related to a custom dialect enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@igalklebanov @IggyMi