specs

Oct 8, 2026

Changes in this version

+ type VersionWarningOption func(*versionWarningOptions)

+ func WithUpgradeCheckRecommendation(configPaths []string, output io.Writer) VersionWarningOption

Jun 25, 2026

Changes in this version

type SpecReader

+ func NewSpecReaderWithoutValidation(paths []string) (*SpecReader, error)

+ func (r *SpecReader) SetDestinationsAndValidate(destinations []*Destination) error

Dec 2, 2024

Changes in this version

+ var AllKinds = [...]string

+ var AllMigrateModes = [...]string

+ var AllPKModes = [...]string

+ var AllRegistries = [...]string

+ var AllWriteModes = [...]string

+ func ReplaceVariables(src string, variables Variables, shouldReplaceLocalhost bool) (string, error)

+ func SpecUnmarshalYamlStrict(b []byte, spec *Spec) error

+ func WarnOnOutdatedVersions(ctx context.Context, p *managedplugin.PluginVersionWarner, sources []*Source, ...)

+ type BackendOptions struct

+ Connection string

+ TableName string

+ func (b *BackendOptions) PluginName() string

+ type Destination struct

+ MigrateMode MigrateMode

+ PKMode PKMode

+ Spec map[string]any

+ SyncGroupId string

+ SyncSummary bool

+ Transformers []string

+ WriteMode WriteMode

+ func (*Destination) GetWarnings() Warnings

+ func (d *Destination) RenderedSyncGroupId(t time.Time, sync_id string) string

+ func (d *Destination) SetDefaults()

+ func (d *Destination) UnmarshalSpec(out any) error

+ func (d *Destination) Validate() error

+ type Kind int

+ const KindDestination

+ const KindSource

+ const KindTransformer

+ func KindFromString(s string) (Kind, error)

+ func (Kind) JSONSchemaExtend(sc *jsonschema.Schema)

+ func (k *Kind) UnmarshalJSON(data []byte) (err error)

+ func (k Kind) MarshalJSON() ([]byte, error)

+ func (k Kind) String() string

+ type Metadata struct

+ DockerRegistryAuthToken string

+ Name string

+ Path string

+ Registry Registry

+ Version string

+ func (Metadata) JSONSchemaExtend(sc *jsonschema.Schema)

+ func (m *Metadata) RegistryInferred() bool

+ func (m *Metadata) SetDefaults()

+ func (m *Metadata) Validate() error

+ func (m Metadata) VersionString() string

+ type MigrateMode int

+ const MigrateModeForced

+ const MigrateModeSafe

+ func MigrateModeFromString(s string) (MigrateMode, error)

+ func (MigrateMode) JSONSchemaExtend(sc *jsonschema.Schema)

+ func (m *MigrateMode) UnmarshalJSON(data []byte) (err error)

+ func (m MigrateMode) MarshalJSON() ([]byte, error)

+ func (m MigrateMode) String() string

+ type PKMode int

+ const PKModeCQID

+ const PKModeDefaultKeys

+ func PKModeFromString(s string) (PKMode, error)

+ func (PKMode) JSONSchemaExtend(sc *jsonschema.Schema)

+ func (m *PKMode) UnmarshalJSON(data []byte) (err error)

+ func (m PKMode) MarshalJSON() ([]byte, error)

+ func (m PKMode) String() string

+ type PluginVariables struct

+ Connection string

+ type Registry int

+ const RegistryCloudQuery

+ const RegistryDocker

+ const RegistryGRPC

+ const RegistryGitHub

+ const RegistryLocal

+ const RegistryUnset

+ func RegistryFromString(s string) (Registry, error)

+ func (Registry) JSONSchemaExtend(sc *jsonschema.Schema)

+ func (r *Registry) UnmarshalJSON(data []byte) (err error)

+ func (r Registry) MarshalJSON() ([]byte, error)

+ func (r Registry) NeedVersion() bool

+ func (r Registry) String() string

+ type Source struct

+ BackendOptions *BackendOptions

+ Destinations []string

+ DeterministicCQID bool

+ OtelEndpoint string

+ OtelEndpointInsecure bool

+ SkipDependentTables *bool

+ SkipTables []string

+ Spec map[string]any

+ Tables []string

+ func (Source) JSONSchemaExtend(sc *jsonschema.Schema)

+ func (s *Source) GetWarnings() Warnings

+ func (s *Source) SetDefaults()

+ func (s *Source) UnmarshalSpec(out any) error

+ func (s *Source) Validate() error

+ type Spec struct

+ Kind Kind

+ Spec any

+ func (Spec) JSONSchemaExtend(sc *jsonschema.Schema)

+ func (s *Spec) UnmarshalJSON(data []byte) error

+ type SpecReader struct

+ Destinations []*Destination

+ Sources []*Source

+ Transformers []*Transformer

+ func NewRelaxedSpecReader(paths []string) (*SpecReader, error)

+ func NewSpecReader(paths []string) (*SpecReader, error)

+ func (r *SpecReader) GetDestinationByName(name string) *Destination

+ func (r *SpecReader) GetDestinationNamesForSource(name string) []string

+ func (r *SpecReader) GetDestinationWarningsByName(name string) Warnings

+ func (r *SpecReader) GetSourceByName(name string) *Source

+ func (r *SpecReader) GetSourceWarningsByName(name string) Warnings

+ func (r *SpecReader) GetTransformerWarningsByName(name string) Warnings

+ type Transformer struct

+ Spec map[string]any

+ func (*Transformer) GetWarnings() Warnings

+ func (d *Transformer) UnmarshalSpec(out any) error

+ func (d *Transformer) Validate() error

+ type Variables struct

+ Plugins map[string]PluginVariables

+ type Warnings map[string]string

+ type WriteMode int

+ const WriteModeAppend

+ const WriteModeOverwrite

+ const WriteModeOverwriteDeleteStale

+ func WriteModeFromString(s string) (WriteMode, error)

+ func (WriteMode) JSONSchemaExtend(sc *jsonschema.Schema)

+ func (m *WriteMode) UnmarshalJSON(data []byte) (err error)

+ func (m WriteMode) MarshalJSON() ([]byte, error)

+ func (m WriteMode) String() string