types/types.go - master - githubmirror/ydb-go-sdk

types/types.go

132 строки3 KB

Aleksey Myasnikov

* Added public package `github.com/ydb-platform/ydb-go-sdk/v3/types` and marked as deprecated all public API in `github.com/ydb-platform/ydb-go-sdk/v3/table/types` as deprecated (#2217)

30 июн 2026, 13:52

Не верифицирован

30 июн 2026, 13:52419b93a

// Package types provides helpers for YDB types and values.
package types

import (
	"github.com/ydb-platform/ydb-go-sdk/v3/internal/scanner"
	"github.com/ydb-platform/ydb-go-sdk/v3/internal/types"
)

const (
	decimalPrecision uint32 = 22
	decimalScale     uint32 = 9
)

// Type describes YDB data types.
type Type = types.Type

// Equal checks for type equivalence
func Equal(lhs, rhs Type) bool {
	return types.Equal(lhs, rhs)
}

func List(t Type) Type {
	return types.NewList(t)
}

func Tuple(elems ...Type) Type {
	return types.NewTuple(elems...)
}

type tStructType struct {
	fields []types.StructField
}

type StructOption func(*tStructType)

func StructField(name string, t Type) StructOption {
	return func(s *tStructType) {
		s.fields = append(s.fields, types.StructField{
			Name: name,
			T:    t,
		})
	}
}

func Struct(opts ...StructOption) Type {
	var s tStructType
	for _, opt := range opts {
		if opt != nil {
			opt(&s)
		}
	}

	return types.NewStruct(s.fields...)
}

func Dict(k, v Type) Type {
	return types.NewDict(k, v)
}

func VariantStruct(opts ...StructOption) Type {
	var s tStructType
	for _, opt := range opts {
		if opt != nil {
			opt(&s)
		}
	}

	return types.NewVariantStruct(s.fields...)
}

func VariantTuple(elems ...Type) Type {
	return types.NewVariantTuple(elems...)
}

func Void() Type {
	return types.NewVoid()
}

func Optional(t Type) Type {
	return types.NewOptional(t)
}

var DefaultDecimal = DecimalType(decimalPrecision, decimalScale)

func DecimalType(precision, scale uint32) Type {
	return types.NewDecimal(precision, scale)
}

func DecimalTypeFromDecimal(d *Decimal) Type {
	return types.NewDecimal(d.Precision, d.Scale)
}

// Primitive types known by YDB.
const (
	TypeUnknown      = types.Unknown
	TypeBool         = types.Bool
	TypeInt8         = types.Int8
	TypeUint8        = types.Uint8
	TypeInt16        = types.Int16
	TypeUint16       = types.Uint16
	TypeInt32        = types.Int32
	TypeUint32       = types.Uint32
	TypeInt64        = types.Int64
	TypeUint64       = types.Uint64
	TypeFloat        = types.Float
	TypeDouble       = types.Double
	TypeDate         = types.Date
	TypeDate32       = types.Date32
	TypeDatetime     = types.Datetime
	TypeDatetime64   = types.Datetime64
	TypeTimestamp    = types.Timestamp
	TypeTimestamp64  = types.Timestamp64
	TypeInterval     = types.Interval
	TypeInterval64   = types.Interval64
	TypeTzDate       = types.TzDate
	TypeTzDatetime   = types.TzDatetime
	TypeTzTimestamp  = types.TzTimestamp
	TypeString       = types.Bytes
	TypeBytes        = types.Bytes
	TypeUTF8         = types.Text
	TypeText         = types.Text
	TypeYSON         = types.YSON
	TypeJSON         = types.JSON
	TypeUUID         = types.UUID
	TypeJSONDocument = types.JSONDocument
	TypeDyNumber     = types.DyNumber
)

type (
	RawValue = scanner.RawValue
	Scanner  = scanner.Scanner
)