types

package
v3.48.5 Latest Latest
Warning

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

 Go to latest Published: Jul 6, 2023 License: Apache-2.0 Imports: 9 Imported by: 39

Documentation

Index

Constants

View Source 
const (
	TypeUnknown      = value.TypeUnknown
	TypeBool         = value.TypeBool
	TypeInt8         = value.TypeInt8
	TypeUint8        = value.TypeUint8
	TypeInt16        = value.TypeInt16
	TypeUint16       = value.TypeUint16
	TypeInt32        = value.TypeInt32
	TypeUint32       = value.TypeUint32
	TypeInt64        = value.TypeInt64
	TypeUint64       = value.TypeUint64
	TypeFloat        = value.TypeFloat
	TypeDouble       = value.TypeDouble
	TypeDate         = value.TypeDate
	TypeDatetime     = value.TypeDatetime
	TypeTimestamp    = value.TypeTimestamp
	TypeInterval     = value.TypeInterval
	TypeTzDate       = value.TypeTzDate
	TypeTzDatetime   = value.TypeTzDatetime
	TypeTzTimestamp  = value.TypeTzTimestamp
	TypeString       = value.TypeBytes
	TypeBytes        = value.TypeBytes
	TypeUTF8         = value.TypeText
	TypeText         = value.TypeText
	TypeYSON         = value.TypeYSON
	TypeJSON         = value.TypeJSON
	TypeUUID         = value.TypeUUID
	TypeJSONDocument = value.TypeJSONDocument
	TypeDyNumber     = value.TypeDyNumber
)

Primitive types known by YDB.

Variables

View Source 
var DefaultDecimal = DecimalType(22, 9)

Functions

func CastTo added in v3.39.0 

func CastTo(v Value, dst interface{}) error

CastTo try cast value to destination type value

func DictFields deprecated added in v3.39.0 

func DictFields(v Value) (map[Value]Value, error)

DictFields returns dict values from abstract Value

Deprecated: use DictValues instead

func DictValues added in v3.48.0 

func DictValues(v Value) (map[Value]Value, error)

DictValues returns dict values from abstract Value

func Equal added in v3.29.0 

func Equal(lhs, rhs Type) bool

Equal checks for type equivalence

func StructFields added in v3.39.0 

func StructFields(v Value) (map[string]Value, error)

StructFields returns struct fields from abstract Value

func WriteTypeStringTo deprecated 

func WriteTypeStringTo(buf *bytes.Buffer, t Type)

WriteTypeStringTo writes ydb type string representation into buffer

Deprecated: use types.Type.Yql() instead

Types

type Decimal 

type Decimal struct {
	Bytes     [16]byte
	Precision uint32
	Scale     uint32
}

Decimal supported in scanner API

func ToDecimal added in v3.47.0 

func ToDecimal(v Value) (*Decimal, error)

ToDecimal returns Decimal struct from abstract Value

func (*Decimal) BigInt 

func (d *Decimal) BigInt() *big.Int

func (*Decimal) String 

func (d *Decimal) String() string

type DictValueOption added in v3.29.0 

type DictValueOption func(*dictValueFields)

func DictFieldValue added in v3.29.0 

func DictFieldValue(k, v Value) DictValueOption

type RawValue 

