dialect

type CRUDSqlFuncName string

type DDLSqlFunc func(cli def.DatabaseClient, name ...string) (*SqlContent, error)

type DDLSqlFuncName string

type DatabaseObjectType string

type DatabaseTransformer interface {
	WithSubType(subType string) any
	EscapeTableName(tableName string) string
	EscapeColumnName(columnName string) string
	BuildPagination(limit, offset string) string
	SupportsBatch() bool
}

type ExtraData interface {
	IsBlockEnd(string) bool
}

type FuncPreProcessSqlLine func(ctx *ParseContext, pline *string) (PreRetType, error)

type FuncSQLStmtCallback func(sqlStatement *SQLBlock) error

type IndexInfo struct {
	Name      string   `db:"index_name"`
	Columns   []string `db:"-"`
	IsUnique  bool     `db:"is_unique"`
	IsPrimary bool     `db:"is_primary"`
}

type MigrationDialect interface {
	// WithSubType returns a new dialect instance with the specified subtype
	WithSubType(subType string) any

	// GetTableName returns the properly quoted table name for the database
	EscapeTableName(tableName string) string

	// GetColumnName returns the properly quoted column name for the database
	EscapeColumnName(columnName string) string

	// GenerateCreateTableSQL generates CREATE TABLE SQL for the dialect
	GenerateCreateTableSQL(tableInfo def.TableInfo) string

	// GenerateAddColumnSQL generates ALTER TABLE ADD COLUMN SQL for the dialect
	GenerateAddColumnSQL(tableName string, field def.ColumnInfo) string

	// GenerateAddIndexSQL generates CREATE INDEX SQL for the dialect
	GenerateAddIndexSQL(tableName string, field def.ColumnInfo) string

	GenerateDropIndexSQL(tableName string, indexName string) string

	GenerateDropConstraintSQL(tableName string, constraintType string, constraintName string) string
	// GenerateCompositeForeignKeySQL generates SQL for composite foreign key constraints
	GenerateCompositeForeignKeySQL(tableName string, fk def.CompositeForeignKey) string
	// GenerateCompositeIndexSQL generates SQL for composite indexes
	GenerateCompositeIndexSQL(tableName string, index def.CompositeIndex) string
	// GenerateRenameColumnSQL generates SQL to rename a column
	// oldColumnName: the current column name in the database
	// fieldInfo: the field information containing the new column name (ColumnName) and type
	GenerateRenameColumnSQL(tableName, oldColumnName string, fieldInfo def.ColumnInfo) string
	// GenerateAlterColumnTypeSQL generates SQL to alter an existing column type
	GenerateAlterColumnTypeSQL(tableName string, field def.ColumnInfo) string

	// NormalizeColumnType returns the normalized/effective column type for comparison
	// This is useful for databases like SQLite where INTEGER represents all integer types
	// Default implementation should return the type as-is
	NormalizeColumnType(fieldType def.StandardFieldType) def.StandardFieldType
}

type ParseContext struct {
	// CurrentStmt 当前正在构建的 SQL 语句
	CurrentStmt strings.Builder
	// StartLineNum 当前语句的起始行号
	StartLineNum int
	// CurrentLineNum 当前处理的行号
	CurrentLineNum int
	// LineContent 当前行的内容
	LineContent string
	// HasContent 标记当前是否有内容正在处理
	HasContent bool
	// BlockIndex 块索引，用于标识 SQL 语句块
	BlockIndex int
	// CurrentType 当前 SQL 语句的类型
	CurrentType SQLType
	// TypeWord 类型关键字
	TypeWord string
	// TraceWord 用于跟踪关键字
	TraceWord *TraceWord
	// ExpectedStringEnd 期望的字符串结束标记
	ExpectedStringEnd string
	// IsMultiLineComment 是否在多行注释中
	IsMultiLineComment bool
	// Filter SQL 过滤器
	Filter []string
	// Extra 额外的特定于方言的数据
	Extra ExtraData
	// WordCallback 处理单词的回调函数
	WordCallback ProcessWordCallback
	// PreProcessSqlLine 预处理 SQL 行的回调函数
	PreProcessSqlLine FuncPreProcessSqlLine
}

type PreRetType int

type ProcessWordCallback func(ctx *ParseContext, word *cyutil.WordInfo) (bool, error)

type RawBlockMarker interface {
	InRawBlock() bool
}

type ReadSQLFileOptions struct {
	// BufferSize 扫描器的缓冲区大小
	BufferSize int
	// MigrationMode 迁移模式过滤器 ("Up", "Down" 或空字符串表示不过滤)
	MigrationMode string
	// Filter SQL 过滤器，用于过滤特定类型的 SQL 语句
	Filter []string

	// WordCallback 单词回调函数，用于处理 SQL 语句中的单词
	WordCallback ProcessWordCallback

	// PreProcessSqlLine 预处理 SQL 行的回调函数
	PreProcessSqlLine FuncPreProcessSqlLine
}

type SQLBlock struct {
	Index     int
	StartLine int
	EndLine   int
	Type      string
	Content   string
}

