Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

dialect

package

Go to main page

Versions in this module

v1

v1.2.1

Sep 11, 2026

v1.2.0

Aug 27, 2026

v1.1.1

Aug 26, 2026

v1.1.0

Aug 26, 2026

v1.0.0

Aug 21, 2026

v0

v0.2.4

Sep 11, 2026

Changes in this version

+ const DefaultBufferSize

+ const MigrationCommentPrefix

+ const MigrationDown

+ const MigrationUp

+ const PreRetTypeCallCallback

+ const PreRetTypeContinue

+ const PreRetTypeReturn

+ func GetSupportSqlDialect() []string

+ func NewSQLParseError(errorType, message string, lineNum int, lineText string) error

+ func ReadSQLFile(r io.Reader, callback FuncSQLStmtCallback, ...) error

+ func RegisterSqlDialect(dbtype string, sql any)

+ func WithBufferSize(size int) func(*ReadSQLFileOptions)

+ func WithFilter(filter []string) func(*ReadSQLFileOptions)

+ func WithMigrationMode(mode string) func(*ReadSQLFileOptions)

+ func WithPreProcessSqlLine(callback FuncPreProcessSqlLine) func(*ReadSQLFileOptions)

+ func WithWordCallback(callback ProcessWordCallback) func(*ReadSQLFileOptions)

+ type CRUDSqlFuncName string

+ const FuncNameGetDeleteSql

+ const FuncNameGetInsertSql

+ const FuncNameGetReplaceSql

+ const FuncNameGetSelectSql

+ const FuncNameGetUpdateSql

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

+ type DDLSqlFuncName string

+ const FuncNameGetBeginSql

+ const FuncNameGetCreateFunctionSql

+ const FuncNameGetCreateProcedureSql

+ const FuncNameGetCreateTableSql

+ const FuncNameGetCreateViewSql

+ const FuncNameGetEndSql

+ const FuncNameGetTableEventSql

+ type DatabaseObjectType string

+ const ObjectTypeFunction

+ const ObjectTypeProcedure

+ const ObjectTypeSequence

+ const ObjectTypeTable

+ const ObjectTypeTrigger

+ const ObjectTypeView

+ type DatabaseTransformer interface

+ BuildPagination func(limit, offset string) string

+ EscapeColumnName func(columnName string) string

+ EscapeTableName func(tableName string) string

+ SupportsBatch func() bool

+ WithSubType func(subType string) any

+ func GetSqlTransformer(dbtype string, dbSubType ...string) (DatabaseTransformer, bool)

+ type ExtraData interface

+ IsBlockEnd func(string) bool

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

+ type FuncSQLStmtCallback func(sqlStatement *SQLBlock) error

+ type IndexInfo struct

+ Columns []string

+ IsPrimary bool

+ IsUnique bool

+ Name string

+ type MigrationDialect interface

+ EscapeColumnName func(columnName string) string

+ EscapeTableName func(tableName string) string

+ GenerateAddColumnSQL func(tableName string, field def.ColumnInfo) string

+ GenerateAddIndexSQL func(tableName string, field def.ColumnInfo) string

+ GenerateAlterColumnTypeSQL func(tableName string, field def.ColumnInfo) string

+ GenerateCompositeForeignKeySQL func(tableName string, fk def.CompositeForeignKey) string

+ GenerateCompositeIndexSQL func(tableName string, index def.CompositeIndex) string

+ GenerateCreateTableSQL func(tableInfo def.TableInfo) string

+ GenerateDropConstraintSQL func(tableName string, constraintType string, constraintName string) string

+ GenerateDropIndexSQL func(tableName string, indexName string) string

+ GenerateRenameColumnSQL func(tableName, oldColumnName string, fieldInfo def.ColumnInfo) string

+ NormalizeColumnType func(fieldType def.StandardFieldType) def.StandardFieldType

+ WithSubType func(subType string) any

+ func GetMigrationDialect(dbtype string, dbSubType ...string) (MigrationDialect, bool)

+ type ParseContext struct

+ BlockIndex int

+ CurrentLineNum int

+ CurrentStmt strings.Builder

+ CurrentType SQLType

+ ExpectedStringEnd string

+ Extra ExtraData

