Platforms to show: All Mac Windows Linux Cross-Platform
SQLDatabaseMBS class
Super class: Database
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | SQL | MBS SQL Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
dim db as new SQLDatabaseMBS
// where is the library?
db.SetFileOption SQLConnectionMBS.kOptionLibrarySQLite, getfolderitem("/usr/lib/libsqlite3.0.dylib", folderitem.PathTypeShell)
// connect to database
// in this example it is SQLite,
// but can also be Sybase, Oracle, Informix, DB2, SQLServer, InterBase, MySQL, SQLBase and ODBC
dim path as string
if TargetMacOS then
path = "/tmp/test.db" // put the database in the temporary folder
else
path = "test.db" // for Windows and Linux in the current folder the application is inside.
end if
db.DatabaseName = "sqlite:"+path
if db.Connect then
MsgBox "We are connected!"
// Disconnect is optional
// autodisconnect will ocur in destructor if needed
db.close
msgbox "We are disconnected!"
end if
You can use the SQL plugin without using Xojo built in database classes if you use the SQLConnectionMBS and SQLCommandMBS classes.
Or you use the SQLDatabaseMBS class which is a subclass of the database class and can be used with Xojo's RecordSet class. The current implementation is not complete. You can connect with passing the database URL in the DatabaseName property of the SQLDatabaseMBS class. You prefix this URL with the database type you are using.
You can use Execute and Select to run SQL statements. Errors can be queries with the lasterror properties. For the RecordSet, you can get the column count, the column names and values and move to the next row. All the other methods like deleting a record or updating a value are not implemented and you need to use SQL commands to do this.
Supported databases: CubeSQL, Centura SQLBase, DB2, DuckDB, Firebird, Informix, InterBase, MariaDB, Microsoft Access, Microsoft SQL Server, MySQL, ODBC, Oracle Database Server, PostgreSQL, SQL Anywhere, SQLite, SQLCipher and Sybase.
Connect to Microsoft Access, FileMaker Server (or Pro), Microsoft Visual FoxPro and others via ODBC.
As field and table schema functions are not implemented, you can't use this database with the database browser features in the Xojo IDE.
The plugin does not provide RecordCount on RecordSet class. For that you need to make a extra SELECT count(*) query.
With Xojo 2013r1, you only need a database server license from Xojo, Inc. if you use the SQLDatabaseMBS class. The SQLConnectionMBS class does not require this license. But some features like getting a recordset do need the license as they refer to the SQLDatabaseMBS class.
Please free all RecordSets and SQLCommand objects before you close the SQLConnection or the SQLDatabase. The plugin keeps references from RecordSets and SQLCommand to prevent automatic destruction of the database connection. If you close a database connection while you have RecordSets and SQLCommand in use, things may go wrong.
The plugin can cache the recordset locally. To enable you can call SQLCommandMBS.Cache or use the Option("AutoCache") = "true" on either command or connection or database objects. The plugin will than fetch all records and store them in memory. After this you can walk over the recordset and use FetchPos, FetchFirst, FetchLast, FetchPrev and FetchNext to locate the rows you need. When you call Field() you always get last row, but to read from cached result set, please use Value() function. When using RecordSet, the values are read via Value() functions automatically.
You can use InternalPostgreSQLLibraryMBS or InternalSQLiteLibraryMBS if you like to use our built in SQLite or PostgreSQL database libraries.
The class pings the database every minute by checking whether it's alive and to avoid server dropping connection. This can be disabled by setting Option("Ping") = "false". Ping is not used for SQLite.
MBS Plugin 21.1 adds support for Edit/Update methods in RecordSet and RowSet classes.
MBS Database connections are implemented via SQLConnectionMBS and SQLCommandMBS classes. We provide a thin layer on top with SQLDatabaseMBS class to make it compatible to the Xojo database class. And when you use SQLDatabaseMBS, you can always get the matching SQLConnectionMBS objet via Connection property. Instead of SQLCommandMBS class, you may just use SelectSQL/ExecuteSQL or older SQLSelect/SQLExecute functions.
We have a collection of library files here:
https://www.monkeybreadsoftware.de/xojo/download/plugin/Libs/
Subclass of the Database class.
- 4 events
- event DidConnect
- event PostgresNotification(NotificationName as string, PID as Integer, Extras as String)
- event Trace(traceInfo as Integer, SQL as string, Command as SQLCommandMBS)
- event WillConnect
- 18 properties
- property AutoCommit as Integer
- property Client as Integer
- property ClientVersion as Integer
- Property Connection as SQLConnectionMBS
- property isAlive as boolean
- property isConnected as boolean
- property IsolationLevel as Integer
- property LastStatement as String
- property Options as Dictionary
- property RaiseExceptions as Boolean
- property RowsAffected as Integer New in 23.5
- property Scrollable as Boolean
- property ServerVersion as Integer
- property ServerVersionString as string
- property SQLiteEncryptionKey as String
- property Tag as Variant
- property Option(name as string) as string
- 40 methods
- method BeginTransaction
- method CancelAllCommands
- method Commands as SQLCommandMBS()
- method Connect as boolean
- method ConnectMT as Boolean
- method Constructor(globals as SQLGlobalsMBS = nil)
- method CubeSQLLastInsertID as Int64
- method CubeSQLReceiveData(byref data as String, byref IsEndChunk as Boolean) as Boolean
- method CubeSQLSendData(data as MemoryBlock)
- method CubeSQLSendData(data as String)
- method CubeSQLSendEndData
- method InsertRecord(TableName as String, Record as Dictionary)
- method Listen
- method MySQLInsertID as Int64
- method Prepare(statement as string) as SQLPreparedStatementMBS
- method SetFileOption(name as string, file as folderitem)
- method SQLExecute(ExecuteString as string, CommandType as Integer)
- method SQLExecuteMT(ExecuteString as string, CommandType as Integer = 0)
- method SQLiteBackupFinish(Backup as SQLite3BackupMBS) as integer
- method SQLiteBackupInit(Dest as Variant, DestName as String, Source as Variant, SourceName as String) as SQLite3BackupMBS
- method SQLiteBackupPageCount(Backup as SQLite3BackupMBS) as integer
- method SQLiteBackupRemaining(Backup as SQLite3BackupMBS) as integer
- method SQLiteBackupStep(Backup as SQLite3BackupMBS, Pages as Integer) as integer
- method SQLiteConnectionHandle as Ptr
- method SQLiteEnableLoadExtension(OnOff as boolean)
- method SQLiteLastInsertRowID as Int64
- method SQLiteLibVersion as String
- method SQLiteLoadExtension(file as FolderItem, ByRef ErrorMessage as String) as Integer
- method SQLiteLoadExtension(path as String, ByRef ErrorMessage as String) as Integer
- method SQLiteMemoryHighwater(reset as boolean = false) as Int64
- method SQLiteMemoryUsed as Int64
- method SQLiteReKey(Key as String) as Integer
- method SQLiteSetBusyHandler(MaxAttempts as Integer = 5)
- method SQLiteSetBusyTimeout(TimeOutMS as Integer = 20)
- method SQLiteSetKey(Key as String) as Integer
- method SQLiteTableColumnMetaData(DBName as string, TableName as string, ColumnName as string, byref DataType as string, byref CollationSequence as string, byref NotNull as boolean, byref PrimaryKey as boolean, byref AutoIncrement as Boolean) as integer
- method SQLiteThreadsafe as integer
- method SQLSelect(SelectString as string, CommandType as Integer) as RecordSet
- method SQLSelectMT(SelectString as string, CommandType as Integer = 0) as RecordSet
- method UpdateRecord(TableName as String, Record as Dictionary, Keys as Dictionary)
- 49 constants
- const kOptionLibraryCubeSQL = "CUBESQL.LIBS"
- const SQLiteInMemory = "Sqlite::memory:"
Isolation Levels
Constant | Value | Description |
---|---|---|
kANSILevel0 | 0 |
ANSI Level 0 |
kANSILevel1 | 1 |
ANSI Level 1 |
kANSILevel2 | 2 |
ANSI Level 2 |
kANSILevel3 | 3 |
ANSI Level 3 |
kLevelUnknown | -1 |
Unknown |
kReadCommitted | 1 |
Read committed. |
kReadUncommitted | 0 |
Read uncommitted. |
kRepeatableRead | 2 |
Repeatable read. |
kSerializable | 3 |
Serializable. |
kSnapshot | 4 |
Changes made in other transactions can not be seen. For Microsoft SQL Server. |
Values for autocommit property
Constant | Value | Description |
---|---|---|
kAutoCommitOff | 0 |
Autocommit is off. |
kAutoCommitOn | 1 |
Autocommit is on. |
kAutoCommitUnknown | -1 |
Autocommit unknown |
Command Types
Constant | Value | Description |
---|---|---|
kCommandTypeSQLStatement | 1 |
Command is an SQL statement. |
kCommandTypeSQLStatementRaw | 2 |
Command is an SQL statement that mustn't be interpreted by SQLAPI. |
kCommandTypeStoredProcedure | 3 |
Command is a stored procedure or a function. |
kCommandTypeUnknown | 0 |
Used by default. Library detects command type automatically. |
Error Codes
Constant | Value | Description |
---|---|---|
kErrorBindVarNotFound | 7 |
Bind variable not found. |
kErrorClientInitFails | 6 |
Initialization failed for client. |
kErrorClientNotSet | 1 |
Client not set. |
kErrorClientNotSupported | 2 |
Unsupported client type for this platform. |
kErrorClientVersionOld | 5 |
Library file is too old. |
kErrorFieldNotFound | 8 |
Field not found. |
kErrorGetLibraryVersionFails | 4 |
Failed to query library version. |
kErrorLoadLibraryFails | 3 |
Failed to load a library. For example path could be wrong or 32/64bit mismatch. |
kErrorNoMemory | 0 |
Out of memory. |
kErrorUnknownColumnType | 11 |
Unknown column type. |
kErrorUnknownDataType | 9 |
Unknown data type. |
kErrorUnknownParameterType | 10 |
Unknown parameter type. |
kErrorWrongConversion | 12 |
Failed to convert a value, e.g. string to number. |
kErrorWrongDatetime | 13 |
Can't convert text to date. |
Options to specify the library with SetFileOption
Constant | Value | Description |
---|---|---|
kOptionLibraryDB2 | "DB2CLI.LIBS" |
for DB2. |
kOptionLibraryFirebird | "IBASE.LIBS" |
for Firebird. |
kOptionLibraryInformix | "INFCLI.LIBS" |
for Informix. |
kOptionLibraryInterbase | "IBASE.LIBS" |
for Interbase. |
kOptionLibraryMySQL | "MYSQL.LIBS" |
for MySQL. Library extension on Mac is ".dylib", on Linux ".so" and on Windows ".dll". You get this library with the MySQL download on their homepage. |
kOptionLibraryODBC | "ODBC.LIBS" |
for ODBC. |
kOptionLibraryOracle | "OCI8.LIBS" |
for Oracle. |
kOptionLibraryPostgreSQL | "LIBPQ.LIBS" |
for Postgre SQL. |
kOptionLibrarySQLanywhere | "SQLANY.LIBS" |
for SQL Anywhere. |
kOptionLibrarySQLBase | "SQLBASE.LIBS" |
for SQLbase. |
kOptionLibrarySQLite | "SQLITE.LIBS" |
for SQLite. Can also be the spatialite or SQLcipher library. |
kOptionLibrarySybaseComn | "SYBCOMN.LIBS" |
for Sybase. |
kOptionLibrarySybaseCS | "SYBCS.LIBS" |
for Sybase. |
kOptionLibrarySybaseCT | "SYBCT.LIBS" |
for Sybase. |
kOptionLibrarySybaseIntl | "SYBINTL.LIBS" |
for Sybase. |
kOptionLibrarySybaseTCL | "SYBTCL.LIBS" |
for Sybase. |
Super class Database
- 7 properties
- property DatabaseName as String
- property Error as Boolean
- property ErrorCode as Integer
- property ErrorMessage as String
- property Host as String
- property Password as String
- property UserName as String
- 17 methods
- method AddRow(TableName as String, row as DatabaseRow)
- method BeginTransaction
- method Close
- method Commit
- method CommitTransaction
- method Connect
- method Connect as boolean
- method ExecuteSQL(sql As String, ParamArray values As Variant)
- method ExecuteSQL(sql As String, values() As Variant)
- method InsertRecord(TableName as String, Data as DatabaseRecord)
- method Prepare(statement as String) as PreparedSQLStatement
- method Rollback
- method RollbackTransaction
- method SelectSQL(sql As String, ParamArray values As Variant) as RowSet
- method SelectSQL(sql As String, values() As Variant) as RowSet
- method SQLExecute(ExecuteString as string)
- method SQLSelect(SelectString as string) as RecordSet
This class has no sub classes.
Some examples using this class:
- /SQL/SQLDatabaseMBS Firebird Connect
- /SQL/SQLDatabaseMBS Microsoft Access Connect
- /SQL/SQLDatabaseMBS MSSQL Execute
- /SQL/SQLDatabaseMBS PostgreSQL
- /SQL/SQLDatabaseMBS SQLite Blob test
- /SQL/SQLDatabaseMBS SQLite Connect console
- /SQL/SQLDatabaseMBS SQLite Create Encrypted
- /SQL/SQLDatabaseMBS SQLite ExecuteSQL with Workers
- /SQL/SQLDatabaseMBS SQLite Fetch values
- /SQL/SQLDatabaseMBS SQLite insert record
Blog Entries
- MBS SQL Plugin Tips and Tricks
- RowSet in MBS Xojo SQL Plugin
- Converting Xojo project to use MBS SQL Plugin
- Connect to Oracle via MBS Xojo SQL Plugin
- MBS Xojo Plugins 18.3
- MBS Xojo Web Starter Kit in version 1.3
- MBS Xojo Web Starter Kit in version 1.1
- Connection Strings
- MBS Real Studio SQL Plugin and Oracle
- MonkeyBread Software Releases the MBS Real Studio plug-ins in version 12.5
Xojo Developer Magazine
- 21.1, page 9: News
- 18.5, page 10: News
- 14.1, pages 24 to 30: The MBS SQL Plugin, An alternative way to connect to databases by Christian Schmitz
- 13.4, page 11: News
- 12.4, page 9: News
- 12.3, page 10: News
- 11.3, page 41: Welcome to Xojo, Real Studio gets a new identity by Marc Zeedar
- 11.2, page 8: News
- 11.2, page 33: Windows Installing, Using Inno Setup to Create a Windows Installer App by Marc Zeedar
- 11.1, page 9: News
Videos
The items on this page are in the following plugins: MBS SQL Plugin.
SQLConnectionMBS - SQLDataConsumerMBS
