mssql

package module
v0.0.0-...-cc2985e Latest Latest
Warning

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

 Go to latest Published: May 3, 2016 License: BSD-3-Clause Imports: 26 Imported by: 0

README

A pure Go MSSQL driver for Go's database/sql package

Install

go get github.com/denisenkom/go-mssqldb

Tests

go test is used for testing. A running instance of MSSQL server is required. Environment variables are used to pass login information.

Example:

env HOST=localhost SQLUSER=sa SQLPASSWORD=sa DATABASE=test go test

Connection Parameters

  • "server" - host or host\instance (default localhost)
  • "port" - used only when there is no instance in server (default 1433)
  • "failoverpartner" - host or host\instance (default is no partner). Used only until a successful connection has been made; thereafter, the partner provided in the first successful connection is used.
  • "failoverport" - used only when there is no instance in failoverpartner (default 1433)
  • "user id" - enter the SQL Server Authentication user id or the Windows Authentication user id in the DOMAIN\User format. On Windows, if user id is empty or missing Single-Sign-On is used.
  • "password"
  • "database"
  • "connection timeout" - in seconds (default is 30)
  • "dial timeout" - in seconds (default is 5)
  • "keepAlive" - in seconds; 0 to disable (default is 0)
  • "log" - logging flags (default 0/no logging, 63 for full logging)
    • 1 log errors
    • 2 log messages
    • 4 log rows affected
    • 8 trace sql statements
    • 16 log statement parameters
    • 32 log transaction begin/end
  • "encrypt"
    • disable - Data send between client and server is not encrypted.
    • false - Data sent between client and server is not encrypted beyond the login packet. (Default)
    • true - Data sent between client and server is encrypted.
  • "TrustServerCertificate"
    • false - Server certificate is checked. Default is false if encypt is specified.
    • true - Server certificate is not checked. Default is true if encrypt is not specified. If trust server certificate is true, driver accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man-in-the-middle attacks. This should be used only for testing.
  • "certificate" - The file that contains the public key certificate of the CA that signed the SQL Server certificate. The specified certificate overrides the go platform specific CA certificates.
  • "hostNameInCertificate" - Specifies the Common Name (CN) in the server certificate. Default value is the server host.
  • "ServerSPN" - The kerberos SPN (Service Principal Name) for the server. Default is MSSQLSvc/host:port.
  • "Workstation ID" - The workstation name (default is the host name)
  • "app name" - The application name (default is go-mssqldb)
  • "ApplicationIntent" - Can be given the value "ReadOnly" to initiate a read-only connection to an Availability Group listener.

Example:

    db, err := sql.Open("mssql", "server=localhost;user id=sa")

Statement Parameters

In the SQL statement text, literals may be replaced by a parameter that matches one of the following:

  • ?
  • ?nnn
  • :nnn
  • $nnn

where nnn represents an integer that specifies a 1-indexed positional parameter. Ex:

db.Query("SELECT * FROM t WHERE a = ?3, b = ?2, c = ?1", "x", "y", "z")

will expand to roughly

SELECT * FROM t WHERE a = 'z', b = 'y', c = 'x'

Features

  • Can be used with SQL Server 2005 or newer
  • Can be used with Microsoft Azure SQL Database
  • Can be used on all go supported platforms (e.g. Linux, Mac OS X and Windows)
  • Supports new date/time types: date, time, datetime2, datetimeoffset
  • Supports string parameters longer than 8000 characters
  • Supports encryption using SSL/TLS
  • Supports SQL Server and Windows Authentication
  • Supports Single-Sign-On on Windows
  • Supports connections to AlwaysOn Availability Group listeners, including re-direction to read-only replicas.
  • Supports query notifications

Known Issues

  • SQL Server 2008 and 2008 R2 engine cannot handle login records when SSL encryption is not disabled. To fix SQL Server 2008 R2 issue, install SQL Server 2008 R2 Service Pack 2. To fix SQL Server 2008 issue, install Microsoft SQL Server 2008 Service Pack 3 and Cumulative update package 3 for SQL Server 2008 SP3. More information: http://support.microsoft.com/kb/2653857

Documentation

Overview

Transaction Manager requests http://msdn.microsoft.com/en-us/library/dd339887.aspx

Index

Constants

View Source 
const (
	NEGOTIATE_MESSAGE    = 1
	CHALLENGE_MESSAGE    = 2
	AUTHENTICATE_MESSAGE = 3
)
View Source 
const (
	NEGOTIATE_UNICODE                  = 0x00000001
	NEGOTIATE_OEM                      = 0x00000002
	NEGOTIATE_TARGET                   = 0x00000004
	NEGOTIATE_SIGN                     = 0x00000010
	NEGOTIATE_SEAL                     = 0x00000020
	NEGOTIATE_DATAGRAM                 = 0x00000040
	NEGOTIATE_LMKEY                    = 0x00000080
	NEGOTIATE_NTLM                     = 0x00000200
	NEGOTIATE_ANONYMOUS                = 0x00000800
	NEGOTIATE_OEM_DOMAIN_SUPPLIED      = 0x00001000
	NEGOTIATE_OEM_WORKSTATION_SUPPLIED = 0x00002000
	NEGOTIATE_ALWAYS_SIGN              = 0x00008000
	NEGOTIATE_TARGET_TYPE_DOMAIN       = 0x00010000
	NEGOTIATE_TARGET_TYPE_SERVER       = 0x00020000
	NEGOTIATE_EXTENDED_SESSIONSECURITY = 0x00080000
	NEGOTIATE_IDENTIFY                 = 0x00100000
	REQUEST_NON_NT_SESSION_KEY         = 0x00400000
	NEGOTIATE_TARGET_INFO              = 0x00800000
	NEGOTIATE_VERSION                  = 0x02000000
	NEGOTIATE_128                      = 0x20000000
	NEGOTIATE_KEY_EXCH                 = 0x40000000
	NEGOTIATE_56                       = 0x80000000
)
View Source 
const NEGOTIATE_FLAGS = NEGOTIATE_UNICODE |
	NEGOTIATE_NTLM |
	NEGOTIATE_OEM_DOMAIN_SUPPLIED |
	NEGOTIATE_OEM_WORKSTATION_SUPPLIED |
	NEGOTIATE_ALWAYS_SIGN |
	NEGOTIATE_EXTENDED_SESSIONSECURITY

