pconnector

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 8, 2024 License: Apache-2.0 Imports: 7 Imported by: 12

Documentation

Index

Constants

View Source 
const (
	EnvConduitConnectorID       = "CONDUIT_CONNECTOR_ID"
	EnvConduitConnectorLogLevel = "CONDUIT_CONNECTOR_LOG_LEVEL"
)

Variables

View Source 
var ErrUnimplemented = errors.New("method not implemented")
View Source 
var HandshakeConfig = plugin.HandshakeConfig{
	MagicCookieKey:   "CONDUIT_PLUGIN_MAGIC_COOKIE",
	MagicCookieValue: "204e8e812c3a1bb73b838928c575b42a105dd2e9aa449be481bc4590486df53f",
}

Functions

This section is empty.

Types

type DestinationConfigureRequest 

type DestinationConfigureRequest struct {
	Config config.Config
}

func (DestinationConfigureRequest) Clone 

func (r DestinationConfigureRequest) Clone() DestinationConfigureRequest

type DestinationConfigureResponse 

type DestinationConfigureResponse struct{}

func (DestinationConfigureResponse) Clone 

func (r DestinationConfigureResponse) Clone() DestinationConfigureResponse

type DestinationLifecycleOnCreatedRequest 

type DestinationLifecycleOnCreatedRequest struct {
	Config config.Config
}

func (DestinationLifecycleOnCreatedRequest) Clone 

func (r DestinationLifecycleOnCreatedRequest) Clone() DestinationLifecycleOnCreatedRequest

type DestinationLifecycleOnCreatedResponse 

type DestinationLifecycleOnCreatedResponse struct{}

func (DestinationLifecycleOnCreatedResponse) Clone 

func (r DestinationLifecycleOnCreatedResponse) Clone() DestinationLifecycleOnCreatedResponse

type DestinationLifecycleOnDeletedRequest 

type DestinationLifecycleOnDeletedRequest struct {
	Config config.Config
}

func (DestinationLifecycleOnDeletedRequest) Clone 

func (r DestinationLifecycleOnDeletedRequest) Clone() DestinationLifecycleOnDeletedRequest

type DestinationLifecycleOnDeletedResponse 

type DestinationLifecycleOnDeletedResponse struct{}

func (DestinationLifecycleOnDeletedResponse) Clone 

func (r DestinationLifecycleOnDeletedResponse) Clone() DestinationLifecycleOnDeletedResponse

type DestinationLifecycleOnUpdatedRequest 

type DestinationLifecycleOnUpdatedRequest struct {
	ConfigBefore config.Config
	ConfigAfter  config.Config
}

func (DestinationLifecycleOnUpdatedRequest) Clone 

func (r DestinationLifecycleOnUpdatedRequest) Clone() DestinationLifecycleOnUpdatedRequest

type DestinationLifecycleOnUpdatedResponse 

type DestinationLifecycleOnUpdatedResponse struct{}

func (DestinationLifecycleOnUpdatedResponse) Clone 

func (r DestinationLifecycleOnUpdatedResponse) Clone() DestinationLifecycleOnUpdatedResponse

type DestinationOpenRequest 

type DestinationOpenRequest struct{}

func (DestinationOpenRequest) Clone 

func (r DestinationOpenRequest) Clone() DestinationOpenRequest

type DestinationOpenResponse 

type DestinationOpenResponse struct{}

func (DestinationOpenResponse) Clone 

func (r DestinationOpenResponse) Clone() DestinationOpenResponse

type DestinationPlugin 

type DestinationPlugin interface {
	Configure(context.Context, DestinationConfigureRequest) (DestinationConfigureResponse, error)
	Open(context.Context, DestinationOpenRequest) (DestinationOpenResponse, 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 {
	Records []opencdc.Record
}

func (DestinationRunRequest) Clone 

func (r DestinationRunRequest) Clone() DestinationRunRequest

type DestinationRunResponse 

type DestinationRunResponse struct {
	Acks []DestinationRunResponseAck
}

func (DestinationRunResponse) Clone 

func (r DestinationRunResponse) Clone() DestinationRunResponse

type DestinationRunResponseAck 

type DestinationRunResponseAck struct {
	Position opencdc.Position
	Error    string
}

func (DestinationRunResponseAck) Clone 

func (r DestinationRunResponseAck) Clone() DestinationRunResponseAck

type DestinationRunStream 

type DestinationRunStream interface {
	// Client is only allowed to be used by the host (Conduit).
	Client() DestinationRunStreamClient
	// Server is only allowed to be used by the plugin (connector).
	Server() DestinationRunStreamServer
}

DestinationRunStream is the bidirectional stream interface for DestinationPlugin.Run. It combines the client and server interfaces into a single interface.

type DestinationRunStreamClient 

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

DestinationRunStreamClient is the client-side interface for a bidirectional stream of DestinationRunRequest and DestinationRunResponse messages.

type DestinationRunStreamServer 

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

DestinationRunStreamServer is the server-side interface for a bidirectional stream of DestinationRunRequest and DestinationRunResponse messages.

type DestinationStopRequest 

type DestinationStopRequest struct {
	LastPosition opencdc.Position
}

func (DestinationStopRequest) Clone 

func (r DestinationStopRequest) Clone() DestinationStopRequest

type DestinationStopResponse 

type DestinationStopResponse struct{}

func (DestinationStopResponse) Clone 

func (r DestinationStopResponse) Clone() DestinationStopResponse

type DestinationTeardownRequest 

type DestinationTeardownRequest struct{}

func (DestinationTeardownRequest) Clone 

func (r DestinationTeardownRequest) Clone() DestinationTeardownRequest

type DestinationTeardownResponse 

type DestinationTeardownResponse struct{}

func (DestinationTeardownResponse) Clone 

func (r DestinationTeardownResponse) Clone() DestinationTeardownResponse

type PluginConfig 

type PluginConfig struct {
	Token       string
	ConnectorID string
	LogLevel    string
}

type SourceConfigureRequest 

type SourceConfigureRequest struct {
	Config config.Config
}

func (SourceConfigureRequest) Clone 

func (r SourceConfigureRequest) Clone() SourceConfigureRequest

type SourceConfigureResponse 

type SourceConfigureResponse struct{}

func (SourceConfigureResponse) Clone 

func (r SourceConfigureResponse) Clone() SourceConfigureResponse

type SourceLifecycleOnCreatedRequest 

type SourceLifecycleOnCreatedRequest struct {
	Config config.Config
}

func (SourceLifecycleOnCreatedRequest) Clone 

func (r SourceLifecycleOnCreatedRequest) Clone() SourceLifecycleOnCreatedRequest

type SourceLifecycleOnCreatedResponse 

type SourceLifecycleOnCreatedResponse struct{}

func (SourceLifecycleOnCreatedResponse) Clone 

func (r SourceLifecycleOnCreatedResponse) Clone() SourceLifecycleOnCreatedResponse

type SourceLifecycleOnDeletedRequest 

type SourceLifecycleOnDeletedRequest struct {
	Config config.Config
}

func (SourceLifecycleOnDeletedRequest) Clone 

func (r SourceLifecycleOnDeletedRequest) Clone() SourceLifecycleOnDeletedRequest

type SourceLifecycleOnDeletedResponse 

type SourceLifecycleOnDeletedResponse struct{}

func (SourceLifecycleOnDeletedResponse) Clone 

func (r SourceLifecycleOnDeletedResponse) Clone() SourceLifecycleOnDeletedResponse

type SourceLifecycleOnUpdatedRequest 

type SourceLifecycleOnUpdatedRequest struct {
	ConfigBefore config.Config
	ConfigAfter  config.Config
}

func (SourceLifecycleOnUpdatedRequest) Clone 

func (r SourceLifecycleOnUpdatedRequest) Clone() SourceLifecycleOnUpdatedRequest

type SourceLifecycleOnUpdatedResponse 

type SourceLifecycleOnUpdatedResponse struct{}

func (SourceLifecycleOnUpdatedResponse) Clone 

func (r SourceLifecycleOnUpdatedResponse) Clone() SourceLifecycleOnUpdatedResponse

type SourceOpenRequest 

type SourceOpenRequest struct {
	Position opencdc.Position
}

func (SourceOpenRequest) Clone 

func (r SourceOpenRequest) Clone() SourceOpenRequest

type SourceOpenResponse 

type SourceOpenResponse struct{}

func (SourceOpenResponse) Clone 

func (r SourceOpenResponse) Clone() SourceOpenResponse

type SourcePlugin 

type SourcePlugin interface {
	Configure(context.Context, SourceConfigureRequest) (SourceConfigureResponse, error)
	Open(context.Context, SourceOpenRequest) (SourceOpenResponse, 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 {
	AckPositions []opencdc.Position
}

func (SourceRunRequest) Clone 

func (r SourceRunRequest) Clone() SourceRunRequest

type SourceRunResponse 

type SourceRunResponse struct {
	Records []opencdc.Record
}

func (SourceRunResponse) Clone 

func (r SourceRunResponse) Clone() SourceRunResponse

type SourceRunStream 

type SourceRunStream interface {
	// Client is only allowed to be used by the host (Conduit).
	Client() SourceRunStreamClient
	// Server is only allowed to be used by the plugin (connector).
	Server() SourceRunStreamServer
}

SourceRunStream is the bidirectional stream interface for SourcePlugin.Run. It combines the client and server interfaces into a single interface.

type SourceRunStreamClient 

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

SourceRunStreamClient is the client-side interface for a bidirectional stream of SourceRunRequest and SourceRunResponse messages.

type SourceRunStreamServer 

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

SourceRunStreamServer is the server-side interface for a bidirectional stream of SourceRunRequest and SourceRunResponse messages.

type SourceStopRequest 

type SourceStopRequest struct{}

func (SourceStopRequest) Clone 

func (r SourceStopRequest) Clone() SourceStopRequest

type SourceStopResponse 

type SourceStopResponse struct {
	LastPosition opencdc.Position
}

func (SourceStopResponse) Clone 

func (r SourceStopResponse) Clone() SourceStopResponse

type SourceTeardownRequest 

type SourceTeardownRequest struct{}

func (SourceTeardownRequest) Clone 

func (r SourceTeardownRequest) Clone() SourceTeardownRequest

type SourceTeardownResponse 

type SourceTeardownResponse struct{}

func (SourceTeardownResponse) Clone 

func (r SourceTeardownResponse) Clone() SourceTeardownResponse

type Specification 

type Specification struct {
	// Name is the name of the plugin.
	Name string
	// Summary is a brief description of the plugin and what it does.
	Summary string
	// Description is a more long form area appropriate for README-like text
	// that the author can provide for documentation about the specified
	// Parameters.
	Description string
	// Version string. Should be a semver prepended with `v`, e.g. `v1.54.3`.
	Version string
	// Author declares the entity that created or maintains this plugin.
	Author string
	// SourceParams and DestinationParams are maps of named Parameters that
	// describe how to configure the plugins Destination or Source.
	SourceParams      config.Parameters
	DestinationParams config.Parameters
}

Specification is returned by a plugin when Specify is called. It contains information about the configuration parameters for plugins and allows them to describe their parameters.

type SpecifierPlugin 

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

type SpecifierSpecifyRequest 

type SpecifierSpecifyRequest struct{}

type SpecifierSpecifyResponse 

type SpecifierSpecifyResponse struct {
	Specification Specification
}

Source Files

View all Source files

Directories

Path Synopsis
Package mock is a generated GoMock package.
 Package mock is a generated GoMock package.
v1
Deprecated: v1 is deprecated.
 Deprecated: v1 is deprecated.
client
Deprecated: v1 is deprecated.
 Deprecated: v1 is deprecated.
fromproto
server
Deprecated: v1 is deprecated.
 Deprecated: v1 is deprecated.
toproto
v2
client
fromproto
server
toproto

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.