Document need for `toFragment` when mapping multiple columns to one type
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 379
- Avg merge
- 14m
- Merged PRs (30d)
- 8
Description
Hello,
I recently worked through a case similar to the Point example which describes the need for Read[A] and Write[A]. The select worked well, the insert/update failed with 'type mismatch' and it took some digging in gitter to learn that I needed:
case class Key(x: Int, y: Int)
case class Foo(key: Key, z: Int) // Need to map key to two columns x,y in the DB
// In my doobie code
fr"""insert into foo values (""" ++ keyWrite.toFragment(foo.key) ++ """, ${foo.z})""".update
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing Point example and the documentation around Read[A], Write[A], and toFragment. Add a clear example explaining how to map multiple database columns to one type during insert/update, and ensure the documentation makes the required toFragment usage discoverable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- database, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100