immich-app/drift
1
0
Fork 0
mirror of https://github.com/immich-app/drift.git synced 2026-09-30 13:22:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add warning about converter imports

Browse Source 
Related to https://github.com/simolus3/drift/issues/3684
This commit is contained in:
Simon Binder
2025-10-05 13:57:14 +02:00
parent d50f8342c5
commit 50037f4fc2
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/type_converters.md
+6 -1
View File
@@ -32,11 +32,16 @@ The generated `User` class will then have a `preferences` column of type
the object in `select`, `update` and `insert` statements. This feature
also works with [compiled custom queries]("/queries/custom").
!!! warning "Caution with equality"
!!! warning "Common type converter issues"
If your converter returns an object that is not comparable by value, the generated dataclass will not
be comparable by value. Consider implementing `==` and `hashCode` on those classes.
Also note that drift generates `part` files by default, which currently can't have their own imports.
For this reason, if you define tables in another file than your database file, you'll have to manually
add imports to type converters to that file.
[Modular code generation](generation_options/modular.md) can fix this issue too.
Since applying type converters for JSON conversion is so common, drift provides a helper
for that. For instance, we could declare the type converter as a field in the
`Preferences` class: