database

package
v0.9.2 Latest Latest
Warning

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

Go to latest
Published: Jan 21, 2025 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterRemindersDatabase

func RegisterRemindersDatabase(ctx context.Context, scheme string, init_func RemindersDatabaseInitializationFunc) error

RegisterRemindersDatabase registers 'scheme' as a key pointing to 'init_func' in an internal lookup table used to create new `RemindersDatabase` instances by the `NewRemindersDatabase` method.

func RemindersDatabaseSchemes

func RemindersDatabaseSchemes() []string

Schemes returns the list of schemes that have been registered.

Types

type CSVRemindersDatabase

type CSVRemindersDatabase struct {
	RemindersDatabase
	// contains filtered or unexported fields
}

func (*CSVRemindersDatabase) AddReminder

func (db *CSVRemindersDatabase) AddReminder(ctx context.Context, r *reminder.Reminder) error

func (*CSVRemindersDatabase) Close

func (db *CSVRemindersDatabase) Close() error

func (*CSVRemindersDatabase) Reminders

func (*CSVRemindersDatabase) RemoveReminder

func (db *CSVRemindersDatabase) RemoveReminder(ctx context.Context, r *reminder.Reminder) error

type DocstoreRemindersDatabase

type DocstoreRemindersDatabase struct {
	RemindersDatabase
	// contains filtered or unexported fields
}

func (*DocstoreRemindersDatabase) AddReminder

func (*DocstoreRemindersDatabase) Close

func (db *DocstoreRemindersDatabase) Close() error

func (*DocstoreRemindersDatabase) Reminders

func (*DocstoreRemindersDatabase) RemoveReminder

func (db *DocstoreRemindersDatabase) RemoveReminder(ctx context.Context, r *reminder.Reminder) error

type NullRemindersDatabase

type NullRemindersDatabase struct {
	RemindersDatabase
	// contains filtered or unexported fields
}

func (*NullRemindersDatabase) AddReminder

func (db *NullRemindersDatabase) AddReminder(ctx context.Context, r *reminder.Reminder) error

func (*NullRemindersDatabase) Close

func (db *NullRemindersDatabase) Close() error

func (*NullRemindersDatabase) Reminders

func (*NullRemindersDatabase) RemoveReminder

func (db *NullRemindersDatabase) RemoveReminder(ctx context.Context, r *reminder.Reminder) error

type RemindersDatabase

type RemindersDatabase interface {
	// AddReminder adds a `reminder.Reminder` to the RemindersDatabase.
	AddReminder(context.Context, *reminder.Reminder) error
	// RemoveReminder removes a `reminder.Reminder` from the RemindersDatabase.
	RemoveReminder(context.Context, *reminder.Reminder) error
	// Reminders returns an `iter.Seq2` instance yielding each `reminder.Reminder` entry in the RemindersDatabase.
	Reminders(context.Context) iter.Seq2[*reminder.Reminder, error]
	// Close performs final operations when terminating the underlying RemindersDatabase connection.
	Close() error
}

RemindersDatabase is an interface for reading and writing `reminder.Reminder` instances.

func NewCSVRemindersDatabase

func NewCSVRemindersDatabase(ctx context.Context, uri string) (RemindersDatabase, error)

func NewDocstoreRemindersDatabase

func NewDocstoreRemindersDatabase(ctx context.Context, uri string) (RemindersDatabase, error)

func NewNullRemindersDatabase

func NewNullRemindersDatabase(ctx context.Context, uri string) (RemindersDatabase, error)

func NewRemindersDatabase

func NewRemindersDatabase(ctx context.Context, uri string) (RemindersDatabase, error)

NewRemindersDatabase returns a new `RemindersDatabase` instance configured by 'uri'. The value of 'uri' is parsed as a `url.URL` and its scheme is used as the key for a corresponding `RemindersDatabaseInitializationFunc` function used to instantiate the new `RemindersDatabase`. It is assumed that the scheme (and initialization function) have been registered by the `RegisterRemindersDatabase` method.

func NewSQLRemindersDatabase

func NewSQLRemindersDatabase(ctx context.Context, uri string) (RemindersDatabase, error)

type RemindersDatabaseInitializationFunc

type RemindersDatabaseInitializationFunc func(ctx context.Context, uri string) (RemindersDatabase, error)

RemindersDatabaseInitializationFunc is a function defined by individual reminders_database package and used to create an instance of that reminders_database

type SQLRemindersDatabase

type SQLRemindersDatabase struct {
	RemindersDatabase
	// contains filtered or unexported fields
}

func (*SQLRemindersDatabase) AddReminder

func (db *SQLRemindersDatabase) AddReminder(ctx context.Context, r *reminder.Reminder) error

func (*SQLRemindersDatabase) Close

func (db *SQLRemindersDatabase) Close() error

func (*SQLRemindersDatabase) Reminders

func (*SQLRemindersDatabase) RemoveReminder

func (db *SQLRemindersDatabase) RemoveReminder(ctx context.Context, r *reminder.Reminder) error

Jump to

Keyboard shortcuts

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