internal

Documentation

Index

• Constants
• Variables
• func ChalkMarshal(attrs map[string]any) ([]byte, error)
• func ChalkUnmarshal(body []byte) (map[string]any, error)
• func ChalkpySnakeCase(s string) string
• func ColumnMapToRecord(inputs map[string]any) (arrow.Record, error)
• func ConvertBytesToTable(byteArr []byte) (result arrow.Table, err error)
• func CreateOnlineQueryBulkBody(inputs map[string]any, header FeatherRequestHeader) ([]byte, error)
• func CreateUploadFeaturesBody(inputs map[string]any) ([]byte, error)
• func ExpandTilde(path string) (string, error)
• func ExtractFeaturesFromTable(table arrow.Table) ([]map[string]any, error)
• func FileExists(path string) bool
• func FormatBucketDuration(duration int) string
• func GenerateGetEnumFunction[K comparable](valueToEnum map[string]K, enumName string) func(string) (*K, error)
• func GetHeaderFromSerializedOnlineQueryBulkBody(body []byte) (map[string]any, error)
• func GetReflectValue(value any, typ reflect.Type) (*reflect.Value, error)
• func GetValueFromArrowArray(a arrow.Array, idx int) (any, error)
• func InputsToArrowBytes(inputs map[string]any) ([]byte, error)
• func IsDataclass(field reflect.Value) bool
• func IsTypeDataclass(typ reflect.Type) bool
• func KindMismatchError(expected reflect.Kind, actual reflect.Kind) error
• func ParseBucketDuration(durationStr string) (int, error)
• func Ptr[T any](value T) *T
• func ReflectPtr(value reflect.Value) reflect.Value
• func ResolveFeatureName(field reflect.StructField) (string, error)
• func SliceAppend(slicePtr any, value reflect.Value)
• func StringOrNil(value string) *string
• type BufferWriteSeeker
  • func (b *BufferWriteSeeker) Bytes() []byte
  • func (b *BufferWriteSeeker) Seek(offset int64, whence int) (int64, error)
  • func (b *BufferWriteSeeker) Write(p []byte) (n int, err error)
• type FeatherRequestHeader
• type Numbers
• type OfflineQueryInputSerialized
• type OfflineQueryRequestSerialized
• type OnlineQueryContext
• type OnlineQueryRequestSerialized

Constants

const ApiServerEnvVarKey = "CHALK_API_SERVER"

const ClientIdEnvVarKey = "CHALK_CLIENT_ID"

const ClientSecretEnvVarKey = "CHALK_CLIENT_SECRET"

const EnvironmentEnvVarKey = "CHALK_ACTIVE_ENVIRONMENT"

Variables

var NameTag = "name"

var SkipUnmarshalFqnRoots = map[string]bool{
	"__chalk__": true,
}

Functions

func ChalkMarshal

func ChalkMarshal(attrs map[string]any) ([]byte, error)

ChalkMarshal converts a map to a byte array. Follows the byte-packing format as described in the Chalk Python repo's `byte_transmit.serialize()` function.

func ChalkUnmarshal

func ChalkUnmarshal(body []byte) (map[string]any, error)

func ChalkpySnakeCase

func ChalkpySnakeCase(s string) string

ChalkpySnakeCase aims to be in parity with our Python implementation of snake_case

func ColumnMapToRecord

func ColumnMapToRecord(inputs map[string]any) (arrow.Record, error)

ColumnMapToRecord converts a map of column names to slices of values to an Arrow Record.

func ConvertBytesToTable

func ConvertBytesToTable(byteArr []byte) (result arrow.Table, err error)

func CreateOnlineQueryBulkBody

func CreateOnlineQueryBulkBody(inputs map[string]any, header FeatherRequestHeader) ([]byte, error)

func CreateUploadFeaturesBody

func CreateUploadFeaturesBody(inputs map[string]any) ([]byte, error)

func ExpandTilde

func ExpandTilde(path string) (string, error)

func ExtractFeaturesFromTable

func ExtractFeaturesFromTable(table arrow.Table) ([]map[string]any, error)

func FileExists

func FileExists(path string) bool

func FormatBucketDuration

func FormatBucketDuration(duration int) string

FormatBucketDuration takes an integer number of seconds and returns a string representation that satisfies these conditions:

• the largest possible unit of time (e.g. "10m" instead of "600s")
• a single unit of time (e.g. "601s" instead of "10m1s")

func GenerateGetEnumFunction

func GenerateGetEnumFunction[K comparable](valueToEnum map[string]K, enumName string) func(string) (*K, error)

func GetHeaderFromSerializedOnlineQueryBulkBody

func GetHeaderFromSerializedOnlineQueryBulkBody(body []byte) (map[string]any, error)

func GetReflectValue

func GetReflectValue(value any, typ reflect.Type) (*reflect.Value, error)

GetReflectValue returns a reflect.Value of the given type from the given non-reflect value.

func GetValueFromArrowArray

func GetValueFromArrowArray(a arrow.Array, idx int) (any, error)

func InputsToArrowBytes

func InputsToArrowBytes(inputs map[string]any) ([]byte, error)

InputsToArrowBytes converts map of FQNs to slice of values to an Arrow Record, serialized.

func IsDataclass

func IsDataclass(field reflect.Value) bool

func IsTypeDataclass

func IsTypeDataclass(typ reflect.Type) bool

func KindMismatchError

func KindMismatchError(expected reflect.Kind, actual reflect.Kind) error

func ParseBucketDuration

func ParseBucketDuration(durationStr string) (int, error)

ParseBucketDuration parses a bucket duration string and returns the duration in seconds. The input string must be of the form "Nunit" where N is a positive integer and unit is one of "s", "m", "h", "d", or "w".

func Ptr

func Ptr[T any](value T) *T

func ReflectPtr

func ReflectPtr(value reflect.Value) reflect.Value

func ResolveFeatureName

func ResolveFeatureName(field reflect.StructField) (string, error)

func SliceAppend

func SliceAppend(slicePtr any, value reflect.Value)

func StringOrNil

func StringOrNil(value string) *string

Types

type BufferWriteSeeker

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

func (*BufferWriteSeeker) Bytes

func (b *BufferWriteSeeker) Bytes() []byte

func (*BufferWriteSeeker) Seek

func (b *BufferWriteSeeker) Seek(offset int64, whence int) (int64, error)

func (*BufferWriteSeeker) Write

func (b *BufferWriteSeeker) Write(p []byte) (n int, err error)

type FeatherRequestHeader

type FeatherRequestHeader struct {
	Outputs  []string            `json:"outputs"`
	BranchId *string             `json:"branch_id"`
	Explain  bool                `json:"explain"`
	Context  *OnlineQueryContext `json:"context"`
}

type Numbers

type Numbers interface {
	int | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | float32 | float64
}

type OfflineQueryInputSerialized

type OfflineQueryInputSerialized struct {
	Columns []string `json:"columns"`
	Values  [][]any  `json:"values"`
}

type OfflineQueryRequestSerialized

type OfflineQueryRequestSerialized struct {
	Input                OfflineQueryInputSerialized `json:"input"`
	Output               []string                    `json:"output"`
	RequiredOutput       []string                    `json:"required_output"`
	DatasetName          *string                     `json:"dataset_name"`
	Branch               *string                     `json:"branch"`
	MaxSamples           *int                        `json:"max_samples"`
	DestinationFormat    string                      `json:"destination_format"`
	JobId                *string                     `json:"job_id"`
	MaxCacheAge          *int                        `json:"max_cache_age_secs"`
	ObservedAtLowerBound *time.Time                  `json:"observed_at_lower_bound"`
	ObservedAtUpperBound *time.Time                  `json:"observed_at_upper_bound"`
	Tags                 []string                    `json:"tags"`
}

type OnlineQueryContext

type OnlineQueryContext struct {
	Environment *string  `json:"environment"`
	Tags        []string `json:"tags"`
}

type OnlineQueryRequestSerialized

type OnlineQueryRequestSerialized struct {
	Inputs           map[string]any     `json:"inputs,string"`
	Outputs          []string           `json:"outputs"`
	Context          OnlineQueryContext `json:"context"`
	Staleness        map[string]string  `json:"staleness"`
	IncludeMeta      bool               `json:"include_meta"`
	IncludeMetrics   bool               `json:"include_metrics"`
	DeploymentId     *string            `json:"deployment_id"`
	QueryName        *string            `json:"query_name"`
	CorrelationId    *string            `json:"correlation_id"`
	Meta             map[string]string  `json:"meta"`
	QueryNameVersion *string            `json:"query_name_version"`
}