model

type Attribute struct {
	Table string
	Name  string
}

type AttributeMigrate struct {
	Nullable     bool
	FieldName    string
	Name         string
	EscapingName string
	DataType     string
	Default      string
}

type Config interface {
	Name() string
	GetDatabaseConfig() *DatabaseConfig
}

type Connection interface {
	ExecContext(ctx context.Context, query *Query) error
	QueryRowContext(ctx context.Context, query *Query) Row
	QueryContext(ctx context.Context, query *Query) (Rows, error)
}

type DatabaseConfig struct {
	Logger           Logger
	IncludeArguments bool          // include all arguments used on query
	QueryThreshold   time.Duration // query threshold to warning on slow queries
	// contains filtered or unexported fields
}

type Driver interface {
	MigrateContext(context.Context, *Migrator) error // MigrateContext migrates the database schema.

	DropTable(schema, table string) error                        // DropTable drops a table from the database schema.
	DropColumn(schema, table, column string) error               // DropColumn drops a column from a table in the database schema.
	RenameColumn(schema, table, oldColumn, newName string) error // RenameColumn renames a column in a table in the database schema.
	RenameTable(schema, table, newName string) error             // RenameTable renames a table in the database schema.

	AddLogger(Logger, error) error               // AddLogger adds a logger to the database driver.
	ErrorTranslator() func(err error) error      // ErrorTranslator translates database errors.
	KeywordHandler(string) string                // KeywordHandler handles SQL keywords in the database driver.
	FormatTableName(schema, table string) string // FormatTableName formats the table name in the database driver.
	SupportsReturning() bool                     // SupportsReturning checks if the database driver supports RETURNING clause.

	NewConnection() Connection                                                    // NewConnection creates a new database connection.
	NewTransaction(ctx context.Context, opts *sql.TxOptions) (Transaction, error) // NewTransaction creates a new database transaction.

	Init() error        // Init initializes the database schema.
	Close() error       // Close closes the database driver.
	Stats() sql.DBStats // Stats returns the database statistics.
	Config              // Config represents a database configuration.
}

type IndexMigrate struct {
	Name         string
	EscapingName string
	Unique       bool
	Func         string
	Attributes   []AttributeMigrate
}

type JoinType string

type Logger interface {
	InfoContext(ctx context.Context, msg string, kv ...any)
	WarnContext(ctx context.Context, msg string, kv ...any)
	ErrorContext(ctx context.Context, msg string, kv ...any)
}

type ManyToSomeMigrate struct {
	TargetTable          string
	TargetColumn         string
	EscapingTargetTable  string
	EscapingTargetColumn string
	TargetSchema         *string
	AttributeMigrate
}

type Migrator struct {
	Tables  map[string]*TableMigrate
	Schemas []string
	Error   error
}

type OneToSomeMigrate struct {
	IsOneToMany          bool
	TargetTable          string
	TargetColumn         string
	EscapingTargetTable  string
	EscapingTargetColumn string
	TargetSchema         *string
	AttributeMigrate
}

type PrimaryKeyMigrate struct {
	AutoIncrement bool
	AttributeMigrate
}

type Query struct {
	RawSql        string
	Arguments     []any
	QueryDuration time.Duration
	Err           error
}

type QueryType uint

type Row interface {
	Scan(dest ...any) error
}

type Rows interface {
	Close() error
	Next() bool
	Row
}

type SavePoint interface {
	Commit() error
	Rollback() error
}

type Table struct {
	Schema *string
	Name   string
}

type TableMigrate struct {
	Name         string
	EscapingName string
	Schema       *string
	Migrated     bool
	PrimaryKeys  []PrimaryKeyMigrate
	Indexes      []IndexMigrate
	Attributes   []AttributeMigrate
	ManyToSomes  []ManyToSomeMigrate
	OneToSomes   []OneToSomeMigrate
}

type Transaction interface {
	Connection
	Commit() error
	Rollback() error
	SavePoint() (SavePoint, error)
}