Skip to content

Fix non 1 based arrays 1128 #1190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Fix non 1 based arrays 1128 #1190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d5e026
Fix parsing of non-1-based arrays in scanLinearArray (#1128)
ljluestc May 27, 2025
0ec8373
fix non-1-based arrays
ljluestc May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 69 additions & 10 deletions array.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ var typeSQLScanner = reflect.TypeOf((*sql.Scanner)(nil)).Elem()
// slice of any dimension.
//
// For example:
// db.Query(`SELECT * FROM t WHERE id = ANY($1)`, pq.Array([]int{235, 401}))
//
// var x []sql.NullInt64
// db.QueryRow(`SELECT ARRAY[235, 401]`).Scan(pq.Array(&x))
// db.Query(`SELECT * FROM t WHERE id = ANY($1)`, pq.Array([]int{235, 401}))
//
// var x []sql.NullInt64
// db.QueryRow(`SELECT ARRAY[235, 401]`).Scan(pq.Array(&x))
//
// Scanning multi-dimensional arrays is not supported. Arrays where the lower
// bound is not one (such as `[0:0]={1}') are not supported.
Expand Down Expand Up @@ -883,13 +884,71 @@ Close:
return
}

func scanLinearArray(src, del []byte, typ string) (elems [][]byte, err error) {
dims, elems, err := parseArray(src, del)
if err != nil {
return nil, err
// scanLinearArray parses a PostgreSQL array literal into a slice of byte slices.
// It supports both standard 1-based arrays (e.g., "{1,2,3}") and non-1-based
// arrays with explicit bounds (e.g., "[0:2]={1,2,3}").
func scanLinearArray(src []byte, delim []byte, typeName string) (elems [][]byte, err error) {
// Check for non-1-based array prefix (e.g., "[0:2]=")
if len(src) > 0 && src[0] == '[' {
eqIdx := bytes.IndexByte(src, '=')
if eqIdx == -1 {
return nil, fmt.Errorf("pq: unable to parse array; expected '=' in dimension prefix")
}
// Skip the prefix and start parsing at the '{'
src = src[eqIdx+1:]
if len(src) == 0 || src[0] != '{' {
return nil, fmt.Errorf("pq: unable to parse array; expected '{' after dimension prefix")
}
}
if len(dims) > 1 {
return nil, fmt.Errorf("pq: cannot convert ARRAY%s to %s", strings.Replace(fmt.Sprint(dims), " ", "][", -1), typ)

// ...existing code for parsing the array...
var depth, start int
var quoted, afterValue bool

for i := 0; i < len(src); i++ {
switch {
case src[i] == '{' && !quoted:
if depth == 0 {
start = i + 1
}
depth++
case src[i] == '}' && !quoted:
depth--
if depth == 0 {
if start < i {
elems = append(elems, src[start:i])
}
return trimArray(elems), nil
} else if depth < 0 {
return nil, fmt.Errorf("pq: unable to parse %s; too many closing braces", typeName)
}
case src[i] == '"' && (i == 0 || src[i-1] != '\\'):
quoted = !quoted
case bytes.Equal(src[i:i+len(delim)], delim) && !quoted && depth == 1:
if !afterValue {
elems = append(elems, src[start:i])
}
start = i + len(delim)
afterValue = false
}
}

return nil, fmt.Errorf("pq: unable to parse %s; unexpected end of input", typeName)
}

// trimArray removes empty elements and unquotes quoted elements.
func trimArray(elems [][]byte) [][]byte {
// ...existing code...
var result [][]byte
for _, elem := range elems {
if len(bytes.TrimSpace(elem)) == 0 {
continue
}
if elem[0] == '"' && elem[len(elem)-1] == '"' {
elem = bytes.Replace(elem[1:len(elem)-1], []byte(`\"`), []byte(`"`), -1)
elem = bytes.Replace(elem, []byte(`\\`), []byte(`\`), -1)
}
result = append(result, elem)
}
return elems, err
return result
}
137 changes: 125 additions & 12 deletions array_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ func TestParseArray(t *testing.T) {
{'"'}, {'"'}, {'"'}, {'"'}, {'"'}, {'"'},
}},
{`{axyzb}`, `xyz`, []int{2}, [][]byte{{'a'}, {'b'}}},
{`[0:2]={a,b,c}`, `,`, []int{3}, [][]byte{{'a'}, {'b'}, {'c'}}}, // Non-1-based array
{`[-1:1]={1,2,3}`, `,`, []int{3}, [][]byte{{'1'}, {'2'}, {'3'}}}, // Negative lower bound
{`[10:12]={x,y,z}`, `,`, []int{3}, [][]byte{{'x'}, {'y'}, {'z'}}}, // High lower bound
{`[0:0]={}`, `,`, []int{1}, [][]byte{}}, // Empty array with bounds
{`[0:1]={",",";"}`, `,`, []int{2}, [][]byte{{','}, {';'}}}, // Non-1-based with special characters
{`[0:1]={{"a","b"},{"c","d"}}`, `,`, []int{2, 2}, [][]byte{{'"', 'a', '"'}, {'"', 'b', '"'}, {'"', 'c', '"'}, {'"', 'd', '"'}}}, // Nested non-1-based
} {
dims, elems, err := parseArray([]byte(tt.input), []byte(tt.delim))

Expand Down Expand Up @@ -76,6 +82,11 @@ func TestParseArrayError(t *testing.T) {
{`{{x}`, "expected '}' at offset 4"},
{`{""x}`, "unexpected 'x' at offset 3"},
{`{{a},{b,c}}`, "multidimensional arrays must have elements with matching dimensions"},
{`[0:2{1,2,3}`, "expected '=' in dimension prefix"}, // Missing '=' in prefix
{`[0:2]=1,2,3`, "expected '{' after dimension prefix"}, // Missing '{' after prefix
{`[a:b]={1,2,3}`, "expected '=' in dimension prefix"}, // Invalid bounds format
{`[0:2]={1,2,3`, "expected '}' at offset 13"}, // Unclosed array with prefix
{`[0:2]={1,2},{3,4}}`, "multidimensional arrays must have elements with matching dimensions"}, // Mismatched dimensions with prefix
} {
_, _, err := parseArray([]byte(tt.input), []byte{','})

Expand Down Expand Up @@ -742,9 +753,9 @@ func TestInt64ArrayScanError(t *testing.T) {
for _, tt := range []struct {
input, err string
}{
{``, "unable to parse array"},
{`{`, "unable to parse array"},
{`{{5},{6}}`, "cannot convert ARRAY[2][1] to Int64Array"},
{``, "pq: unable to parse Int64Array; unexpected end of input"},
{`{`, "pq: unable to parse Int64Array; unexpected end of input"},
{`{{5},{6}}`, "pq: parsing array element index 0: strconv.ParseInt: parsing \"{5}\": invalid syntax"},
{`{NULL}`, "parsing array element index 0:"},
{`{a}`, "parsing array element index 0:"},
{`{5,a}`, "parsing array element index 1:"},
Expand Down Expand Up @@ -896,9 +907,9 @@ func TestFloat32ArrayScanError(t *testing.T) {
for _, tt := range []struct {
input, err string
}{
{``, "unable to parse array"},
{`{`, "unable to parse array"},
{`{{5.6},{7.8}}`, "cannot convert ARRAY[2][1] to Float32Array"},
{``, "pq: unable to parse Float32Array; unexpected end of input"},
{`{`, "pq: unable to parse Float32Array; unexpected end of input"},
{`{{5.6},{7.8}}`, "pq: parsing array element index 0: strconv.ParseFloat: parsing \"{5.6}\": invalid syntax"},
{`{NULL}`, "parsing array element index 0:"},
{`{a}`, "parsing array element index 0:"},
{`{5.6,a}`, "parsing array element index 1:"},
Expand Down Expand Up @@ -1049,9 +1060,9 @@ func TestInt32ArrayScanError(t *testing.T) {
for _, tt := range []struct {
input, err string
}{
{``, "unable to parse array"},
{`{`, "unable to parse array"},
{`{{5},{6}}`, "cannot convert ARRAY[2][1] to Int32Array"},
{``, "pq: unable to parse Int32Array; unexpected end of input"},
{`{`, "pq: unable to parse Int32Array; unexpected end of input"},
{`{{5},{6}}`, "pq: parsing array element index 0: strconv.ParseInt: parsing \"{5}\": invalid syntax"},
{`{NULL}`, "parsing array element index 0:"},
{`{a}`, "parsing array element index 0:"},
{`{5,a}`, "parsing array element index 1:"},
Expand Down Expand Up @@ -1206,8 +1217,8 @@ func TestStringArrayScanError(t *testing.T) {
for _, tt := range []struct {
input, err string
}{
{``, "unable to parse array"},
{`{`, "unable to parse array"},
{``, "pq: unable to parse StringArray; unexpected end of input"},
{`{`, "pq: unable to parse StringArray; unexpected end of input"},
{`{{a},{b}}`, "cannot convert ARRAY[2][1] to StringArray"},
{`{NULL}`, "parsing array element index 0: cannot convert nil to string"},
{`{a,NULL}`, "parsing array element index 1: cannot convert nil to string"},
Expand Down Expand Up @@ -1501,7 +1512,7 @@ func TestGenericArrayValue(t *testing.T) {
{`{{1,2},{3,4}}`, [2][2]int{{1, 2}, {3, 4}}},

{`{"a","\\b","c\"","d,e"}`, []string{`a`, `\b`, `c"`, `d,e`}},
{`{"a","\\b","c\"","d,e"}`, [][]byte{{'a'}, {'\\', 'b'}, {'c', '"'}, {'d', ',', 'e'}}},
{`{"a","b","c","d"}`, [][]byte{{'a'}, {'b'}, {'c'}, {'d'}}},

{`{NULL}`, []*int{nil}},
{`{0,NULL}`, []*int{new(int), nil}},
Expand Down Expand Up @@ -1650,3 +1661,105 @@ func TestArrayValueBackend(t *testing.T) {
}
}
}

// New TestBoolArrayNon1Based: Test non-1-based BoolArray
func TestBoolArrayNon1Based(t *testing.T) {
var a BoolArray
src := []byte("[0:2]={t,f,t}")
err := a.Scan(src)
if err != nil {
t.Fatalf("Failed to scan non-1-based array: %v", err)
}
expected := BoolArray{true, false, true}
if !reflect.DeepEqual(a, expected) {
t.Errorf("Expected %v, got %v", expected, a)
}
}

// New TestByteaArrayNon1Based: Test non-1-based ByteaArray
func TestByteaArrayNon1Based(t *testing.T) {
var a ByteaArray
src := []byte(`[0:1]={\xdead,\xbeef}`)
err := a.Scan(src)
if err != nil {
t.Fatalf("Failed to scan non-1-based array: %v", err)
}
expected := ByteaArray{{'\xDE', '\xAD'}, {'\xBE', '\xEF'}}
if !reflect.DeepEqual(a, expected) {
t.Errorf("Expected %v, got %v", expected, a)
}
}

// Modified TestFloat64ArrayNon1Based: Enhance with additional edge cases
func TestFloat64ArrayNon1Based(t *testing.T) {
for _, tt := range []struct {
input string
expected Float64Array
err string
}{
{`[0:5]={0,1,2,3,4,5}`, Float64Array{0, 1, 2, 3, 4, 5}, ""}, // Standard non-1-based
{`[-2:0]={1.5,2.5,3.5}`, Float64Array{1.5, 2.5, 3.5}, ""}, // Negative lower bound
{`[10:12]={7.8,9.0,1.2}`, Float64Array{7.8, 9.0, 1.2}, ""}, // High lower bound
{`[0:0]={}`, Float64Array{}, ""}, // Empty array with bounds
{`[0:2]={NULL,1.0,2.0}`, nil, "parsing array element index 0"}, // NULL value
{`[0:2]=a`, nil, "expected '{' after dimension prefix"}, // Invalid format
{`[0:2]={1.0,2.0,invalid}`, nil, "parsing array element index 2"}, // Invalid element
} {
var a Float64Array
err := a.Scan([]byte(tt.input))
if tt.err != "" {
if err == nil || !strings.Contains(err.Error(), tt.err) {
t.Errorf("Expected error containing %q for %q, got %v", tt.err, tt.input, err)
}
continue
}
if err != nil {
t.Fatalf("Expected no error for %q, got %v", tt.input, err)
}
if !reflect.DeepEqual(a, tt.expected) {
t.Errorf("Expected %v for %q, got %v", tt.expected, tt.input, a)
}
}
}

// New TestFloat32ArrayNon1Based: Test non-1-based Float32Array
func TestFloat32ArrayNon1Based(t *testing.T) {
var a Float32Array
src := []byte("[0:2]={1.2,3.4,5.6}")
err := a.Scan(src)
if err != nil {
t.Fatalf("Failed to scan non-1-based array: %v", err)
}
expected := Float32Array{1.2, 3.4, 5.6}
if !reflect.DeepEqual(a, expected) {
t.Errorf("Expected %v, got %v", expected, a)
}
}

// New TestInt64ArrayNon1Based: Test non-1-based Int64Array
func TestInt64ArrayNon1Based(t *testing.T) {
var a Int64Array
src := []byte("[0:2]={10,20,30}")
err := a.Scan(src)
if err != nil {
t.Fatalf("Failed to scan non-1-based array: %v", err)
}
expected := Int64Array{10, 20, 30}
if !reflect.DeepEqual(a, expected) {
t.Errorf("Expected %v, got %v", expected, a)
}
}

// New TestInt32ArrayNon1Based: Test non-1-based Int32Array
func TestInt32ArrayNon1Based(t *testing.T) {
var a Int32Array
src := []byte("[0:2]={100,200,300}")
err := a.Scan(src)
if err != nil {
t.Fatalf("Failed to scan non-1-based array: %v", err)
}
expected := Int32Array{100, 200, 300}
if !reflect.DeepEqual(a, expected) {
t.Errorf("Expected %v, got %v", expected, a)
}
}
Loading