script

package

v0.13.0 Latest Latest Go to latest Published: Apr 19, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/raystack/meteor

Links

Open Source Insights

README ¶

Script

Transform each record by running a user-defined Tengo script.

Usage

processors:
  - name: script
    config:
      engine: tengo
      script: |
        entity.properties.custom_flag = "reviewed"

Configuration

Key	Type	Required	Description
`engine`	`string`	Yes	Script engine. Only `tengo` is supported.
`script`	`string`	Yes	Tengo script to execute for each record.

Behavior

The entity is exposed in the script as a variable called entity. It has the following fields:

Field	Type	Description
`urn`	`string`	Unique resource name
`name`	`string`	Human-readable name
`source`	`string`	Source system (e.g. `bigquery`, `postgres`)
`type`	`string`	Entity type (`table`, `dashboard`, `job`, etc.)
`description`	`string`	Description
`properties`	`map`	Flat key-value map holding all type-specific data
`create_time`	`string`	Creation timestamp (RFC 3339)
`update_time`	`string`	Last update timestamp (RFC 3339)

All type-specific data (schema, columns, labels, config, etc.) lives under entity.properties. Mutations to entity fields inside the script are reflected in the output record.

Edges attached to the record are passed through unchanged.

Notes

The os stdlib module cannot be imported. All other Tengo standard library modules are available.
The script is compiled once during Init and cloned per record for safe concurrent execution.

Example

Add a label and modify a timestamp:

times := import("times")

entity.properties.labels = merge({script_engine: "tengo"}, entity.properties.labels)

update_time := times.parse("2006-01-02T15:04:05Z07:00", entity.properties.update_time)
entity.properties.update_time = times.add_date(update_time, 0, 0, 1)

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Documentation ¶

Index ¶

type Config
type Processor
- func New(logger log.Logger) *Processor
- func (p *Processor) Init(ctx context.Context, config plugins.Config) error
- func (p *Processor) Process(ctx context.Context, src models.Record) (models.Record, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Engine string `mapstructure:"engine" validate:"required,oneof=tengo"`
	Script string `mapstructure:"script" validate:"required"`
}

type Processor ¶

type Processor struct {
	plugins.BasePlugin
	// contains filtered or unexported fields
}

Processor executes the configured Tengo script to transform the given entity record.

func New ¶

func New(logger log.Logger) *Processor

New create a new processor

func (*Processor) Init ¶

func (p *Processor) Init(ctx context.Context, config plugins.Config) error

func (*Processor) Process ¶

func (p *Processor) Process(ctx context.Context, src models.Record) (models.Record, error)

Process processes the data

Source Files ¶

View all Source files

tengo_script.go

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