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

For more recent updates, see the Microsoft fork.

Install

Requires Go 1.8 or above.

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

Connection Parameters and DSN

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

Common parameters

• 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)

Connection parameters for ODBC and ADO style connection strings

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

Less common parameters

• 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:
• 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 value ReadOnly to initiate a read-only connection to an Availability Group listener. The database must be specified when connecting with Application Intent set to ReadOnly.

The connection string can be specified in one of three formats

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

   • sqlserver://username:password@host/instance?param1=value¶m2=value
   • sqlserver://username:password@host:port?param1=value¶m2=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 the URL type in the net/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 port
   	RawQuery: 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 with odbc, key=value pairs separated by ;. Allow ; by wrapping values 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

Azure Active Directory authentication uses temporary authentication tokens to authenticate. The mssql package does not provide an implementation to obtain tokens: instead, import the azuread package and use driver name azuresql. This driver uses azidentity to acquire tokens using a variety of credential types.

The credential type is determined by the new fedauth connection string parameter.

• fedauth=ActiveDirectoryServicePrincipal or fedauth=ActiveDirectoryApplication - authenticates using an Azure Active Directory application client ID and client secret or certificate. Implemented using ClientSecretCredential or CertificateCredential
  • `clientcertpath=