introspect column comments

[maktouch]

closes #841

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
kysely	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 14, 2024 1:43pm

[koskimas]

Thank you!

How about SQLite and mssql? If they support comments, this feature needs to be implemented for those also.

Tests are also needed for every feature. Add at least one test that adds a comment and checks that it gets returned by the introspector. Currently the tests and the whole feature are completely broken.

[maktouch]

Thank you!

How about SQLite and mssql? If they support comments, this feature needs to be implemented for those also.

Tests are also needed for every feature. Add at least one test that adds a comment and checks that it gets returned by the introspector. Currently the tests and the whole feature are completely broken.

Haha it's why I made this field optional. I wasn't familiar enough with them to implement it 😂

Ok I'll get familiar, implement the feature, make it non optional but billable, and do the tests.

[koskimas]

Haha it's why I made this field optional. I wasn't familiar enough with them to implement it

It should still be optional even if all built-in dialects support it. Not all databases do, and we want 3rd party dialects to be able to implement the API.

[maktouch]

Haha it's why I made this field optional. I wasn't familiar enough with them to implement it

It should still be optional even if all built-in dialects support it. Not all databases do, and we want 3rd party dialects to be able to implement the API.

ok that makes sense, so I'll make the value be undefined if it's empty

[maktouch]

I've reverted my changes and started from scratch in TDD mode

• The first thing I did was modify test/node/src/test-setup.ts to add a comment somewhere for each dialect. Unfortunately, I wasn't able to reliably add a comment for sqlite here, so sqlite always returns undefined for comment. If you can help me out here, that would be great! (or we can also just ignore it, it doesn't seem like comment is a real feature in sqlite)
• Then I added the expected comments in test/node/src/schema.test.ts and test/node/src/introspect.test.ts
• Implemented the features in src/dialect/$DB/$DB-introspector.ts until it passed.

Let me know what else I can change! Thanks! :)

[maktouch]

Hey @koskimas

Please check this PR when you have time 🙏🙏

Thank you

[koskimas]

Perfect! Thank you 👍