The highest tagged major version is
Documentation
¶
Index ¶
- func ConstantValue(_ context.Context, d *TransformData) (interface{}, error)
- func EnsureStringArray(_ context.Context, d *TransformData) (interface{}, error)
- func FieldValue(_ context.Context, d *TransformData) (interface{}, error)
- func FieldValueCamelCase(ctx context.Context, d *TransformData) (interface{}, error)
- func FieldValueGo(ctx context.Context, d *TransformData) (interface{}, error)
- func FieldValueTag(ctx context.Context, d *TransformData) (interface{}, error)
- func MethodValue(_ context.Context, d *TransformData) (interface{}, error)
- func NullIfEqualParam(_ context.Context, d *TransformData) (interface{}, error)
- func NullIfZeroValue(_ context.Context, d *TransformData) (interface{}, error)
- func RawValue(_ context.Context, d *TransformData) (interface{}, error)
- func StringArrayToMap(_ context.Context, d *TransformData) (interface{}, error)
- func ToBool(_ context.Context, d *TransformData) (interface{}, error)
- func ToDouble(_ context.Context, d *TransformData) (interface{}, error)
- func ToInt(_ context.Context, d *TransformData) (interface{}, error)
- func ToLower(_ context.Context, d *TransformData) (interface{}, error)
- func ToString(_ context.Context, d *TransformData) (interface{}, error)
- func ToUpper(_ context.Context, d *TransformData) (interface{}, error)
- func UnixMsToTimestamp(_ context.Context, d *TransformData) (interface{}, error)
- func UnixToTimestamp(_ context.Context, d *TransformData) (interface{}, error)
- func UnmarshalYAML(_ context.Context, d *TransformData) (interface{}, error)
- type ColumnTransforms
- func From(transformFunc TransformFunc) *ColumnTransforms
- func FromCamel() *ColumnTransforms
- func FromConstant(value interface{}) *ColumnTransforms
- func FromField(field string) *ColumnTransforms
- func FromGo() *ColumnTransforms
- func FromJSONTag() *ColumnTransforms
- func FromMethod(methodName string) *ColumnTransforms
- func FromP(transformFunc TransformFunc, param interface{}) *ColumnTransforms
- func FromTag(tagName string) *ColumnTransforms
- func FromValue() *ColumnTransforms
- func (t *ColumnTransforms) Execute(ctx context.Context, hydrateItem interface{}, ...) (interface{}, error)
- func (t *ColumnTransforms) NullIfEqual(nullValue interface{}) *ColumnTransforms
- func (t *ColumnTransforms) NullIfZero() *ColumnTransforms
- func (t *ColumnTransforms) Transform(transformFunc TransformFunc) *ColumnTransforms
- func (t *ColumnTransforms) TransformP(transformFunc TransformFunc, param interface{}) *ColumnTransforms
- type GetSourceFieldFunc
- type TransformCall
- type TransformData
- type TransformFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConstantValue ¶
func ConstantValue(_ context.Context, d *TransformData) (interface{}, error)
ConstantValue :: intended for the start of a transform chain return the value passed as d.Param
func EnsureStringArray ¶ added in v0.1.1
func EnsureStringArray(_ context.Context, d *TransformData) (interface{}, error)
EnsureStringArray :: convert the input value to a string array
func FieldValue ¶
func FieldValue(_ context.Context, d *TransformData) (interface{}, error)
FieldValue :: intended for the start of a transform chain return a field value of either the hydrate call result (if present) or the root item if not the field name is in the 'Param'
func FieldValueCamelCase ¶
func FieldValueCamelCase(ctx context.Context, d *TransformData) (interface{}, error)
FieldValueCamelCase :: intended for the start of a transform chain convert the column name to camel case and call FieldValue
func FieldValueGo ¶
func FieldValueGo(ctx context.Context, d *TransformData) (interface{}, error)
FieldValueGo :: intended for the start of a transform chain convert the column name to camel case, with common initialisms upper case, and call FieldValue
func FieldValueTag ¶
func FieldValueTag(ctx context.Context, d *TransformData) (interface{}, error)
FieldValueTag :: intended for the start of a transform chain find the data value with the tag matching the column name
func MethodValue ¶
func MethodValue(_ context.Context, d *TransformData) (interface{}, error)
func NullIfEqualParam ¶
func NullIfEqualParam(_ context.Context, d *TransformData) (interface{}, error)
NullIfEqualParam :: if the input Value equals the transform param, return nil
func NullIfZeroValue ¶
func NullIfZeroValue(_ context.Context, d *TransformData) (interface{}, error)
NullIfZero :: if the input value equals the zero value of its type, return nil
func RawValue ¶
func RawValue(_ context.Context, d *TransformData) (interface{}, error)
RawValue :: intended for the start of a transform chain return the whole hydrate item
func StringArrayToMap ¶ added in v0.1.1
func StringArrayToMap(_ context.Context, d *TransformData) (interface{}, error)
StringArrayToMap :: converts a string array to a map where the keys are the array elements
func ToBool ¶
func ToBool(_ context.Context, d *TransformData) (interface{}, error)
ToBool :: convert the (string) value to a bool if value is not a string, do nothing
func ToDouble ¶
func ToDouble(_ context.Context, d *TransformData) (interface{}, error)
ToDouble :: convert the value to an float64
func ToInt ¶
func ToInt(_ context.Context, d *TransformData) (interface{}, error)
ToInt :: convert the value to an int64
func ToLower ¶
func ToLower(_ context.Context, d *TransformData) (interface{}, error)
ToLower :: convert the (string or *string) value to lower case if value is not a string, return unaltered value
func ToString ¶
func ToString(_ context.Context, d *TransformData) (interface{}, error)
ToString :: convert the value to a string
func ToUpper ¶
func ToUpper(_ context.Context, d *TransformData) (interface{}, error)
ToUpper :: convert the (string or *string) value to upper case if value is not a string, return unaltered value
func UnixMsToTimestamp ¶
func UnixMsToTimestamp(_ context.Context, d *TransformData) (interface{}, error)
UnixMsToTimestamp :: convert unix time in milliseconds to RFC3339 format
func UnixToTimestamp ¶
func UnixToTimestamp(_ context.Context, d *TransformData) (interface{}, error)
UnixToTimestamp :: convert unix time format to RFC3339 format
func UnmarshalYAML ¶
func UnmarshalYAML(_ context.Context, d *TransformData) (interface{}, error)
UnmarshalYAML :: parse the yaml-encoded data and return the result
Types ¶
type ColumnTransforms ¶
type ColumnTransforms struct {
// a list of transforms to apply to the data
Transforms []*TransformCall
// should this transform chain start with the default transform for the column
ApplyDefaultTransform bool
}
ColumnTransforms :: a struct defining the data transforms required to map from a JSON value to a column value
func From ¶
func From(transformFunc TransformFunc) *ColumnTransforms
Generate a value by calling 'transformFunc'
func FromCamel ¶
func FromCamel() *ColumnTransforms
Generate a value by converting the given field name to camel case and retrieving from the source item
func FromConstant ¶
func FromConstant(value interface{}) *ColumnTransforms
Return a constant value (specified by 'param')
func FromField ¶
func FromField(field string) *ColumnTransforms
Generate a value by retrieving a field from the source item
func FromGo ¶
func FromGo() *ColumnTransforms
Generate a value by converting the given field name to camel case and retrieving from the source item
func FromJSONTag ¶
func FromJSONTag() *ColumnTransforms
Generate a value by finding a struct property with the json tag matching the column name
func FromMethod ¶
func FromMethod(methodName string) *ColumnTransforms
FromMethod invokes a function on the hydrate item
func FromP ¶
func FromP(transformFunc TransformFunc, param interface{}) *ColumnTransforms
Generate a value by calling 'transformFunc' passing param
func FromTag ¶
func FromTag(tagName string) *ColumnTransforms
Generate a value by finding a struct property with the tag 'tagName' matching the column name
func FromValue ¶
func FromValue() *ColumnTransforms
Generate a value by returning the raw hydrate item
func (*ColumnTransforms) Execute ¶
func (t *ColumnTransforms) Execute(ctx context.Context, hydrateItem interface{}, hydrateResults map[string]interface{}, defaultTransform *ColumnTransforms, columnName string) (interface{}, error)
func (*ColumnTransforms) NullIfEqual ¶
func (t *ColumnTransforms) NullIfEqual(nullValue interface{}) *ColumnTransforms
NullValue :: if the input Value equals the transform param, return nil
func (*ColumnTransforms) NullIfZero ¶
func (t *ColumnTransforms) NullIfZero() *ColumnTransforms
NullIfZero :: if the input value equals the zero value of its type, return nil
func (*ColumnTransforms) Transform ¶
func (t *ColumnTransforms) Transform(transformFunc TransformFunc) *ColumnTransforms
Apply an arbitrary transform to the data (specified by 'transformFunc')
func (*ColumnTransforms) TransformP ¶
func (t *ColumnTransforms) TransformP(transformFunc TransformFunc, param interface{}) *ColumnTransforms
Apply an arbitrary transform to the data, passing a parameter
type GetSourceFieldFunc ¶
type GetSourceFieldFunc func(interface{}) string
type TransformCall ¶
type TransformCall struct {
Transform TransformFunc
Param interface{}
}
TransformCall :: a transform function and parameter to invoke it with
type TransformData ¶
type TransformData struct {
// an optional parameter
Param interface{}
// the value to be transformed
Value interface{}
// a data object containing the the source data for this column
HydrateItem interface{}
// all hydrate results
HydrateResults map[string]interface{}
// the column this transform is generating
ColumnName string
}
TransformData :: the input to a transform function
type TransformFunc ¶
type TransformFunc func(context.Context, *TransformData) (interface{}, error)
TransformFunc :: function to transform a data value from the api value to a column value parameters are: value, parent json object, param returns the transformed HydrateItem
Source Files