mysql

package
v1.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 8, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package mysql provides a database provider for MySQL and MariaDB.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider implements the Provider interface for MySQL

func New

func New() *Provider

New creates a new MySQL provider

func (*Provider) ConvertFieldType

func (p *Provider) ConvertFieldType(field *types.Field) string

ConvertFieldType converts YAML field type to MySQL-specific SQL type

func (*Provider) GenerateAddColumn

func (p *Provider) GenerateAddColumn(tableName string, field *types.Field) string

GenerateAddColumn generates ALTER TABLE ADD COLUMN statement. The DEFAULT clause is emitted when field.Default is non-empty (already resolved from symbolic keys by resolveFieldDefault before this is called).

func (*Provider) GenerateAlterColumn

func (p *Provider) GenerateAlterColumn(tableName string, oldField, newField *types.Field) (string, error)

GenerateAlterColumn generates an ALTER TABLE MODIFY COLUMN statement for MySQL.

func (*Provider) GenerateCreateIndex

func (p *Provider) GenerateCreateIndex(index *types.Index, tableName string) string

GenerateCreateIndex generates CREATE INDEX statement for MySQL. MySQL supports Method (USING clause for index type) but does not support WHERE clauses.

func (*Provider) GenerateCreateTable

func (p *Provider) GenerateCreateTable(schema *types.Schema, table *types.Table) (string, error)

GenerateCreateTable generates the CREATE TABLE SQL statement for the given table.

func (*Provider) GenerateDropColumn

func (p *Provider) GenerateDropColumn(tableName, columnName string) string

GenerateDropColumn generates ALTER TABLE DROP COLUMN statement

func (*Provider) GenerateDropForeignKeyConstraint

func (p *Provider) GenerateDropForeignKeyConstraint(tableName, constraintName string) string

GenerateDropForeignKeyConstraint generates an ALTER TABLE DROP FOREIGN KEY statement for MySQL.

func (*Provider) GenerateDropIndex

func (p *Provider) GenerateDropIndex(indexName, tableName string) string

GenerateDropIndex generates DROP INDEX statement for MySQL

func (*Provider) GenerateDropTable

func (p *Provider) GenerateDropTable(tableName string) string

GenerateDropTable generates DROP TABLE statement

func (*Provider) GenerateDropTableCascade

func (p *Provider) GenerateDropTableCascade(tableName string) string

GenerateDropTableCascade generates DROP TABLE IF EXISTS statement for MySQL. MySQL does not support CASCADE on DROP TABLE; foreign key constraints must be dropped separately before dropping the table. IF EXISTS is used to prevent errors if the table does not exist, matching the behaviour callers expect for rollback scenarios.

func (*Provider) GenerateForeignKeyConstraint

func (p *Provider) GenerateForeignKeyConstraint(tableName, fieldName, referencedTable, constraintName, onDelete, onUpdate string) string

GenerateForeignKeyConstraint generates an ALTER TABLE statement to add a foreign key constraint.

func (*Provider) GenerateForeignKeyConstraints

func (p *Provider) GenerateForeignKeyConstraints(schema *types.Schema, junctionTables []types.Table) string

GenerateForeignKeyConstraints generates all foreign key constraint SQL statements for a schema.

func (*Provider) GenerateIndexes

func (p *Provider) GenerateIndexes(schema *types.Schema) string

GenerateIndexes generates CREATE INDEX statements for all tables in the schema.

func (*Provider) GenerateJunctionTable

func (p *Provider) GenerateJunctionTable(table1, table2 string, schema *types.Schema) (string, error)

GenerateJunctionTable generates the CREATE TABLE SQL for a many-to-many junction table.

func (*Provider) GenerateRenameColumn

func (p *Provider) GenerateRenameColumn(tableName, oldName, newName string) string

GenerateRenameColumn generates ALTER TABLE CHANGE statement for MySQL

func (*Provider) GenerateRenameTable

func (p *Provider) GenerateRenameTable(oldName, newName string) string

GenerateRenameTable generates RENAME TABLE statement

func (*Provider) GenerateUpsert

func (p *Provider) GenerateUpsert(table string, conflictKeys []string, columns []string, valueLiterals [][]string) string

GenerateUpsert generates a MySQL INSERT ... ON DUPLICATE KEY UPDATE statement. MySQL identifies conflicts automatically via unique indexes, so conflictKeys is accepted for interface compatibility but not used in the generated SQL.

func (*Provider) GetDatabaseSchema

func (p *Provider) GetDatabaseSchema(connectionString string) (*types.Schema, error)

GetDatabaseSchema extracts schema information from a MySQL database

func (*Provider) GetDefaultValue

func (p *Provider) GetDefaultValue(defaultRef string, defaults map[string]string) (string, error)

GetDefaultValue converts default value references to MySQL-specific values

func (*Provider) HistoryTableDDL

func (p *Provider) HistoryTableDDL() string

HistoryTableDDL returns the CREATE TABLE IF NOT EXISTS statement for the morphic_history migration-tracking table, using this provider's SQL dialect.

func (*Provider) InferForeignKeyType

func (p *Provider) InferForeignKeyType(referencedTable string, schema *types.Schema) string

InferForeignKeyType returns the SQL type to use for a foreign key column referencing the given table.

func (*Provider) IsAlreadyExistsError

func (p *Provider) IsAlreadyExistsError(err error) bool

IsAlreadyExistsError returns true when err indicates an object already exists in the database.

func (*Provider) IsNotFoundError

func (p *Provider) IsNotFoundError(err error) bool

IsNotFoundError returns true when err is a MySQL "unknown table" or "can't drop key" error (codes 1051 and 1091).

func (*Provider) Placeholder

func (p *Provider) Placeholder(_ int) string

Placeholder returns the bind-parameter placeholder for the nth argument (1-indexed).

func (*Provider) QuoteName

func (p *Provider) QuoteName(name string) string

QuoteName quotes database identifiers for MySQL

func (*Provider) SetTypeMappings

func (p *Provider) SetTypeMappings(mappings map[string]string)

SetTypeMappings sets user-defined type mappings for this provider.

func (*Provider) SupportsOperation

func (p *Provider) SupportsOperation(operation string) bool

SupportsOperation checks if MySQL supports a specific operation

func (*Provider) TableColumns added in v1.12.0

func (p *Provider) TableColumns(db *sql.DB, tableName string) ([]string, error)

TableColumns is not yet implemented for MySQL.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL