db

package

v0.3.0 Latest Latest Go to latest Published: Apr 9, 2025 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/xmtp/xmtpd

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Get5MinutesOfCongestion(ctx context.Context, querier *queries.Queries, originatorID, endMinute int32) (out [5]int32, err error)
func InsertGatewayEnvelopeAndIncrementUnsettledUsage(ctx context.Context, db *sql.DB, ...) (int64, error)
func NewNamespacedDB(ctx context.Context, logger *zap.Logger, dsn string, namespace string, ...) (*sql.DB, error)
func NullInt32(v int32) sql.NullInt32
func NullInt64(v int64) sql.NullInt64
func RunInTx(ctx context.Context, db *sql.DB, opts *sql.TxOptions, ...) error
func RunInTxWithResult[T any](ctx context.Context, db *sql.DB, opts *sql.TxOptions, ...) (result T, err error)
func SetVectorClock(q *queries.SelectGatewayEnvelopesParams, vc VectorClock) *queries.SelectGatewayEnvelopesParams
type DBSubscription
- func NewDBSubscription[ValueType any, CursorType any](ctx context.Context, log *zap.Logger, ...) *DBSubscription[ValueType, CursorType]
- func (s *DBSubscription[ValueType, CursorType]) Start() (<-chan []ValueType, error)
type PollableDBQuery
type PollingOptions
type Topic
type VectorClock
- func ToVectorClock(rows []queries.SelectVectorClockRow) VectorClock

Constants ¶

View Source

const MAX_NAMESPACE_LENGTH = 32

Variables ¶

This section is empty.

Functions ¶

func Get5MinutesOfCongestion ¶ added in v0.3.0

func Get5MinutesOfCongestion(
	ctx context.Context,
	querier *queries.Queries,
	originatorID, endMinute int32,
) (out [5]int32, err error)

Gets the congestion for the minute specified by `endMinute` and the previous 4 minutes returned in descending order with missing values filled with 0

func InsertGatewayEnvelopeAndIncrementUnsettledUsage ¶ added in v0.3.0

func InsertGatewayEnvelopeAndIncrementUnsettledUsage(
	ctx context.Context,
	db *sql.DB,
	insertParams queries.InsertGatewayEnvelopeParams,
	incrementParams queries.IncrementUnsettledUsageParams,
) (int64, error)

InsertGatewayEnvelopeAndIncrementUnsettledUsage inserts a gateway envelope and increments the unsettled usage for the payer. It returns the number of rows inserted.

func NewNamespacedDB ¶ added in v0.1.2

func NewNamespacedDB(
	ctx context.Context,
	logger *zap.Logger,
	dsn string,
	namespace string,
	waitForDB time.Duration, statementTimeout time.Duration,
) (*sql.DB, error)

Creates a new database with the given namespace if it doesn't exist and returns the full DSN for the new database.

func NullInt32 ¶

func NullInt32(v int32) sql.NullInt32

func NullInt64 ¶

func NullInt64(v int64) sql.NullInt64

func RunInTx ¶

func RunInTx(
	ctx context.Context,
	db *sql.DB,
	opts *sql.TxOptions,
	fn func(ctx context.Context, txQueries *queries.Queries) error,
) error

func RunInTxWithResult ¶ added in v0.3.0

func RunInTxWithResult[T any](
	ctx context.Context,
	db *sql.DB,
	opts *sql.TxOptions,
	fn func(ctx context.Context, txQueries *queries.Queries) (T, error),
) (result T, err error)

func SetVectorClock ¶

func SetVectorClock(
	q *queries.SelectGatewayEnvelopesParams,
	vc VectorClock,
) *queries.SelectGatewayEnvelopesParams

Types ¶

type DBSubscription ¶

type DBSubscription[ValueType any, CursorType any] struct {
	// contains filtered or unexported fields
}

A subscription that polls a DB for updates Assumes there is only one listener (updates block on a single unbuffered channel)

func NewDBSubscription ¶

func NewDBSubscription[ValueType any, CursorType any](
	ctx context.Context,
	log *zap.Logger,
	query PollableDBQuery[ValueType, CursorType],
	lastSeen CursorType,
	options PollingOptions,
) *DBSubscription[ValueType, CursorType]

func (*DBSubscription[ValueType, CursorType]) Start ¶

func (s *DBSubscription[ValueType, CursorType]) Start() (<-chan []ValueType, error)

type PollableDBQuery ¶

type PollableDBQuery[ValueType any, CursorType any] func(
	ctx context.Context,
	lastSeen CursorType,
	numRows int32,
) (results []ValueType, nextCursor CursorType, err error)

type PollingOptions ¶

type PollingOptions struct {
	Interval time.Duration
	Notifier <-chan bool
	NumRows  int32
}

Poll whenever notified, or at an interval if not notified

type Topic ¶

type Topic = []byte

type VectorClock ¶

type VectorClock = map[uint32]uint64

func ToVectorClock ¶

func ToVectorClock(rows []queries.SelectVectorClockRow) VectorClock

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
queries

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL