joao-r-reis commented on code in PR #1855:
URL:
https://github.com/apache/cassandra-gocql-driver/pull/1855#discussion_r2001272913
##########
marshal.go:
##########
@@ -2456,37 +3292,29 @@ func unmarshalUDT(info TypeInfo, data []byte, value
interface{}) error {
return nil
}
-// TypeInfo describes a Cassandra specific data type.
+// TypeInfo describes a Cassandra specific data type. Typically this is just a
+// Type but can be a struct when more information is needed.
+// TODO: move to types.go
type TypeInfo interface {
Type() Type
- Version() byte
- Custom() string
-
- // NewWithError creates a pointer to an empty version of whatever type
- // is referenced by the TypeInfo receiver.
- //
- // If there is no corresponding Go type for the CQL type, NewWithError
returns an error.
- NewWithError() (interface{}, error)
}
+// NativeType is a simple type that is defined by the Cassandra protocol.
+// Deprecated. Use Type instead.
+// TODO: move to types.go
type NativeType struct {
proto byte
Review Comment:
I think we're using this field to basically tell the marshaller/unmarshaller
what the protocol version is. Maybe we should add protocol version to the
marshal interface instead? And then deprecate the current one?
##########
types.go:
##########
@@ -0,0 +1,431 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package gocql
+
+import (
+ "fmt"
+ "reflect"
+)
+
+// CQLType is the interface that must be implemented by all registered types.
+type CQLType interface {
+ // Params should return the types to build the slice of params for
+ // TypeInfoFromParams. These params are sent to TypeInfoFromParams
after being read
+ // from the frame. The supported types are: Type, TypeInfo, []UDTField,
+ // []byte, string, int, byte.
+ // If no params are needed this can return a nil slice.
+ Params(proto int) []reflect.Type
+
+ // TypeInfoFromParams should return a TypeInfo implementation for the
type
+ // with the given parameters filled after the return from Params().
+ TypeInfoFromParams(proto int, params []interface{}) TypeInfo
+
+ // TypeInfoFromString should return a TypeInfo implementation for the
type with
+ // the given names/classes. Only the portion within the parantheses or
arrows
+ // are passed to this function. For simple types, the name passed might
be empty.
+ TypeInfoFromString(proto int, name string) TypeInfo
+
+ // Marshal should marshal the value for the given TypeInfo into a byte
slice
+ Marshal(info TypeInfo, value interface{}) ([]byte, error)
+
+ // Unmarshal should unmarshal the byte slice into the value for the
given
+ // TypeInfo. It must support data being nil for nullable columns and it
must
+ // support pointers to empty interfaces to get the default go type for
the
+ // column.
+ Unmarshal(info TypeInfo, data []byte, value interface{}) error
+}
+
+var (
+ asciiRegisteredType = ®isteredType{
+ CQLType: varcharLikeCQLType{
+ typ: TypeAscii,
+ },
+ str: "ascii",
+ }
+
+ bigIntRegisteredType = ®isteredType{
+ CQLType: bigIntLikeCQLType{
+ typ: TypeBigInt,
+ },
+ str: "bigint",
+ }
+
+ blobRegisteredType = ®isteredType{
+ CQLType: varcharLikeCQLType{
+ typ: TypeBlob,
+ },
+ str: "blob",
+ }
+
+ booleanRegisteredType = ®isteredType{
+ CQLType: booleanCQLType{},
+ str: "boolean",
+ }
+
+ counterRegisteredType = ®isteredType{
+ CQLType: bigIntLikeCQLType{
+ typ: TypeCounter,
+ },
+ str: "counter",
+ }
+
+ dateRegisteredType = ®isteredType{
+ CQLType: dateCQLType{},
+ str: "date",
+ }
+
+ decimalRegisteredType = ®isteredType{
+ CQLType: decimalCQLType{},
+ str: "decimal",
+ }
+
+ doubleRegisteredType = ®isteredType{
+ CQLType: doubleCQLType{},
+ str: "double",
+ }
+
+ durationRegisteredType = ®isteredType{
+ CQLType: durationCQLType{},
+ str: "duration",
+ }
+
+ floatRegisteredType = ®isteredType{
+ CQLType: floatCQLType{},
+ str: "float",
+ }
+
+ inetRegisteredType = ®isteredType{
+ CQLType: inetCQLType{},
+ str: "inet",
+ }
+
+ intRegisteredType = ®isteredType{
+ CQLType: intCQLType{},
+ str: "int",
+ }
+
+ smallintRegisteredType = ®isteredType{
+ CQLType: smallIntCQLType{},
+ str: "smallint",
+ }
+
+ textRegisteredType = ®isteredType{
+ CQLType: varcharLikeCQLType{
+ typ: TypeText,
+ },
+ str: "text",
+ }
+
+ timeRegisteredType = ®isteredType{
+ CQLType: timeCQLType{},
+ str: "time",
+ }
+
+ timestampRegisteredType = ®isteredType{
+ CQLType: timestampCQLType{},
+ str: "timestamp",
+ }
+
+ timeUUIDRegisteredType = ®isteredType{
+ CQLType: timeUUIDCQLType{},
+ str: "timeuuid",
+ }
+
+ tinyIntRegisteredType = ®isteredType{
+ CQLType: tinyIntCQLType{},
+ str: "tinyint",
+ }
+
+ uuidRegisteredType = ®isteredType{
+ CQLType: uuidCQLType{},
+ str: "uuid",
+ }
+
+ varcharRegisteredType = ®isteredType{
+ CQLType: varcharLikeCQLType{
+ typ: TypeVarchar,
+ },
+ str: "varchar",
+ }
+
+ varintRegisteredType = ®isteredType{
+ CQLType: varintCQLType{},
+ str: "varint",
+ }
+
+ listRegisteredType = ®isteredType{
+ CQLType: listSetCQLType{
+ typ: TypeList,
+ },
+ str: "list",
+ }
+
+ mapRegisteredType = ®isteredType{
+ CQLType: mapCQLType{},
+ str: "map",
+ }
+
+ setRegisteredType = ®isteredType{
+ CQLType: listSetCQLType{
+ typ: TypeSet,
+ },
+ str: "set",
+ }
+
+ tupleRegisteredType = ®isteredType{
+ CQLType: tupleCQLType{},
+ str: "tuple",
+ }
+
+ udtRegisteredType = ®isteredType{
+ CQLType: udtCQLType{},
+ str: "udt",
+ }
+
+ customRegisteredType = ®isteredType{
+ CQLType: customCQLType{},
+ str: "custom",
+ }
+)
+
+var registeredTypes = map[Type]*registeredType{
+ TypeAscii: asciiRegisteredType,
+ TypeBigInt: bigIntRegisteredType,
+ TypeBlob: blobRegisteredType,
+ TypeBoolean: booleanRegisteredType,
+ TypeCounter: counterRegisteredType,
+ TypeDate: dateRegisteredType,
+ TypeDecimal: decimalRegisteredType,
+ TypeDouble: doubleRegisteredType,
+ TypeDuration: durationRegisteredType,
+ TypeFloat: floatRegisteredType,
+ TypeInet: inetRegisteredType,
+ TypeInt: intRegisteredType,
+ TypeSmallInt: smallintRegisteredType,
+ TypeText: textRegisteredType,
+ TypeTime: timeRegisteredType,
+ TypeTimestamp: timestampRegisteredType,
+ TypeTimeUUID: timeUUIDRegisteredType,
+ TypeTinyInt: tinyIntRegisteredType,
+ TypeUUID: uuidRegisteredType,
+ TypeVarchar: varcharRegisteredType,
+ TypeVarint: varintRegisteredType,
+ TypeList: listRegisteredType,
+ TypeMap: mapRegisteredType,
+ TypeSet: setRegisteredType,
+ TypeTuple: tupleRegisteredType,
+ TypeUDT: udtRegisteredType,
+ TypeCustom: customRegisteredType,
+}
+
+// fastRegisteredTypeLookup is a fast lookup for the registered type that
avoids
+// the need for a map lookup which was shown to be significant
+// in cases where it's necessary you should consider manually inlining this
method
+func fastRegisteredTypeLookup(typ Type) CQLType {
+ switch typ {
+ case TypeAscii:
+ return asciiRegisteredType.CQLType
+ case TypeBigInt:
+ return bigIntRegisteredType.CQLType
+ case TypeBlob:
+ return blobRegisteredType.CQLType
+ case TypeBoolean:
+ return booleanRegisteredType.CQLType
+ case TypeCounter:
+ return counterRegisteredType.CQLType
+ case TypeDate:
+ return dateRegisteredType.CQLType
+ case TypeDecimal:
+ return decimalRegisteredType.CQLType
+ case TypeDouble:
+ return doubleRegisteredType.CQLType
+ case TypeDuration:
+ return durationRegisteredType.CQLType
+ case TypeFloat:
+ return floatRegisteredType.CQLType
+ case TypeInet:
+ return inetRegisteredType.CQLType
+ case TypeInt:
+ return intRegisteredType.CQLType
+ case TypeSmallInt:
+ return smallintRegisteredType.CQLType
+ case TypeText:
+ return textRegisteredType.CQLType
+ case TypeTime:
+ return timeRegisteredType.CQLType
+ case TypeTimestamp:
+ return timestampRegisteredType.CQLType
+ case TypeTimeUUID:
+ return timeUUIDRegisteredType.CQLType
+ case TypeTinyInt:
+ return tinyIntRegisteredType.CQLType
+ case TypeUUID:
+ return uuidRegisteredType.CQLType
+ case TypeVarchar:
+ return varcharRegisteredType.CQLType
+ case TypeVarint:
+ return varintRegisteredType.CQLType
+ case TypeList:
+ return listRegisteredType.CQLType
+ case TypeMap:
+ return mapRegisteredType.CQLType
+ case TypeSet:
+ return setRegisteredType.CQLType
+ case TypeTuple:
+ return tupleRegisteredType.CQLType
+ case TypeUDT:
+ return udtRegisteredType.CQLType
+ case TypeCustom:
+ return customRegisteredType.CQLType
+ default:
+ rt, ok := registeredTypes[typ]
+ if !ok {
+ return nil
+ }
+ return rt.CQLType
+ }
+}
+
+var registeredTypesByString = map[string]Type{
+ "ascii": TypeAscii,
+ "bigint": TypeBigInt,
+ "blob": TypeBlob,
+ "boolean": TypeBoolean,
+ "counter": TypeCounter,
+ "date": TypeDate,
+ "decimal": TypeDecimal,
+ "double": TypeDouble,
+ "duration": TypeDuration,
+ "float": TypeFloat,
+ "inet": TypeInet,
+ "int": TypeInt,
+ "smallint": TypeSmallInt,
+ "text": TypeText,
+ "time": TypeTime,
+ "timestamp": TypeTimestamp,
+ "timeuuid": TypeTimeUUID,
+ "tinyint": TypeTinyInt,
+ "uuid": TypeUUID,
+ "varchar": TypeVarchar,
+ "varint": TypeVarint,
+ "map": TypeMap,
+ "list": TypeList,
+ "set": TypeSet,
+ "tuple": TypeTuple,
+
+ // these are all for Cassandra 2.x and older
+ "AsciiType": TypeAscii,
+ "LongType": TypeBigInt,
+ "BytesType": TypeBlob,
+ "BooleanType": TypeBoolean,
+ "CounterColumnType": TypeCounter,
+ "DecimalType": TypeDecimal,
+ "DoubleType": TypeDouble,
+ "FloatType": TypeFloat,
+ "Int32Type": TypeInt,
+ "ShortType": TypeSmallInt,
+ "ByteType": TypeTinyInt,
+ "TimeType": TypeTime,
+ "DateType": TypeTimestamp, // DateType was a timestamp when
date didn't exist
+ "TimestampType": TypeTimestamp,
+ "UUIDType": TypeUUID,
+ "LexicalUUIDType": TypeUUID,
+ "UTF8Type": TypeVarchar,
+ "IntegerType": TypeVarint,
+ "TimeUUIDType": TypeTimeUUID,
+ "InetAddressType": TypeInet,
+ "MapType": TypeMap,
+ "ListType": TypeList,
+ "SetType": TypeSet,
+ "TupleType": TypeTuple,
+}
+
+type registeredType struct {
+ CQLType
+ str string
+}
+
+// RegisterType registers a new CQL data type. Type should be the CQL id for
+// the type. Name is the name of the type as returned in the metadata for the
+// column. CQLType is the implementation of the type.
+// This function is not goroutine-safe and must be called before any other
usage
+// of the gocql package. Typically this should be called in an init function.
+func RegisterType(typ Type, name string, t CQLType) {
Review Comment:
I wonder if we should make this a part of clusterconfig so that users can
have different sessions with different type registrations within the same app
##########
helpers.go:
##########
@@ -26,187 +26,51 @@ package gocql
import (
"fmt"
- "math/big"
"net"
"reflect"
"strings"
- "time"
-
- "gopkg.in/inf.v0"
)
+// RowData contains the column names and pointers to the default values for
each
+// column
type RowData struct {
Columns []string
Values []interface{}
}
-func goType(t TypeInfo) (reflect.Type, error) {
- switch t.Type() {
- case TypeVarchar, TypeAscii, TypeInet, TypeText:
- return reflect.TypeOf(*new(string)), nil
- case TypeBigInt, TypeCounter:
- return reflect.TypeOf(*new(int64)), nil
- case TypeTime:
- return reflect.TypeOf(*new(time.Duration)), nil
- case TypeTimestamp:
- return reflect.TypeOf(*new(time.Time)), nil
- case TypeBlob:
- return reflect.TypeOf(*new([]byte)), nil
- case TypeBoolean:
- return reflect.TypeOf(*new(bool)), nil
- case TypeFloat:
- return reflect.TypeOf(*new(float32)), nil
- case TypeDouble:
- return reflect.TypeOf(*new(float64)), nil
- case TypeInt:
- return reflect.TypeOf(*new(int)), nil
- case TypeSmallInt:
- return reflect.TypeOf(*new(int16)), nil
- case TypeTinyInt:
- return reflect.TypeOf(*new(int8)), nil
- case TypeDecimal:
- return reflect.TypeOf(*new(*inf.Dec)), nil
- case TypeUUID, TypeTimeUUID:
- return reflect.TypeOf(*new(UUID)), nil
- case TypeList, TypeSet:
- elemType, err := goType(t.(CollectionType).Elem)
- if err != nil {
- return nil, err
- }
- return reflect.SliceOf(elemType), nil
- case TypeMap:
- keyType, err := goType(t.(CollectionType).Key)
- if err != nil {
- return nil, err
- }
- valueType, err := goType(t.(CollectionType).Elem)
- if err != nil {
- return nil, err
- }
- return reflect.MapOf(keyType, valueType), nil
- case TypeVarint:
- return reflect.TypeOf(*new(*big.Int)), nil
- case TypeTuple:
- // what can we do here? all there is to do is to make a list of
interface{}
- tuple := t.(TupleTypeInfo)
- return reflect.TypeOf(make([]interface{}, len(tuple.Elems))),
nil
- case TypeUDT:
- return reflect.TypeOf(make(map[string]interface{})), nil
- case TypeDate:
- return reflect.TypeOf(*new(time.Time)), nil
- case TypeDuration:
- return reflect.TypeOf(*new(Duration)), nil
- default:
- return nil, fmt.Errorf("cannot create Go type for unknown CQL
type %s", t)
- }
-}
-
func dereference(i interface{}) interface{} {
return reflect.Indirect(reflect.ValueOf(i)).Interface()
}
-func getCassandraBaseType(name string) Type {
- switch name {
- case "ascii":
- return TypeAscii
- case "bigint":
- return TypeBigInt
- case "blob":
- return TypeBlob
- case "boolean":
- return TypeBoolean
- case "counter":
- return TypeCounter
- case "date":
- return TypeDate
- case "decimal":
- return TypeDecimal
- case "double":
- return TypeDouble
- case "duration":
- return TypeDuration
- case "float":
- return TypeFloat
- case "int":
- return TypeInt
- case "smallint":
- return TypeSmallInt
- case "tinyint":
- return TypeTinyInt
- case "time":
- return TypeTime
- case "timestamp":
- return TypeTimestamp
- case "uuid":
- return TypeUUID
- case "varchar":
- return TypeVarchar
- case "text":
- return TypeText
- case "varint":
- return TypeVarint
- case "timeuuid":
- return TypeTimeUUID
- case "inet":
- return TypeInet
- case "MapType":
- return TypeMap
- case "ListType":
- return TypeList
- case "SetType":
- return TypeSet
- case "TupleType":
- return TypeTuple
- default:
- return TypeCustom
+// TODO: move to types.go
Review Comment:
do we still want to keep these TODOs?
##########
helpers.go:
##########
@@ -444,19 +237,41 @@ func (iter *Iter) MapScan(m map[string]interface{}) bool {
return false
}
- rowData, err := iter.RowData()
- if err != nil {
- return false
- }
-
- for i, col := range rowData.Columns {
- if dest, ok := m[col]; ok {
- rowData.Values[i] = dest
+ cols := iter.Columns()
+ columnNames := make([]string, 0, len(cols))
+ values := make([]interface{}, 0, len(cols))
+ for _, column := range iter.Columns() {
+ if c, ok := column.TypeInfo.(TupleTypeInfo); ok {
+ for i := range c.Elems {
+ columnName := TupleColumnName(column.Name, i)
+ if dest, ok := m[columnName]; ok {
+ // TODO: check if dest is a pointer and
if not, error here
Review Comment:
Some TODOs here too
##########
types.go:
##########
@@ -0,0 +1,431 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package gocql
+
+import (
+ "fmt"
+ "reflect"
+)
+
+// CQLType is the interface that must be implemented by all registered types.
+type CQLType interface {
+ // Params should return the types to build the slice of params for
+ // TypeInfoFromParams. These params are sent to TypeInfoFromParams
after being read
+ // from the frame. The supported types are: Type, TypeInfo, []UDTField,
+ // []byte, string, int, byte.
+ // If no params are needed this can return a nil slice.
+ Params(proto int) []reflect.Type
+
+ // TypeInfoFromParams should return a TypeInfo implementation for the
type
+ // with the given parameters filled after the return from Params().
+ TypeInfoFromParams(proto int, params []interface{}) TypeInfo
+
+ // TypeInfoFromString should return a TypeInfo implementation for the
type with
+ // the given names/classes. Only the portion within the parantheses or
arrows
+ // are passed to this function. For simple types, the name passed might
be empty.
+ TypeInfoFromString(proto int, name string) TypeInfo
+
+ // Marshal should marshal the value for the given TypeInfo into a byte
slice
+ Marshal(info TypeInfo, value interface{}) ([]byte, error)
+
+ // Unmarshal should unmarshal the byte slice into the value for the
given
+ // TypeInfo. It must support data being nil for nullable columns and it
must
+ // support pointers to empty interfaces to get the default go type for
the
+ // column.
+ Unmarshal(info TypeInfo, data []byte, value interface{}) error
+}
+
+var (
+ asciiRegisteredType = ®isteredType{
+ CQLType: varcharLikeCQLType{
+ typ: TypeAscii,
+ },
+ str: "ascii",
+ }
+
+ bigIntRegisteredType = ®isteredType{
+ CQLType: bigIntLikeCQLType{
+ typ: TypeBigInt,
+ },
+ str: "bigint",
+ }
+
+ blobRegisteredType = ®isteredType{
+ CQLType: varcharLikeCQLType{
+ typ: TypeBlob,
+ },
+ str: "blob",
+ }
+
+ booleanRegisteredType = ®isteredType{
+ CQLType: booleanCQLType{},
+ str: "boolean",
+ }
+
+ counterRegisteredType = ®isteredType{
+ CQLType: bigIntLikeCQLType{
+ typ: TypeCounter,
+ },
+ str: "counter",
+ }
+
+ dateRegisteredType = ®isteredType{
+ CQLType: dateCQLType{},
+ str: "date",
+ }
+
+ decimalRegisteredType = ®isteredType{
+ CQLType: decimalCQLType{},
+ str: "decimal",
+ }
+
+ doubleRegisteredType = ®isteredType{
+ CQLType: doubleCQLType{},
+ str: "double",
+ }
+
+ durationRegisteredType = ®isteredType{
+ CQLType: durationCQLType{},
+ str: "duration",
+ }
+
+ floatRegisteredType = ®isteredType{
+ CQLType: floatCQLType{},
+ str: "float",
+ }
+
+ inetRegisteredType = ®isteredType{
+ CQLType: inetCQLType{},
+ str: "inet",
+ }
+
+ intRegisteredType = ®isteredType{
+ CQLType: intCQLType{},
+ str: "int",
+ }
+
+ smallintRegisteredType = ®isteredType{
+ CQLType: smallIntCQLType{},
+ str: "smallint",
+ }
+
+ textRegisteredType = ®isteredType{
+ CQLType: varcharLikeCQLType{
+ typ: TypeText,
+ },
+ str: "text",
+ }
+
+ timeRegisteredType = ®isteredType{
+ CQLType: timeCQLType{},
+ str: "time",
+ }
+
+ timestampRegisteredType = ®isteredType{
+ CQLType: timestampCQLType{},
+ str: "timestamp",
+ }
+
+ timeUUIDRegisteredType = ®isteredType{
+ CQLType: timeUUIDCQLType{},
+ str: "timeuuid",
+ }
+
+ tinyIntRegisteredType = ®isteredType{
+ CQLType: tinyIntCQLType{},
+ str: "tinyint",
+ }
+
+ uuidRegisteredType = ®isteredType{
+ CQLType: uuidCQLType{},
+ str: "uuid",
+ }
+
+ varcharRegisteredType = ®isteredType{
+ CQLType: varcharLikeCQLType{
+ typ: TypeVarchar,
+ },
+ str: "varchar",
+ }
+
+ varintRegisteredType = ®isteredType{
+ CQLType: varintCQLType{},
+ str: "varint",
+ }
+
+ listRegisteredType = ®isteredType{
+ CQLType: listSetCQLType{
+ typ: TypeList,
+ },
+ str: "list",
+ }
+
+ mapRegisteredType = ®isteredType{
+ CQLType: mapCQLType{},
+ str: "map",
+ }
+
+ setRegisteredType = ®isteredType{
+ CQLType: listSetCQLType{
+ typ: TypeSet,
+ },
+ str: "set",
+ }
+
+ tupleRegisteredType = ®isteredType{
+ CQLType: tupleCQLType{},
+ str: "tuple",
+ }
+
+ udtRegisteredType = ®isteredType{
+ CQLType: udtCQLType{},
+ str: "udt",
+ }
+
+ customRegisteredType = ®isteredType{
+ CQLType: customCQLType{},
+ str: "custom",
+ }
+)
+
+var registeredTypes = map[Type]*registeredType{
+ TypeAscii: asciiRegisteredType,
+ TypeBigInt: bigIntRegisteredType,
+ TypeBlob: blobRegisteredType,
+ TypeBoolean: booleanRegisteredType,
+ TypeCounter: counterRegisteredType,
+ TypeDate: dateRegisteredType,
+ TypeDecimal: decimalRegisteredType,
+ TypeDouble: doubleRegisteredType,
+ TypeDuration: durationRegisteredType,
+ TypeFloat: floatRegisteredType,
+ TypeInet: inetRegisteredType,
+ TypeInt: intRegisteredType,
+ TypeSmallInt: smallintRegisteredType,
+ TypeText: textRegisteredType,
+ TypeTime: timeRegisteredType,
+ TypeTimestamp: timestampRegisteredType,
+ TypeTimeUUID: timeUUIDRegisteredType,
+ TypeTinyInt: tinyIntRegisteredType,
+ TypeUUID: uuidRegisteredType,
+ TypeVarchar: varcharRegisteredType,
+ TypeVarint: varintRegisteredType,
+ TypeList: listRegisteredType,
+ TypeMap: mapRegisteredType,
+ TypeSet: setRegisteredType,
+ TypeTuple: tupleRegisteredType,
+ TypeUDT: udtRegisteredType,
+ TypeCustom: customRegisteredType,
+}
+
+// fastRegisteredTypeLookup is a fast lookup for the registered type that
avoids
+// the need for a map lookup which was shown to be significant
+// in cases where it's necessary you should consider manually inlining this
method
+func fastRegisteredTypeLookup(typ Type) CQLType {
+ switch typ {
+ case TypeAscii:
+ return asciiRegisteredType.CQLType
+ case TypeBigInt:
+ return bigIntRegisteredType.CQLType
+ case TypeBlob:
+ return blobRegisteredType.CQLType
+ case TypeBoolean:
+ return booleanRegisteredType.CQLType
+ case TypeCounter:
+ return counterRegisteredType.CQLType
+ case TypeDate:
+ return dateRegisteredType.CQLType
+ case TypeDecimal:
+ return decimalRegisteredType.CQLType
+ case TypeDouble:
+ return doubleRegisteredType.CQLType
+ case TypeDuration:
+ return durationRegisteredType.CQLType
+ case TypeFloat:
+ return floatRegisteredType.CQLType
+ case TypeInet:
+ return inetRegisteredType.CQLType
+ case TypeInt:
+ return intRegisteredType.CQLType
+ case TypeSmallInt:
+ return smallintRegisteredType.CQLType
+ case TypeText:
+ return textRegisteredType.CQLType
+ case TypeTime:
+ return timeRegisteredType.CQLType
+ case TypeTimestamp:
+ return timestampRegisteredType.CQLType
+ case TypeTimeUUID:
+ return timeUUIDRegisteredType.CQLType
+ case TypeTinyInt:
+ return tinyIntRegisteredType.CQLType
+ case TypeUUID:
+ return uuidRegisteredType.CQLType
+ case TypeVarchar:
+ return varcharRegisteredType.CQLType
+ case TypeVarint:
+ return varintRegisteredType.CQLType
+ case TypeList:
+ return listRegisteredType.CQLType
+ case TypeMap:
+ return mapRegisteredType.CQLType
+ case TypeSet:
+ return setRegisteredType.CQLType
+ case TypeTuple:
+ return tupleRegisteredType.CQLType
+ case TypeUDT:
+ return udtRegisteredType.CQLType
+ case TypeCustom:
+ return customRegisteredType.CQLType
+ default:
+ rt, ok := registeredTypes[typ]
+ if !ok {
+ return nil
+ }
+ return rt.CQLType
+ }
+}
+
+var registeredTypesByString = map[string]Type{
+ "ascii": TypeAscii,
+ "bigint": TypeBigInt,
+ "blob": TypeBlob,
+ "boolean": TypeBoolean,
+ "counter": TypeCounter,
+ "date": TypeDate,
+ "decimal": TypeDecimal,
+ "double": TypeDouble,
+ "duration": TypeDuration,
+ "float": TypeFloat,
+ "inet": TypeInet,
+ "int": TypeInt,
+ "smallint": TypeSmallInt,
+ "text": TypeText,
+ "time": TypeTime,
+ "timestamp": TypeTimestamp,
+ "timeuuid": TypeTimeUUID,
+ "tinyint": TypeTinyInt,
+ "uuid": TypeUUID,
+ "varchar": TypeVarchar,
+ "varint": TypeVarint,
+ "map": TypeMap,
+ "list": TypeList,
+ "set": TypeSet,
+ "tuple": TypeTuple,
+
+ // these are all for Cassandra 2.x and older
+ "AsciiType": TypeAscii,
+ "LongType": TypeBigInt,
+ "BytesType": TypeBlob,
+ "BooleanType": TypeBoolean,
+ "CounterColumnType": TypeCounter,
+ "DecimalType": TypeDecimal,
+ "DoubleType": TypeDouble,
+ "FloatType": TypeFloat,
+ "Int32Type": TypeInt,
+ "ShortType": TypeSmallInt,
+ "ByteType": TypeTinyInt,
+ "TimeType": TypeTime,
+ "DateType": TypeTimestamp, // DateType was a timestamp when
date didn't exist
+ "TimestampType": TypeTimestamp,
+ "UUIDType": TypeUUID,
+ "LexicalUUIDType": TypeUUID,
+ "UTF8Type": TypeVarchar,
+ "IntegerType": TypeVarint,
+ "TimeUUIDType": TypeTimeUUID,
+ "InetAddressType": TypeInet,
+ "MapType": TypeMap,
+ "ListType": TypeList,
+ "SetType": TypeSet,
+ "TupleType": TypeTuple,
+}
+
+type registeredType struct {
+ CQLType
+ str string
+}
+
+// RegisterType registers a new CQL data type. Type should be the CQL id for
+// the type. Name is the name of the type as returned in the metadata for the
+// column. CQLType is the implementation of the type.
+// This function is not goroutine-safe and must be called before any other
usage
+// of the gocql package. Typically this should be called in an init function.
+func RegisterType(typ Type, name string, t CQLType) {
+ if reg, ok := registeredTypes[typ]; ok {
+ panic(fmt.Errorf("type %d already registered to %v", typ,
reg.str))
+ }
+ registeredTypes[typ] = ®isteredType{
+ CQLType: t,
+ str: name,
+ }
+ if reg, ok := registeredTypesByString[name]; ok {
+ panic(fmt.Errorf("type name %s already registered to %v", name,
reg.String()))
+ }
+ registeredTypesByString[name] = typ
+}
+
+type customCQLType struct{}
+
+var customCQLTypeParams = []reflect.Type{
+ stringType, // name
+}
+
+// Params returns the types to build the slice of params for
TypeInfoFromParams.
+func (t customCQLType) Params(proto int) []reflect.Type {
+ return customCQLTypeParams
+}
+
+// TypeInfoFromParams builds a TypeInfo implementation for the composite type
with
+// the given parameters.
+func (t customCQLType) TypeInfoFromParams(proto int, params []interface{})
TypeInfo {
+ if len(params) != 1 {
+ panic(fmt.Errorf("expected 1 param for custom, got %d",
len(params)))
+ }
+ custom, ok := params[0].(string)
+ if !ok {
+ panic(fmt.Errorf("expected string for custom, got %T",
params[0]))
+ }
+ // TODO: ideally we'd return something else but this already exists
+ return NativeType{
+ proto: byte(proto),
+ typ: getCassandraType(custom),
+ custom: custom,
+ }
+}
+
+// TypeInfoFromString builds a TypeInfo implementation for the composite type
with
+// the given names/classes. Only the portion within the parantheses or arrows
+// are passed to this function.
+func (t customCQLType) TypeInfoFromString(proto int, name string) TypeInfo {
+ return NativeType{
+ proto: byte(proto),
+ typ: getCassandraType(name),
+ custom: name,
+ }
+}
+
+// Marshal marshals the value for the given TypeInfo into a byte slice.
+func (t customCQLType) Marshal(info TypeInfo, value interface{}) ([]byte,
error) {
+ panic("not implemented")
Review Comment:
I don't understand how this new API works for custom types, typically you
can have multiple custom types but all of them are of type "custom" and then
the name (string) is what identifies the type (this is how vectors are
implemented for example).
##########
types.go:
##########
@@ -0,0 +1,431 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package gocql
+
+import (
+ "fmt"
+ "reflect"
+)
+
+// CQLType is the interface that must be implemented by all registered types.
+type CQLType interface {
+ // Params should return the types to build the slice of params for
+ // TypeInfoFromParams. These params are sent to TypeInfoFromParams
after being read
+ // from the frame. The supported types are: Type, TypeInfo, []UDTField,
+ // []byte, string, int, byte.
+ // If no params are needed this can return a nil slice.
+ Params(proto int) []reflect.Type
+
+ // TypeInfoFromParams should return a TypeInfo implementation for the
type
+ // with the given parameters filled after the return from Params().
+ TypeInfoFromParams(proto int, params []interface{}) TypeInfo
+
+ // TypeInfoFromString should return a TypeInfo implementation for the
type with
+ // the given names/classes. Only the portion within the parantheses or
arrows
+ // are passed to this function. For simple types, the name passed might
be empty.
+ TypeInfoFromString(proto int, name string) TypeInfo
+
+ // Marshal should marshal the value for the given TypeInfo into a byte
slice
+ Marshal(info TypeInfo, value interface{}) ([]byte, error)
+
+ // Unmarshal should unmarshal the byte slice into the value for the
given
+ // TypeInfo. It must support data being nil for nullable columns and it
must
+ // support pointers to empty interfaces to get the default go type for
the
+ // column.
+ Unmarshal(info TypeInfo, data []byte, value interface{}) error
Review Comment:
I think we need to add protocol version to this function parameters (and
marshal). I've mentioned this in a previous comment above
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
