sqldav

README

sqldav

"sql.Scanner"/"driver.Valuer" for DynamoDB PartiQL (And its Tooltip)

Types

sqldav implements the following sql.Scanner, driver.Valuer

• sqldav.Set[string | int | float64 | []byte], the Defined Type of []string, []int, []float64, [][]byte. Converted to set in DynamoDB.

• sqldav.List, the Defined Type of []interface{}. Converted to list in DynamoDB.

• sqldav.Map, the Defined Type of map[string]interface{}. Converted to map in DynamoDB.

• sqldav.TypedList[T], the Defined Type of []T. Converted to list in DynamoDB.

Contributing

Feel free to open a PR or an Issue.

However, you must promise to follow our Code of Conduct.

License

sqldav released under the MIT License

Documentation

Index

• Variables
• func AssignMapValueToReflectValue(rt reflect.Type, rv reflect.Value, mv map[string]interface{}) error
• func ToDocumentAttributeValue[T DocumentAttributeMember](value interface{}) (T, error)
• type DocumentAttributeMember
• type List
  • func (l *List) GormDataType() string
  • func (l *List) Scan(value interface{}) error
  • func (l List) Value() (v driver.Value, err error)
• type Map
  • func (m Map) GormDataType() string
  • func (m *Map) Scan(value interface{}) error
  • func (m Map) Value() (v driver.Value, err error)
• type Set
  • func (s *Set[T]) GormDataType() string
  • func (s *Set[T]) Scan(value interface{}) error
  • func (s Set[T]) Value() (v driver.Value, err error)
• type SetSupportable
• type TypedList
  • func (l *TypedList[T]) GormDataType() string
  • func (l *TypedList[T]) Scan(value interface{}) error
  • func (l TypedList[T]) Value() (v driver.Value, err error)

Variables

var (
	ErrValueIsIncompatibleOfStringSlice  = errors.New("value is incompatible of string slice")
	ErrValueIsIncompatibleOfIntSlice     = errors.New("value is incompatible of int slice")
	ErrValueIsIncompatibleOfFloat64Slice = errors.New("value is incompatible of float64 slice")
	ErrValueIsIncompatibleOfBinarySlice  = errors.New("value is incompatible of []byte slice")
	ErrCollectionAlreadyContainsItem     = errors.New("collection already contains item")
	ErrFailedToCast                      = errors.New("failed to cast")
)

var ErrDocumentAttributeValueIsIncompatible = fmt.Errorf("document-attribute-value is incompatible")

ErrDocumentAttributeValueIsIncompatible occurs when an incompatible conversion to following:

• *types.AttributeValueMemberL
• *types.AttributeValueMemberM
• *types.AttributeValueMemberSS
• *types.AttributeValueMemberNS
• *types.AttributeValueMemberBS

var ErrNestedStructHasIncompatibleAttributes = errors.New("nested struct has incompatible attributes")

ErrNestedStructHasIncompatibleAttributes occurs when the nested struct has incompatible attributes.

Functions

func AssignMapValueToReflectValue

func AssignMapValueToReflectValue(rt reflect.Type, rv reflect.Value, mv map[string]interface{}) error

AssignMapValueToReflectValue assigns the map type value to the reflect.Value

func ToDocumentAttributeValue

func ToDocumentAttributeValue[T DocumentAttributeMember](value interface{}) (T, error)

ToDocumentAttributeValue converts given interface to a DocumentAttributeMember.

NOTE: this function returns a typed-nil if the conversion is incompatible. therefore, nil-check is not guaranteed to work.

Types

type DocumentAttributeMember

type DocumentAttributeMember interface {
	*types.AttributeValueMemberL | *types.AttributeValueMemberM | *types.AttributeValueMemberSS | *types.AttributeValueMemberNS | *types.AttributeValueMemberBS
}

DocumentAttributeMember represents Document Attribute Member.

type List

type List []interface{}

List is a DynamoDB list type.

See: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html

func (*List) GormDataType

func (l *List) GormDataType() string

GormDataType returns the data type for Gorm.

func (*List) Scan

func (l *List) Scan(value interface{}) error

Scan implements the sql.Scanner#Scan

func (List) Value

func (l List) Value() (v driver.Value, err error)

Value implements the driver.Valuer interface.

type Map

type Map map[string]interface{}

Map is a DynamoDB map type.

See: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html

func (Map) GormDataType

func (m Map) GormDataType() string

GormDataType returns the data type for Gorm.

func (*Map) Scan

func (m *Map) Scan(value interface{}) error

Scan implements the sql.Scanner#Scan

func (Map) Value

func (m Map) Value() (v driver.Value, err error)

Value implements the driver.Valuer interface.

type Set

type Set[T SetSupportable] []T

Set is a DynamoDB set type.

See: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html

func (*Set[T]) GormDataType

func (s *Set[T]) GormDataType() string

GormDataType returns the data type for Gorm.

func (*Set[T]) Scan

func (s *Set[T]) Scan(value interface{}) error

Scan implements the sql.Scanner#Scan

func (Set[T]) Value

func (s Set[T]) Value() (v driver.Value, err error)

type SetSupportable

type SetSupportable interface {
	string | []byte | int | float64
}

SetSupportable are the types that support the Set

type TypedList

type TypedList[T any] []T

TypedList is a DynamoDB list type with type specification.

See: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html

func (*TypedList[T]) GormDataType

func (l *TypedList[T]) GormDataType() string

GormDataType returns the data type for Gorm.

func (*TypedList[T]) Scan

func (l *TypedList[T]) Scan(value interface{}) error

Scan implements the sql.Scanner#Scan

func (TypedList[T]) Value

func (l TypedList[T]) Value() (v driver.Value, err error)

Value implements the driver.Valuer interface.