From Xojo Documentation

Class (inherits from Database)

New in 2011r1

Used to connect to MS SQL Server databases.

DatabaseName ErrorMessage fa-lock-32.png Port
Error fa-lock-32.png Host Timeout
ErrorCode fa-lock-32.png Password UserName
Close GetAffectedRows Rollback
Commit IndexSchema SQLExecute
Connect InsertRecord SQLSelect
FieldSchema Prepare TableSchema


In order to use this class, you must have the MSSQServerDatabase plug-in in your plugins folder. The plug-in is included in the installation.

When the plug-in is installed, this class becomes available and you can also added a MS SQL Server database connection directly to the project.

This plug-in is a Windows-only feature. Other platforms will get a PlatformNotSupportedException when any method is called.

The MSSQLServerDatabase engine supports only the MoveNext RecordSet navigation method.

Multiple result sets are not supported. If your query returns multiple results sets you will only get back the first result set.


SQLSelect and SQLExecute statements do not block when called from within Threads.

Sample Code

To connect to a local MS SQL Server database:

Dim db As New MSSQLServerDatabase

db.Host = "\InstanceName" // or just the IP if using the default instance
db.DatabaseName = "NorthWind"
db.UserName = "MyUserID" // or "Domain\UserID for trusted domain accounts
db.Password = "mypassword"

If db.Connect Then
// Proceed with database operations
MsgBox("Connection error:" + db.ErrorMessage)
End If

See Also

Database Class, PreparedSQLStatement, MSSQLServerPreparedStatement, RecordSet classes