script

package

Go to main page

Versions in this module

v1

v1.129.0

Sep 2, 2026

Changes in this version

+ func DeleteMessage(name string, rm Removed) string

+ func SavedMessage(sc *Script) string

+ func StateResetMessage(cleared bool) string

+ type OutputDisposition string

+ const OutputsKeep

+ const OutputsMove

+ func ParseOutputDisposition(s string) (OutputDisposition, error)

+ type Removed struct

+ Runs bool

+ Schedule bool

+ State bool

+ type TransferRequest struct

+ ID string

+ NewOwnerEmail string

+ Outputs OutputDisposition

+ type Transferred struct

+ AssetsMoved int

+ CollectionsMoved int

v1.128.0

Sep 1, 2026

Changes in this version

+ var ErrNotFound = errors.New("script not found")

v1.127.0

Aug 31, 2026

v1.126.7

Aug 29, 2026

v1.126.6

Aug 29, 2026

v1.126.5

Aug 29, 2026

Changes in this version

+ const MaxStateBytes

+ var ErrStateConflict = errors.New("the script's state changed after this run read it")

+ func ValidateState(value map[string]any) error

type Contract

+ State *ContractState

+ type ContractState struct

+ Reads bool

+ Revision int64

+ Saves bool

+ UpdatedAt *time.Time

+ func ContractStateOf(use StateUse, st *State) *ContractState

type DryRun

+ StateWritten map[string]any

type Run

+ StateRead map[string]any

+ StateRevision int64

+ StateRevisionWritten int64

+ StateWritten map[string]any

type RunOutput

+ Tables []string

type RunResult

+ State *StateWrite

+ type State struct

+ Revision int64

+ RunID string

+ ScriptID string

+ UpdatedAt time.Time

+ UpdatedBy string

+ Value map[string]any

+ func EmptyState(scriptID string) *State

+ func (s *State) WrittenBy() string

+ type StateConflictError struct

+ Current int64

+ Read int64

+ WrittenBy string

+ func (*StateConflictError) Unwrap() error

+ func (e *StateConflictError) Error() string

+ type StateStore interface

+ GetState func(ctx context.Context, scriptID string) (*State, error)

+ SetState func(ctx context.Context, scriptID string, value map[string]any, by string) (*State, error)

+ type StateUse struct

+ Reads bool

+ Saves bool

+ type StateWrite struct

+ Value map[string]any

v1.126.4

Aug 27, 2026

v1.126.3

Aug 27, 2026

v1.126.2

Aug 26, 2026

v1.126.1

Aug 26, 2026

v1.126.0

Aug 26, 2026

v1.125.5

Aug 24, 2026

v1.125.4

Aug 24, 2026

v1.125.3

Aug 24, 2026

v1.125.2

Aug 23, 2026

v1.125.1

Aug 23, 2026

v1.125.0

Aug 22, 2026

v1.124.1

Aug 22, 2026

v1.124.0

Aug 21, 2026

v1.123.1

Aug 21, 2026

Changes in this version

+ func DraftSource(sent string, sc *Script) string

v1.123.0

Aug 21, 2026

Changes in this version

+ const ConnectionParamKind

+ const DataRegionSelector

+ var ErrNameTaken = errors.New("the new owner already has a script with this name")

+ func ValidateDeclaredDestinations(destinations []Destination) error

type Contract

+ Refusal string

+ Version int

+ func (c Contract) OwnedBy(email string) bool

type ContractOutput

+ Refresh bool

type DryRunOutput

+ Document bool

+ Refresh bool

type RunFilter

+ ScriptIDs []string

type RunOutput

+ Document bool

+ Refresh bool

type Script

+ func (s *Script) OwnedBy(email string) bool

+ func (s *Script) Transfer(newOwnerEmail string) error

type Store

+ GetByName func(ctx context.Context, ownerEmail, name string) (*Script, error)

+ Transfer func(ctx context.Context, id, newOwnerEmail string, author Author) error

v1.122.1

Aug 19, 2026

v1.122.0

Aug 19, 2026

