sqlserver

README

GORM SQL Server Driver

USAGE

import (
  "gorm.io/driver/sqlserver"
  "gorm.io/gorm"
)

// github.com/microsoft/go-mssqldb
dsn := "sqlserver://gorm:LoremIpsum86@localhost:9930?database=gorm"
db, err := gorm.Open(sqlserver.Open(dsn), &gorm.Config{})

Azure AD Auth

import (
  "github.com/microsoft/go-mssqldb/azuread"
  "gorm.io/driver/sqlserver"
  "gorm.io/gorm"
)

// github.com/microsoft/go-mssqldb
dsn := "sqlserver://gorm:LoremIpsum86@localhost:9930?database=gorm"
dialector := &sqlserver.Dialector{Config: &sqlserver.Config{DSN: dsn, DriverName: azuread.DriverName}}
db, err := gorm.Open(dialector, &gorm.Config{})

Checkout https://gorm.io for details.

Documentation

Index

• func Create(db *gorm.DB)
• func MergeCreate(db *gorm.DB, onConflict clause.OnConflict, values clause.Values)
• func New(config Config) gorm.Dialector
• func Open(dsn string) gorm.Dialector
• func Update(db *gorm.DB)
• type Config
• type Dialector
  • func (dialector Dialector) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{})
  • func (dialector Dialector) ClauseBuilders() map[string]clause.ClauseBuilder
  • func (dialector Dialector) DataTypeOf(field *schema.Field) string
  • func (dialector Dialector) DefaultValueOf(field *schema.Field) clause.Expression
  • func (dialector Dialector) Explain(sql string, vars ...interface{}) string
  • func (dialector Dialector) Initialize(db *gorm.DB) (err error)
  • func (dialector Dialector) Migrator(db *gorm.DB) gorm.Migrator
  • func (dialector Dialector) Name() string
  • func (dialector Dialector) QuoteTo(writer clause.Writer, str string)
  • func (dialectopr Dialector) RollbackTo(tx *gorm.DB, name string) error
  • func (dialectopr Dialector) SavePoint(tx *gorm.DB, name string) error
  • func (dialector Dialector) Translate(err error) error
• type ErrMessage
• type Index
• type Migrator
  • func (m Migrator) AddColumn(value interface{}, name string) error
  • func (m Migrator) AlterColumn(value interface{}, field string) error
  • func (m Migrator) ColumnTypes(value interface{}) ([]gorm.ColumnType, error)
  • func (m Migrator) CreateIndex(value interface{}, name string) error
  • func (m Migrator) CreateTable(values ...interface{}) (err error)
  • func (m Migrator) CurrentDatabase() (name string)
  • func (m Migrator) DefaultSchema() (name string)
  • func (m Migrator) DropTable(values ...interface{}) error
  • func (m Migrator) GetColumnComment(stmt *gorm.Statement, fieldDBName string) (description string)
  • func (m Migrator) GetIndexes(value interface{}) ([]gorm.Index, error)
  • func (m Migrator) GetTables() (tableList []string, err error)
  • func (m Migrator) HasColumn(value interface{}, field string) bool
  • func (m Migrator) HasConstraint(value interface{}, name string) bool
  • func (m Migrator) HasIndex(value interface{}, name string) bool
  • func (m Migrator) HasTable(value interface{}) bool
  • func (m Migrator) MigrateColumn(value interface{}, field *schema.Field, columnType gorm.ColumnType) error
  • func (m Migrator) RenameColumn(value interface{}, oldName, newName string) error
  • func (m Migrator) RenameIndex(value interface{}, oldName, newName string) error
  • func (m Migrator) RenameTable(oldName, newName interface{}) error

Functions

func Create

func Create(db *gorm.DB)

func MergeCreate

func MergeCreate(db *gorm.DB, onConflict clause.OnConflict, values clause.Values)

func New

func New(config Config) gorm.Dialector

func Open

func Open(dsn string) gorm.Dialector

func Update

func Update(db *gorm.DB)

Types

type Config

type Config struct {
	DriverName        string
	DSN               string
	DefaultStringSize int
	Conn              gorm.ConnPool
}

type Dialector

type Dialector struct {
	*Config
}

func (Dialector) BindVarTo

func (dialector Dialector) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{})

func (Dialector) ClauseBuilders

func (dialector Dialector) ClauseBuilders() map[string]clause.ClauseBuilder

func (Dialector) DataTypeOf

func (dialector Dialector) DataTypeOf(field *schema.Field) string

func (Dialector) DefaultValueOf

func (dialector Dialector) DefaultValueOf(field *schema.Field) clause.Expression

func (Dialector) Explain

func (dialector Dialector) Explain(sql string, vars ...interface{}) string

func (Dialector) Initialize

func (dialector Dialector) Initialize(db *gorm.DB) (err error)

func (Dialector) Migrator

func (dialector Dialector) Migrator(db *gorm.DB) gorm.Migrator

func (Dialector) Name

func (dialector Dialector) Name() string

func (Dialector) QuoteTo

func (dialector Dialector) QuoteTo(writer clause.Writer, str string)

func (Dialector) RollbackTo

func (dialectopr Dialector) RollbackTo(tx *gorm.DB, name string) error

func (Dialector) SavePoint

func (dialectopr Dialector) SavePoint(tx *gorm.DB, name string) error

func (Dialector) Translate

func (dialector Dialector) Translate(err error) error

Translate it will translate the error to native gorm errors.

type ErrMessage

type ErrMessage struct {
	Number  int32  `json:"Number"`
	Message string `json:"Message"`
}

type Index

type Index struct {
	TableName    string
	ColumnName   string
	IndexName    string
	IsUnique     sql.NullBool
	IsPrimaryKey sql.NullBool
}

type Migrator

type Migrator struct {
	migrator.Migrator
}

func (Migrator) AddColumn

func (m Migrator) AddColumn(value interface{}, name string) error

func (Migrator) AlterColumn

func (m Migrator) AlterColumn(value interface{}, field string) error

func (Migrator) ColumnTypes

func (m Migrator) ColumnTypes(value interface{}) ([]gorm.ColumnType, error)

ColumnTypes return columnTypes []gorm.ColumnType and execErr error

func (Migrator) CreateIndex

func (m Migrator) CreateIndex(value interface{}, name string) error

func (Migrator) CreateTable

func (m Migrator) CreateTable(values ...interface{}) (err error)

func (Migrator) CurrentDatabase

func (m Migrator) CurrentDatabase() (name string)

func (Migrator) DefaultSchema

func (m Migrator) DefaultSchema() (name string)

func (Migrator) DropTable

func (m Migrator) DropTable(values ...interface{}) error

func (Migrator) GetColumnComment

func (m Migrator) GetColumnComment(stmt *gorm.Statement, fieldDBName string) (description string)

func (Migrator) GetIndexes

func (m Migrator) GetIndexes(value interface{}) ([]gorm.Index, error)

func (Migrator) GetTables

func (m Migrator) GetTables() (tableList []string, err error)

func (Migrator) HasColumn

func (m Migrator) HasColumn(value interface{}, field string) bool

func (Migrator) HasConstraint

func (m Migrator) HasConstraint(value interface{}, name string) bool

func (Migrator) HasIndex

func (m Migrator) HasIndex(value interface{}, name string) bool

func (Migrator) HasTable

func (m Migrator) HasTable(value interface{}) bool

func (Migrator) MigrateColumn

func (m Migrator) MigrateColumn(value interface{}, field *schema.Field, columnType gorm.ColumnType) error

func (Migrator) RenameColumn

func (m Migrator) RenameColumn(value interface{}, oldName, newName string) error

func (Migrator) RenameIndex

func (m Migrator) RenameIndex(value interface{}, oldName, newName string) error

func (Migrator) RenameTable

func (m Migrator) RenameTable(oldName, newName interface{}) error