cpluginv1

Documentation

Index

• Constants
• type Change
• type Data
• type DestinationConfigureRequest
• type DestinationConfigureResponse
• type DestinationLifecycleOnCreatedRequest
• type DestinationLifecycleOnCreatedResponse
• type DestinationLifecycleOnDeletedRequest
• type DestinationLifecycleOnDeletedResponse
• type DestinationLifecycleOnUpdatedRequest
• type DestinationLifecycleOnUpdatedResponse
• type DestinationPlugin
• type DestinationRunRequest
• type DestinationRunResponse
• type DestinationRunStream
• type DestinationStartRequest
• type DestinationStartResponse
• type DestinationStopRequest
• type DestinationStopResponse
• type DestinationTeardownRequest
• type DestinationTeardownResponse
• type Operation
• type ParameterType
• type ParameterValidation
• type RawData
• type Record
• type SourceConfigureRequest
• type SourceConfigureResponse
• type SourceLifecycleOnCreatedRequest
• type SourceLifecycleOnCreatedResponse
• type SourceLifecycleOnDeletedRequest
• type SourceLifecycleOnDeletedResponse
• type SourceLifecycleOnUpdatedRequest
• type SourceLifecycleOnUpdatedResponse
• type SourcePlugin
• type SourceRunRequest
• type SourceRunResponse
• type SourceRunStream
• type SourceStartRequest
• type SourceStartResponse
• type SourceStopRequest
• type SourceStopResponse
• type SourceTeardownRequest
• type SourceTeardownResponse
• type SpecifierParameter
• type SpecifierPlugin
• type SpecifierSpecifyRequest
• type SpecifierSpecifyResponse
• type StructuredData
• type ValidationType

Constants

const (
	// OpenCDCVersion is a constant that should be used as the value in the
	// metadata field MetadataVersion. It ensures the OpenCDC format version can
	// be easily identified in case the record gets marshaled into a different
	// untyped format (e.g. JSON).
	OpenCDCVersion = "v1"

	// MetadataOpenCDCVersion is a Record.Metadata key for the version of the
	// OpenCDC format (e.g. "v1"). This field exists to ensure the OpenCDC
	// format version can be easily identified in case the record gets marshaled
	// into a different untyped format (e.g. JSON).
	MetadataOpenCDCVersion = "opencdc.version"
	// MetadataCreatedAt is a Record.Metadata key for the time when the record
	// was created in the 3rd party system. The expected format is a unix
	// timestamp in nanoseconds.
	MetadataCreatedAt = "opencdc.createdAt"
	// MetadataReadAt is a Record.Metadata key for the time when the record was
	// read from the 3rd party system. The expected format is a unix timestamp
	// in nanoseconds.
	MetadataReadAt = "opencdc.readAt"
	// MetadataCollection is a Record.Metadata key for the name of the collection
	// where the record originated from and/or where it should be stored.
	MetadataCollection = "opencdc.collection"

	// MetadataConduitSourcePluginName is a Record.Metadata key for the name of
	// the source plugin that created this record.
	MetadataConduitSourcePluginName = "conduit.source.plugin.name"
	// MetadataConduitSourcePluginVersion is a Record.Metadata key for the
	// version of the source plugin that created this record.
	MetadataConduitSourcePluginVersion = "conduit.source.plugin.version"
	// MetadataConduitDestinationPluginName is a Record.Metadata key for the
	// name of the destination plugin that has written this record
	// (only available in records once they are written by a destination).
	MetadataConduitDestinationPluginName = "conduit.destination.plugin.name"
	// MetadataConduitDestinationPluginVersion is a Record.Metadata key for the
	// version of the destination plugin that has written this record
	// (only available in records once they are written by a destination).
	MetadataConduitDestinationPluginVersion = "conduit.destination.plugin.version"

	// MetadataConduitSourceConnectorID is a Record.Metadata key for the ID of
	// the source connector that produced this record.
	MetadataConduitSourceConnectorID = "conduit.source.connector.id"
	// MetadataConduitDLQNackError is a Record.Metadata key for the error that
	// caused a record to be nacked and pushed to the dead-letter queue.
	MetadataConduitDLQNackError = "conduit.dlq.nack.error"
	// MetadataConduitDLQNackNodeID is a Record.Metadata key for the ID of the
	// internal node that nacked the record.
	MetadataConduitDLQNackNodeID = "conduit.dlq.nack.node.id"
)

Types

type Change

type Change struct {
	Before Data
	After  Data
}

type Data

type Data interface {
	// contains filtered or unexported methods
}

type DestinationConfigureRequest

type DestinationConfigureRequest struct {
	Config map[string]string
}

type DestinationConfigureResponse

type DestinationConfigureResponse struct{}

type DestinationLifecycleOnCreatedRequest

type DestinationLifecycleOnCreatedRequest struct {
	Config map[string]string
}

type DestinationLifecycleOnCreatedResponse

type DestinationLifecycleOnCreatedResponse struct{}

type DestinationLifecycleOnDeletedRequest

type DestinationLifecycleOnDeletedRequest struct {
	Config map[string]string
}

type DestinationLifecycleOnDeletedResponse

type DestinationLifecycleOnDeletedResponse struct{}

type DestinationLifecycleOnUpdatedRequest

type DestinationLifecycleOnUpdatedRequest struct {
	ConfigBefore map[string]string
	ConfigAfter  map[string]string
}

type DestinationLifecycleOnUpdatedResponse

type DestinationLifecycleOnUpdatedResponse struct{}

type DestinationPlugin

