sdk

package
v0.5.22 Latest Latest
Warning

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

Go to latest
Published: Jul 17, 2023 License: MIT Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Created          = 1
	Initialized      = 2
	ReceivingRecords = 3
	Closed           = 4
)

Variables

This section is empty.

Functions

func RegisterTool

func RegisterTool(plugin Plugin, toolId int, xmlProperties unsafe.Pointer, engineInterface unsafe.Pointer, pluginInterface unsafe.Pointer, optionSetters ...ToolOptionSetter) int

Types

type AddFieldOptionSetter

type AddFieldOptionSetter func(AddFieldOptions) AddFieldOptions

func InsertAt

func InsertAt(position int) AddFieldOptionSetter

type AddFieldOptions

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

type BoolGetter

type BoolGetter func(Record) (bool, bool)

type BytesGetter

type BytesGetter func(Record) []byte

type EditingRecordInfo

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

func (*EditingRecordInfo) AddBlobField

func (i *EditingRecordInfo) AddBlobField(name string, source string, size int, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddBoolField

func (i *EditingRecordInfo) AddBoolField(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddByteField

func (i *EditingRecordInfo) AddByteField(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddDateField

func (i *EditingRecordInfo) AddDateField(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddDateTimeField

func (i *EditingRecordInfo) AddDateTimeField(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddDoubleField

func (i *EditingRecordInfo) AddDoubleField(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddFixedDecimalField

func (i *EditingRecordInfo) AddFixedDecimalField(name string, source string, size int, scale int, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddFloatField

func (i *EditingRecordInfo) AddFloatField(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddInt16Field

func (i *EditingRecordInfo) AddInt16Field(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddInt32Field

func (i *EditingRecordInfo) AddInt32Field(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddInt64Field

func (i *EditingRecordInfo) AddInt64Field(name string, source string, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddSpatialObjField

func (i *EditingRecordInfo) AddSpatialObjField(name string, source string, size int, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddStringField

func (i *EditingRecordInfo) AddStringField(name string, source string, size int, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddV_StringField

func (i *EditingRecordInfo) AddV_StringField(name string, source string, size int, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddV_WStringField

func (i *EditingRecordInfo) AddV_WStringField(name string, source string, size int, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) AddWStringField

func (i *EditingRecordInfo) AddWStringField(name string, source string, size int, options ...AddFieldOptionSetter) string

func (*EditingRecordInfo) Fields

func (i *EditingRecordInfo) Fields() []IncomingField

func (*EditingRecordInfo) GenerateOutgoingRecordInfo

func (i *EditingRecordInfo) GenerateOutgoingRecordInfo() *OutgoingRecordInfo

func (*EditingRecordInfo) MoveField

func (i *EditingRecordInfo) MoveField(name string, newIndex int) error

func (*EditingRecordInfo) NumFields

func (i *EditingRecordInfo) NumFields() int

func (*EditingRecordInfo) RemoveFields

func (i *EditingRecordInfo) RemoveFields(fieldNames ...string)

type Environment

type Environment interface {
	UpdateOnly() bool
	UpdateMode() string
	DesignerVersion() string
	WorkflowDir() string
	AlteryxInstallDir() string
	AlteryxLocale() string
	ToolId() int
	UpdateToolConfig(string)
}

type FilePusher

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

func (*FilePusher) Init

func (f *FilePusher) Init(provider Provider)

func (*FilePusher) OnComplete

func (f *FilePusher) OnComplete()

func (*FilePusher) OnInputConnectionOpened

func (f *FilePusher) OnInputConnectionOpened(_ InputConnection)

func (*FilePusher) OnRecordPacket

func (f *FilePusher) OnRecordPacket(_ InputConnection)

type FileTestRunner

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

func RegisterToolTest

func RegisterToolTest(plugin Plugin, toolId int, xmlProperties string, optionSetters ...OptionSetter) *FileTestRunner

func (*FileTestRunner) CaptureOutgoingAnchor

func (r *FileTestRunner) CaptureOutgoingAnchor(name string) *RecordCollector

func (*FileTestRunner) ConnectInput

func (r *FileTestRunner) ConnectInput(name string, dataFile string)

func (*FileTestRunner) SimulateLifecycle

func (r *FileTestRunner) SimulateLifecycle()

type FloatGetter

type FloatGetter func(Record) (float64, bool)

type ImpInputConnection

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

func (*ImpInputConnection) Metadata

func (i *ImpInputConnection) Metadata() IncomingRecordInfo

func (*ImpInputConnection) Name

func (i *ImpInputConnection) Name() string

func (*ImpInputConnection) Progress

func (i *ImpInputConnection) Progress() float64

func (*ImpInputConnection) Read

func (i *ImpInputConnection) Read() RecordPacket

func (*ImpInputConnection) Status

func (i *ImpInputConnection) Status() Status

type ImpInputConnectionNoCache added in v0.5.18

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

func (*ImpInputConnectionNoCache) Metadata added in v0.5.18

func (*ImpInputConnectionNoCache) Name added in v0.5.18

func (*ImpInputConnectionNoCache) Progress added in v0.5.18

func (i *ImpInputConnectionNoCache) Progress() float64

func (*ImpInputConnectionNoCache) Read added in v0.5.18

func (*ImpInputConnectionNoCache) Status added in v0.5.18

func (i *ImpInputConnectionNoCache) Status() Status

type IncomingBlobField

type IncomingBlobField struct {
	Name     string
	Type     string
	Source   string
	Size     int
	GetValue BytesGetter
}

type IncomingBoolField

type IncomingBoolField struct {
	Name     string
	Type     string
	Source   string
	GetValue BoolGetter
}

type IncomingField

type IncomingField struct {
	Name     string `xml:"name,attr"`
	Type     string `xml:"type,attr"`
	Source   string `xml:"source,attr"`
	Size     int    `xml:"size,attr"`
	Scale    int    `xml:"scale,attr"`
	GetBytes BytesGetter
}

type IncomingFloatField

type IncomingFloatField struct {
	Name     string
	Type     string
	Source   string
	GetValue FloatGetter
}

type IncomingIntField

type IncomingIntField struct {
	Name     string
	Type     string
	Source   string
	GetValue IntGetter
}

type IncomingRecordInfo

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

func (IncomingRecordInfo) Clone

func (IncomingRecordInfo) Fields

func (i IncomingRecordInfo) Fields() []b.FieldBase

func (IncomingRecordInfo) GetBlobField

func (i IncomingRecordInfo) GetBlobField(name string) (IncomingBlobField, error)

func (IncomingRecordInfo) GetBoolField

func (i IncomingRecordInfo) GetBoolField(name string) (IncomingBoolField, error)

func (IncomingRecordInfo) GetFloatField

func (i IncomingRecordInfo) GetFloatField(name string) (IncomingFloatField, error)

func (IncomingRecordInfo) GetIntField

func (i IncomingRecordInfo) GetIntField(name string) (IncomingIntField, error)

func (IncomingRecordInfo) GetStringField

func (i IncomingRecordInfo) GetStringField(name string) (IncomingStringField, error)

func (IncomingRecordInfo) GetTimeField

func (i IncomingRecordInfo) GetTimeField(name string) (IncomingTimeField, error)

func (IncomingRecordInfo) NumFields

func (i IncomingRecordInfo) NumFields() int

type IncomingStringField

type IncomingStringField struct {
	Name     string
	Type     string
	Source   string
	Size     int
	GetValue StringGetter
}

type IncomingTimeField

type IncomingTimeField struct {
	Name     string
	Type     string
	Source   string
	GetValue TimeGetter
}

type InputConnection

type InputConnection interface {
	Name() string
	Metadata() IncomingRecordInfo
	Read() RecordPacket
	Progress() float64
	Status() Status
}

type IntGetter

type IntGetter func(Record) (int, bool)

type Io

type Io interface {
	Error(string)
	Warn(string)
	Info(string)
	UpdateProgress(float64) bool
	DecryptPassword(string) string
	CreateTempFile(string) string
	NotifyFileInput(string)
	NotifyFileOutput(string)
}

type MessageStatus

type MessageStatus int
const (
	Info                          MessageStatus = 1
	TransientInfo                 MessageStatus = 0x40000000 | 1
	Warning                       MessageStatus = 2
	TransientWarning              MessageStatus = 0x40000000 | 2
	Error                         MessageStatus = 3
	Complete                      MessageStatus = 4
	FieldConversionError          MessageStatus = 5
	TransientFieldConversionError MessageStatus = 0x40000000 | 5
	FileInput                     MessageStatus = 8
	FileOutput                    MessageStatus = 9
	UpdateOutputMetaInfoXml       MessageStatus = 10
	RecordCountString             MessageStatus = 50
	BrowseEverywhereFileName      MessageStatus = 70
)

type NewOutgoingField

type NewOutgoingField func() *outgoingField

func NewBlobField

func NewBlobField(name string, source string, size int) NewOutgoingField

func NewBoolField

func NewBoolField(name string, source string) NewOutgoingField

func NewByteField

func NewByteField(name string, source string) NewOutgoingField

func NewDateField

func NewDateField(name string, source string) NewOutgoingField

func NewDateTimeField

func NewDateTimeField(name string, source string) NewOutgoingField

func NewDoubleField

func NewDoubleField(name string, source string) NewOutgoingField

func NewFixedDecimalField

func NewFixedDecimalField(name string, source string, size int, scale int) NewOutgoingField

func NewFloatField

func NewFloatField(name string, source string) NewOutgoingField

func NewInt16Field

func NewInt16Field(name string, source string) NewOutgoingField

func NewInt32Field

func NewInt32Field(name string, source string) NewOutgoingField

func NewInt64Field

func NewInt64Field(name string, source string) NewOutgoingField

func NewSpatialObjField

func NewSpatialObjField(name string, source string, size int) NewOutgoingField

func NewStringField

func NewStringField(name string, source string, size int) NewOutgoingField

func NewV_StringField

func NewV_StringField(name string, source string, size int) NewOutgoingField

func NewV_WStringField

func NewV_WStringField(name string, source string, size int) NewOutgoingField

func NewWStringField

func NewWStringField(name string, source string, size int) NewOutgoingField

type NullableField

type NullableField interface {
	GetNull() bool
	SetNull()
}

type OptionSetter

type OptionSetter func(testOptions) testOptions

func AlteryxLocale

func AlteryxLocale(value string) OptionSetter

func NoCache added in v0.5.18

func NoCache(value bool) OptionSetter

func UpdateMode

func UpdateMode(value string) OptionSetter

func UpdateOnly

func UpdateOnly(value bool) OptionSetter

func WorkflowDir

func WorkflowDir(value string) OptionSetter

type OutgoingBlobField

type OutgoingBlobField interface {
	NullableField
	SetBlob([]byte)
	GetCurrentBlob() ([]byte, bool)
}

type OutgoingBoolField

type OutgoingBoolField interface {
	NullableField
	SetBool(bool)
	GetCurrentBool() (bool, bool)
}

type OutgoingDateTimeField

type OutgoingDateTimeField interface {
	NullableField
	SetDateTime(time.Time)
	GetCurrentDateTime() (time.Time, bool)
}

type OutgoingFloatField

type OutgoingFloatField interface {
	NullableField
	SetFloat(float64)
	GetCurrentFloat() (float64, bool)
}

type OutgoingIntField

type OutgoingIntField interface {
	NullableField
	SetInt(int)
	GetCurrentInt() (int, bool)
}

type OutgoingRecordInfo

type OutgoingRecordInfo struct {
	BlobFields     map[string]OutgoingBlobField
	BoolFields     map[string]OutgoingBoolField
	DateTimeFields map[string]OutgoingDateTimeField
	FloatFields    map[string]OutgoingFloatField
	IntFields      map[string]OutgoingIntField
	StringFields   map[string]OutgoingStringField
	// contains filtered or unexported fields
}

func NewOutgoingRecordInfo

func NewOutgoingRecordInfo(fields []NewOutgoingField) (*OutgoingRecordInfo, []string)

func (*OutgoingRecordInfo) CopyFrom

func (i *OutgoingRecordInfo) CopyFrom(record Record)

func (*OutgoingRecordInfo) DataSize

func (i *OutgoingRecordInfo) DataSize() uint32

func (*OutgoingRecordInfo) FixedSize

func (i *OutgoingRecordInfo) FixedSize() int

func (*OutgoingRecordInfo) HasVarFields

func (i *OutgoingRecordInfo) HasVarFields() bool

type OutgoingStringField

type OutgoingStringField interface {
	NullableField
	SetString(string)
	GetCurrentString() (string, bool)
}

type OutputAnchor

type OutputAnchor interface {
	Name() string
	IsOpen() bool
	Metadata() *OutgoingRecordInfo
	Open(info *OutgoingRecordInfo)
	Write()
	UpdateProgress(float64)
	Close()
	NumConnections() int
}

type Plugin

type Plugin interface {
	Init(Provider)
	OnInputConnectionOpened(InputConnection)
	OnRecordPacket(InputConnection)
	OnComplete()
}

type Provider

type Provider interface {
	ToolConfig() string
	Io() Io
	GetOutputAnchor(string) OutputAnchor
	Environment() Environment
}

type Record

type Record = unsafe.Pointer

type RecordCache

type RecordCache unsafe.Pointer

type RecordCollector

type RecordCollector struct {
	Config          IncomingRecordInfo
	Name            string
	Data            map[string][]interface{}
	Progress        float64
	PacketsReceived int
	// contains filtered or unexported fields
}

func (*RecordCollector) Init

func (r *RecordCollector) Init(_ Provider)

func (*RecordCollector) OnComplete

func (r *RecordCollector) OnComplete()

func (*RecordCollector) OnInputConnectionOpened

func (r *RecordCollector) OnInputConnectionOpened(connection InputConnection)

func (*RecordCollector) OnRecordPacket

func (r *RecordCollector) OnRecordPacket(connection InputConnection)

type RecordPacket

type RecordPacket interface {
	Next() bool
	Record() Record
}

func NewRecordPacket

func NewRecordPacket(cache RecordCache, size int, fixedLen int, hasVarData bool) RecordPacket

func NewSingleRecord added in v0.5.18

func NewSingleRecord(record Record) RecordPacket

type Status

type Status byte

type StringGetter

type StringGetter func(Record) (string, bool)

type TimeGetter

type TimeGetter func(Record) (time.Time, bool)

type ToolOptionSetter added in v0.5.18

type ToolOptionSetter func(toolOptions) toolOptions

func ToolNoCache added in v0.5.18

func ToolNoCache() ToolOptionSetter

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL