ftl

package
v0.424.2 Latest Latest
Warning

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

 Go to latest Published: Jan 15, 2025 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Trace   = log.Trace
	Debug   = log.Debug
	Info    = log.Info
	Warn    = log.Warn
	Error   = log.Error
	Default = log.Default
)

Log levels.

Variables

View Source 
var ErrLeaseHeld = fmt.Errorf("lease already held")

ErrLeaseHeld is returned when an attempt is made to acquire a lease that is already held.

Functions

This section is empty.

Types

type Config 

type Config[T ConfigType] struct {
	reflection.Ref
}

Config is a typed configuration key for the current module.

func (Config[T]) Get 

func (c Config[T]) Get(ctx context.Context) (out T)

Get returns the value of the configuration key from FTL.

func (Config[T]) GoString 

func (c Config[T]) GoString() string

func (Config[T]) String 

func (c Config[T]) String() string

type ConfigType 

type ConfigType interface{ any }

ConfigType is a type that can be used as a configuration value.

type DatabaseConfig 

type DatabaseConfig interface {
	// Name returns the name of the database.
	Name() string
	// contains filtered or unexported methods
}

type DatabaseHandle 

type DatabaseHandle[T DatabaseConfig] struct {
	// contains filtered or unexported fields
}

func NewDatabaseHandle 

func NewDatabaseHandle[T DatabaseConfig](config T, dbType DatabaseType, db *once.Handle[*sql.DB]) DatabaseHandle[T]

NewDatabaseHandle is managed by FTL.

func (DatabaseHandle[T]) Get 

func (d DatabaseHandle[T]) Get(ctx context.Context) *sql.DB

Get returns the SQL DB connection for the database.

func (DatabaseHandle[T]) Name 

func (d DatabaseHandle[T]) Name() string

Name returns the name of the database.

func (DatabaseHandle[T]) String 

func (d DatabaseHandle[T]) String() string

String returns a string representation of the database handle.

func (DatabaseHandle[T]) Type 

func (d DatabaseHandle[T]) Type() DatabaseType

Type returns the type of the database, e.g. "postgres"

type DatabaseType 

type DatabaseType string
const (
	DatabaseTypePostgres DatabaseType = "postgres"
	DatabaseTypeMysql    DatabaseType = "mysql"
)

type DefaultMySQLDatabaseConfig 

type DefaultMySQLDatabaseConfig struct{}

DefaultMySQLDatabaseConfig is a default implementation of MySQLDatabaseConfig. It does not provide an implementation for the Name method and should be embedded in a struct that does.

type DefaultPostgresDatabaseConfig 

type DefaultPostgresDatabaseConfig struct{}

DefaultPostgresDatabaseConfig is a default implementation of PostgresDatabaseConfig. It does not provide an implementation for the Name method and should be embedded in a struct that does.

type Empty 

type Empty func(context.Context) error

An Empty is a function that does not accept input or return output.

type ExternalPartitionMapper 

type ExternalPartitionMapper[E any] struct{}

ExternalPartitionMapper is a fake partition mapper that is used to indicate that a topic is external. External topics can not be directly published to.

func (ExternalPartitionMapper[E]) PartitionKey 

func (ExternalPartitionMapper[E]) PartitionKey(_ E) string

type Handle 

type Handle[T any] interface {
	Get(ctx context.Context) T
}

Handle represents a resource that can be retrieved such as a database connection, secret, etc.

type LeaseHandle 

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

func Lease 

func Lease(ctx context.Context, ttl time.Duration, key ...string) (LeaseHandle, error)

Lease acquires a new exclusive lease on a resource uniquely identified by [key].

The [ttl] defines the time after which the lease will be released if no heartbeat has been received. It must be >= 5s.

Each [key] is scoped to the module that acquires the lease.

Returns ErrLeaseHeld if the lease is already held.

func (LeaseHandle) Err 

func (l LeaseHandle) Err() error

Err returns an error if the lease heartbeat fails.

func (LeaseHandle) Release 

func (l LeaseHandle) Release() error

Release attempts to release the lease.

Will return an error if the heartbeat failed. In this situation there are no guarantees that the lease was held to completion.

type Logger 

type Logger = log.Logger

Logger is a levelled printf-style logger with support for structured attributes.

func LoggerFromContext 

func LoggerFromContext(ctx context.Context) *Logger

LoggerFromContext retrieves the current logger from the Context.

type MapHandle 

type MapHandle[T, U any] struct {
	// contains filtered or unexported fields
}

func Map 

func Map[T, U any](getter Handle[T], fn func(context.Context, T) (U, error)) *MapHandle[T, U]

Map an FTL resource type to a new type.

func (*MapHandle[T, U]) Get 

func (mh *MapHandle[T, U]) Get(ctx context.Context) U