type RawValue interface {
	Path() string
	WritePathTo(w io.Writer) (n int64, err error)
	Type() Type
	Bool() (v bool)
	Int8() (v int8)
	Uint8() (v uint8)
	Int16() (v int16)
	Uint16() (v uint16)
	Int32() (v int32)
	Uint32() (v uint32)
	Int64() (v int64)
	Uint64() (v uint64)
	Float() (v float32)
	Double() (v float64)
	Date() (v time.Time)
	Datetime() (v time.Time)
	Timestamp() (v time.Time)
	Interval() (v time.Duration)
	TzDate() (v time.Time)
	TzDatetime() (v time.Time)
	TzTimestamp() (v time.Time)
	String() (v []byte)
	UTF8() (v string)
	YSON() (v []byte)
	JSON() (v []byte)
	UUID() (v [16]byte)
	JSONDocument() (v []byte)
	DyNumber() (v string)
	Value() Value

	// Any returns any primitive or optional value.
	// Currently, it may return one of these types:
	//
	//   bool
	//   int8
	//   uint8
	//   int16
	//   uint16
	//   int32
	//   uint32
	//   int64
	//   uint64
	//   float32
	//   float64
	//   []byte
	//   string
	//   [16]byte
	//
	Any() interface{}

	// Unwrap unwraps current item under scan interpreting it as Optional<Type> types.
	Unwrap()
	AssertType(t Type) bool
	IsNull() bool
	IsOptional() bool

	// ListIn interprets current item under scan as a ydb's list.
	// It returns the size of the nested items.
	// If current item under scan is not a list types, it returns -1.
	ListIn() (size int)

	// ListItem selects current item i-th element as an item to scan.
	// ListIn() must be called before.
	ListItem(i int)

	// ListOut leaves list entered before by ListIn() call.
	ListOut()

	// TupleIn interprets current item under scan as a ydb's tuple.
	// It returns the size of the nested items.
	TupleIn() (size int)

	// TupleItem selects current item i-th element as an item to scan.
	// Note that TupleIn() must be called before.
	// It panics if it is out of bounds.
	TupleItem(i int)

	// TupleOut leaves tuple entered before by TupleIn() call.
	TupleOut()

	// StructIn interprets current item under scan as a ydb's struct.
	// It returns the size of the nested items – the struct fields values.
	// If there is no current item under scan it returns -1.
	StructIn() (size int)

	// StructField selects current item i-th field value as an item to scan.
	// Note that StructIn() must be called before.
	// It panics if i is out of bounds.
	StructField(i int) (name string)

	// StructOut leaves struct entered before by StructIn() call.
	StructOut()

	// DictIn interprets current item under scan as a ydb's dict.
	// It returns the size of the nested items pairs.
	// If there is no current item under scan it returns -1.
	DictIn() (size int)

	// DictKey selects current item i-th pair key as an item to scan.
	// Note that DictIn() must be called before.
	// It panics if i is out of bounds.
	DictKey(i int)

	// DictPayload selects current item i-th pair value as an item to scan.
	// Note that DictIn() must be called before.
	// It panics if i is out of bounds.
	DictPayload(i int)

	// DictOut leaves dict entered before by DictIn() call.
	DictOut()

	// Variant unwraps current item under scan interpreting it as Variant<Type> types.
	// It returns non-empty name of a field that is filled for struct-based
	// variant.
	// It always returns an index of filled field of a Type.
	Variant() (name string, index uint32)

	// Decimal returns decimal value represented by big-endian 128 bit signed integer.
	Decimal(t Type) (v [16]byte)

	// UnwrapDecimal returns decimal value represented by big-endian 128 bit signed
	// integer and its types information.
	UnwrapDecimal() Decimal
	IsDecimal() bool
	Err() error
}

RawValue scanning non-primitive yql types or for own implementation scanner native API

type Scanner 

type Scanner interface {
	// UnmarshalYDB must be implemented on client-side for unmarshal raw ydb value.
	UnmarshalYDB(raw RawValue) error
}

Scanner scanning raw ydb types

type StructOption 

type StructOption func(*tStructType)

func StructField 

func StructField(name string, t Type) StructOption

type StructValueOption 

type StructValueOption func(*structValueFields)

func StructFieldValue 

func StructFieldValue(name string, v Value) StructValueOption

type Type 

type Type = value.Type

Type describes YDB data types.

func DecimalType 

func DecimalType(precision, scale uint32) Type

func DecimalTypeFromDecimal 

func DecimalTypeFromDecimal(d *Decimal) Type

func Dict added in v3.29.5 

func Dict(k, v Type) Type

func IsOptional added in v3.48.3 

func IsOptional(t Type) (isOptional bool, innerType Type)

IsOptional checks if type is optional and returns innerType if it is.

func List 

func List(t Type) Type

func Optional 

func Optional(t Type) Type

func Struct 

func Struct(opts ...StructOption) Type

func Tuple 

func Tuple(elems ...Type) Type

func VariantStruct added in v3.39.0 

func VariantStruct(opts ...StructOption) Type

func VariantTuple added in v3.39.0 

func VariantTuple(elems ...Type) Type

func Void 

func Void() Type

type Value 

type Value = value.Value

func BoolValue 

func BoolValue(v bool) Value

func BytesValue added in v3.36.0 

func BytesValue(v []byte) Value

func BytesValueFromString added in v3.36.0 

func BytesValueFromString(v string) Value

func DateValue 

func DateValue(v uint32) Value

DateValue returns ydb date value by given days since Epoch

func DateValueFromTime 

func DateValueFromTime(t time.Time) Value

DateValueFromTime makes Date value from time.Time

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func DatetimeValue 

func DatetimeValue(v uint32) Value

DatetimeValue makes ydb datetime value from seconds since Epoch

func DatetimeValueFromTime 

func DatetimeValueFromTime(t time.Time) Value

DatetimeValueFromTime makes Datetime value from time.Time

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func DecimalValue 

func DecimalValue(v *Decimal) Value

DecimalValue creates decimal value of given types t and value v. Note that Decimal.Bytes interpreted as big-endian int128.

