connector

Documentation

Index

• type ConnectionSecrets
• type Store
  • func Init(logger *zap.Logger, secrets ConnectionSecrets, ...) *Store
  • func (cs *Store) CreateExecution(defUID uuid.UUID, sysVars map[string]any, connection *structpb.Struct, ...) (*base.ExecutionWrapper, error)
  • func (cs *Store) GetConnectorDefinitionByID(defID string, sysVars map[string]any, component *pipelinePB.ConnectorComponent) (*pipelinePB.ConnectorDefinition, error)
  • func (cs *Store) GetConnectorDefinitionByUID(defUID uuid.UUID, sysVars map[string]any, ...) (*pipelinePB.ConnectorDefinition, error)
  • func (cs *Store) Import(con base.IConnector)
  • func (cs *Store) IsSecretField(defUID uuid.UUID, target string) (bool, error)
  • func (cs *Store) ListConnectorDefinitions(sysVars map[string]any, returnTombstone bool) []*pipelinePB.ConnectorDefinition

Types

type ConnectionSecrets

type ConnectionSecrets map[string]map[string]any

ConnectionSecrets contains the global connection secrets of each implemented connector (referenced by ID). Connectors may use these secrets to skip the connector configuration step and have a ready-to-run connection.

type Store

type Store struct {
	// contains filtered or unexported fields
}

Store holds in-memory information about the initialized connectors.

func Init

func Init(
	logger *zap.Logger,
	secrets ConnectionSecrets,
	usageHandlerCreators map[string]base.UsageHandlerCreator,
) *Store

Init initializes the different connector components and loads their information to memory.

func (*Store) CreateExecution

func (cs *Store) CreateExecution(defUID uuid.UUID, sysVars map[string]any, connection *structpb.Struct, task string) (*base.ExecutionWrapper, error)

CreateExecution initializes the execution of a connector given its UID.

func (*Store) GetConnectorDefinitionByID

func (cs *Store) GetConnectorDefinitionByID(defID string, sysVars map[string]any, component *pipelinePB.ConnectorComponent) (*pipelinePB.ConnectorDefinition, error)

GetConnectorDefinitionByID returns a connector definition by its ID.

func (*Store) GetConnectorDefinitionByUID

func (cs *Store) GetConnectorDefinitionByUID(defUID uuid.UUID, sysVars map[string]any, component *pipelinePB.ConnectorComponent) (*pipelinePB.ConnectorDefinition, error)

GetConnectorDefinitionByUID returns a connector definition by its UID.

func (*Store) Import

func (cs *Store) Import(con base.IConnector)

Import loads the connector definitions into memory.

func (*Store) IsSecretField

func (cs *Store) IsSecretField(defUID uuid.UUID, target string) (bool, error)

func (*Store) ListConnectorDefinitions

func (cs *Store) ListConnectorDefinitions(sysVars map[string]any, returnTombstone bool) []*pipelinePB.ConnectorDefinition

ListConnectorDefinitions returns all the loaded connector definitions.