Get the mapped value.

type MySQLDatabaseConfig 

type MySQLDatabaseConfig interface {
	DatabaseConfig
	// contains filtered or unexported methods
}

type Option 

type Option[T any] struct {
	// contains filtered or unexported fields
}

An Option type is a type that can contain a value or nothing.

func Nil 

func Nil[T any](ptr T) Option[T]

Nil returns an Option that is invalid if the value is nil, otherwise the value.

If the type is not nillable (slice, map, chan, ptr, interface) this will panic.

func None 

func None[T any]() Option[T]

None returns an Option that contains nothing.

func Ptr 

func Ptr[T any](ptr *T) Option[T]

Ptr returns an Option that is invalid if the pointer is nil, otherwise the dereferenced pointer.

func Some 

func Some[T any](value T) Option[T]

Some returns an Option that contains a value.

func Zero 

func Zero[T any](value T) Option[T]

Zero returns an Option that is invalid if the value is the zero value, otherwise the value.

func (Option[T]) Default 

func (o Option[T]) Default(value T) T

Default returns the Option value if it is present, otherwise it returns the value passed.

func (Option[T]) Get 

func (o Option[T]) Get() (T, bool)

Get returns the value and a boolean indicating if the Option contains a value.

func (Option[T]) GoString 

func (o Option[T]) GoString() string

func (Option[T]) Marshal 

func (o Option[T]) Marshal(
	w *bytes.Buffer,
	encode func(v reflect.Value, w *bytes.Buffer) error,
) error

func (Option[T]) MarshalJSON 

func (o Option[T]) MarshalJSON() ([]byte, error)

func (Option[T]) MustGet 

func (o Option[T]) MustGet() T

MustGet returns the value. It panics if the Option contains nothing.

func (Option[T]) Ok 

func (o Option[T]) Ok() bool

Ok returns true if the Option contains a value.

func (Option[T]) Ptr 

func (o Option[T]) Ptr() *T

Ptr returns a pointer to the value if the Option contains a value, otherwise nil.

func (*Option[T]) Scan 

func (o *Option[T]) Scan(src any) error

func (Option[T]) String 

func (o Option[T]) String() string

func (*Option[T]) Unmarshal 

func (o *Option[T]) Unmarshal(
	d *json.Decoder,
	isNull bool,
	decode func(d *json.Decoder, v reflect.Value) error,
) error

func (*Option[T]) UnmarshalJSON 

func (o *Option[T]) UnmarshalJSON(data []byte) error

func (Option[T]) Value 

func (o Option[T]) Value() (driver.Value, error)

type PostgresDatabaseConfig 

type PostgresDatabaseConfig interface {
	DatabaseConfig
	// contains filtered or unexported methods
}

type Secret 

type Secret[T SecretType] struct {
	reflection.Ref
}

Secret declares a typed secret for the current module.

func (Secret[T]) Get 

func (s Secret[T]) Get(ctx context.Context) (out T)

Get returns the value of the secret from FTL.

func (Secret[T]) GoString 

func (s Secret[T]) GoString() string

func (Secret[T]) String 

func (s Secret[T]) String() string

type SecretType 

type SecretType interface{ any }

SecretType is a type that can be used as a secret value.

type SinglePartitionMap 

type SinglePartitionMap[E any] struct{}

SinglePartitionMap can be used for topics with a single partition

func (SinglePartitionMap[E]) PartitionKey 

func (SinglePartitionMap[E]) PartitionKey(_ E) string

type Sink 

type Sink[Req any] func(context.Context, Req) error

A Sink is a function that accepts input but returns nothing.

type Source 

type Source[Resp any] func(context.Context) (Resp, error)

A Source is a function that does not accept input but returns output.

type TopicHandle 

type TopicHandle[E any, M TopicPartitionMap[E]] struct {
	Ref          *schema.Ref
	PartitionMap M
}

TopicHandle accesses a topic

Topics publish events, and subscriptions can listen to them.

func (TopicHandle[E, M]) Publish 

func (t TopicHandle[E, M]) Publish(ctx context.Context, event E) error

Publish publishes an event to a topic

type TopicPartitionMap 

type TopicPartitionMap[E any] interface {
	PartitionKey(event E) string
}

TopicPartitionMap maps an event to a partition key

type Unit 

type Unit struct{}

Unit is a type that has no value.

It can be used as a parameter or return value to indicate that a function does not accept or return any value.

type Verb 

type Verb[Req, Resp any] func(context.Context, Req) (Resp, error)

A Verb is a function that accepts input and returns output.

Source Files

View all Source files

Directories

Path Synopsis
Package ftltest contains test utilities for the ftl package.
 Package ftltest contains test utilities for the ftl package.

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.