Skip to content

Commit

Permalink
Update docs about pgx native interface support
Browse files Browse the repository at this point in the history
  • Loading branch information
georgysavva committed Jul 23, 2020
1 parent c3f7042 commit 085da34
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ with just one function call and don't bother with rows iteration.

scany isn't limited to any specific database. It integrates with `database/sql`,
so any database with `database/sql` driver is supported.
It also works with [pgx](https://github.com/jackc/pgx) native interface.
It also works with [pgx](https://github.com/jackc/pgx) library native interface.
Apart from the out of the box support, scany can be easily extended to work with almost any database library.

Note that, scany isn't an ORM. First of all, it works only in one direction:
Expand Down Expand Up @@ -94,7 +94,7 @@ func main() {
```

Use [`pgxscan`](https://pkg.go.dev/github.com/georgysavva/scany/pgxscan)
package to work with `pgx` library.
package to work with `pgx` library native interface.

## How to use with other database libraries

Expand Down
4 changes: 2 additions & 2 deletions doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
/*
scany isn't limited to any specific database. It integrates with database/sql,
so any database with database/sql driver is supported.
It also works with https://github.com/jackc/pgx - specific library for PostgreSQL.
It also works with https://github.com/jackc/pgx native interface.
Apart from the out of the box support, scany can be easily extended to work with almost any database library.
scany contains the following packages:
sqlscan package works with database/sql standard library.
pgxscan package works with github.com/jackc/pgx library.
pgxscan package works with github.com/jackc/pgx library native interface.
dbscan package works with an abstract database and can be integrated with any library that has a concept of rows.
This particular package implements core scany features and contains all the logic.
Expand Down
4 changes: 2 additions & 2 deletions pgxscan/doc.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Package pgxscan allows scanning data into Go structs and other composite types,
// when working with pgx library.
// when working with pgx library native interface.
/*
Essentially, pgxscan is a wrapper around github.com/georgysavva/scany/dbscan package.
pgxscan connects github.com/jackc/pgx/v4 with dbscan functionality.
pgxscan connects github.com/jackc/pgx/v4 native interface with dbscan functionality.
It contains adapters that are meant to work with pgx.Rows and proxy all calls to dbscan.
pgxscan mirrors all capabilities provided by dbscan.
It's encouraged to read dbscan docs first to get familiar with all concepts and features.
Expand Down

0 comments on commit 085da34

Please sign in to comment.