Changes in this version

+ const MaxDescriptionBytes

+ const MaxDisplayNameLen

+ const ParamTypeConnection

+ const TriggerPortal

+ func AutoApprovable(sc *Script, author Author) bool

+ func CheckConnectionParams(defs []Param, bound map[string]any, g Grants) error

+ func DescriptionNotice(desc string) string

+ func ExecutionNote(s *Script) string

+ func IndexText(s *Script) string

+ func RefuseDraftRun(sc *Script) error

+ func RefuseUnreachable(g Grants, reachable []string) string

+ func SourceDigest(source string) []byte

+ func Title(s *Script) string

+ func WithdrawsAutoApproval(before, after *Script) bool

+ type AutoApprovalStore interface

+ AutoApproveVersion func(ctx context.Context, scriptID string, version int, owner string, grants Grants) (*Version, error)

+ type AutoApprover interface

+ Approve func(ctx context.Context, sc *Script, version int, decision AutoDecision) AutoOutcome

+ Consider func(ctx context.Context, sc *Script, author Author) AutoDecision

+ type AutoDecision struct

+ Approvable bool

+ Approved *Version

+ Grants Grants

+ Reason string

+ type AutoOutcome struct

+ Approved bool

+ Reason string

type Contract

+ Category string

type ContractApproval

+ Automatic bool

+ type DryRun struct

+ CreatedAt time.Time

+ Error string

+ ID string

+ Log string

+ LogTruncated bool

+ Metrics RunMetrics

+ Outputs []DryRunOutput

+ RequestedBy string

+ ScriptID string

+ SourceSHA256 []byte

+ Status string

+ func (d *DryRun) Succeeded() bool

+ type DryRunOutput struct

+ Bytes int

+ Destination string

+ Format string

+ Name string

+ RowCount int

+ type DryRunStore interface

+ LatestDryRun func(ctx context.Context, scriptID string, sourceSHA256 []byte) (*DryRun, error)

+ RecordDryRun func(ctx context.Context, d *DryRun) error

+ type Edit struct

+ After *Script

+ Author Author

+ Auto AutoApprover

+ Before *Script

type EditOutcome

+ Auto AutoOutcome

type Grants

+ func DeriveGrants(ref Referenced, roles []string, pinned []Destination) (Grants, error)

type ListFilter

+ Category string

+ Tags []string

+ type Referenced struct

+ Capabilities []string

+ Connections []string

+ Destinations []string

+ Incomplete bool

type Schedule

+ func (s Schedule) DueAt() time.Time

+ func (s Schedule) MarshalJSON() ([]byte, error)

type Script

+ Category string

+ func (s *Script) OwnedPersonally(email string) bool

type SearchQuery

+ Embedding []float32

type Version

+ AutoApproved bool

+ Category string

v1.121.1

Aug 18, 2026

v1.121.0

Aug 18, 2026

Changes in this version

+ const CapabilityExport

+ const CapabilityQuery

+ const DateLayout

+ const DefaultSearchLimit

+ const DefaultTimezone

+ const DestinationKindPortal

+ const DestinationKindS3

+ const DestinationPortal

+ const FireDateToken

+ const MaxCronSpecLength

+ const MaxSourceBytes

+ const MinFireInterval

+ const OutputKindAsset

+ const OutputKindObject

+ const ParamTypeBool

+ const ParamTypeDate

+ const ParamTypeEnum

+ const ParamTypeFloat

+ const ParamTypeInt

+ const ParamTypeString

+ const PrincipalPrefix

+ const RunStatusFailed

+ const RunStatusPending

+ const RunStatusRunning

+ const RunStatusSkippedOverlap

+ const RunStatusSucceeded

+ const ScopeGlobal

+ const ScopePersona

+ const ScopePersonal

+ const StatusActive

+ const StatusDeprecated

+ const StatusDraft

+ const StatusSuperseded

+ const TriggerSchedule

+ const TriggerTool

+ const VersionStatusApplied

+ const VersionStatusDraft

+ const VersionStatusRejected

