Repository files navigation

For more recent updates, see theMicrosoft fork.

Requires Go 1.8 or above.

Install withgo get github.com/denisenkom/go-mssqldb .

The recommended connection string uses a URL format:sqlserver://username:password@host/instance?param1=value&param2=valueOther supported formats are listed below.

• 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. The user domain sensitive to the case which is defined in the connection string.
• password
• database
• connection timeout - in seconds (default is 0 for no timeout), set to 0 for no timeout. Recommended to set to 0 and use context to manage query and connection timeouts.
• dial timeout - in seconds (default is 15), set to 0 for no timeout
• 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.
• app name - The application name (default is go-mssqldb)

• server - host or host\instance (default localhost)
• port - used only when there is no instance in server (default 1433)

• keepAlive - in seconds; 0 to disable (default is 30)
• failoverpartner - host or host\instance (default is no partner).
• failoverport - used only when there is no instance in failoverpartner (default 1433)
• packet size - in bytes; 512 to 32767 (default is 4096)
  • Encrypted connections have a maximum packet size of 16383 bytes
  • Further information on usage:https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/configure-the-network-packet-size-server-configuration-option
• 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
• TrustServerCertificate
  • false - Server certificate is checked. Default is false if encrypt 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)
• ApplicationIntent - Can be given the valueReadOnly to initiate a read-only connection to an Availability Group listener. Thedatabase must be specified when connecting withApplication Intent set toReadOnly.