type SQLDialect interface {
	WithSubType(subType string) any
	// DDL operations
	GetDDLSqlFunc(funcName DDLSqlFuncName) (DDLSqlFunc, error)
	GetSortedSqlFunc(funcName SortFuncName) (SortedSqlFunc, error)
	GetDDLEmbedFiles() (*embed.FS, error)

	// Schema operations - using def.DatabaseClient instead of specific type
	GetTableInfo(cli def.DatabaseClient, database, tableName string) (def.TableInfo, error)
	IsTableExist(cli def.DatabaseClient, tableName string) (bool, error)
	ObjectExists(cli def.DatabaseClient, objectName string, objectType DatabaseObjectType) (bool, error)

	EnsureDBExists(cli def.DatabaseClient, dbName string) error
	ReadSQLFile(r io.Reader, callback FuncSQLStmtCallback, options ...func(*ReadSQLFileOptions)) error
	GetConnectStr(dbConn *def.DBConnection) (string, string)

	ValidateSQL(cli def.DatabaseClient, sql string) *def.ValidationError
	AnalyzeSQL(cli def.DatabaseClient, sql string) (*def.SQLImpact, error)

	// ExplainSQL returns the execution plan for the provided SQL
	// Dialect implementations should handle database-specific explain semantics
	ExplainSQL(cli def.DatabaseClient, sql string) (def.QueryResult, error)

	GetTables(cli def.DatabaseClient, dbName string, schema *string, keyword *string) ([]string, error)

	// GetIndexes 返回表索引列表。
	GetIndexes(cli def.DatabaseClient, dbName, schema, tableName string) ([]IndexInfo, error)

	// GetDatabases 返回数据库列表。
	GetDatabases(cli def.DatabaseClient) ([]string, error)

	// GetSchemas 返回指定库内的 schema/模式列表（PG 系为用户 schema；
	// MySQL/SQLite 无 schema 概念返回空；Oracle 返回用户列表）。
	GetSchemas(cli def.DatabaseClient, dbName string) ([]string, error)

	// GetSchemaSummaries 返回库内用户 schema 列表及每 schema 的表计数（PG 系一次往返；
	// 非 PG 系返回空，调用方应回退 GetObjects/GetTables 逐库枚举）。
	GetSchemaSummaries(cli def.DatabaseClient, dbName string) ([]SchemaSummary, error)

	// GetSchemaObjects 一次往返枚举 schema 内全部对象（表/视图/函数/过程）；
	// 非 PG 系返回空对象（与 GetSchemaSummaries 口径一致，调用方无需区分）。
	GetSchemaObjects(cli def.DatabaseClient, dbName, schema string) (*SchemaObjects, error)

	// GetObjects 枚举指定库/schema 内某类对象的名称列表（与 GetTables 对称的元数据能力）。
	// TABLE 类型应使用 GetTables；不支持的对象类型返回错误
	GetObjects(cli def.DatabaseClient, dbName string, schema *string, objectType DatabaseObjectType) ([]string, error)

	GetReplaceSql(rd def.RowData) (string, error)

	// SuspendConstraintChecksSQL 返回挂起会话级外键/触发器校验的 SQL（空串表示方言不支持，
	// 如 Oracle 需逐约束 DISABLE CONSTRAINT）。会话级语句，调用方须先钉单连接
	// （PinSingleConnection）保证开关与后续写入同连接
	SuspendConstraintChecksSQL() string
	// ResumeConstraintChecksSQL 返回恢复校验的 SQL（空串表示不支持），与 SuspendConstraintChecksSQL 成对
	ResumeConstraintChecksSQL() string

	// GetWriteCapability 返回该方言的批量写入能力（多行 VALUES 支持、绑定参数上限、冲突列要求），
	// 调用方按能力决策语句形态，不感知具体方言
	GetWriteCapability() WriteCapability
}

type SQLParseError struct {
	// Message 错误消息
	Message string
	// LineNum 发生错误的行号
	LineNum int
	// LineText 发生错误的行文本
	LineText string
	// ErrorType 错误类型
	ErrorType string
}

type SQLType interface {
	// AsInt 返回 SQL 类型的整数表示
	AsInt() int
	// String 返回 SQL 类型的字符串表示
	String() string
	// IsBlock 判断该 SQL 类型是否为块级语句（如存储过程、函数等）
	IsBlock() bool

	// IsNull 判断该 SQL 类型是否为空
	IsNull() bool
}

type SchemaObjects struct {
	Tables     []string `json:"tables"`
	Views      []string `json:"views"`
	Functions  []string `json:"functions"`
	Procedures []string `json:"procedures"`
}

type SchemaSummary struct {
	Name       string `json:"name"`
	TableCount int    `json:"tableCount"` // 表数量（视图/函数等不计入）
}

type SortFuncName string

type SortedSqlFunc func(cli def.DatabaseClient, names []string) ([]*SqlContent, error)

type SqlContent struct {
	Name    string
	Content string
}

type TraceWord struct {
	// Key 表示当前关键字
	Key string
	// Skip 表示跳过的字符数
	Skip int
	// NextKeys 表示可能的下一个关键字及其对应的 SQL 类型
	NextKeys map[string]SQLType
}

type WriteCapability struct {
	// MultiRowInsertValues 报告 INSERT ... VALUES 子句是否支持一次写多行
	// （含 REPLACE/upsert 语义的等价多值形式，如 REPLACE INTO t (...) VALUES (...),(...)）
	MultiRowInsertValues bool
	// MaxBindParams 单条语句绑定参数个数上限（0 表示无已知硬限制）。
	// 多值语句总参数量为 行数×列数，调用方据此对批量分块
	MaxBindParams int
	// ReplaceNeedsConflictColumns 报告 REPLACE 语义写入是否需要显式冲突列
	// （如 PG ON CONFLICT (...) / Oracle MERGE ON；MySQL REPLACE、SQLite INSERT OR REPLACE
	// 依赖唯一键自动判定，无需冲突列）
	ReplaceNeedsConflictColumns bool
	// UpsertNeedsConflictColumns 报告 UPSERT 语义写入是否需要显式冲突列
	// （如 PG/SQLite ON CONFLICT (...) / Oracle MERGE ON；MySQL ON DUPLICATE KEY UPDATE 依赖唯一键自动判定）
	UpsertNeedsConflictColumns bool
}