Expose executor via InternalExecutorBundle on Client #494
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-expose-executor
branch
2 times, most recently
from
84f18b8
to
abebce8
Compare
This adds an `InternalExecutorBundle()` method to `Client` which returns a new `driver.InternalExecutorBundle[TTx]` interface type. The interface exposes the driver's internal executors via `Executor()` and `ExecutorTx(tx)` methods. This can enable external modules to run queries against River's underlying drivers, including arbitrary SQL. Compatibility interfaces for `ExecResult`, `Rows`, and `Row` are able to paper over the basic differences between `database/sql` and `pgx` in order to expose just enough functionality for basic arbitrary SQL queries.
bgentry
force-pushed
the
bg-expose-executor
branch
from
abebce8
to
ef5dff2
Compare
Merged
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.
This adds an
InternalExecutorBundle()method toClientwhich returns a newdriver.InternalExecutorBundle[TTx]interface type. The interface exposes the driver's internal executors viaExecutor()andExecutorTx(tx)methods. This can enable external modules to run queries against River's underlying drivers, including arbitrary SQL.Compatibility interfaces for
ExecResult,Rows, andRoware able to paper over the basic differences betweendatabase/sqlandpgxin order to expose just enough functionality for basic arbitrary SQL queries.For now, this allows us to run simple SQL queries against River's drivers from external libraries. In the future, it could be a path toward extracting most of the duplicate queries in drivers into a shared query module that isn't driver-specific. Drivers would become a simpler interface focused on
Exec/Query/QueryRowand row scanning details, rather than each needing to implement every query under the sun.A final commit ef5dff2 demonstrates a possible extension of this pattern to expand the driver interface so that it can abstract all details of deserializing
river_jobrows, allowing driver-specific details like[]bytevsstringfor json to be tucked away in a single implementation, even if external packages are able to run arbitrary queries for jobs. This commit can be omitted from merge but I wanted to at least illustrate the potential here.