sql

type Connection interface {
	// GetDB returns the underlying SQL database connection.
	GetDB() *sqlx.DB
	// GetErrorTranslator returns the error translator associated with the connection.
	GetErrorTranslator() ErrorTranslator
	// GetMigrator returns the database migrator associated with the connection.
	GetMigrator() Migrator
	// GetDialectName returns the name of the SQL dialect used by the connection.
	GetDialectName() string
}

type ConnectionData struct {
	ConnectionString string
	Driver           string
}

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

type ConnectionFwOptions struct {
	// Postgres defines the PostgresSQL connection information
	Postgres *PostgresInfo `mapstructure:"postgres"`
	// SQLite defines the SQLite connection information
	SQLite *SQLiteInfo
}

type ContextKey string

type Dialect interface {
	Opener
	Migrator
	ErrorTranslator
}

type ErrorTranslator interface {
	// TranslateError translates an SQL error.
	TranslateError(ctx context.Context, originalErr error, defaultError error) error
}

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

type FwOptions struct {
	Connection          Connection
	SQLClientParameters SQLClientParameters
}

type GetVersionOutput struct {
	MigrationVersion
}

type MigrationVersion struct {
	Version     int
	Dirty       bool
	Description string
}

type Migrator interface {
	// OpenConnection opens a connection to the database.
	OpenConnection(ctx context.Context) error
	// InitMigration initializes the migration process.
	InitMigration(ctx context.Context, migrationsTablePrefix *string) error
	// GetMigrationVersion retrieves the current migration version.
	GetMigrationVersion(ctx context.Context) (*GetVersionOutput, error)
	// SetMigrationVersion sets the migration version.
	SetMigrationVersion(ctx context.Context, input SetVersionInput) error
	// RunMigration runs a migration script.
	RunMigration(ctx context.Context, migration string) error
	// CloseConnection closes the connection to the database.
	CloseConnection(ctx context.Context) error
}

type Opener interface {
	// GetConnectionData retrieves connection data from the provided configuration.
	GetConnectionData(config interface{}) (*ConnectionData, error)
	// Connect establishes a database connection using the provided connection data.
	Connect(connectionData ConnectionData) (*sqlx.DB, error)
}

type PostgresInfo struct {
	Host     string `mapstructure:"host" valid:"required~hosts is mandatory in Postgres Connection config"`
	Port     int    `mapstructure:"port" valid:"required~port is mandatory in Postgres Connection config"`
	Scheme   string `mapstructure:"scheme" valid:"required~scheme is mandatory in Postgres Connection config"`
	Username string `mapstructure:"username" valid:"required~username is mandatory in Postgres Connection config"`
	Password string `mapstructure:"password" valid:"required~password is mandatory in Postgres Connection config"`
	SSLMode  string `mapstructure:"sslMode" valid:"required~sslMode is mandatory in Postgres Connection config"`
	Database string `mapstructure:"database" valid:"required~database is mandatory in Postgres Connection config"`
}

type SQLClientParameters struct {
	MaxIdleConnections    *int
	MaxOpenConnections    *int
	MaxConnectionLifetime *int
}

type SQLiteInfo struct {
	// ConnectionString to connect to sqlite databases
	ConnectionString string `valid:"required~connectionString is mandatory in SQLite Connection config"`
}

type SetVersionInput struct {
	MigrationVersion
}