Skip to content

Commit 498b990

Browse files
committed
Removed outdated comment in riverdatabasesql
Removed outdated comment in `riverdatabasesql` that indicates that it's not a fully functional driver, which is no longer accurate as of #351. Also mention Bun and GORM in the Godoc.
1 parent b44f59a commit 498b990

1 file changed

Lines changed: 5 additions & 9 deletions

File tree

riverdriver/riverdatabasesql/river_database_sql.go

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
// Package riverdatabasesql bundles a River driver for Go's built in
2-
// database/sql. It's generally still powered under the hood by Pgx because it's
3-
// the only maintained, fully functional Postgres driver in the Go ecosystem,
4-
// but it uses some lib/pq constructs internally by virtue of being implemented
5-
// with Sqlc.
1+
// Package riverdatabasesql bundles a River driver for Go's built-in
2+
// database/sql, making it interoperable with ORMs like Bun and GORM. It's
3+
// generally still powered under the hood by Pgx because it's the only
4+
// maintained, fully functional Postgres driver in the Go ecosystem, but it uses
5+
// some lib/pq constructs internally by virtue of being implemented with Sqlc.
66
package riverdatabasesql
77

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

0 commit comments

Comments
 (0)