table

type Accessor[Type any] interface {
	// Obtain the item stored in a database at the given id.
	// Returns the item stored in a database at the given id.
	// If the item can not be obtained, a [gopolutils.ValueError] is returned with a nil data pointer.
	Get(id gopolutils.Size) (*Type, *gopolutils.Exception)
	// Obtain all the items stored in a database.
	// Returns a [collections.View] of all the items stored in a database.
	// If the items can not be obtained, an [gopolutils.IOError] is returned with a nil data pointer.
	GetAll() (collections.View[*Type], *gopolutils.Exception)
}

type Closer interface {
	// Close a database.
	// If a database can not close, an [gopolutils.IOError] is returned.
	Close() *gopolutils.Exception
}

type Creator interface {
	// Create a database with a given name.
	// If the database can not be created, an [gopolutils.IOError] is returned.
	Create(name string) *gopolutils.Exception
}

type Driver gopolutils.StringEnum

type Dropper interface {
	// Drop a database with a given name.
	// If the database can not be dropped, an [gopolutils.IOError] is returned.
	Drop(name string) *gopolutils.Exception
}

type Field gopolutils.StringEnum

type Getter interface {
	// Obtain the name of the database.
	Name() string
	// Obtain a handle to the database.
	Connection() *sql.DB
}

type Inserter[Type any] interface {
	// Insert a given record into the database.
	// If the given record can not be inserted, an [gopolutils.IOError] is returned.
	Insert(record Type) *gopolutils.Exception
	// Insert a [collections.View] of records into the database.
	// If the given records can not be inserted, an [gopolutils.IOError] is returned.
	InsertMany(records collections.View[Type]) *gopolutils.Exception
}

type Remover[Type any] interface {
	// Remove a given item from a database.
	// If the given item can not be removed, an [gopolutils.IOError] is returned.
	Remove(item Type) *gopolutils.Exception
}

type Setter interface {
	// Set the name of the database.
	SetName(name string)
	// Set the connection of the database.
	SetConnection(connection *sql.DB)
}

type Table[Type any] interface {
	Creator
	Setter
	Getter
	Inserter[Type]
	Accessor[Type]
	Remover[Type]
	Dropper
	Closer
	collections.Sized
}