experimental

Documentation

Index

• Constants
• type LabelAndOffset
• type TablePointsMetadata
  • func GetTablePointsMetadata(tbl flux.Table) (*TablePointsMetadata, error)
• type ToOpSpec
  • func (o *ToOpSpec) BucketsAccessed(orgID *platform.ID) (readBuckets, writeBuckets []platform.BucketFilter)
  • func (ToOpSpec) Kind() flux.OperationKind
  • func (o *ToOpSpec) ReadArgs(args flux.Arguments) error
• type ToProcedureSpec
  • func (o *ToProcedureSpec) Copy() plan.ProcedureSpec
  • func (o *ToProcedureSpec) Kind() plan.ProcedureKind
• type ToTransformation
  • func NewToTransformation(ctx context.Context, d execute.Dataset, cache execute.TableBuilderCache, ...) (*ToTransformation, error)
  • func (t *ToTransformation) Finish(id execute.DatasetID, err error)
  • func (t *ToTransformation) Process(id execute.DatasetID, tbl flux.Table) error
  • func (t *ToTransformation) RetractTable(id execute.DatasetID, key flux.GroupKey) error
  • func (t *ToTransformation) UpdateProcessingTime(id execute.DatasetID, pt execute.Time) error
  • func (t *ToTransformation) UpdateWatermark(id execute.DatasetID, pt execute.Time) error

Constants

const ExperimentalToKind = experimental.ExperimentalToKind

ToKind is the kind for the `to` flux function

Types

type LabelAndOffset

type LabelAndOffset struct {
	Label  string
	Offset int
}

type TablePointsMetadata

type TablePointsMetadata struct {
	// The tags in the table (final element is left as nil, to be replaced by field name)
	Tags [][]byte
	// The offset in tags where to store the field name
	FieldKeyTagValueOffset int
	// The column offset in the input table where the _time column is stored
	TimestampOffset int
	// The labels and offsets of all the fields in the table
	Fields []LabelAndOffset
}

TablePointsMetadata stores state needed to write the points from one table.

func GetTablePointsMetadata

func GetTablePointsMetadata(tbl flux.Table) (*TablePointsMetadata, error)

type ToOpSpec

type ToOpSpec struct {
	Bucket   string `json:"bucket"`
	BucketID string `json:"bucketID"`
	Org      string `json:"org"`
	OrgID    string `json:"orgID"`
	Host     string `json:"host"`
	Token    string `json:"token"`
}

ToOpSpec is the flux.OperationSpec for the `to` flux function.

func (*ToOpSpec) BucketsAccessed

func (o *ToOpSpec) BucketsAccessed(orgID *platform.ID) (readBuckets, writeBuckets []platform.BucketFilter)

BucketsAccessed returns the buckets accessed by the spec.

func (ToOpSpec) Kind

func (ToOpSpec) Kind() flux.OperationKind

Kind returns the kind for the ToOpSpec function.

func (*ToOpSpec) ReadArgs

func (o *ToOpSpec) ReadArgs(args flux.Arguments) error

ReadArgs reads the args from flux.Arguments into the op spec

type ToProcedureSpec

type ToProcedureSpec struct {
	plan.DefaultCost
	Spec *ToOpSpec
}

ToProcedureSpec is the procedure spec for the `to` flux function.

func (*ToProcedureSpec) Copy

func (o *ToProcedureSpec) Copy() plan.ProcedureSpec

Copy clones the procedure spec for `to` flux function.

func (*ToProcedureSpec) Kind

func (o *ToProcedureSpec) Kind() plan.ProcedureKind

Kind returns the kind for the procedure spec for the `to` flux function.

type ToTransformation

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

ToTransformation is the transformation for the `to` flux function.

func NewToTransformation

func NewToTransformation(ctx context.Context, d execute.Dataset, cache execute.TableBuilderCache, spec *ToProcedureSpec, deps influxdb.ToDependencies) (*ToTransformation, error)

NewToTransformation returns a new *ToTransformation with the appropriate fields set.

func (*ToTransformation) Finish

func (t *ToTransformation) Finish(id execute.DatasetID, err error)

Finish is called after the `to` flux function's transformation is done processing.

func (*ToTransformation) Process

func (t *ToTransformation) Process(id execute.DatasetID, tbl flux.Table) error

Process does the actual work for the ToTransformation.

func (*ToTransformation) RetractTable

func (t *ToTransformation) RetractTable(id execute.DatasetID, key flux.GroupKey) error

RetractTable retracts the table for the transformation for the `to` flux function.

func (*ToTransformation) UpdateProcessingTime

func (t *ToTransformation) UpdateProcessingTime(id execute.DatasetID, pt execute.Time) error

UpdateProcessingTime updates the processing time for the transformation for the `to` flux function.

func (*ToTransformation) UpdateWatermark

func (t *ToTransformation) UpdateWatermark(id execute.DatasetID, pt execute.Time) error

UpdateWatermark updates the watermark for the transformation for the `to` flux function.