scalar

package
v18.0.0-...-f9949aa Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 16, 2024 License: Apache-2.0, BSD-3-Clause Imports: 26 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Append 

func Append(bldr array.Builder, s Scalar) error

Append requires the passed in builder and scalar to have the same datatype otherwise it will return an error. Will return arrow.ErrNotImplemented if the type hasn't been implemented for this.

NOTE only available in go1.18+

func AppendSlice 

func AppendSlice(bldr array.Builder, scalars []Scalar) error

AppendSlice requires the passed in builder and all scalars in the slice to have the same datatype otherwise it will return an error. Will return arrow.ErrNotImplemented if the type hasn't been implemented for this.

NOTE only available in go1.18+

func ApproxEquals 

func ApproxEquals(left, right Scalar, opts ...EqualOption) bool

func Equals 

func Equals(left, right Scalar) bool

Equals returns true if two scalars are equal, which means they have the same datatype, validity and value.

func FromScalar 

func FromScalar(sc *Struct, val interface{}) error

func Hash 

func Hash(seed maphash.Seed, s Scalar) uint64

func MakeArrayFromScalar 

func MakeArrayFromScalar(sc Scalar, length int, mem memory.Allocator) (arrow.Array, error)

MakeArrayFromScalar returns an array filled with the scalar value repeated length times. Not yet implemented for nested types such as Struct, List, extension and so on.

func MakeArrayOfNull deprecated 

func MakeArrayOfNull(dt arrow.DataType, length int, mem memory.Allocator) arrow.Array

MakeArrayOfNull creates an array of size length which is all null of the given data type.

Deprecated: Use array.MakeArrayOfNull

Types

type Binary 

type Binary struct {
	Value *memory.Buffer
	// contains filtered or unexported fields
}

func NewBinaryScalar 

func NewBinaryScalar(val *memory.Buffer, typ arrow.DataType) *Binary

func (*Binary) Buffer 

func (b *Binary) Buffer() *memory.Buffer

func (*Binary) CastTo 

func (b *Binary) CastTo(to arrow.DataType) (Scalar, error)

func (*Binary) Data 

func (b *Binary) Data() []byte

func (Binary) DataType 

func (s Binary) DataType() arrow.DataType

func (*Binary) IsValid 

func (s *Binary) IsValid() bool

func (*Binary) Release 

func (b *Binary) Release()

func (*Binary) Retain 

func (b *Binary) Retain()

func (*Binary) String 

func (b *Binary) String() string

func (*Binary) Validate 

func (b *Binary) Validate() (err error)

func (*Binary) ValidateFull 

func (b *Binary) ValidateFull() error

type BinaryScalar 

type BinaryScalar interface {
	Scalar

	Retain()
	Release()
	Buffer() *memory.Buffer
	Data() []byte
}

type Boolean 

type Boolean struct {
	Value bool
	// contains filtered or unexported fields
}

func NewBooleanScalar 

func NewBooleanScalar(val bool) *Boolean

func (*Boolean) CastTo 

func (s *Boolean) CastTo(dt arrow.DataType) (Scalar, error)

func (*Boolean) Data 

func (s *Boolean) Data() []byte

func (Boolean) DataType 

func (s Boolean) DataType() arrow.DataType

func (*Boolean) IsValid 

func (s *Boolean) IsValid() bool

func (*Boolean) String 

func (s *Boolean) String() string

func (*Boolean) Validate 

func (s *Boolean) Validate() error

func (*Boolean) ValidateFull 

func (s *Boolean) ValidateFull() error

type Date32 

type Date32 struct {
	Value arrow.Date32
	// contains filtered or unexported fields
}

func NewDate32Scalar 

func NewDate32Scalar(val arrow.Date32) *Date32

func (*Date32) CastTo 

func (s *Date32) CastTo(to arrow.DataType) (Scalar, error)

func (*Date32) Data 

func (s *Date32) Data() []byte

func (Date32) DataType 

func (s Date32) DataType() arrow.DataType

func (*Date32) IsValid 

func (s *Date32) IsValid() bool

func (*Date32) String 

func (s *Date32) String() string

func (*Date32) ToTime 

func (s *Date32) ToTime() time.Time

func (*Date32) Validate 

func (s *Date32) Validate() error

func (*Date32) ValidateFull 

func (s *Date32) ValidateFull() error

type Date64 

type Date64 struct {
	Value arrow.Date64
	// contains filtered or unexported fields
}

func NewDate64Scalar 

func NewDate64Scalar(val arrow.Date64) *Date64

func (*Date64) CastTo 

