Add pgxtype package for simpler type registration

go.mod

@@ -4,6 +4,7 @@ go 1.12
 
 require (
 	github.com/gofrs/uuid v3.2.0+incompatible
+	github.com/jackc/pgconn v1.5.0
 	github.com/jackc/pgio v1.0.0
 	github.com/jackc/pgx/v4 v4.6.1-0.20200510190926-94ba730bb1e9
 	github.com/lib/pq v1.3.0

pgxtype/README.md

@@ -0,0 +1,3 @@
+# pgxtype
+
+pgxtype is a helper module that connects pgx and pgtype. This package is not currently covered by semantic version guarantees. i.e. The interfaces may change without a major version release of pgtype.

pgxtype/pgxtype.go

@@ -0,0 +1,145 @@
+package pgxtype
+
+import (
+	"context"
+	"errors"
+
+	"github.com/jackc/pgconn"
+	"github.com/jackc/pgtype"
+	"github.com/jackc/pgx/v4"
+)
+
+type Querier interface {
+	Exec(ctx context.Context, sql string, arguments ...interface{}) (pgconn.CommandTag, error)
+	Query(ctx context.Context, sql string, optionsAndArgs ...interface{}) (pgx.Rows, error)
+	QueryRow(ctx context.Context, sql string, optionsAndArgs ...interface{}) pgx.Row
+}
+
+// LoadDataType uses conn to inspect the database for typeName and produces a pgtype.DataType suitable for
+// registration on ci.
+func LoadDataType(ctx context.Context, conn Querier, ci *pgtype.ConnInfo, typeName string) (pgtype.DataType, error) {
+	var oid uint32
+
+	err := conn.QueryRow(ctx, "select $1::text::regtype::oid;", typeName).Scan(&oid)
+	if err != nil {
+		return pgtype.DataType{}, err
+	}
+
+	var typtype string
+
+	err = conn.QueryRow(ctx, "select typtype::text from pg_type where oid=$1", oid).Scan(&typtype)
+	if err != nil {
+		return pgtype.DataType{}, err
+	}
+
+	switch typtype {
+	case "b": // array
+		elementOID, err := GetArrayElementOID(ctx, conn, oid)
+		if err != nil {
+			return pgtype.DataType{}, err
+		}
+
+		var element pgtype.ValueTranscoder
+		if dt, ok := ci.DataTypeForOID(elementOID); ok {
+			if element, ok = dt.Value.(pgtype.ValueTranscoder); !ok {
+				return pgtype.DataType{}, errors.New("array element OID not registered as ValueTranscoder")
+			}
+		}
+
+		newElement := func() pgtype.ValueTranscoder {
+			return pgtype.NewValue(element).(pgtype.ValueTranscoder)
+		}
+
+		at := pgtype.NewArrayType(typeName, elementOID, newElement)
+		return pgtype.DataType{Value: at, Name: typeName, OID: oid}, nil
+	case "c": // composite
+		fields, err := GetCompositeFields(ctx, conn, oid)
+		if err != nil {
+			return pgtype.DataType{}, err
+		}
+		ct, err := pgtype.NewCompositeType(typeName, fields, ci)
+		if err != nil {
+			return pgtype.DataType{}, err
+		}
+		return pgtype.DataType{Value: ct, Name: typeName, OID: oid}, nil
+	case "e": // enum
+		members, err := GetEnumMembers(ctx, conn, oid)
+		if err != nil {
+			return pgtype.DataType{}, err
+		}
+		return pgtype.DataType{Value: pgtype.NewEnumType(typeName, members), Name: typeName, OID: oid}, nil
+	default:
+		return pgtype.DataType{}, errors.New("unknown typtype")
+	}
+}
+
+func GetArrayElementOID(ctx context.Context, conn Querier, oid uint32) (uint32, error) {
+	var typelem uint32
+
+	err := conn.QueryRow(ctx, "select typelem from pg_type where oid=$1", oid).Scan(&typelem)
+	if err != nil {
+		return 0, err
+	}
+
+	return typelem, nil
+}
+
+// GetCompositeFields gets the fields of a composite type.
+func GetCompositeFields(ctx context.Context, conn Querier, oid uint32) ([]pgtype.CompositeTypeField, error) {
+	var typrelid uint32
+
+	err := conn.QueryRow(ctx, "select typrelid from pg_type where oid=$1", oid).Scan(&typrelid)
+	if err != nil {
+		return nil, err
+	}
+
+	var fields []pgtype.CompositeTypeField
+
+	rows, err := conn.Query(ctx, `select attname, atttypid
+from pg_attribute
+where attrelid=$1
+order by attnum`, typrelid)
+	if err != nil {
+		return nil, err
+	}
+
+	for rows.Next() {
+		var f pgtype.CompositeTypeField
+		err := rows.Scan(&f.Name, &f.OID)
+		if err != nil {
+			return nil, err
+		}
+		fields = append(fields, f)
+	}
+
+	if rows.Err() != nil {
+		return nil, rows.Err()
+	}
+
+	return fields, nil
+}
+
+// GetEnumMembers gets the possible values of the enum by oid.
+func GetEnumMembers(ctx context.Context, conn Querier, oid uint32) ([]string, error) {
+	members := []string{}
+
+	rows, err := conn.Query(ctx, "select enumlabel from pg_enum where enumtypid=$1 order by enumsortorder", oid)
+	if err != nil {
+		return nil, err
+	}
+
+	for rows.Next() {
+		var m string
+		err := rows.Scan(&m)
+		if err != nil {
+			return nil, err
+		}
+		members = append(members, m)
+	}
+
+	if rows.Err() != nil {
+		return nil, rows.Err()
+	}
+
+	return members, nil
+}