+ const VersionStatusSuperseded

+ var Capabilities = []string

+ var DestinationKinds = []string

+ var ErrInvalidGrant = errors.New("invalid grant")

+ var ErrLeaseLost = errors.New("the lease on this script run was lost")

+ var ErrNoGrants = errors.New("this script version carries no approved capability grant")

+ var ErrNoWork = errors.New("no script run is due")

+ var ErrReviewRequiredMixedEdit = errors.New(...)

+ var ErrRunNotFound = errors.New("script run not found")

+ var ErrScheduleNotFound = errors.New("this script has no schedule")

+ var ErrUnknownParam = errors.New("unknown parameter")

+ var ErrUnknownTimezone = errors.New("unknown timezone")

+ var ErrUnknownToken = errors.New("unknown schedule token")

+ var ErrVersionConflict = errors.New("script version conflict")

+ func BindParams(defs []Param, values map[string]any) (map[string]any, error)

+ func BindScheduleParams(defs []Param, raw map[string]any, fire time.Time, loc *time.Location) (map[string]any, error)

+ func ParamSummary(params []Param) string

+ func ParamsEqual(a, b []Param) bool

+ func RefuseNewRun(sc *Script, approved *Version) error

+ func RefuseRun(sc *Script, v *Version, run *Run) error

+ func RequiresReview(before, after *Script) bool

+ func SnapshotChanged(before, after *Script) bool

+ func ValidateName(name string) error

+ func ValidateObjectKey(key string) error

+ func ValidateParams(params []Param) error

+ func ValidateScope(scope string) error

+ func ValidateSource(src string) error

+ func ValidateStatus(status string) error

+ func ValidateStatusTransition(from, to string) error

+ func ValidateTags(tags []string) error

+ type ApprovalStore interface

+ ApproveVersion func(ctx context.Context, scriptID string, version int, approver string, ...) (*Version, error)

+ type Author struct

+ Email string

+ Roles []string

+ type Contract struct

+ Approval ContractApproval

+ Description string

+ DisplayName string

+ Enabled bool

+ ID string

+ LastRun *ContractRun

+ Name string

+ OwnerEmail string

+ Params []Param

+ Personas []string

+ Schedule *ContractSchedule

+ Scope string

+ Status string

+ Tags []string

+ func BuildContract(sc *Script, approved *Version, sched *Schedule, lastRun *Run) Contract

+ func (c Contract) Text() string

+ func (c Contract) Title() string

+ func (c Contract) VisibleToAny(email string, personas []string) bool

+ type ContractApproval struct

+ Approved bool

+ ApprovedAt *time.Time

+ ApprovedBy string

+ Refusal string

+ Version int

+ type ContractOutput struct

+ AssetID string

+ AssetVersion int

+ Bucket string

+ Bytes int

+ Destination string

+ Format string

+ Key string

+ Kind string

+ Name string

+ RowCount int

+ type ContractRun struct

+ FinishedAt *time.Time

+ Outputs []ContractOutput

+ RunID string

+ Version int

+ type ContractSchedule struct

+ CronSpec string

+ Enabled bool

+ NextRunAt *time.Time

+ Timezone string

+ type Cron struct

+ func ParseCron(spec, timezone string) (Cron, error)

+ func (c Cron) Location() *time.Location

+ func (c Cron) Next(t time.Time) time.Time

+ type Destination struct

+ Bucket string

+ Connection string

+ Kind string

+ Name string

+ Prefix string

+ func PortalDestination() Destination

+ func (d *Destination) UnmarshalJSON(data []byte) error

+ func (d Destination) IsPortal() bool

+ func (d Destination) Label() string

+ func (d Destination) Normalized() Destination

+ func (d Destination) Validate() error

+ type EditOutcome struct

+ Applied bool

+ PendingVersion int

+ func ApplyEdit(ctx context.Context, store Store, before, after *Script, author Author) (EditOutcome, error)

+ type Grants struct

+ Capabilities []string

+ Connections []string

+ Destinations []Destination

+ Roles []string