func (s *Date64) CastTo(to arrow.DataType) (Scalar, error)

func (*Date64) Data 

func (s *Date64) Data() []byte

func (Date64) DataType 

func (s Date64) DataType() arrow.DataType

func (*Date64) IsValid 

func (s *Date64) IsValid() bool

func (*Date64) String 

func (s *Date64) String() string

func (*Date64) ToTime 

func (s *Date64) ToTime() time.Time

func (*Date64) Validate 

func (s *Date64) Validate() error

func (*Date64) ValidateFull 

func (s *Date64) ValidateFull() error

type DateScalar 

type DateScalar interface {
	TemporalScalar
	ToTime() time.Time
	// contains filtered or unexported methods
}

type DayTimeInterval 

type DayTimeInterval struct {
	Value arrow.DayTimeInterval
	// contains filtered or unexported fields
}

func NewDayTimeIntervalScalar 

func NewDayTimeIntervalScalar(val arrow.DayTimeInterval) *DayTimeInterval

func (*DayTimeInterval) CastTo 

func (s *DayTimeInterval) CastTo(to arrow.DataType) (Scalar, error)

func (*DayTimeInterval) Data 

func (s *DayTimeInterval) Data() []byte

func (DayTimeInterval) DataType 

func (s DayTimeInterval) DataType() arrow.DataType

func (*DayTimeInterval) IsValid 

func (s *DayTimeInterval) IsValid() bool

func (*DayTimeInterval) String 

func (s *DayTimeInterval) String() string

func (*DayTimeInterval) Validate 

func (s *DayTimeInterval) Validate() error

func (*DayTimeInterval) ValidateFull 

func (s *DayTimeInterval) ValidateFull() error

type Decimal128 

type Decimal128 struct {
	Value decimal128.Num
	// contains filtered or unexported fields
}

func NewDecimal128Scalar 

func NewDecimal128Scalar(val decimal128.Num, typ arrow.DataType) *Decimal128

func (*Decimal128) CastTo 

func (s *Decimal128) CastTo(to arrow.DataType) (Scalar, error)

func (*Decimal128) Data 

func (s *Decimal128) Data() []byte

func (Decimal128) DataType 

func (s Decimal128) DataType() arrow.DataType

func (*Decimal128) IsValid 

func (s *Decimal128) IsValid() bool

func (*Decimal128) String 

func (s *Decimal128) String() string

func (*Decimal128) Validate 

func (s *Decimal128) Validate() error

func (*Decimal128) ValidateFull 

func (s *Decimal128) ValidateFull() error

type Decimal256 

type Decimal256 struct {
	Value decimal256.Num
	// contains filtered or unexported fields
}

func NewDecimal256Scalar 

func NewDecimal256Scalar(val decimal256.Num, typ arrow.DataType) *Decimal256

func (*Decimal256) CastTo 

func (s *Decimal256) CastTo(to arrow.DataType) (Scalar, error)

func (*Decimal256) Data 

func (s *Decimal256) Data() []byte

func (Decimal256) DataType 

func (s Decimal256) DataType() arrow.DataType

func (*Decimal256) IsValid 

func (s *Decimal256) IsValid() bool

func (*Decimal256) String 

func (s *Decimal256) String() string

func (*Decimal256) Validate 

func (s *Decimal256) Validate() error

func (*Decimal256) ValidateFull 

func (s *Decimal256) ValidateFull() error

type DenseUnion 

type DenseUnion struct {
	TypeCode arrow.UnionTypeCode
	Value    Scalar
	// contains filtered or unexported fields
}

func NewDenseUnionScalar 

func NewDenseUnionScalar(v Scalar, code arrow.UnionTypeCode, dt *arrow.DenseUnionType) *DenseUnion

func (*DenseUnion) CastTo 

func (s *DenseUnion) CastTo(to arrow.DataType) (Scalar, error)

func (*DenseUnion) ChildValue 

func (s *DenseUnion) ChildValue() Scalar

func (DenseUnion) DataType 

func (s DenseUnion) DataType() arrow.DataType

func (*DenseUnion) IsValid 

func (s *DenseUnion) IsValid() bool

func (*DenseUnion) Release 

func (s *DenseUnion) Release()

func (*DenseUnion) Retain 

func (s *DenseUnion) Retain()

func (*DenseUnion) String 

func (s *DenseUnion) String() string

func (*DenseUnion) Validate 

func (s *DenseUnion) Validate() (err error)

func (*DenseUnion) ValidateFull 

func (s *DenseUnion) ValidateFull() error

type Dictionary 

type Dictionary struct {
	Value struct {
		Index Scalar
		Dict  arrow.Array
	}
	// contains filtered or unexported fields
}

func NewDictScalar 

func NewDictScalar(index Scalar, dict arrow.Array) *Dictionary

func NewNullDictScalar 

func NewNullDictScalar(dt arrow.DataType) *Dictionary

func (*Dictionary) CastTo 

func (s *Dictionary) CastTo(arrow.DataType) (Scalar, error)

func (*Dictionary) Data 

func (s *Dictionary) Data() []byte

func (Dictionary) DataType 

func (s Dictionary) DataType() arrow.DataType

func (*Dictionary) GetEncodedValue 

func (s *Dictionary) GetEncodedValue() (Scalar, error)

func (*Dictionary) IsValid 

func (s *Dictionary) IsValid() bool

func (*Dictionary) Release 

func (s *Dictionary) Release()

func (*Dictionary) Retain 

func (s *Dictionary) Retain()

func (*Dictionary) String 

func (s *Dictionary) String() string

func (*Dictionary) Validate 

func (s *Dictionary) Validate() (err error)

func (*Dictionary) ValidateFull 

func (s *Dictionary) ValidateFull() (err error)

type Duration 

type Duration struct {
	Value arrow.Duration
	// contains filtered or unexported fields
}

func NewDurationScalar 

func NewDurationScalar(val arrow.Duration, typ arrow.DataType) *Duration

func (*Duration) CastTo 

func (s *Duration) CastTo(to arrow.DataType) (Scalar, error)

func (*Duration) Data 

func (s *Duration) Data() []byte

func (Duration) DataType 

func (s Duration) DataType() arrow.DataType

func (*Duration) IsValid 

func (s *Duration) IsValid() bool

func (*Duration) String 

func (s *Duration) String() string

func (*Duration) Unit 

func (s *Duration) Unit() arrow.TimeUnit

func (*Duration) Validate 

func (s *Duration) Validate() error

func (*Duration) ValidateFull 

func (s *Duration) ValidateFull() error

type EqualOption 

type EqualOption func(*equalOption)

EqualOption is a functional option type used to configure how Records and Arrays are compared.

func WithAbsTolerance 

func WithAbsTolerance(atol float64) EqualOption

WithAbsTolerance configures the comparison functions so that 2 floating point values v1 and v2 are considered equal if |v1-v2| <= atol.

func WithNaNsEqual 

func WithNaNsEqual(val bool) EqualOption

WithNaNsEqual configures the comparison functions so that NaNs are considered equal.

type Extension 

type Extension struct {
	Value Scalar
	// contains filtered or unexported fields
}

func NewExtensionScalar 

func NewExtensionScalar(storage Scalar, typ arrow.DataType) *Extension

func (*Extension) CastTo 

func (s *Extension) CastTo(to arrow.DataType) (Scalar, error)

func (Extension) DataType 

func (s Extension) DataType() arrow.DataType

func (*Extension) IsValid 

func (s *Extension) IsValid() bool

func (*Extension) String 

func (s *Extension) String() string

func (*Extension) Validate 

func (e *Extension) Validate() (err error)

func (*Extension) ValidateFull 

func (e *Extension) ValidateFull() error

type FixedSizeBinary 

type FixedSizeBinary struct {
	*Binary
}

func NewFixedSizeBinaryScalar 

func NewFixedSizeBinaryScalar(val *memory.Buffer, typ arrow.DataType) *FixedSizeBinary

func (FixedSizeBinary) DataType 

func (s FixedSizeBinary) DataType() arrow.DataType

func (FixedSizeBinary) IsValid 

func (s FixedSizeBinary) IsValid() bool

func (*FixedSizeBinary) Validate 

func (b *FixedSizeBinary) Validate() (err error)

func (*FixedSizeBinary) ValidateFull 

func (b *FixedSizeBinary) ValidateFull() error

type FixedSizeList 

type FixedSizeList struct {
	*List
}

func NewFixedSizeListScalar 

func NewFixedSizeListScalar(val arrow.Array) *FixedSizeList

func NewFixedSizeListScalarWithType 

func NewFixedSizeListScalarWithType(val arrow.Array, typ arrow.DataType) *FixedSizeList

func (FixedSizeList) DataType 

func (s FixedSizeList) DataType() arrow.DataType

func (FixedSizeList) IsValid 

func (s FixedSizeList) IsValid() bool

func (*FixedSizeList) Validate 

func (f *FixedSizeList) Validate() (err error)

func (*FixedSizeList) ValidateFull 

func (f *FixedSizeList) ValidateFull() error

type Float16 

type Float16 struct {
	Value float16.Num
	// contains filtered or unexported fields
}

func NewFloat16Scalar 

func NewFloat16Scalar(val float16.Num) *Float16

func NewFloat16ScalarFromFloat32 

func NewFloat16ScalarFromFloat32(val float32) *Float16

func (*Float16) CastTo 

func (f *Float16) CastTo(to arrow.DataType) (Scalar, error)

func (*Float16) Data 

func (f *Float16) Data() []byte

func (Float16) DataType 

func (s Float16) DataType() arrow.DataType

func (*Float16) IsValid 

func (s *Float16) IsValid() bool

func (*Float16) String 

func (s *Float16) String() string

func (*Float16) Validate 

func (s *Float16) Validate() error

func (*Float16) ValidateFull 

func (s *Float16) ValidateFull() error

type Float32 

type Float32 struct {
	Value float32
	// contains filtered or unexported fields
}

func NewFloat32Scalar 

func NewFloat32Scalar(val float32) *Float32

func (*Float32) CastTo 

func (s *Float32) CastTo(dt arrow.DataType) (Scalar, error)

func (*Float32) Data 

func (s *Float32) Data() []byte

func (Float32) DataType 

func (s Float32) DataType() arrow.DataType

func (*Float32) IsValid 

func (s *Float32) IsValid() bool

func (*Float32) String 

func (s *Float32) String() string

func (*Float32) Validate 

func (s *Float32) Validate() error

func (*Float32) ValidateFull 

func (s *Float32) ValidateFull() error

type Float64 

type Float64 struct {
	Value float64
	// contains filtered or unexported fields
}

func NewFloat64Scalar 

func NewFloat64Scalar(val float64) *Float64

func (*Float64) CastTo 

func (s *Float64) CastTo(dt arrow.DataType) (Scalar, error)

func (*Float64) Data 

func (s *Float64) Data() []byte

func (Float64) DataType 

func (s Float64) DataType() arrow.DataType

func (*Float64) IsValid 

func (s *Float64) IsValid() bool

func (*Float64) String 

func (s *Float64) String() string

func (*Float64) Validate 

func (s *Float64) Validate() error

func (*Float64) ValidateFull 

func (s *Float64) ValidateFull() error

type Int16 

type Int16 struct {
	Value int16
	// contains filtered or unexported fields
}

func NewInt16Scalar 

func NewInt16Scalar(val int16) *Int16

func (*Int16) CastTo 

func (s *Int16) CastTo(dt arrow.DataType) (Scalar, error)

func (*Int16) Data 

func (s *Int16) Data() []byte

func (Int16) DataType 

func (s Int16) DataType() arrow.DataType

func (*Int16) IsValid 

func (s *Int16) IsValid() bool

func (*Int16) String 

func (s *Int16) String() string

func (*Int16) Validate 

func (s *Int16) Validate() error

func (*Int16) ValidateFull 

func (s *Int16) ValidateFull() error

type Int32 

type Int32 struct {
	Value int32
	// contains filtered or unexported fields
}

func NewInt32Scalar 

func NewInt32Scalar(val int32) *Int32

func (*Int32) CastTo 

func (s *Int32) CastTo(dt arrow.DataType) (Scalar, error)

func (*Int32) Data 

func (s *Int32) Data() []byte

func (Int32) DataType 

func (s Int32) DataType() arrow.DataType

func (*Int32) IsValid 

func (s *Int32) IsValid() bool

func (*Int32) String 

func (s *Int32) String() string

func (*Int32) Validate 

func (s *Int32) Validate() error

func (*Int32) ValidateFull 

func (s *Int32) ValidateFull() error

type Int64 

type Int64 struct {
	Value int64
	// contains filtered or unexported fields
}

func NewInt64Scalar 

func NewInt64Scalar(val int64) *Int64

func (*Int64) CastTo 

func (s *Int64) CastTo(dt arrow.DataType) (Scalar, error)

func (*Int64) Data 

func (s *Int64) Data() []byte

func (Int64) DataType 

func (s Int64) DataType() arrow.DataType

func (*Int64) IsValid 

func (s *Int64) IsValid() bool

func (*Int64) String 

func (s *Int64) String() string

func (*Int64) Validate 

func (s *Int64) Validate() error

func (*Int64) ValidateFull 

func (s *Int64) ValidateFull() error

type Int8 

type Int8 struct {
	Value int8
	// contains filtered or unexported fields
}

func NewInt8Scalar 

func NewInt8Scalar(val int8) *Int8

func (*Int8) CastTo 

func (s *Int8) CastTo(dt arrow.DataType) (Scalar, error)

func (*Int8) Data 

func (s *Int8) Data() []byte

func (Int8) DataType 

func (s Int8) DataType() arrow.DataType

func (*Int8) IsValid 

func (s *Int8) IsValid() bool

func (*Int8) String 

func (s *Int8) String() string

func (*Int8) Validate 

func (s *Int8) Validate() error

func (*Int8) ValidateFull 

func (s *Int8) ValidateFull() error

type IntervalScalar 

type IntervalScalar interface {
	TemporalScalar
	// contains filtered or unexported methods
}

type LargeBinary 

type LargeBinary struct {
	*Binary
}

func NewLargeBinaryScalar 

func NewLargeBinaryScalar(val *memory.Buffer) *LargeBinary

func (LargeBinary) DataType 

func (s LargeBinary) DataType() arrow.DataType

func (LargeBinary) IsValid 

func (s LargeBinary) IsValid() bool

type LargeList 

type LargeList struct {
	*List
}

func NewLargeListScalar 

func NewLargeListScalar(val arrow.Array) *LargeList

func NewLargeListScalarData 

func NewLargeListScalarData(val arrow.ArrayData) *LargeList

func (LargeList) DataType 

func (s LargeList) DataType() arrow.DataType

func (LargeList) IsValid 

func (s LargeList) IsValid() bool

type LargeString 

type LargeString struct {
	// contains filtered or unexported fields
}

func NewLargeStringScalar 

func NewLargeStringScalar(val string) *LargeString

func NewLargeStringScalarFromBuffer 

func NewLargeStringScalarFromBuffer(val *memory.Buffer) *LargeString

type List 

type List struct {
	Value arrow.Array
	// contains filtered or unexported fields
}

func NewListScalar 

func NewListScalar(val arrow.Array) *List

func NewListScalarData 

func NewListScalarData(val arrow.ArrayData) *List

func (*List) CastTo 

func (l *List) CastTo(to arrow.DataType) (Scalar, error)

func (List) DataType 

func (s List) DataType() arrow.DataType

func (*List) GetList 

func (l *List) GetList() arrow.Array

func (*List) IsValid 

func (s *List) IsValid() bool

func (*List) Release 

func (l *List) Release()

func (*List) Retain 

func (l *List) Retain()

func (*List) String 

func (l *List) String() string

func (*List) Validate 

func (l *List) Validate() (err error)

func (*List) ValidateFull 

func (l *List) ValidateFull() error

type ListScalar 

type ListScalar interface {
	Scalar
	GetList() arrow.Array
	Release()
	Retain()
}

type Map 

type Map struct {
	*List
}

func NewMapScalar 

func NewMapScalar(val arrow.Array) *Map

func (Map) DataType 

func (s Map) DataType() arrow.DataType

func (Map) IsValid 

func (s Map) IsValid() bool

type MonthDayNanoInterval 

type MonthDayNanoInterval struct {
	Value arrow.MonthDayNanoInterval
	// contains filtered or unexported fields
}

func NewMonthDayNanoIntervalScalar 

func NewMonthDayNanoIntervalScalar(val arrow.MonthDayNanoInterval) *MonthDayNanoInterval

func (*MonthDayNanoInterval) CastTo 

func (s *MonthDayNanoInterval) CastTo(to arrow.DataType) (Scalar, error)

func (*MonthDayNanoInterval) Data 

func (s *MonthDayNanoInterval) Data() []byte

func (MonthDayNanoInterval) DataType 

func (s MonthDayNanoInterval) DataType() arrow.DataType

func (*MonthDayNanoInterval) IsValid 

func (s *MonthDayNanoInterval) IsValid() bool

func (*MonthDayNanoInterval) String 

func (s *MonthDayNanoInterval) String() string

func (*MonthDayNanoInterval) Validate 

func (s *MonthDayNanoInterval) Validate() error

func (*MonthDayNanoInterval) ValidateFull 

func (s *MonthDayNanoInterval) ValidateFull() error

type MonthInterval 

type MonthInterval struct {
	Value arrow.MonthInterval
	// contains filtered or unexported fields
}

func NewMonthIntervalScalar 

func NewMonthIntervalScalar(val arrow.MonthInterval) *MonthInterval

func (*MonthInterval) CastTo 

func (s *MonthInterval) CastTo(to arrow.DataType) (Scalar, error)

func (*MonthInterval) Data 

func (s *MonthInterval) Data() []byte

func (MonthInterval) DataType 

func (s MonthInterval) DataType() arrow.DataType

func (*MonthInterval) IsValid 

func (s *MonthInterval) IsValid() bool

func (*MonthInterval) String 

func (s *MonthInterval) String() string

func (*MonthInterval) Validate 

func (s *MonthInterval) Validate() error

func (*MonthInterval) ValidateFull 

func (s *MonthInterval) ValidateFull() error

type Null 

type Null struct {
	// contains filtered or unexported fields
}
var (
	ScalarNull *Null = &Null{scalar{Type: arrow.Null, Valid: false}}
)

func (*Null) CastTo 

func (n *Null) CastTo(dt arrow.DataType) (Scalar, error)

func (Null) DataType 

func (s Null) DataType() arrow.DataType

func (*Null) IsValid 

func (s *Null) IsValid() bool

func (*Null) String 

func (s *Null) String() string

func (*Null) Validate 

func (n *Null) Validate() (err error)

func (*Null) ValidateFull 

func (n *Null) ValidateFull() error

type PrimitiveScalar 

type PrimitiveScalar interface {
	Scalar
	Data() []byte
}

type Releasable 

type Releasable interface {
	Release()
	Retain()
}

type RunEndEncoded 

type RunEndEncoded struct {
	Value Scalar
	// contains filtered or unexported fields
}

func NewRunEndEncodedScalar 

func NewRunEndEncodedScalar(v Scalar, dt *arrow.RunEndEncodedType) *RunEndEncoded

func (*RunEndEncoded) CastTo 

func (s *RunEndEncoded) CastTo(to arrow.DataType) (Scalar, error)

func (RunEndEncoded) DataType 

func (s RunEndEncoded) DataType() arrow.DataType

func (*RunEndEncoded) IsValid 

func (s *RunEndEncoded) IsValid() bool

func (*RunEndEncoded) Release 

func (s *RunEndEncoded) Release()

func (*RunEndEncoded) String 

func (s *RunEndEncoded) String() string

func (*RunEndEncoded) Validate 

func (s *RunEndEncoded) Validate() (err error)

func (*RunEndEncoded) ValidateFull 

func (s *RunEndEncoded) ValidateFull() error

type Scalar 

type Scalar interface {
	fmt.Stringer
	// IsValid returns true if the value is non-null, otherwise false.
	IsValid() bool
	// The datatype of the value in this scalar
	DataType() arrow.DataType
	// Performs cheap validation checks, returns nil if successful
	Validate() error
	// Perform more expensive validation checks, returns nil if successful
	ValidateFull() error
	// Cast the value to the desired DataType (returns an error if unable to do so)
	// should take semantics into account and modify the value accordingly.
	CastTo(arrow.DataType) (Scalar, error)
	// contains filtered or unexported methods
}

Scalar represents a single value of a specific DataType as opposed to an array.

Scalars are useful for passing single value inputs to compute functions (not yet implemented) or for representing individual array elements, (with a non-trivial cost though).

func GetScalar 

func GetScalar(arr arrow.Array, idx int) (Scalar, error)

GetScalar creates a scalar object from the value at a given index in the passed in array, returns an error if unable to do so.

func MakeIntegerScalar 

func MakeIntegerScalar(v int64, bitsize int) (Scalar, error)

MakeIntegerScalar is a helper function for creating an integer scalar of a given bitsize.

func MakeNullScalar 

func MakeNullScalar(dt arrow.DataType) Scalar

MakeNullScalar creates a scalar value of the desired type representing a null value

func MakeScalar 

func MakeScalar(val interface{}) Scalar

MakeScalar creates a scalar of the passed in type via reflection.

func MakeScalarParam 

func MakeScalarParam(val interface{}, dt arrow.DataType) (Scalar, error)

MakeScalarParam is for converting a value to a scalar when it requires a parameterized data type such as a time type that needs units, or a fixed size list which needs it's size.

Will fall back to MakeScalar without the passed in type if not one of the parameterized types.

func MakeUnsignedIntegerScalar 

func MakeUnsignedIntegerScalar(v uint64, bitsize int) (Scalar, error)

MakeUnsignedIntegerScalar is a helper function for creating an unsigned int scalar of the specified bit width.

func ParseScalar 

func ParseScalar(dt arrow.DataType, val string) (Scalar, error)

ParseScalar parses a string to create a scalar of the passed in type. Currently does not support any nested types such as Structs or Lists.

func ToScalar 

func ToScalar(val interface{}, mem memory.Allocator) (Scalar, error)

type SparseUnion 

type SparseUnion struct {
	TypeCode arrow.UnionTypeCode
	Value    []Scalar
	ChildID  int
	// contains filtered or unexported fields
}

