From 498b990f1a72c500229496a85eeb19a4daf4a2ba Mon Sep 17 00:00:00 2001 From: Brandur Date: Wed, 10 Jul 2024 19:19:13 -0700 Subject: [PATCH] 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. --- riverdriver/riverdatabasesql/river_database_sql.go | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/riverdriver/riverdatabasesql/river_database_sql.go b/riverdriver/riverdatabasesql/river_database_sql.go index bbdfb812..ebaaf0a8 100644 --- a/riverdriver/riverdatabasesql/river_database_sql.go +++ b/riverdriver/riverdatabasesql/river_database_sql.go @@ -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 ( @@ -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()} }