sources

Documentation

Index

• func GetCloudSQLOpts(ipType, userAgent string, useIAM bool) ([]cloudsqlconn.Option, error)
• func GetIAMAccessToken(ctx context.Context) (string, error)
• func GetIAMPrincipalEmailFromADC(ctx context.Context) (string, error)
• func InitConnectionSpan(ctx context.Context, tracer trace.Tracer, sourceKind, sourceName string) (context.Context, trace.Span)
• func Register(kind string, factory SourceConfigFactory) bool
• type Dialect
  • func (i *Dialect) String() string
  • func (i *Dialect) UnmarshalYAML(ctx context.Context, unmarshal func(interface{}) error) error
• type IPType
  • func (i *IPType) String() string
  • func (i *IPType) UnmarshalYAML(ctx context.Context, unmarshal func(interface{}) error) error
• type Source
• type SourceConfig
  • func DecodeConfig(ctx context.Context, kind string, name string, decoder *yaml.Decoder) (SourceConfig, error)
• type SourceConfigFactory

Functions

func GetCloudSQLOpts

func GetCloudSQLOpts(ipType, userAgent string, useIAM bool) ([]cloudsqlconn.Option, error)

GetCloudSQLDialOpts retrieve dial options with the right ip type and user agent for cloud sql databases.

func GetIAMAccessToken

func GetIAMAccessToken(ctx context.Context) (string, error)

func GetIAMPrincipalEmailFromADC

func GetIAMPrincipalEmailFromADC(ctx context.Context) (string, error)

GetIAMPrincipalEmailFromADC finds the email associated with ADC

func InitConnectionSpan

func InitConnectionSpan(ctx context.Context, tracer trace.Tracer, sourceKind, sourceName string) (context.Context, trace.Span)

InitConnectionSpan adds a span for database pool connection initialization

func Register

func Register(kind string, factory SourceConfigFactory) bool

Register registers a new source kind with its factory. It returns false if the kind is already registered.

Types

type Dialect

type Dialect string

Dialect represents the dialect type of a database.

func (*Dialect) String

func (i *Dialect) String() string

func (*Dialect) UnmarshalYAML

func (i *Dialect) UnmarshalYAML(ctx context.Context, unmarshal func(interface{}) error) error

type IPType

type IPType string

func (*IPType) String

func (i *IPType) String() string

func (*IPType) UnmarshalYAML

func (i *IPType) UnmarshalYAML(ctx context.Context, unmarshal func(interface{}) error) error

type Source

type Source interface {
	SourceKind() string
}

Source is the interface for the source itself.

type SourceConfig

type SourceConfig interface {
	SourceConfigKind() string
	Initialize(ctx context.Context, tracer trace.Tracer) (Source, error)
}

SourceConfig is the interface for configuring a source.

func DecodeConfig

func DecodeConfig(ctx context.Context, kind string, name string, decoder *yaml.Decoder) (SourceConfig, error)

DecodeConfig decodes a source configuration using the registered factory for the given kind.

type SourceConfigFactory

type SourceConfigFactory func(ctx context.Context, name string, decoder *yaml.Decoder) (SourceConfig, error)

SourceConfigFactory defines the function signature for creating a SourceConfig.