func NewSparseUnionScalar 

func NewSparseUnionScalar(val []Scalar, code arrow.UnionTypeCode, dt *arrow.SparseUnionType) *SparseUnion

func NewSparseUnionScalarFromValue 

func NewSparseUnionScalarFromValue(val Scalar, idx int, dt *arrow.SparseUnionType) *SparseUnion

func (*SparseUnion) CastTo 

func (s *SparseUnion) CastTo(to arrow.DataType) (Scalar, error)

func (*SparseUnion) ChildValue 

func (s *SparseUnion) ChildValue() Scalar

func (SparseUnion) DataType 

func (s SparseUnion) DataType() arrow.DataType

func (*SparseUnion) IsValid 

func (s *SparseUnion) IsValid() bool

func (*SparseUnion) Release 

func (s *SparseUnion) Release()

func (*SparseUnion) Retain 

func (s *SparseUnion) Retain()

func (*SparseUnion) String 

func (s *SparseUnion) String() string

func (*SparseUnion) Validate 

func (s *SparseUnion) Validate() (err error)

func (*SparseUnion) ValidateFull 

func (s *SparseUnion) ValidateFull() (err error)

type String 

type String struct {
	*Binary
}

func NewStringScalar 

func NewStringScalar(val string) *String

func NewStringScalarFromBuffer 

func NewStringScalarFromBuffer(val *memory.Buffer) *String

func (*String) CastTo 

func (s *String) CastTo(to arrow.DataType) (Scalar, error)

func (String) DataType 

func (s String) DataType() arrow.DataType

func (String) IsValid 

func (s String) IsValid() bool

func (*String) Validate 

func (s *String) Validate() error

func (*String) ValidateFull 

func (s *String) ValidateFull() (err error)

type Struct 

type Struct struct {
	Value Vector
	// contains filtered or unexported fields
}

func NewStructScalar 

func NewStructScalar(val []Scalar, typ arrow.DataType) *Struct

func NewStructScalarWithNames 

func NewStructScalarWithNames(val []Scalar, names []string) (*Struct, error)

func (*Struct) CastTo 

func (s *Struct) CastTo(to arrow.DataType) (Scalar, error)

func (Struct) DataType 

func (s Struct) DataType() arrow.DataType

func (*Struct) Field 

func (s *Struct) Field(name string) (Scalar, error)

func (*Struct) IsValid 

func (s *Struct) IsValid() bool

func (*Struct) Release 

func (s *Struct) Release()

func (*Struct) String 

func (s *Struct) String() string

func (*Struct) Validate 

func (s *Struct) Validate() (err error)

func (*Struct) ValidateFull 

func (s *Struct) ValidateFull() (err error)

type TemporalScalar 

type TemporalScalar interface {
	Scalar
	// contains filtered or unexported methods
}

type Time32 

type Time32 struct {
	Value arrow.Time32
	// contains filtered or unexported fields
}

func NewTime32Scalar 

func NewTime32Scalar(val arrow.Time32, typ arrow.DataType) *Time32

func (*Time32) CastTo 

func (s *Time32) CastTo(to arrow.DataType) (Scalar, error)

func (*Time32) Data 

func (s *Time32) Data() []byte

func (Time32) DataType 

func (s Time32) DataType() arrow.DataType

func (*Time32) IsValid 

func (s *Time32) IsValid() bool

func (*Time32) String 

func (s *Time32) String() string

func (*Time32) ToTime 

func (s *Time32) ToTime() time.Time

func (*Time32) Unit 

func (s *Time32) Unit() arrow.TimeUnit

func (*Time32) Validate 

func (s *Time32) Validate() error

func (*Time32) ValidateFull 

func (s *Time32) ValidateFull() error

type Time64 

type Time64 struct {
	Value arrow.Time64
	// contains filtered or unexported fields
}

func NewTime64Scalar 

func NewTime64Scalar(val arrow.Time64, typ arrow.DataType) *Time64

func (*Time64) CastTo 

func (s *Time64) CastTo(to arrow.DataType) (Scalar, error)

func (*Time64) Data 

func (s *Time64) Data() []byte

func (Time64) DataType 

func (s Time64) DataType() arrow.DataType

func (*Time64) IsValid 

func (s *Time64) IsValid() bool

func (*Time64) String 

func (s *Time64) String() string

func (*Time64) ToTime 

func (s *Time64) ToTime() time.Time

func (*Time64) Unit 

func (s *Time64) Unit() arrow.TimeUnit

func (*Time64) Validate 

func (s *Time64) Validate() error

func (*Time64) ValidateFull 

func (s *Time64) ValidateFull() error

type TimeScalar 

type TimeScalar interface {
	TemporalScalar
	Unit() arrow.TimeUnit
	ToTime() time.Time
	// contains filtered or unexported methods
}

type Timestamp 

type Timestamp struct {
	Value arrow.Timestamp
	// contains filtered or unexported fields
}

func NewTimestampScalar 

func NewTimestampScalar(val arrow.Timestamp, typ arrow.DataType) *Timestamp

func (*Timestamp) CastTo 

func (s *Timestamp) CastTo(to arrow.DataType) (Scalar, error)

func (*Timestamp) Data 

func (s *Timestamp) Data() []byte

func (Timestamp) DataType 

func (s Timestamp) DataType() arrow.DataType

func (*Timestamp) IsValid 

func (s *Timestamp) IsValid() bool

func (*Timestamp) String 

func (s *Timestamp) String() string

func (*Timestamp) ToTime 

func (s *Timestamp) ToTime() time.Time

func (*Timestamp) Unit 

func (s *Timestamp) Unit() arrow.TimeUnit

func (*Timestamp) Validate 

func (s *Timestamp) Validate() error

func (*Timestamp) ValidateFull 

func (s *Timestamp) ValidateFull() error

type TypeFromScalar 

type TypeFromScalar interface {
	FromStructScalar(*Struct) error
}

type TypeToScalar 

type TypeToScalar interface {
	ToScalar() (Scalar, error)
}

type Uint16 

type Uint16 struct {
	Value uint16
	// contains filtered or unexported fields
}

func NewUint16Scalar 

func NewUint16Scalar(val uint16) *Uint16

func (*Uint16) CastTo 

func (s *Uint16) CastTo(dt arrow.DataType) (Scalar, error)

func (*Uint16) Data 

func (s *Uint16) Data() []byte

func (Uint16) DataType 

func (s Uint16) DataType() arrow.DataType

func (*Uint16) IsValid 

func (s *Uint16) IsValid() bool

func (*Uint16) String 

func (s *Uint16) String() string

func (*Uint16) Validate 

func (s *Uint16) Validate() error

func (*Uint16) ValidateFull 

func (s *Uint16) ValidateFull() error

type Uint32 

type Uint32 struct {
	Value uint32
	// contains filtered or unexported fields
}

func NewUint32Scalar 

func NewUint32Scalar(val uint32) *Uint32

func (*Uint32) CastTo 

func (s *Uint32) CastTo(dt arrow.DataType) (Scalar, error)

func (*Uint32) Data 

func (s *Uint32) Data() []byte

func (Uint32) DataType 

func (s Uint32) DataType() arrow.DataType

func (*Uint32) IsValid 

func (s *Uint32) IsValid() bool

func (*Uint32) String 

func (s *Uint32) String() string

func (*Uint32) Validate 

func (s *Uint32) Validate() error

func (*Uint32) ValidateFull 

func (s *Uint32) ValidateFull() error

type Uint64 

type Uint64 struct {
	Value uint64
	// contains filtered or unexported fields
}

func NewUint64Scalar 

func NewUint64Scalar(val uint64) *Uint64

func (*Uint64) CastTo 

func (s *Uint64) CastTo(dt arrow.DataType) (Scalar, error)

func (*Uint64) Data 

func (s *Uint64) Data() []byte

func (Uint64) DataType 

func (s Uint64) DataType() arrow.DataType

func (*Uint64) IsValid 

func (s *Uint64) IsValid() bool

func (*Uint64) String 

func (s *Uint64) String() string

func (*Uint64) Validate 

func (s *Uint64) Validate() error

func (*Uint64) ValidateFull 

func (s *Uint64) ValidateFull() error

type Uint8 

type Uint8 struct {
	Value uint8
	// contains filtered or unexported fields
}

func NewUint8Scalar 

func NewUint8Scalar(val uint8) *Uint8

func (*Uint8) CastTo 

func (s *Uint8) CastTo(dt arrow.DataType) (Scalar, error)

func (*Uint8) Data 

func (s *Uint8) Data() []byte

func (Uint8) DataType 

func (s Uint8) DataType() arrow.DataType

func (*Uint8) IsValid 

func (s *Uint8) IsValid() bool

func (*Uint8) String 

func (s *Uint8) String() string

func (*Uint8) Validate 

func (s *Uint8) Validate() error

func (*Uint8) ValidateFull 

func (s *Uint8) ValidateFull() error

type Union 

type Union interface {
	Scalar
	ChildValue() Scalar
	Release()
}

type Vector 

type Vector []Scalar

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.