Documentation ¶
Index ¶
- Constants
- func New() sdk.Source
- type Config
- type Iterator
- type Source
- func (s *Source) Ack(ctx context.Context, p sdk.Position) error
- func (s *Source) Configure(_ context.Context, cfgRaw map[string]string) error
- func (s *Source) Open(ctx context.Context, rp sdk.Position) error
- func (s *Source) Parameters() map[string]sdk.Parameter
- func (s *Source) Read(ctx context.Context) (sdk.Record, error)
- func (s *Source) Teardown(context.Context) error
Constants ¶
View Source
const ( // KeyOrderingColumn is a config name for an ordering column. KeyOrderingColumn = "orderingColumn" // KeyColumns is a config name for columns. KeyColumns = "columns" // KeyBatchSize is a config name for a batch size. KeyBatchSize = "batchSize" // KeyPrimaryKeys is a config name for primary keys. KeyPrimaryKeys = "primaryKeys" // KeySnapshot is a config name for snapshotMode. KeySnapshot = "snapshot" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Config ¶
type Config struct { config.Config // OrderingColumn is a name of a column that the connector will use for ordering rows. OrderingColumn string `key:"orderingColumn" validate:"required,max=128"` // Columns list of column names that should be included in each Record's payload. Columns []string `key:"columns" validate:"contains_or_default=OrderingColumn,dive,max=128"` // BatchSize is a size of rows batch. BatchSize int `key:"batchSize" validate:"gte=1,lte=100000"` // PrimaryKeys list of column names should use for their `Key` fields. PrimaryKeys []string `validate:"dive,max=128"` // Snapshot whether or not the plugin will take a snapshot of the entire table before starting cdc. Snapshot bool }
Config holds source specific configurable values.
type Iterator ¶
type Iterator interface { HasNext(ctx context.Context) (bool, error) Next(ctx context.Context) (sdk.Record, error) Stop() error Ack(ctx context.Context, rp sdk.Position) error }
Iterator interface.
type Source ¶
type Source struct { sdk.UnimplementedSource // contains filtered or unexported fields }
Source connector.
func (*Source) Configure ¶
Configure parses and stores configurations, returns an error in case of invalid configuration.
func (*Source) Parameters ¶
Parameters returns a map of named sdk.Parameters that describe how to configure the Source.
Click to show internal directories.
Click to hide internal directories.