1. URL: withsqlserver scheme. username and password appears before the host. Any instance appears asthe first segment in the path. All other options are query parameters. Examples:

   • sqlserver://username:password@host/instance?param1=value&param2=value
   • sqlserver://username:password@host:port?param1=value&param2=value
   • sqlserver://sa@localhost/SQLExpress?database=master&connection+timeout=30 // `SQLExpress instance.
   • sqlserver://sa:mypass@localhost?database=master&connection+timeout=30 // username=sa, password=mypass.
   • sqlserver://sa:mypass@localhost:1234?database=master&connection+timeout=30 // port 1234 on localhost.
   • sqlserver://sa:my%7Bpass@somehost?connection+timeout=30 // password is "my{pass"A string of this format can be constructed using theURL type in thenet/url package.

   query:= url.Values{}query.Add("app name","MyAppName")u:=&url.URL{Scheme:"sqlserver",User:url.UserPassword(username,password),Host:fmt.Sprintf("%s:%d",hostname,port),// Path:  instance, // if connecting to an instance instead of a portRawQuery:query.Encode(),}db,err:=sql.Open("sqlserver",u.String())

2. ADO:key=value pairs separated by;. Values may not contain;, leading and trailing whitespace is ignored.Examples:

   • server=localhost\\SQLExpress;user id=sa;database=master;app name=MyAppName
   • server=localhost;user id=sa;database=master;app name=MyAppName

   ADO strings support synonyms for database, app name, user id, and server

   • server <= addr, address, network address, data source
   • user id <= user, uid
   • database <= initial catalog
   • app name <= application name

3. ODBC: Prefix withodbc,key=value pairs separated by;. Allow; by wrappingvalues in{}. Examples:

   • odbc:server=localhost\\SQLExpress;user id=sa;database=master;app name=MyAppName
   • odbc:server=localhost;user id=sa;database=master;app name=MyAppName
   • odbc:server=localhost;user id=sa;password={foo;bar} // Value marked with{}, password is "foo;bar"
   • odbc:server=localhost;user id=sa;password={foo{bar} // Value marked with{}, password is "foo{bar"
   • odbc:server=localhost;user id=sa;password={foobar } // Value marked with{}, password is "foobar "
   • odbc:server=localhost;user id=sa;password=foo{bar // Literal{, password is "foo{bar"
   • odbc:server=localhost;user id=sa;password=foo}bar // Literal}, password is "foo}bar"
   • odbc:server=localhost;user id=sa;password={foo{bar} // Literal{, password is "foo{bar"
   • odbc:server=localhost;user id=sa;password={foo}}bar} // Escaped} with}}`, password is "foo}bar"

Azure Active Directory authentication uses temporary authentication tokens to authenticate.Themssql package does not provide an implementation to obtain tokens: instead, import theazuread package and use driver nameazuresql. This driver usesazidentity to acquire tokens using a variety of credential types.

The credential type is determined by the newfedauth connection string parameter.

• fedauth=ActiveDirectoryServicePrincipal orfedauth=ActiveDirectoryApplication - authenticates using an Azure Active Directory application client ID and client secret or certificate. Implemented usingClientSecretCredential or CertificateCredential
  • clientcertpath=<path to certificate file>;password=<certificate password> or
  • password=<client secret>
  • user id=<application id>[@tenantid] Note the@tenantid component can be omitted if the server's tenant is the same as the application's tenant.
• fedauth=ActiveDirectoryPassword - authenticates using a user name and password.
  • user id=username@domain
  • password=<password>
  • applicationclientid=<application id> - This guid identifies an Azure Active Directory enterprise application that the AAD admin has approved for accessing Azure SQL database resources in the tenant. This driver does not have an associated application id of its own.
• fedauth=ActiveDirectoryDefault - authenticates using a chained set of credentials. The chain is built from EnvironmentCredential -> ManagedIdentityCredential->AzureCLICredential. SeeDefaultAzureCredential docs for instructions on setting up your host environment to use it. Using this option allows you to have the same connection string in a service deployment as on your interactive development machine.
• fedauth=ActiveDirectoryManagedIdentity orfedauth=ActiveDirectoryMSI - authenticates using a system-assigned or user-assigned Azure Managed Identity.
  • user id=<identity id> - optional id of user-assigned managed identity. If empty, system-assigned managed identity is used.
• fedauth=ActiveDirectoryInteractive - authenticates using credentials acquired from an external web browser. Only suitable for use with human interaction.
  • applicationclientid=<application id> - This guid identifies an Azure Active Directory enterprise application that the AAD admin has approved for accessing Azure SQL database resources in the tenant. This driver does not have an associated application id of its own.

import ("database/sql""net/url"// Import the Azure AD driver module (also imports the regular driver package)"github.com/denisenkom/go-mssqldb/azuread")funcConnectWithMSI() (*sql.DB,error) {returnsql.Open(azuread.DriverName,"sqlserver://azuresql.database.windows.net?database=yourdb&fedauth=ActiveDirectoryMSI")}

To run a stored procedure, set the query text to the procedure name:

varaccount="abc"_,err:=db.ExecContext(ctx,"sp_RunMe",sql.Named("ID",123),sql.Named("Account", sql.Out{Dest:&account}),)

To read output parameters from a stored procedure with resultset, make sure you read all the rows before reading the output parameters:

sqltextcreate:=`CREATE PROCEDURE spwithoutputandrows@bitparam BIT OUTPUTAS BEGINSET @bitparam = 1SELECT 'Row 1'END`varbitoutint64rows,err:=db.QueryContext(ctx,"spwithoutputandrows",sql.Named("bitparam", sql.Out{Dest:&bitout}))varstrrowstringforrows.Next() {err=rows.Scan(&strrow)}fmt.Printf("bitparam is %d",bitout)

Due to protocol limitations, temporary tables will only be allocated on the connectionas a result of executing a query with zero parameters. The following querywill, due to the use of a parameter, execute in its own session,and#mytemp will be de-allocated right away:

conn,err:=pool.Conn(ctx)deferconn.Close()_,err:=conn.ExecContext(ctx,"select @p1 as x into #mytemp",1)// at this point #mytemp is already dropped again as the session of the ExecContext is over

To work around this, always explicitly create the local temporarytable in a query without any parameters. As a special case, the driverwill then be able to execute the query directly on theconnection-scoped session. The following example works:

conn,err:=pool.Conn(ctx)// Set us up so that temp table is always cleaned up, since conn.Close()// merely returns conn to pool, rather than actually closing the connection.deferfunc() {_,_=conn.ExecContext(ctx,"drop table #mytemp")// always clean upconn.Close()// merely returns conn to pool}()// Since we not pass any parameters below, the query will execute on the scope of// the connection and succeed in creating the table._,err:=conn.ExecContext(ctx,"create table #mytemp ( x int )")// #mytemp is now available even if you pass parameters_,err:=conn.ExecContext(ctx,"insert into #mytemp (x) values (@p1)",1)

To get the procedure return status, pass into the parameters a*mssql.ReturnStatus. For example:

varrs mssql.ReturnStatus_,err:=db.ExecContext(ctx,"theproc",&rs)log.Printf("status=%d",rs)

or

varrs mssql.ReturnStatus_,err:=db.QueryContext(ctx,"theproc",&rs)forrows.Next() {err=rows.Scan(&val)}log.Printf("status=%d",rs)

Limitation: ReturnStatus cannot be retrieved usingQueryRow.

Thesqlserver driver uses normal MS SQL Server syntax and expects parameters inthe sql query to be in the form of either@Name or@p1 to@pN (ordinal position).

db.QueryContext(ctx,`select * from t where ID = @ID and Name = @p2;`,sql.Named("ID",6),"Bob")

To pass specific types to the query parameters, sayvarchar ordate types,you must convert the types to the type before passing in. The following typesare supported:

• string -> nvarchar
• mssql.VarChar -> varchar
• time.Time -> datetimeoffset or datetime (TDS version dependent)
• mssql.DateTime1 -> datetime
• mssql.DateTimeOffset -> datetimeoffset
• "github.com/golang-sql/civil".Date -> date
• "github.com/golang-sql/civil".DateTime -> datetime2
• "github.com/golang-sql/civil".Time -> time
• mssql.TVP -> Table Value Parameter (TDS version dependent)

• LastInsertId shouldnot be used with this driver (or SQL Server) due to how the TDS protocolworks. Please use theOUTPUT Clauseor add aselect ID = convert(bigint, SCOPE_IDENTITY()); to the end of yourquery (refSCOPE_IDENTITY).This will ensure you are getting the correct ID and will prevent a network round trip.
• NewConnectormay be used withOpenDB.
• Connector.SessionInitSQLmay be set to set any driver specific session settings after the sessionhas been reset. If empty the session will still be reset but use the databasedefaults in Go1.10+.

• 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

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

Example:

    env SQLSERVER_DSN=sqlserver://user:pass@hostname/instance?database=test1 gotest

AZURESERVER_DSN environment variable provides the connection string for Azure Active Directory-based authentication. If it's not set the AAD test will be skipped.

These features still exist in the driver, but they are are deprecated.

If you use the driver name "mssql" (rather then "sqlserver") the SQL textwill be loosly parsed and an attempt to extract identifiers using one of

• ?
• ?nnn
• :nnn
• $nnn

will be used. This is not recommended with SQL Server.There is at least one existingwon't fix issue with the query parsing.

Use the native "@Name" parameters instead with the "sqlserver" driver name.

• 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