sqlx

Documentation

Index

• Constants
• func Exec(ctx context.Context, ex Executor, sql string, args ...any) error
• func IsDatabaseConnected(ctx context.Context, db *sql.DB) (perr error)
• func LoadDatabase(addr string, addrConnMax int) (drv string, db *sql.DB, err error)
• func ParseAddress(addr string) (drv, dsn string, err error)
• type DMLInsert
• type DMLLevel
• type Executor
• type Parsed
  • func Parse(drv, sql string) Parsed
• type StatementType
  • func Preview(sql string) StatementType
• type TCLLevel

Constants

const (
	MySQLDialect     = "mysql"
	MariaDBDialect   = MySQLDialect
	PostgresDialect  = "postgres"
	OracleDialect    = "oracle"
	SQLServerDialect = "mssql"
)

const (
	StatementTypeTCLBegin = iota + StatementTypeTCL
	StatementTypeTCLEnd
)

const (
	StatementTypeDMLSingle = iota + StatementTypeDML
	StatementTypeDMLMultiple
)

Functions

func Exec

func Exec(ctx context.Context, ex Executor, sql string, args ...any) error

Exec executes the given SQL with the executor.

func IsDatabaseConnected

func IsDatabaseConnected(ctx context.Context, db *sql.DB) (perr error)

func LoadDatabase

func LoadDatabase(addr string, addrConnMax int) (drv string, db *sql.DB, err error)

func ParseAddress

func ParseAddress(addr string) (drv, dsn string, err error)

Types

type DMLInsert

type DMLInsert struct {
	Prefix string
	Values []string
}

type DMLLevel

type DMLLevel = uint

const (
	SingleSessionDML DMLLevel = iota + 1
	MultiSessionsDML
)

type Executor

type Executor interface {
	ExecContext(ctx context.Context, query string, args ...any) (stdsql.Result, error)
}

type Parsed

type Parsed interface {
	// Origin returns the original SQL.
	Origin() string
	// Unknown returns true if not matched any languages.
	Unknown() bool
	// TCL returns the TCLLevel and true if the Origin is transaction control language.
	TCL() (TCLLevel, bool)
	// DCL returns true if the Origin is data control language.
	DCL() bool
	// DDL returns true if the Origin is data definition language.
	DDL() bool
	// DML returns the DMLLevel and true if the Origin is data manipulation language.
	DML() (DMLLevel, bool)
	// AsDMLInsert returns the structuring insert statement if possible.
	AsDMLInsert() (DMLInsert, bool)
}

func Parse

func Parse(drv, sql string) Parsed

type StatementType

type StatementType = uint

const (
	StatementTypeUnknown StatementType
	StatementTypeTCL
	StatementTypeDCL
	StatementTypeDDL
	StatementTypeDML
)

func Preview

func Preview(sql string) StatementType

Preview analyzes the beginning of the query using a simpler and faster textual comparison to identify the statement type, borrows from the vitess.io/vitess/go/vt/sqlparser.

type TCLLevel

type TCLLevel = uint

const (
	StartTCL TCLLevel = iota + 1
	EndTCL
)