FEAT: Enhanced Introspection - store types/function/etc. metadata

[austinm911]

I haven't used the introspect feature very much, but in my limited use I'm wondering if some improvements can be made to the
feature, namely around importing types, default functions, and so forth.

I understand introspect was likely planned for users who had no drizzle configuartion setup but had a database already created, so users using introspect can easily import and get started.

However for my use case, I have a database I'm using in different projects. I have noticed in my limited use that I have to go back to my source schema to copy over types/default functions used. So in effect, I should have just copy and pasted my original files.

This feature idea is inspired from Windmill - which has a really robust way of syncing between remote and local code configuration - see Local development | Windmill

Problems

If you have any extra options, types, etc defined in a source drizzle schema and you introspect it to other projects, you will lose this extra information.

For example, with SQLite

Field Options

Source: field: text('field', { mode: 'json' }),
Introspected: field: text("field")

Default Functions

Source: createdOn: text("created_on").notNull().$defaultFn(() => new Date().toISOString())
Introspected: createdOn: text("created_on")

Proposed Solution

• store additional metadata containing this extra information in a similar manner how drizzle stores migrations

Reason for Improvement

• this may enable users to sync drizzle schema and relations across projects
• allows users to pull down exact schema configuration with no further work needed
• could enable feature to push/pull schema/relation definitions (see windmill's push/pull syncing)
• could enable code splitting to import schemas/relations matching user's source directory (e.g. if user defined one schema per file, then when introspecting this would be respected instead of all tables imported into a single schema.ts file

Unknowns

• bundling functions used in schemas e.g. id: text().primaryKey().notNull().$defaultFn(nanoid),, where nanoId is a function imported from another file. How should this be handled? Ideally, when user introspects, the functions imported could be bundled and imported into a utils.ts file alongside schema.ts and relations.ts