model

type Attribute struct {
	Table string // Table name
	Name  string // Column name
}

type AttributeMigrate struct {
	Nullable     bool   // Whether the column allows null values
	FieldName    string // Go struct field name
	Name         string // Column name
	EscapingName string // Escaped column name
	DataType     string // Data type
	Default      string // Default value
	FieldPos     int    // Field position in struct (for ordering)
}

type ColumnNotFoundError struct {
	Column string
}

type Config interface {
	// Name returns the name of the database
	Name() string
	// GetDatabaseConfig returns the database configuration
	GetDatabaseConfig() *DatabaseConfig
}

type Connection interface {
	// ExecContext executes a SQL statement without returning rows
	ExecContext(ctx context.Context, query *Query) error
	// QueryRowContext executes a SQL query and returns a single row
	QueryRowContext(ctx context.Context, query *Query) Row
	// QueryContext executes a SQL query and returns multiple rows
	QueryContext(ctx context.Context, query *Query) (Rows, error)
}

type DatabaseConfig struct {
	Logger           Logger        // Logger interface for logging
	IncludeArguments bool          // Whether to include arguments in logs
	QueryThreshold   time.Duration // Threshold for slow query warnings
	// contains filtered or unexported fields
}

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

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

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

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

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

type DuplicateIndexError struct {
	TableName string
	IndexName string
}

type FieldNotFoundError struct {
	Field string
}

type ForeignKeyNotFoundError struct {
	ForeignKey string
}

type IndexMigrate struct {
	Name         string             // Index name
	EscapingName string             // Escaped index name
	Unique       bool               // Whether the index is unique
	Func         string             // Index function (e.g., "UPPER")
	Attributes   []AttributeMigrate // Attributes included in the index
}

type JoinType string

type Logger interface {
	// InfoContext logs information messages
	InfoContext(ctx context.Context, msg string, kv ...any)
	// WarnContext logs warning messages
	WarnContext(ctx context.Context, msg string, kv ...any)
	// ErrorContext logs error messages
	ErrorContext(ctx context.Context, msg string, kv ...any)
}

type ManyToSomeMigrate struct {
	TargetTable          string  // Target table name
	TargetColumn         string  // Target column name
	EscapingTargetTable  string  // Escaped target table name
	EscapingTargetColumn string  // Escaped target column name
	TargetSchema         *string // Target schema name
	AttributeMigrate             // Embedded attribute information
}

type Migrator struct {
	Tables  map[string]*TableMigrate // Tables to migrate
	Schemas []string                 // Schemas to use
	Error   error                    // Migration error
}

type NoPrimaryKeyError struct {
	TypeName string
}

type OneToSomeMigrate struct {
	IsOneToMany          bool    // Whether the relationship is one-to-many
	TargetTable          string  // Target table name
	TargetColumn         string  // Target column name
	EscapingTargetTable  string  // Escaped target table name
	EscapingTargetColumn string  // Escaped target column name
	TargetSchema         *string // Target schema name
	AttributeMigrate             // Embedded attribute information
}

type OrderedColumn struct {
	Pos    int // Field position in struct
	IsPK   bool
	PK     *PrimaryKeyMigrate
	Attr   *AttributeMigrate
	OneTo  *OneToSomeMigrate
	ManyTo *ManyToSomeMigrate
}

type PrimaryKeyMigrate struct {
	AutoIncrement    bool // Whether the primary key is auto-incrementing
	AttributeMigrate      // Embedded attribute information
}

type Query struct {
	RawSql        string        // Raw SQL statement
	Arguments     []any         // Query arguments
	QueryDuration time.Duration // Execution duration
	Err           error         // Execution error
}

type QueryType uint

type Row interface {
	// Scan scans the row values into the provided destinations
	Scan(dest ...any) error
}

type Rows interface {
	// Close closes the result set
	Close() error
	// Next advances to the next row
	Next() bool
	// Row represents a single row in the result set
	Row
}

type SavePoint interface {
	// Commit commits the savepoint
	Commit() error
	// Rollback rolls back the savepoint
	Rollback() error
}

type Table struct {
	Schema *string // Schema name (optional)
	Name   string  // Table name
}

type TableMigrate struct {
	Name         string              // Table name
	EscapingName string              // Escaped table name
	Schema       *string             // Schema name
	Migrated     bool                // Whether the table has been migrated
	PrimaryKeys  []PrimaryKeyMigrate // Primary key columns
	Indexes      []IndexMigrate      // Indexes
	Attributes   []AttributeMigrate  // Columns
	ManyToSomes  []ManyToSomeMigrate // Many-to-one/many-to-many relationships
	OneToSomes   []OneToSomeMigrate  // One-to-one/one-to-many relationships
}

type Transaction interface {
	// Connection represents the underlying database connection
	Connection
	// Commit commits the transaction
	Commit() error
	// Rollback rolls back the transaction
	Rollback() error
	// SavePoint creates a savepoint in the transaction
	SavePoint() (SavePoint, error)
}