type DestinationPlugin interface {
	Configure(context.Context, DestinationConfigureRequest) (DestinationConfigureResponse, error)
	Start(context.Context, DestinationStartRequest) (DestinationStartResponse, error)
	Run(context.Context, DestinationRunStream) error
	Stop(context.Context, DestinationStopRequest) (DestinationStopResponse, error)
	Teardown(context.Context, DestinationTeardownRequest) (DestinationTeardownResponse, error)

	LifecycleOnCreated(context.Context, DestinationLifecycleOnCreatedRequest) (DestinationLifecycleOnCreatedResponse, error)
	LifecycleOnUpdated(context.Context, DestinationLifecycleOnUpdatedRequest) (DestinationLifecycleOnUpdatedResponse, error)
	LifecycleOnDeleted(context.Context, DestinationLifecycleOnDeletedRequest) (DestinationLifecycleOnDeletedResponse, error)
}

type DestinationRunRequest

type DestinationRunRequest struct {
	Record Record
}

type DestinationRunResponse

type DestinationRunResponse struct {
	AckPosition []byte
	Error       string
}

type DestinationRunStream

type DestinationRunStream interface {
	Send(DestinationRunResponse) error
	Recv() (DestinationRunRequest, error)
}

type DestinationStartRequest

type DestinationStartRequest struct{}

type DestinationStartResponse

type DestinationStartResponse struct{}

type DestinationStopRequest

type DestinationStopRequest struct {
	LastPosition []byte
}

type DestinationStopResponse

type DestinationStopResponse struct{}

type DestinationTeardownRequest

type DestinationTeardownRequest struct{}

type DestinationTeardownResponse

type DestinationTeardownResponse struct{}

type Operation

type Operation int

const (
	OperationCreate Operation = iota + 1
	OperationUpdate
	OperationDelete
	OperationSnapshot
)

type ParameterType

type ParameterType int

const (
	ParameterTypeString ParameterType = iota + 1
	ParameterTypeInt
	ParameterTypeFloat
	ParameterTypeBool
	ParameterTypeFile
	ParameterTypeDuration
)

type ParameterValidation

type ParameterValidation struct {
	Type  ValidationType
	Value string
}

type RawData

type RawData []byte

type Record

type Record struct {
	Position  []byte
	Operation Operation
	Metadata  map[string]string
	Key       Data
	Payload   Change
}

type SourceConfigureRequest

type SourceConfigureRequest struct {
	Config map[string]string
}

type SourceConfigureResponse

type SourceConfigureResponse struct{}

type SourceLifecycleOnCreatedRequest

type SourceLifecycleOnCreatedRequest struct {
	Config map[string]string
}

type SourceLifecycleOnCreatedResponse

type SourceLifecycleOnCreatedResponse struct{}

type SourceLifecycleOnDeletedRequest

type SourceLifecycleOnDeletedRequest struct {
	Config map[string]string
}

type SourceLifecycleOnDeletedResponse

type SourceLifecycleOnDeletedResponse struct{}

type SourceLifecycleOnUpdatedRequest

type SourceLifecycleOnUpdatedRequest struct {
	ConfigBefore map[string]string
	ConfigAfter  map[string]string
}

type SourceLifecycleOnUpdatedResponse

type SourceLifecycleOnUpdatedResponse struct{}

type SourcePlugin

type SourcePlugin interface {
	Configure(context.Context, SourceConfigureRequest) (SourceConfigureResponse, error)
	Start(context.Context, SourceStartRequest) (SourceStartResponse, error)
	Run(context.Context, SourceRunStream) error
	Stop(context.Context, SourceStopRequest) (SourceStopResponse, error)
	Teardown(context.Context, SourceTeardownRequest) (SourceTeardownResponse, error)

	LifecycleOnCreated(context.Context, SourceLifecycleOnCreatedRequest) (SourceLifecycleOnCreatedResponse, error)
	LifecycleOnUpdated(context.Context, SourceLifecycleOnUpdatedRequest) (SourceLifecycleOnUpdatedResponse, error)
	LifecycleOnDeleted(context.Context, SourceLifecycleOnDeletedRequest) (SourceLifecycleOnDeletedResponse, error)
}

type SourceRunRequest

type SourceRunRequest struct {
	AckPosition []byte
}

type SourceRunResponse

type SourceRunResponse struct {
	Record Record
}

type SourceRunStream

type SourceRunStream interface {
	Send(SourceRunResponse) error
	Recv() (SourceRunRequest, error)
}

type SourceStartRequest

type SourceStartRequest struct {
	Position []byte
}

type SourceStartResponse

type SourceStartResponse struct{}

type SourceStopRequest

type SourceStopRequest struct{}

type SourceStopResponse

type SourceStopResponse struct {
	LastPosition []byte
}

type SourceTeardownRequest

type SourceTeardownRequest struct{}

type SourceTeardownResponse

type SourceTeardownResponse struct{}

type SpecifierParameter

type SpecifierParameter struct {
	Default string
	// Deprecated: Use ValidationTypeRequired instead.
	Required    bool
	Description string
	Type        ParameterType
	Validations []ParameterValidation
}

type SpecifierPlugin

type SpecifierPlugin interface {
	Specify(context.Context, SpecifierSpecifyRequest) (SpecifierSpecifyResponse, error)
}

type SpecifierSpecifyRequest

type SpecifierSpecifyRequest struct{}

type SpecifierSpecifyResponse

type SpecifierSpecifyResponse struct {
	Name              string
	Summary           string
	Description       string
	Version           string
	Author            string
	DestinationParams map[string]SpecifierParameter
	SourceParams      map[string]SpecifierParameter
}

type StructuredData

type StructuredData map[string]interface{}

type ValidationType

type ValidationType int

const (
	ValidationTypeRequired ValidationType = iota + 1
	ValidationTypeGreaterThan
	ValidationTypeLessThan
	ValidationTypeInclusion
	ValidationTypeExclusion
	ValidationTypeRegex
)