storage

Documentation

Index

• type Database
  • func NewDatabase(base *base.BaseDendrite, dbProperties *config.DatabaseOptions, ...) (Database, error)

Types

type Database

type Database interface {
	// Adds a new transaction to the queue json table.
	// Adding a duplicate transaction will result in a new row being added and a new unique nid.
	// return: unique nid representing this entry.
	StoreTransaction(ctx context.Context, txn gomatrixserverlib.Transaction) (*receipt.Receipt, error)

	// Adds a new transaction_id: server_name mapping with associated json table nid to the queue
	// entry table for each provided destination.
	AssociateTransactionWithDestinations(ctx context.Context, destinations map[gomatrixserverlib.UserID]struct{}, transactionID gomatrixserverlib.TransactionID, dbReceipt *receipt.Receipt) error

	// Removes every server_name: receipt pair provided from the queue entries table.
	// Will then remove every entry for each receipt provided from the queue json table.
	// If any of the entries don't exist in either table, nothing will happen for that entry and
	// an error will not be generated.
	CleanTransactions(ctx context.Context, userID gomatrixserverlib.UserID, receipts []*receipt.Receipt) error

	// Gets the oldest transaction for the provided server_name.
	// If no transactions exist, returns nil and no error.
	GetTransaction(ctx context.Context, userID gomatrixserverlib.UserID) (*gomatrixserverlib.Transaction, *receipt.Receipt, error)

	// Gets the number of transactions being stored for the provided server_name.
	// If the server doesn't exist in the database then 0 is returned with no error.
	GetTransactionCount(ctx context.Context, userID gomatrixserverlib.UserID) (int64, error)
}

func NewDatabase

func NewDatabase(
	base *base.BaseDendrite,
	dbProperties *config.DatabaseOptions,
	cache caching.FederationCache,
	isLocalServerName func(gomatrixserverlib.ServerName) bool,
) (Database, error)

NewDatabase opens a new database