Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed outdated comment in riverdatabasesql #445

Merged
merged 1 commit into from
Jul 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions riverdriver/riverdatabasesql/river_database_sql.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Package riverdatabasesql bundles a River driver for Go's built in
// database/sql. It's generally still powered under the hood by Pgx because it's
// the only maintained, fully functional Postgres driver in the Go ecosystem,
// but it uses some lib/pq constructs internally by virtue of being implemented
// with Sqlc.
// Package riverdatabasesql bundles a River driver for Go's built-in
// database/sql, making it interoperable with ORMs like Bun and GORM. It's
// generally still powered under the hood by Pgx because it's the only
// maintained, fully functional Postgres driver in the Go ecosystem, but it uses
// some lib/pq constructs internally by virtue of being implemented with Sqlc.
package riverdatabasesql

import (
Expand Down Expand Up @@ -40,10 +40,6 @@ type Driver struct {
// It takes an sql.DB to use for use with River. The pool should already be
// configured to use the schema specified in the client's Schema field. The pool
// must not be closed while associated River objects are running.
//
// This is _not_ a fully functional driver, and only supports use through
// rivermigrate for purposes of interacting with migration frameworks like
// Goose. Using it with a River client will panic.
func New(dbPool *sql.DB) *Driver {
return &Driver{dbPool: dbPool, queries: dbsqlc.New()}
}
Expand Down
Loading