tux_pgx_scan

README

tux-pgx-scan

Easier method to scan from DB to complicated structs

Requirements

this library uses pgx (https://github.com/jackc/pgx) to connect to the database. it makes it a lot easier for me to unpack each row and json data properly.

the story

I was looking for an easy to scan a query to a struct, a variable, a row , several rows, array of complicated structs.. all in one function that fits all.

I have a project that I'm working on with gqlgen for GraphQL API (https://github.com/99designs/gqlgen) and pgx (https://github.com/jackc/pgx) to connect to a postgresql database. I still didn't find a proper solution that fits all. that I can take the structs that are being created by gqlgen as-is and scan rows directly to them. so I made this!

HOW TO

the best method i think is to open scan_test.go and see all the tests I created there.

you have one function

func MyQuery(ctx context.Context, conn *pgxpool.Pool, dstAddr interface{}, sql string, args ...interface{}) (bool, error)

needs context, connection pool, destination address (can be an address to a slice, variable, struct.. whatever), the sql query and it's arguments.

so this example is a test to insert query result to a string

sqlQuery := "select 'moshe'"
if conn, err := GetDbConnection(); err != nil {
	t.Errorf("could not connect to database: %v", err)
} else {
	var foo string
	if _, err := MyQuery(context.Background(), conn, &foo, sqlQuery); err != nil {
		t.Error(err)
	} else {
		if foo != "moshe" {
			t.Errorf("foo should be moshe: '%v'", foo)
		}
	}
}

TODO

pgx is a must, so I'm not gonna change that!

• I tested only with postgres I would like to add more test cases with other databases to make sure things are working right.
• I would also want to create profiling tests to see how slow/fast it is compared to other methods.

Documentation

Index

• func BytesToString(b []byte) string
• func MyQuery(ctx context.Context, conn dbconn, dstAddr interface{}, sql string, ...) (bool, error)
• type MyQueryScanRet
  • func MyQueryScan(ctx context.Context, conn dbconn, sql string, args ...interface{}) (*MyQueryScanRet, bool, error)
  • func (m *MyQueryScanRet) Scan(dest ...interface{}) error

Functions

func BytesToString

func BytesToString(b []byte) string

func MyQuery

func MyQuery(ctx context.Context, conn dbconn, dstAddr interface{}, sql string, args ...interface{}) (bool, error)

Types

type MyQueryScanRet

type MyQueryScanRet struct {
	Rows pgx.Rows
}

func MyQueryScan

func MyQueryScan(ctx context.Context, conn dbconn, sql string, args ...interface{}) (*MyQueryScanRet, bool, error)

func (*MyQueryScanRet) Scan

func (m *MyQueryScanRet) Scan(dest ...interface{}) error