Add sql.Valuer support for all types (#1144)

The existing implementation of strings value.Valuer only checked if the return type was a `string` and none of the other supported types and so changed to send it back through AppendRow again for those supported types to be checked again.
ClickHouse · Dec 1, 2023 · fb3a5ca · fb3a5ca
1 parent 05ce897
commit fb3a5ca
Show file tree

Hide file tree

Showing 47 changed files with 2,183 additions and 33 deletions.
diff --git a/contributors/list b/contributors/list
@@ -22,14 +22,14 @@ Chao Wang <chaowang@uber.com>
 Chris Duncan <veqryn@hotmail.com>
 Daguang <28806852+DGuang21@users.noreply.github.com>
 Dale McDiarmid <dale@clickhouse.com>
-Dale Mcdiarmid <dale@clickhouse.com>
 Damir Sayfutdinov <sayfutdinov@selectel.ru>
 Dan Walters <dan@walters.io>
 Daniel Bershatsky <daniel.bershatsky@skolkovotech.ru>
 Danila Migalin <miga@uber.com>
 Danny.Dunn <danny@DannyDunndeMBP.lan>
 Darío <dgrripoll@gmail.com>
 Dave Josephsen <dave.josephsen@gmail.com>
+Dean Karn <dean.karn@gmail.com>
 Denis Gukov <denguk@gmail.com>
 Denis Krivak <dokrivak@avito.ru>
 Denys <drimd@ukr.net>

diff --git a/lib/column/array.go b/lib/column/array.go
@@ -191,13 +191,23 @@ func appendNullableRowPlain[T any](col *Array, arr []*T) error {
 
 func (col *Array) append(elem reflect.Value, level int) error {
 	if level < col.depth {
-		col.appendOffset(level, uint64(elem.Len()))
-		for i := 0; i < elem.Len(); i++ {
-			if err := col.append(elem.Index(i), level+1); err != nil {
-				return err
+		switch elem.Kind() {
+		// reflect.Value.Len() & reflect.Value.Index() is called in `append` method which is only valid for
+		// Slice, Array and String that make sense here.
+		case reflect.Slice, reflect.Array, reflect.String:
+			col.appendOffset(level, uint64(elem.Len()))
+			for i := 0; i < elem.Len(); i++ {
+				if err := col.append(elem.Index(i), level+1); err != nil {
+					return err
+				}
 			}
+			return nil
+		}
+		return &ColumnConverterError{
+			Op:   "AppendRow",
+			To:   "Array",
+			From: fmt.Sprintf("%T", elem),
 		}
-		return nil
 	}
 	if elem.Kind() == reflect.Ptr && elem.IsNil() {
 		return col.values.AppendRow(nil)

diff --git a/lib/column/array_gen.go b/lib/column/array_gen.go
diff --git a/lib/column/bigint.go b/lib/column/bigint.go
@@ -18,6 +18,7 @@
 package column
 
 import (
+	"database/sql/driver"
 	"encoding/binary"
 	"fmt"
 	"github.com/ClickHouse/ch-go/proto"
@@ -97,6 +98,18 @@ func (col *BigInt) Append(v any) (nulls []uint8, err error) {
 			}
 		}
 	default:
+		if valuer, ok := v.(driver.Valuer); ok {
+			val, err := valuer.Value()
+			if err != nil {
+				return nil, &ColumnConverterError{
+					Op:   "Append",
+					To:   string(col.chType),
+					From: fmt.Sprintf("%T", v),
+					Hint: "could not get driver.Valuer value",
+				}
+			}
+			return col.Append(val)
+		}
 		return nil, &ColumnConverterError{
 			Op:   "Append",
 			To:   string(col.chType),
@@ -120,6 +133,18 @@ func (col *BigInt) AppendRow(v any) error {
 	case nil:
 		col.append(big.NewInt(0))
 	default:
+		if valuer, ok := v.(driver.Valuer); ok {
+			val, err := valuer.Value()
+			if err != nil {
+				return &ColumnConverterError{
+					Op:   "AppendRow",
+					To:   string(col.chType),
+					From: fmt.Sprintf("%T", v),
+					Hint: "could not get driver.Valuer value",
+				}
+			}
+			return col.AppendRow(val)
+		}
 		return &ColumnConverterError{
 			Op:   "AppendRow",
 			To:   string(col.chType),

diff --git a/lib/column/bool.go b/lib/column/bool.go
@@ -19,6 +19,7 @@ package column
 
 import (
 	"database/sql"
+	"database/sql/driver"
 	"fmt"
 	"github.com/ClickHouse/ch-go/proto"
 	"reflect"
@@ -110,6 +111,18 @@ func (col *Bool) Append(v any) (nulls []uint8, err error) {
 			col.Append(v[i])
 		}
 	default:
+		if valuer, ok := v.(driver.Valuer); ok {
+			val, err := valuer.Value()
+			if err != nil {
+				return nil, &ColumnConverterError{
+					Op:   "Append",
+					To:   "Bool",
+					From: fmt.Sprintf("%T", v),
+					Hint: "could not get driver.Valuer value",
+				}
+			}
+			return col.Append(val)
+		}
 		return nil, &ColumnConverterError{
 			Op:   "Append",
 			To:   "Bool",
@@ -140,6 +153,18 @@ func (col *Bool) AppendRow(v any) error {
 		}
 	case nil:
 	default:
+		if valuer, ok := v.(driver.Valuer); ok {
+			val, err := valuer.Value()
+			if err != nil {
+				return &ColumnConverterError{
+					Op:   "AppendRow",
+					To:   "Bool",
+					From: fmt.Sprintf("%T", v),
+					Hint: "could not get driver.Valuer value",
+				}
+			}
+			return col.AppendRow(val)
+		}
 		return &ColumnConverterError{
 			Op:   "AppendRow",
 			To:   "Bool",

diff --git a/lib/column/codegen/array.tpl b/lib/column/codegen/array.tpl
@@ -22,6 +22,7 @@ package column
 
 import (
 	"database/sql"
+    "database/sql/driver"
 	"github.com/ClickHouse/ch-go/proto"
 	"github.com/google/uuid"
 	"github.com/paulmach/orb"
@@ -30,6 +31,7 @@ import (
 	"net"
 	"net/netip"
 	"time"
+	"fmt"
 )
 
 // appendRowPlain is a reflection-free realisation of append for plain arrays.
@@ -42,6 +44,18 @@ func (col *Array) appendRowPlain(v any) error {
 		return appendNullableRowPlain(col, tv)
 	{{- end }}
 	default:
+	    if valuer, ok := v.(driver.Valuer); ok {
+            val, err := valuer.Value()
+            if err != nil {
+                return &ColumnConverterError{
+                    Op:   "AppendRow",
+                    To:   "Array",
+                    From: fmt.Sprintf("%T", v),
+                    Hint: "could not get driver.Valuer value",
+                }
+            }
+            return col.appendRowPlain(val)
+        }
 		return col.appendRowDefault(v)
 	}
 }
diff --git a/lib/column/codegen/column.tpl b/lib/column/codegen/column.tpl
@@ -31,6 +31,7 @@ import (
 	"github.com/paulmach/orb"
 	"github.com/shopspring/decimal"
 	"database/sql"
+	"database/sql/driver"
 	"github.com/ClickHouse/ch-go/proto"
 )
 
@@ -315,6 +316,20 @@ func (col *{{ .ChType }}) Append(v any) (nulls []uint8,err error) {
 		}
 	{{- end }}
 	default:
+
+	    if valuer, ok := v.(driver.Valuer); ok {
+            val, err := valuer.Value()
+            if err != nil {
+                return nil, &ColumnConverterError{
+                    Op:   "Append",
+                    To:   "{{ .ChType }}",
+                    From: fmt.Sprintf("%T", v),
+                    Hint: "could not get driver.Valuer value",
+                }
+            }
+            return col.Append(val)
+        }
+
 		return nil, &ColumnConverterError{
 			Op:   "Append",
 			To:   "{{ .ChType }}",
@@ -382,6 +397,20 @@ func (col *{{ .ChType }}) AppendRow(v any) error {
         col.col.Append(val)
 	{{- end }}
 	default:
+
+	    if valuer, ok := v.(driver.Valuer); ok {
+            val, err := valuer.Value()
+            if err != nil {
+                return &ColumnConverterError{
+                    Op:   "AppendRow",
+                    To:   "{{ .ChType }}",
+                    From: fmt.Sprintf("%T", v),
+                    Hint: "could not get driver.Valuer value",
+                }
+            }
+            return col.AppendRow(val)
+        }
+
 		if rv := reflect.ValueOf(v); rv.Kind() == col.ScanType().Kind() || rv.CanConvert(col.ScanType()) {
 			col.col.Append(rv.Convert(col.ScanType()).Interface().({{ .GoType }}))
 		} else {