typelevel / typelevel/doobie

Allow insertions using case classes

Open
#468 9 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
2.2k
Forks
379
Avg merge
14m
Merged PRs (30d)
8

Description

Currently, the documentation show insertion examples being done only through individual values:

def insert1(name: String, age: Option[Short]): Update0 =
  sql"insert into person (name, age) values ($name, $age)".update

scala> insert1("Alice", Some(12)).run.transact(xa).unsafePerformIO
res2: Int = 1

It seems like it's possible to do insertions using case classes through the Update constructor but according to @tpolecat this is discouraged. This issue is mainly to look into why that is so.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation's individual-value insertion examples and the Update constructor usage mentioned in the issue. Determine why case-class insertions are discouraged, then document the supported approach and the rationale clearly enough for users to tell when each option is appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.