+ func (g Grants) AllowsCapability(name string) bool

+ func (g Grants) AllowsConnection(name string) bool

+ func (g Grants) AllowsDestination(name string) bool

+ func (g Grants) Destination(name string) (Destination, bool)

+ func (g Grants) DestinationNames() []string

+ func (g Grants) IsZero() bool

+ func (g Grants) MissingFor(capabilities, connections, destinations []string) Missing

+ func (g Grants) Validate() error

+ type ListFilter struct

+ Enabled *bool

+ Limit int

+ OwnerEmail string

+ Personas []string

+ Scope string

+ Search string

+ Status string

+ VisiblePersona string

+ VisibleTo string

+ type Materialization string

+ const MaterializedDuplicate

+ const MaterializedRun

+ const MaterializedSkippedOverlap

+ type Missing struct

+ Capabilities []string

+ Connections []string

+ Destinations []string

+ func (m Missing) Any() bool

+ type Param struct

+ Default any

+ Description string

+ Name string

+ Required bool

+ Type string

+ Values []string

+ type PendingReview struct

+ Author string

+ AuthorRoles []string

+ CreatedAt time.Time

+ Description string

+ DisplayName string

+ FirstApproval bool

+ OwnerEmail string

+ Scope string

+ ScriptID string

+ ScriptName string

+ Version int

+ VersionID string

+ VersionStatus string

+ func (p PendingReview) AgeDays(now time.Time) int

+ type RejectionStore interface

+ RejectVersion func(ctx context.Context, scriptID string, version int) error

+ type ReviewStore interface

+ ListPendingReviews func(ctx context.Context) ([]PendingReview, error)

+ type Run struct

+ Attempt int

+ CreatedAt time.Time

+ Error string

+ FinishedAt *time.Time

+ FireTime time.Time

+ ID string

+ LockedBy string

+ LockedUntil *time.Time

+ Log string

+ LogTruncated bool

+ Metrics RunMetrics

+ Outputs []RunOutput

+ Params map[string]any

+ RequestedBy string

+ ScheduleID string

+ ScheduledFor time.Time

+ ScriptID string

+ StartedAt *time.Time

+ Status string

+ Trigger string

+ UpdatedAt time.Time

+ Version int

+ VersionID string

+ func (r *Run) Lease() RunLease

+ func (r *Run) Output(name, destination string) *RunOutput

+ func (r *Run) Terminal() bool

+ type RunFilter struct

+ Limit int

+ ScriptID string

+ Status string

+ type RunLease struct

+ Attempt int

+ RunID string

+ Worker string

+ type RunMetrics struct

+ DurationMS int64

+ Exports int

+ Queries int

+ Steps uint64

+ type RunOutput struct

+ AssetID string

+ AssetVersion int

+ Bucket string

+ Bytes int

+ Destination string

+ Format string

+ Key string

+ Name string

+ RowCount int

+ type RunResult struct

+ Error string

+ Log string

+ LogTruncated bool

+ Metrics RunMetrics

+ Status string

+ type RunStore interface

+ Claim func(ctx context.Context, worker string, lease time.Duration) (*Run, error)

+ Enqueue func(ctx context.Context, r *Run) error

+ Finish func(ctx context.Context, lease RunLease, res RunResult) error

+ GetRun func(ctx context.Context, id string) (*Run, error)

+ ListRuns func(ctx context.Context, filter RunFilter) ([]Run, error)

+ PurgeRuns func(ctx context.Context, retention time.Duration) (int64, error)

+ RecordOutput func(ctx context.Context, lease RunLease, out RunOutput) error

+ Retry func(ctx context.Context, lease RunLease, cause string, backoff time.Duration) error

+ type Schedule struct

+ CreatedAt time.Time

+ CreatedBy string

+ CronSpec string

+ Enabled bool

+ ID string

+ LastFireAt *time.Time

+ MissedFires int

+ NextRunAt time.Time

+ Params map[string]any

+ ScriptID string

+ Timezone string

+ UpdatedAt time.Time

+ UpdatedBy string