func DecimalValueFromBigInt 

func DecimalValueFromBigInt(v *big.Int, precision, scale uint32) Value

func DictValue 

func DictValue(opts ...DictValueOption) Value

func DoubleValue 

func DoubleValue(v float64) Value

func DyNumberValue 

func DyNumberValue(v string) Value

func FloatValue 

func FloatValue(v float32) Value

func Int16Value 

func Int16Value(v int16) Value

func Int32Value 

func Int32Value(v int32) Value

func Int64Value 

func Int64Value(v int64) Value

func Int8Value 

func Int8Value(v int8) Value

func IntervalValue deprecated 

func IntervalValue(v int64) Value

IntervalValue makes Value from given microseconds value

Deprecated: use IntervalValueFromMicroseconds instead

func IntervalValueFromDuration 

func IntervalValueFromDuration(v time.Duration) Value

IntervalValueFromDuration makes Interval value from time.Duration

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func IntervalValueFromMicroseconds added in v3.26.9 

func IntervalValueFromMicroseconds(v int64) Value

IntervalValueFromMicroseconds makes Value from given microseconds value

func JSONDocumentValue 

func JSONDocumentValue(v string) Value

func JSONDocumentValueFromBytes 

func JSONDocumentValueFromBytes(v []byte) Value

JSONDocumentValueFromBytes makes JSONDocument value from bytes

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func JSONValue 

func JSONValue(v string) Value

func JSONValueFromBytes 

func JSONValueFromBytes(v []byte) Value

JSONValueFromBytes makes JSON value from bytes

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func ListItems added in v3.48.0 

func ListItems(v Value) ([]Value, error)

ListItems returns list items from abstract Value

func ListValue 

func ListValue(vs ...Value) Value

func NullValue 

func NullValue(t Type) Value

func Nullable added in v3.15.0 

func Nullable(t Type, v interface{}) Value

Nullable makes optional value from nullable type Warning: type interface will be replaced in the future with typed parameters pattern from go1.18

func NullableBoolValue added in v3.15.0 

func NullableBoolValue(v *bool) Value

func NullableBytesValue added in v3.36.2 

func NullableBytesValue(v *[]byte) Value

func NullableBytesValueFromString added in v3.36.2 

func NullableBytesValueFromString(v *string) Value

func NullableDateValue added in v3.15.0 

func NullableDateValue(v *uint32) Value

func NullableDateValueFromTime added in v3.15.0 

func NullableDateValueFromTime(v *time.Time) Value

func NullableDatetimeValue added in v3.15.0 

func NullableDatetimeValue(v *uint32) Value

func NullableDatetimeValueFromTime added in v3.15.0 

func NullableDatetimeValueFromTime(v *time.Time) Value

func NullableDoubleValue added in v3.15.0 

func NullableDoubleValue(v *float64) Value

func NullableDyNumberValue added in v3.15.0 

func NullableDyNumberValue(v *string) Value

func NullableFloatValue added in v3.15.0 

func NullableFloatValue(v *float32) Value

func NullableInt16Value added in v3.15.0 

func NullableInt16Value(v *int16) Value

func NullableInt32Value added in v3.15.0 

func NullableInt32Value(v *int32) Value

func NullableInt64Value added in v3.15.0 

func NullableInt64Value(v *int64) Value

func NullableInt8Value added in v3.15.0 

func NullableInt8Value(v *int8) Value

func NullableIntervalValue deprecated added in v3.15.0 

func NullableIntervalValue(v *int64) Value

NullableIntervalValue makes Value which maybe nil or valued

Deprecated: use NullableIntervalValueFromMicroseconds instead

func NullableIntervalValueFromDuration added in v3.15.0 

func NullableIntervalValueFromDuration(v *time.Duration) Value

func NullableIntervalValueFromMicroseconds added in v3.26.9 

func NullableIntervalValueFromMicroseconds(v *int64) Value

func NullableJSONDocumentValue added in v3.15.0 

func NullableJSONDocumentValue(v *string) Value

func NullableJSONDocumentValueFromBytes added in v3.15.0 

func NullableJSONDocumentValueFromBytes(v *[]byte) Value

func NullableJSONValue added in v3.15.0 

func NullableJSONValue(v *string) Value

func NullableJSONValueFromBytes added in v3.15.0 

func NullableJSONValueFromBytes(v *[]byte) Value

func NullableStringValue deprecated added in v3.15.0 

func NullableStringValue(v *[]byte) Value

NullableStringValue

Deprecated: use NullableBytesValue instead

func NullableStringValueFromString added in v3.15.0 

func NullableStringValueFromString(v *string) Value

func NullableTextValue added in v3.36.2 

func NullableTextValue(v *string) Value

