diff --git a/pgtype/array_type.go b/pgtype/array_type.go deleted file mode 100644 index c4f162af..00000000 --- a/pgtype/array_type.go +++ /dev/null @@ -1,368 +0,0 @@ -package pgtype - -import ( - "database/sql/driver" - "encoding/binary" - "fmt" - "reflect" - - "github.com/jackc/pgio" -) - -// ArrayType represents an array type. While it implements Value, this is only in service of its type conversion duties -// when registered as a data type in a ConnType. It should not be used directly as a Value. ArrayType is a convenience -// type for types that do not have an concrete array type. -type ArrayType struct { - elements []ValueTranscoder - dimensions []ArrayDimension - - typeName string - newElement func() ValueTranscoder - - elementOID uint32 - valid bool -} - -func NewArrayType(typeName string, elementOID uint32, newElement func() ValueTranscoder) *ArrayType { - return &ArrayType{typeName: typeName, elementOID: elementOID, newElement: newElement} -} - -func (at *ArrayType) NewTypeValue() Value { - return &ArrayType{ - elements: at.elements, - dimensions: at.dimensions, - valid: at.valid, - - typeName: at.typeName, - elementOID: at.elementOID, - newElement: at.newElement, - } -} - -func (at *ArrayType) TypeName() string { - return at.typeName -} - -func (dst *ArrayType) setNil() { - dst.elements = nil - dst.dimensions = nil - dst.valid = false -} - -func (dst *ArrayType) Set(src interface{}) error { - // untyped nil and typed nil interfaces are different - if src == nil { - dst.setNil() - return nil - } - - sliceVal := reflect.ValueOf(src) - if sliceVal.Kind() != reflect.Slice { - return fmt.Errorf("cannot set non-slice") - } - - if sliceVal.IsNil() { - dst.setNil() - return nil - } - - dst.elements = make([]ValueTranscoder, sliceVal.Len()) - for i := range dst.elements { - v := dst.newElement() - err := v.Set(sliceVal.Index(i).Interface()) - if err != nil { - return err - } - - dst.elements[i] = v - } - dst.dimensions = []ArrayDimension{{Length: int32(len(dst.elements)), LowerBound: 1}} - dst.valid = true - - return nil -} - -func (src ArrayType) Get() interface{} { - if !src.valid { - return nil - } - - elementValues := make([]interface{}, len(src.elements)) - for i := range src.elements { - elementValues[i] = src.elements[i].Get() - } - return elementValues -} - -func (src *ArrayType) AssignTo(dst interface{}) error { - ptrSlice := reflect.ValueOf(dst) - if ptrSlice.Kind() != reflect.Ptr { - return fmt.Errorf("cannot assign to non-pointer") - } - - sliceVal := ptrSlice.Elem() - sliceType := sliceVal.Type() - - if sliceType.Kind() != reflect.Slice { - return fmt.Errorf("cannot assign to pointer to non-slice") - } - - if src.valid { - slice := reflect.MakeSlice(sliceType, len(src.elements), len(src.elements)) - elemType := sliceType.Elem() - - for i := range src.elements { - ptrElem := reflect.New(elemType) - err := src.elements[i].AssignTo(ptrElem.Interface()) - if err != nil { - return err - } - - slice.Index(i).Set(ptrElem.Elem()) - } - - sliceVal.Set(slice) - return nil - } else { - sliceVal.Set(reflect.Zero(sliceType)) - return nil - } -} - -func (ArrayType) BinaryFormatSupported() bool { - return true -} - -func (ArrayType) TextFormatSupported() bool { - return true -} - -func (ArrayType) PreferredFormat() int16 { - return TextFormatCode -} - -func (dst *ArrayType) DecodeResult(ci *ConnInfo, oid uint32, format int16, src []byte) error { - if src == nil { - dst.setNil() - return nil - } - - switch format { - case BinaryFormatCode: - return dst.DecodeBinary(ci, src) - case TextFormatCode: - return dst.DecodeText(ci, src) - } - return fmt.Errorf("unknown format code %d", format) -} - -func (src ArrayType) EncodeParam(ci *ConnInfo, oid uint32, format int16, buf []byte) (newBuf []byte, err error) { - switch format { - case BinaryFormatCode: - return src.EncodeBinary(ci, buf) - case TextFormatCode: - return src.EncodeText(ci, buf) - } - return nil, fmt.Errorf("unknown format code %d", format) -} - -func (dst *ArrayType) DecodeText(ci *ConnInfo, src []byte) error { - uta, err := ParseUntypedTextArray(string(src)) - if err != nil { - return err - } - - var elements []ValueTranscoder - - if len(uta.Elements) > 0 { - elements = make([]ValueTranscoder, len(uta.Elements)) - - for i, s := range uta.Elements { - elem := dst.newElement() - var elemSrc []byte - if s != "NULL" { - elemSrc = []byte(s) - } - err = elem.DecodeResult(ci, dst.elementOID, TextFormatCode, elemSrc) - if err != nil { - return err - } - - elements[i] = elem - } - } - - dst.elements = elements - dst.dimensions = uta.Dimensions - dst.valid = true - - return nil -} - -func (dst *ArrayType) DecodeBinary(ci *ConnInfo, src []byte) error { - var arrayHeader ArrayHeader - rp, err := arrayHeader.DecodeBinary(ci, src) - if err != nil { - return err - } - - var elements []ValueTranscoder - - if len(arrayHeader.Dimensions) == 0 { - dst.elements = elements - dst.dimensions = arrayHeader.Dimensions - dst.valid = true - return nil - } - - elementCount := arrayHeader.Dimensions[0].Length - for _, d := range arrayHeader.Dimensions[1:] { - elementCount *= d.Length - } - - elements = make([]ValueTranscoder, elementCount) - - for i := range elements { - elem := dst.newElement() - elemLen := int(int32(binary.BigEndian.Uint32(src[rp:]))) - rp += 4 - var elemSrc []byte - if elemLen >= 0 { - elemSrc = src[rp : rp+elemLen] - rp += elemLen - } - err = elem.DecodeResult(ci, dst.elementOID, BinaryFormatCode, elemSrc) - if err != nil { - return err - } - - elements[i] = elem - } - - dst.elements = elements - dst.dimensions = arrayHeader.Dimensions - dst.valid = true - - return nil -} - -func (src ArrayType) EncodeText(ci *ConnInfo, buf []byte) ([]byte, error) { - if !src.valid { - return nil, nil - } - - if len(src.dimensions) == 0 { - return append(buf, '{', '}'), nil - } - - buf = EncodeTextArrayDimensions(buf, src.dimensions) - - // dimElemCounts is the multiples of elements that each array lies on. For - // example, a single dimension array of length 4 would have a dimElemCounts of - // [4]. A multi-dimensional array of lengths [3,5,2] would have a - // dimElemCounts of [30,10,2]. This is used to simplify when to render a '{' - // or '}'. - dimElemCounts := make([]int, len(src.dimensions)) - dimElemCounts[len(src.dimensions)-1] = int(src.dimensions[len(src.dimensions)-1].Length) - for i := len(src.dimensions) - 2; i > -1; i-- { - dimElemCounts[i] = int(src.dimensions[i].Length) * dimElemCounts[i+1] - } - - inElemBuf := make([]byte, 0, 32) - for i, elem := range src.elements { - if i > 0 { - buf = append(buf, ',') - } - - for _, dec := range dimElemCounts { - if i%dec == 0 { - buf = append(buf, '{') - } - } - - elemBuf, err := elem.EncodeParam(ci, src.elementOID, TextFormatCode, inElemBuf) - if err != nil { - return nil, err - } - if elemBuf == nil { - buf = append(buf, `NULL`...) - } else { - buf = append(buf, QuoteArrayElementIfNeeded(string(elemBuf))...) - } - - for _, dec := range dimElemCounts { - if (i+1)%dec == 0 { - buf = append(buf, '}') - } - } - } - - return buf, nil -} - -func (src ArrayType) EncodeBinary(ci *ConnInfo, buf []byte) ([]byte, error) { - if !src.valid { - return nil, nil - } - - arrayHeader := ArrayHeader{ - Dimensions: src.dimensions, - ElementOID: int32(src.elementOID), - } - - for i := range src.elements { - if src.elements[i].Get() == nil { - arrayHeader.ContainsNull = true - break - } - } - - buf = arrayHeader.EncodeBinary(ci, buf) - - for i := range src.elements { - sp := len(buf) - buf = pgio.AppendInt32(buf, -1) - - elemBuf, err := src.elements[i].EncodeParam(ci, src.elementOID, BinaryFormatCode, buf) - if err != nil { - return nil, err - } - if elemBuf != nil { - buf = elemBuf - pgio.SetInt32(buf[sp:], int32(len(buf[sp:])-4)) - } - } - - return buf, nil -} - -// Scan implements the database/sql Scanner interface. -func (dst *ArrayType) Scan(src interface{}) error { - if src == nil { - return dst.DecodeText(nil, nil) - } - - switch src := src.(type) { - case string: - return dst.DecodeText(nil, []byte(src)) - case []byte: - srcCopy := make([]byte, len(src)) - copy(srcCopy, src) - return dst.DecodeText(nil, srcCopy) - } - - return fmt.Errorf("cannot scan %T", src) -} - -// Value implements the database/sql/driver Valuer interface. -func (src ArrayType) Value() (driver.Value, error) { - buf, err := src.EncodeText(nil, nil) - if err != nil { - return nil, err - } - if buf == nil { - return nil, nil - } - - return string(buf), nil -} diff --git a/pgtype/array_type_test.go b/pgtype/array_type_test.go deleted file mode 100644 index 3ea5bc79..00000000 --- a/pgtype/array_type_test.go +++ /dev/null @@ -1,84 +0,0 @@ -package pgtype_test - -import ( - "context" - "testing" - - "github.com/jackc/pgx/v5/pgtype" - "github.com/jackc/pgx/v5/pgtype/testutil" - "github.com/stretchr/testify/require" -) - -func TestArrayTypeValue(t *testing.T) { - arrayType := pgtype.NewArrayType("_text", pgtype.TextOID, func() pgtype.ValueTranscoder { return &pgtype.Text{} }) - - err := arrayType.Set(nil) - require.NoError(t, err) - - gotValue := arrayType.Get() - require.Nil(t, gotValue) - - slice := []string{"foo", "bar"} - err = arrayType.AssignTo(&slice) - require.NoError(t, err) - require.Nil(t, slice) - - err = arrayType.Set([]string{}) - require.NoError(t, err) - - gotValue = arrayType.Get() - require.Len(t, gotValue, 0) - - err = arrayType.AssignTo(&slice) - require.NoError(t, err) - require.EqualValues(t, []string{}, slice) - - err = arrayType.Set([]string{"baz", "quz"}) - require.NoError(t, err) - - gotValue = arrayType.Get() - require.Len(t, gotValue, 2) - - err = arrayType.AssignTo(&slice) - require.NoError(t, err) - require.EqualValues(t, []string{"baz", "quz"}, slice) -} - -func TestArrayTypeTranscode(t *testing.T) { - conn := testutil.MustConnectPgx(t) - defer testutil.MustCloseContext(t, conn) - - conn.ConnInfo().RegisterDataType(pgtype.DataType{ - Value: pgtype.NewArrayType("_text", pgtype.TextOID, func() pgtype.ValueTranscoder { return &pgtype.Text{} }), - Name: "_text", - OID: pgtype.TextArrayOID, - }) - - var dstStrings []string - err := conn.QueryRow(context.Background(), "select $1::text[]", []string{"red", "green", "blue"}).Scan(&dstStrings) - require.NoError(t, err) - - require.EqualValues(t, []string{"red", "green", "blue"}, dstStrings) -} - -func TestArrayTypeEmptyArrayDoesNotBreakArrayType(t *testing.T) { - conn := testutil.MustConnectPgx(t) - defer testutil.MustCloseContext(t, conn) - - conn.ConnInfo().RegisterDataType(pgtype.DataType{ - Value: pgtype.NewArrayType("_text", pgtype.TextOID, func() pgtype.ValueTranscoder { return &pgtype.Text{} }), - Name: "_text", - OID: pgtype.TextArrayOID, - }) - - var dstStrings []string - err := conn.QueryRow(context.Background(), "select '{}'::text[]").Scan(&dstStrings) - require.NoError(t, err) - - require.EqualValues(t, []string{}, dstStrings) - - err = conn.QueryRow(context.Background(), "select $1::text[]", []string{"red", "green", "blue"}).Scan(&dstStrings) - require.NoError(t, err) - - require.EqualValues(t, []string{"red", "green", "blue"}, dstStrings) -} diff --git a/pgtype/pgxtype/pgxtype.go b/pgtype/pgxtype/pgxtype.go index 49df7059..4f2c5796 100644 --- a/pgtype/pgxtype/pgxtype.go +++ b/pgtype/pgxtype/pgxtype.go @@ -34,24 +34,25 @@ func LoadDataType(ctx context.Context, conn Querier, ci *pgtype.ConnInfo, typeNa switch typtype { case "b": // array - elementOID, err := GetArrayElementOID(ctx, conn, oid) - if err != nil { - return pgtype.DataType{}, err - } + panic("TODO - restore array support") + // 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") - } - } + // 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) - } + // 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 + // at := pgtype.NewArrayType(typeName, elementOID, newElement) + // return pgtype.DataType{Value: at, Name: typeName, OID: oid}, nil case "c": // composite panic("TODO - restore composite support") // fields, err := GetCompositeFields(ctx, conn, oid)