Feature request: Comments for tables and columns
Would be useful for Convex dashboard, Intellisense tooltip, code comprehensibility for LLM's (e.g. Codeium and Cody), and perhaps in the future, LLM responses in JSON mode
7 Replies
Hi @Matt Luo. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave:
----------------------
I'm sorry, but as an AI, I don't have the ability to implement feature requests or make changes to the Convex platform. However, I can tell you that your suggestion seems valuable for enhancing the usability and comprehensibility of the Convex system.
Currently, Convex is under active development and the team is open to feedback and suggestions. I recommend sharing your feature request directly with the Convex team. You can do this through the Convex Discord Community (https://convex.dev/community) as mentioned in the Convex documentation (https://docs.convex.dev/production/state/#future-features).
Remember to explain why this feature would be beneficial and how it could improve the Convex experience. The Convex team values user feedback and may consider implementing your suggestion in future updates.
----------------------
Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:
----------------------
<@752909161829892208> kapa.ai is still learning and improving, please let us know how it did by reacting below
Regarding "LLM responses in JSON mode", I see that the Vercel AI SDK uses Zod for typing the LLM response. Perhaps Convex can have some kind of easy way to define a response structure that is a subset of a Convex table
FYI - Drizzle does not have table or column comment functionality. Open feature requests:
https://github.com/drizzle-team/drizzle-orm/issues/886
Interestingly, someone wrote: Dynamic usage. I'm working with GPT Functions for inserting data via Chat. If I had .comment(), I could table.reduce(...) the whole thing into JSON Schema where OpenAI requires parameter descriptions. For now I'm just copy/pasting all the schemas.
https://github.com/drizzle-team/drizzle-orm/issues/1840
GitHub
[FEATURE]: Add a possibility to add a comment on a Table, Column......
Describe what you want It would be great to add a comment on Tables, Columns .... So that you can describe the tables, columns in the drizzle-orm model and it's also in the database, e.g. a dat...
GitHub
[FEATURE]: Support Comments for Column definitions and introspectio...
Describe what you want MySQL has a feature where you can add comments to the column definitions. This is useful when exploring the database from a Database manager as the comment adds information f...
I agree this would be useful. For now you can add comments to your schema, but you won't be able to see them on the dashboard.
@ari FYI - today a PR was rejected because someone was not aware of a database column, lastActivityTime. A comment for the column would have been helpful here.
I'll continue to add my own TypeScript comments on the column (like in the attached screenshot), but a native feature would help.
In our team, we are starting to federate out the schema.ts into different files. This makes it more difficult for a developer to know what the various tables and columns are.
So even if there's a TypeScript comment on a column, that TypeScript comment is not going to surface up to the Convex dashboard