Variables

View Source 
var (
	Sp_Cursor          = ProcId{1, ""}
	Sp_CursorOpen      = ProcId{2, ""}
	Sp_CursorPrepare   = ProcId{3, ""}
	Sp_CursorExecute   = ProcId{4, ""}
	Sp_CursorPrepExec  = ProcId{5, ""}
	Sp_CursorUnprepare = ProcId{6, ""}
	Sp_CursorFetch     = ProcId{7, ""}
	Sp_CursorOption    = ProcId{8, ""}
	Sp_CursorClose     = ProcId{9, ""}
	Sp_ExecuteSql      = ProcId{10, ""}
	Sp_Prepare         = ProcId{11, ""}
	Sp_PrepExec        = ProcId{13, ""}
	Sp_PrepExecRpc     = ProcId{14, ""}
	Sp_Unprepare       = ProcId{15, ""}
)

Functions

func CheckBadConn 

func CheckBadConn(err error) error

func NewTimeoutConn 

func NewTimeoutConn(conn net.Conn, timeout time.Duration) *timeoutConn

Types

type Auth 

type Auth interface {
	InitialBytes() ([]byte, error)
	NextBytes([]byte) ([]byte, error)
	Free()
}

type Decimal 

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

http://msdn.microsoft.com/en-us/library/ee780893.aspx

func Float64ToDecimal 

func Float64ToDecimal(f float64) (Decimal, error)

func (Decimal) Bytes 

func (d Decimal) Bytes() []byte

func (Decimal) String 

func (d Decimal) String() string

func (Decimal) ToFloat64 

func (d Decimal) ToFloat64() float64

type Error 

type Error struct {
	Number     int32
	State      uint8
	Class      uint8
	Message    string
	ServerName string
	ProcName   string
	LineNo     int32
}

func (Error) Error 

func (e Error) Error() string

type KeySlice 

type KeySlice []uint8

func (KeySlice) Len 

func (p KeySlice) Len() int

func (KeySlice) Less 

func (p KeySlice) Less(i, j int) bool

func (KeySlice) Swap 

func (p KeySlice) Swap(i, j int)

type Logger 

type Logger log.Logger

func (*Logger) Printf 

func (logger *Logger) Printf(format string, v ...interface{})

func (*Logger) Println 

func (logger *Logger) Println(v ...interface{})

type MssqlConn 

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

func (*MssqlConn) Begin 

func (c *MssqlConn) Begin() (driver.Tx, error)

func (*MssqlConn) Close 

func (c *MssqlConn) Close() error

func (*MssqlConn) Commit 

func (c *MssqlConn) Commit() error

func (*MssqlConn) Prepare 

func (c *MssqlConn) Prepare(query string) (driver.Stmt, error)

func (*MssqlConn) Rollback 

func (c *MssqlConn) Rollback() error

type MssqlDriver 

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

func (*MssqlDriver) Open 

func (d *MssqlDriver) Open(dsn string) (driver.Conn, error)

func (*MssqlDriver) SetLogger 

func (d *MssqlDriver) SetLogger(logger *log.Logger)

type MssqlResult 

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

func (*MssqlResult) LastInsertId 

func (r *MssqlResult) LastInsertId() (int64, error)

func (*MssqlResult) RowsAffected 

func (r *MssqlResult) RowsAffected() (int64, error)

type MssqlRows 

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

func (*MssqlRows) Close 

func (rc *MssqlRows) Close() error

func (*MssqlRows) Columns 

func (rc *MssqlRows) Columns() (res []string)

func (*MssqlRows) Next 

func (rc *MssqlRows) Next(dest []driver.Value) (err error)

type MssqlStmt 

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

func (*MssqlStmt) Close 

func (s *MssqlStmt) Close() error

func (*MssqlStmt) Exec 

func (s *MssqlStmt) Exec(args []driver.Value) (res driver.Result, err error)

func (*MssqlStmt) NumInput 

func (s *MssqlStmt) NumInput() int

func (*MssqlStmt) Query 

func (s *MssqlStmt) Query(args []driver.Value) (res driver.Rows, err error)

func (*MssqlStmt) SetQueryNotification 

func (s *MssqlStmt) SetQueryNotification(id, options string, timeout time.Duration)

type NTLMAuth 

type NTLMAuth struct {
	Domain      string
	UserName    string
	Password    string
	Workstation string
}

func (*NTLMAuth) Free 

func (auth *NTLMAuth) Free()

func (*NTLMAuth) InitialBytes 

func (auth *NTLMAuth) InitialBytes() ([]byte, error)

func (*NTLMAuth) NextBytes 

func (auth *NTLMAuth) NextBytes(bytes []byte) ([]byte, error)

type Param 

type Param struct {
	Name  string
	Flags uint8
	// contains filtered or unexported fields
}

type ProcId 

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

func MakeProcId 

func MakeProcId(name string) (res ProcId)

type StreamError 

type StreamError struct {
	Message string
}

func (StreamError) Error 

func (e StreamError) Error() string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.