Document running custom JDBC operations
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 379
- Avg merge
- 14m
- Merged PRs (30d)
- 8
Description
Since https://github.com/typelevel/doobie/pull/2064 we have better ways for users to customize their JDBC execution more while still retaining the ability to log and measure execution times.
We should document how to:
- Extract the individual "steps" from a fragment (Need #2065)
- Plug the various "steps" into
doobie.hi.executeWithResultSet/executeWithoutResultSetwhile customizing some of the steps (e.g. running executeLargeUpdate instead of executeUpdate)
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 by reading pull request #2064 and the prerequisite work in #2065 to understand the custom JDBC execution APIs. Document extracting fragment steps and composing them with doobie.hi.executeWithResultSet or executeWithoutResultSet, including customization such as executeLargeUpdate; done means both workflows are explained for users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100