add ClientFromContext examples for both pgx + dbsql #656
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bgentry
force-pushed
the
bg-examples-for-client-from-context
branch
from
486aad7 to
da75042
Compare
bgentry
force-pushed
the
bg-examples-for-client-from-context
branch
from
da75042 to
9402c38
Compare
bgentry
commented
Oct 25, 2024
| // ExampleClientFromContext_databaseSQL demonstrates how to extract the River | ||
| // client from the worker context when using the [database/sql] driver. | ||
| // ([github.com/riverqueue/river/riverdriver/riverdatabasesql]) | ||
| func ExampleClientFromContext_databaseSQL() { |
There was a problem hiding this comment.
These examples are named so that they can be correctly associated with the ClientFromContext function. The pkgsite docs will group them together underneath the function's documentation.
https://pkg.go.dev/github.com/fluhus/godoc-tricks#Examples
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While researching #643, I decided to write examples to illustrate whether or not
ClientFromContextwas actually working as intended. Turns out it is, but that there's some nuanced differences between pgx and database/sql drivers here due to the fact thatpgx.Txis an interface, whereassql.Txis a struct which needs to be referenced by pointer with generics.