+ func BuildSchedule(sc *Script, approved *Version, prev *Schedule, req ScheduleRequest, ...) (*Schedule, error)

+ func (s *Schedule) NextFire(c Cron, now time.Time) ScheduleFire

+ func (s *Schedule) Validate(params []Param) error

+ type ScheduleAdvance struct

+ Fired time.Time

+ From time.Time

+ ID string

+ Missed int

+ Next time.Time

+ type ScheduleFilter struct

+ Enabled *bool

+ Limit int

+ ScriptID string

+ ScriptIDs []string

+ type ScheduleFire struct

+ At time.Time

+ Due bool

+ Missed int

+ Next time.Time

+ type ScheduleRequest struct

+ Actor string

+ CronSpec string

+ Enabled *bool

+ Params map[string]any

+ Timezone string

+ type ScheduleStore interface

+ AdvanceSchedule func(ctx context.Context, adv ScheduleAdvance) (bool, error)

+ DueSchedules func(ctx context.Context, now time.Time, limit int) ([]Schedule, error)

+ GetSchedule func(ctx context.Context, scriptID string) (*Schedule, error)

+ ListSchedules func(ctx context.Context, filter ScheduleFilter) ([]Schedule, error)

+ MaterializeRun func(ctx context.Context, r *Run) (Materialization, error)

+ SetSchedule func(ctx context.Context, s *Schedule) error

+ SetScheduleEnabled func(ctx context.Context, scriptID string, enabled bool, actor string) error

+ type ScoredScript struct

+ Score float64

+ Script Script

+ type Script struct

+ ApprovedVersionID string

+ CreatedAt time.Time

+ DeprecatedAt *time.Time

+ Description string

+ DisplayName string

+ Enabled bool

+ ID string

+ Name string

+ OwnerEmail string

+ Params []Param

+ Personas []string

+ Scope string

+ Source string

+ Status string

+ SupersededBy string

+ Tags []string

+ UpdatedAt time.Time

+ Version int

+ func (s *Script) ApplyStatusTransition(newStatus, supersededBy string, now time.Time) error

+ func (s *Script) Executable() bool

+ func (s *Script) Principal() string

+ func (s *Script) Validate() error

+ func (s *Script) VisibleTo(email, persona string) bool

+ func (s *Script) VisibleToAny(email string, personas []string) bool

+ type SearchQuery struct

+ Limit int

+ OwnerEmail string

+ Personas []string

+ QueryText string

+ func (q SearchQuery) EffectiveLimit() int

+ type Searcher interface

+ Contract func(ctx context.Context, id string) (*Contract, error)

+ Search func(ctx context.Context, q SearchQuery) ([]ScoredScript, error)

+ type Store interface

+ Create func(ctx context.Context, s *Script, author Author) error

+ Delete func(ctx context.Context, id string) error

+ Get func(ctx context.Context, name string) (*Script, error)

+ GetByID func(ctx context.Context, id string) (*Script, error)

+ GetPersonal func(ctx context.Context, ownerEmail, name string) (*Script, error)

+ List func(ctx context.Context, filter ListFilter) ([]Script, error)

+ Update func(ctx context.Context, s *Script) error

+ type Version struct

+ ApprovedAt *time.Time

+ ApprovedBy string

+ Author string

+ AuthorRoles []string

+ CreatedAt time.Time

+ Description string

+ DisplayName string

+ Grants Grants

+ ID string

+ Params []Param

+ ScriptID string

+ Source string

+ Status string

+ Tags []string

+ Version int

+ func (v *Version) Approved() bool

+ type VersionStore interface

+ CreateDraftVersion func(ctx context.Context, scriptID string, proposed *Script, author Author) (int, error)

+ GetVersion func(ctx context.Context, scriptID string, version int) (*Version, error)

+ GetVersionByID func(ctx context.Context, id string) (*Version, error)

+ ListVersions func(ctx context.Context, scriptID string) ([]Version, error)

+ UpdateWithVersion func(ctx context.Context, s *Script, author Author) error

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