+ Filter []string

+ HasContent bool

+ IsMultiLineComment bool

+ LineContent string

+ PreProcessSqlLine FuncPreProcessSqlLine

+ StartLineNum int

+ TraceWord *TraceWord

+ TypeWord string

+ WordCallback ProcessWordCallback

+ func (ctx *ParseContext) ReadSQLCallback(callback FuncSQLStmtCallback) error

+ func (pc *ParseContext) IsBlockEnd(line string) bool

+ func (pc *ParseContext) IsCurrentTypeNull() bool

+ func (pc *ParseContext) Reset()

+ type PreRetType int

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

+ type RawBlockMarker interface

+ InRawBlock func() bool

+ type ReadSQLFileOptions struct

+ BufferSize int

+ Filter []string

+ MigrationMode string

+ PreProcessSqlLine FuncPreProcessSqlLine

+ WordCallback ProcessWordCallback

+ func NewReadSQLFileOptions(options ...func(*ReadSQLFileOptions)) ReadSQLFileOptions

+ type SQLBlock struct

+ Content string

+ EndLine int

+ Index int

+ StartLine int

+ Type string

+ type SQLDialect interface

+ AnalyzeSQL func(cli def.DatabaseClient, sql string) (*def.SQLImpact, error)

+ EnsureDBExists func(cli def.DatabaseClient, dbName string) error

+ ExplainSQL func(cli def.DatabaseClient, sql string) (def.QueryResult, error)

+ GetConnectStr func(dbConn *def.DBConnection) (string, string)

+ GetDDLEmbedFiles func() (*embed.FS, error)

+ GetDDLSqlFunc func(funcName DDLSqlFuncName) (DDLSqlFunc, error)

+ GetDatabases func(cli def.DatabaseClient) ([]string, error)

+ GetIndexes func(cli def.DatabaseClient, dbName, schema, tableName string) ([]IndexInfo, error)

+ GetObjects func(cli def.DatabaseClient, dbName string, schema *string, ...) ([]string, error)

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

+ GetSchemaObjects func(cli def.DatabaseClient, dbName, schema string) (*SchemaObjects, error)

+ GetSchemaSummaries func(cli def.DatabaseClient, dbName string) ([]SchemaSummary, error)

+ GetSchemas func(cli def.DatabaseClient, dbName string) ([]string, error)

+ GetSortedSqlFunc func(funcName SortFuncName) (SortedSqlFunc, error)

+ GetTableInfo func(cli def.DatabaseClient, database, tableName string) (def.TableInfo, error)

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

+ GetWriteCapability func() WriteCapability

+ IsTableExist func(cli def.DatabaseClient, tableName string) (bool, error)

+ ObjectExists func(cli def.DatabaseClient, objectName string, objectType DatabaseObjectType) (bool, error)

+ ReadSQLFile func(r io.Reader, callback FuncSQLStmtCallback, ...) error

+ ResumeConstraintChecksSQL func() string

+ SuspendConstraintChecksSQL func() string

+ ValidateSQL func(cli def.DatabaseClient, sql string) *def.ValidationError

+ WithSubType func(subType string) any

+ func GetSqlDialect(dbtype string, dbSubType ...string) (SQLDialect, bool)

+ type SQLParseError struct

+ ErrorType string

+ LineNum int

+ LineText string

+ Message string

+ func (e *SQLParseError) Error() string

+ type SQLType interface

+ AsInt func() int

+ IsBlock func() bool

+ IsNull func() bool

+ String func() string

+ type SchemaObjects struct

+ Functions []string

+ Procedures []string

+ Tables []string

+ Views []string

+ type SchemaSummary struct

+ Name string

+ TableCount int

+ type SortFuncName string

+ const FuncNameSortFunctions

+ const FuncNameSortProcedures

+ const FuncNameSortTables

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

+ type SqlContent struct

+ Content string

+ Name string

+ type TraceWord struct

+ Key string

+ NextKeys map[string]SQLType

+ Skip int

+ type WriteCapability struct

+ MaxBindParams int

+ MultiRowInsertValues bool

+ ReplaceNeedsConflictColumns bool

+ UpsertNeedsConflictColumns bool

+ func DefaultWriteCapability() WriteCapability