engine

type BasePlugin struct{}

type Capabilities struct {
	SupportsScratchpad     bool
	SupportsChat           bool
	SupportsGraph          bool
	SupportsSchema         bool
	SupportsDatabaseSwitch bool
	SupportsModifiers      bool
}

type ChatMessage struct {
	Type                 string
	Result               *GetRowsResult
	Text                 string
	RequiresConfirmation bool
}

type Column struct {
	Type             string
	Name             string
	IsNullable       bool
	IsPrimary        bool
	IsAutoIncrement  bool
	IsComputed       bool // Database-managed, generated, etc
	IsForeignKey     bool
	ReferencedTable  *string
	ReferencedColumn *string
	Length           *int // For VARCHAR(n), CHAR(n) types
	Precision        *int // For DECIMAL(p,s) types
	Scale            *int // For DECIMAL(p,s) types
}

type Credentials struct {
	Id          *string  `json:"Id,omitempty"`
	Type        string   `json:"Type"`
	Hostname    string   `json:"Hostname"`
	Username    string   `json:"Username"`
	Password    string   `json:"Password"`
	Database    string   `json:"Database"`
	Advanced    []Record `json:"Advanced,omitempty"`
	AccessToken *string  `json:"AccessToken,omitempty"`
	IsProfile   bool     `json:"IsProfile,omitempty"`
}

type DatabaseMetadata struct {
	DatabaseType    DatabaseType
	TypeDefinitions []TypeDefinition
	Operators       []string
	AliasMap        map[string]string
	Capabilities    Capabilities
}

type DatabaseType string

type Engine struct {
	Plugins           []*Plugin
	LoginProfiles     []types.DatabaseCredentials
	ProfileRetrievers []LoginProfileRetriever
}

type ExternalModel struct {
	Type     string // Provider type: "OpenAI", "Anthropic", "Ollama", etc.
	Token    string // API key
	Model    string // User-selected model: "gpt-4o", "claude-sonnet-4", etc.
	Endpoint string // Base URL (for Ollama/generic providers)
}

type ForeignKeyRelationship struct {
	ColumnName       string
	ReferencedTable  string
	ReferencedColumn string
}

type GetRowsRequest struct {
	Schema      string
	StorageUnit string
	Where       *model.WhereCondition
	Sort        []*model.SortCondition
	PageSize    int
	PageOffset  int
}

type GetRowsResult struct {
	Columns       []Column
	Rows          [][]string
	DisableUpdate bool
	TotalCount    int64
}

type GraphUnit struct {
	Unit      StorageUnit
	Relations []GraphUnitRelationship
}

type GraphUnitRelationship struct {
	Name             string
	RelationshipType GraphUnitRelationshipType
	SourceColumn     *string
	TargetColumn     *string
}

type GraphUnitRelationshipType string

type LoginProfileRetriever func() ([]types.DatabaseCredentials, error)

type Plugin struct {
	PluginFunctions
	Type DatabaseType
}

type PluginConfig struct {
	Credentials           *Credentials
	ExternalModel         *ExternalModel
	Transaction           any      // Optional transaction for transactional operations (e.g., *gorm.DB for SQL plugins)
	MultiStatement        bool     // Hint for plugins that need special handling for multi-statement scripts (e.g., MySQL)
	UpsertPKColumns       []string // PK columns for ON CONFLICT DO UPDATE; non-nil = upsert mode
	SkipConflictPKColumns []string // PK columns for ON CONFLICT DO NOTHING (append mode — skip duplicate rows)
}