func NullableTimestampValue added in v3.15.0 

func NullableTimestampValue(v *uint64) Value

func NullableTimestampValueFromTime added in v3.15.0 

func NullableTimestampValueFromTime(v *time.Time) Value

func NullableTzDateValue added in v3.15.0 

func NullableTzDateValue(v *string) Value

func NullableTzDateValueFromTime added in v3.15.0 

func NullableTzDateValueFromTime(v *time.Time) Value

func NullableTzDatetimeValue added in v3.15.0 

func NullableTzDatetimeValue(v *string) Value

func NullableTzDatetimeValueFromTime added in v3.15.0 

func NullableTzDatetimeValueFromTime(v *time.Time) Value

func NullableTzTimestampValue added in v3.15.0 

func NullableTzTimestampValue(v *string) Value

func NullableTzTimestampValueFromTime added in v3.15.0 

func NullableTzTimestampValueFromTime(v *time.Time) Value

func NullableUTF8Value added in v3.15.0 

func NullableUTF8Value(v *string) Value

func NullableUUIDValue added in v3.15.0 

func NullableUUIDValue(v *[16]byte) Value

func NullableUint16Value added in v3.15.0 

func NullableUint16Value(v *uint16) Value

func NullableUint32Value added in v3.15.0 

func NullableUint32Value(v *uint32) Value

func NullableUint64Value added in v3.15.0 

func NullableUint64Value(v *uint64) Value

func NullableUint8Value added in v3.15.0 

func NullableUint8Value(v *uint8) Value

func NullableYSONValue added in v3.15.0 

func NullableYSONValue(v *string) Value

func NullableYSONValueFromBytes added in v3.15.0 

func NullableYSONValueFromBytes(v *[]byte) Value

func OptionalValue 

func OptionalValue(v Value) Value

func SetValue added in v3.39.0 

func SetValue(vs ...Value) Value

func StringValue deprecated 

func StringValue(v []byte) Value

StringValue returns bytes value

Deprecated: use BytesValue instead

func StringValueFromString 

func StringValueFromString(v string) Value

StringValueFromString makes String value from string

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func StructValue 

func StructValue(opts ...StructValueOption) Value

func TextValue added in v3.36.0 

func TextValue(v string) Value

func TimestampValue 

func TimestampValue(v uint64) Value

TimestampValue makes ydb timestamp value from microseconds since Epoch

func TimestampValueFromTime 

func TimestampValueFromTime(t time.Time) Value

TimestampValueFromTime makes Timestamp value from time.Time

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func TupleItems added in v3.39.0 

func TupleItems(v Value) ([]Value, error)

TupleItems returns tuple items from abstract Value

func TupleValue 

func TupleValue(vs ...Value) Value

func TzDateValue 

func TzDateValue(v string) Value

TzDateValue makes TzDate value from string

func TzDateValueFromTime 

func TzDateValueFromTime(t time.Time) Value

TzDateValueFromTime makes TzDate value from time.Time

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func TzDatetimeValue 

func TzDatetimeValue(v string) Value

TzDatetimeValue makes TzDatetime value from string

func TzDatetimeValueFromTime 

func TzDatetimeValueFromTime(t time.Time) Value

TzDatetimeValueFromTime makes TzDatetime value from time.Time

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func TzTimestampValue 

func TzTimestampValue(v string) Value

TzTimestampValue makes TzTimestamp value from string

func TzTimestampValueFromTime 

func TzTimestampValueFromTime(t time.Time) Value

TzTimestampValueFromTime makes TzTimestamp value from time.Time

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func UTF8Value 

func UTF8Value(v string) Value

func UUIDValue 

func UUIDValue(v [16]byte) Value

func Uint16Value 

func Uint16Value(v uint16) Value

func Uint32Value 

func Uint32Value(v uint32) Value

func Uint64Value 

func Uint64Value(v uint64) Value

func Uint8Value 

func Uint8Value(v uint8) Value

func VariantValue 

func VariantValue(v Value) (name string, idx uint32, _ Value, _ error)

VariantValue returns variant value from abstract Value

func VariantValueStruct added in v3.39.0 

func VariantValueStruct(v Value, name string, variantT Type) Value

func VariantValueTuple added in v3.39.0 

func VariantValueTuple(v Value, i uint32, variantT Type) Value

func VoidValue 

func VoidValue() Value

func YSONValue 

func YSONValue(v string) Value

func YSONValueFromBytes 

func YSONValueFromBytes(v []byte) Value

YSONValueFromBytes makes YSON value from bytes

Warning: all *From* helpers will be removed at next major release (functional will be implements with go1.18 type lists)

func ZeroValue 

func ZeroValue(t Type) Value

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.