type PluginFunctions interface {
	GetDatabases(config *PluginConfig) ([]string, error)
	IsAvailable(ctx context.Context, config *PluginConfig) bool
	GetAllSchemas(config *PluginConfig) ([]string, error)
	GetStorageUnits(config *PluginConfig, schema string) ([]StorageUnit, error)
	StorageUnitExists(config *PluginConfig, schema string, storageUnit string) (bool, error)
	AddStorageUnit(config *PluginConfig, schema string, storageUnit string, fields []Record) (bool, error)
	UpdateStorageUnit(config *PluginConfig, schema string, storageUnit string, values map[string]string, updatedColumns []string) (bool, error)
	AddRow(config *PluginConfig, schema string, storageUnit string, values []Record) (bool, error)
	AddRowReturningID(config *PluginConfig, schema string, storageUnit string, values []Record) (int64, error)
	BulkAddRows(config *PluginConfig, schema string, storageUnit string, rows [][]Record) (bool, error)
	DeleteRow(config *PluginConfig, schema string, storageUnit string, values map[string]string) (bool, error)
	GetRows(config *PluginConfig, req *GetRowsRequest) (*GetRowsResult, error)
	GetRowCount(config *PluginConfig, schema string, storageUnit string, where *model.WhereCondition) (int64, error)
	GetGraph(config *PluginConfig, schema string) ([]GraphUnit, error)
	RawExecute(config *PluginConfig, query string, params ...any) (*GetRowsResult, error)
	Chat(config *PluginConfig, schema string, previousConversation string, query string) ([]*ChatMessage, error)
	ExportData(config *PluginConfig, schema string, storageUnit string, writer func([]string) error, selectedRows []map[string]any) error
	FormatValue(val any) string
	GetColumnsForTable(config *PluginConfig, schema string, storageUnit string) ([]Column, error)

	// MarkGeneratedColumns enriches columns with auto-increment and computed column flags
	// by querying database-specific system catalogs
	MarkGeneratedColumns(config *PluginConfig, schema string, storageUnit string, columns []Column) error

	// Mock data generation methods
	GetColumnConstraints(config *PluginConfig, schema string, storageUnit string) (map[string]map[string]any, error)
	ClearTableData(config *PluginConfig, schema string, storageUnit string) (bool, error)
	NullifyFKColumn(config *PluginConfig, schema string, storageUnit string, column string) error

	// Foreign key detection
	GetForeignKeyRelationships(config *PluginConfig, schema string, storageUnit string) (map[string]*ForeignKeyRelationship, error)

	// Transaction support
	WithTransaction(config *PluginConfig, operation func(tx any) error) error

	// Database metadata for frontend type/operator configuration
	GetDatabaseMetadata() *DatabaseMetadata

	// GetSSLStatus returns the verified SSL/TLS status of the current connection.
	// Returns nil if SSL status cannot be determined (e.g., SQLite) or is not applicable.
	GetSSLStatus(config *PluginConfig) (*SSLStatus, error)
}

type Record struct {
	Key   string            `json:"Key"`
	Value string            `json:"Value"`
	Extra map[string]string `json:"Extra,omitempty"`
}

type SSLStatus struct {
	IsEnabled bool   // Whether SSL/TLS is active on the current connection
	Mode      string // SSL mode: disabled, required, verify-ca, verify-identity, etc.
}

type StorageUnit struct {
	Name       string
	Attributes []Record
}

type TypeCategory string

type TypeDefinition struct {
	ID               string       // Canonical type name (e.g., "VARCHAR", "INTEGER")
	Label            string       // Display label for UI (e.g., "varchar", "integer")
	HasLength        bool         // Shows length input when selected (VARCHAR, CHAR)
	HasPrecision     bool         // Shows precision/scale inputs (DECIMAL, NUMERIC)
	DefaultLength    *int         // Default length for types with HasLength
	DefaultPrecision *int         // Default precision for types with HasPrecision
	Category         TypeCategory // Type category for grouping
	InsertFunc       string       // Function to wrap INSERT values (e.g. "TO_BITMAP"), empty for normal types
	TableModel       string       // Required table key model (e.g. "AGGREGATE"), empty for normal types
	DDLSuffix        string       // Appended after type in CREATE TABLE (e.g. "BITMAP_UNION"), empty for normal types
}

type UnsupportedTypeError struct {
	TypeName     string
	DatabaseType string
}