Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

SQLDatabaseMBS.AutoCommit as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 12.3 Yes Yes Yes Yes No
Function: Whether autocommit is enabled or disabled for the current connection.
Notes:
If autocommit is on, the database is committed automatically after each SQL command. Otherwise, transaction is committed only after Commit calling.
(Read and Write property)

Feedback, Comments & Corrections

SQLDatabaseMBS.Client as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 14.1 Yes Yes Yes Yes No
Function: The current DBMS client assigned for the connection.
Notes: (Read and Write property)

Feedback, Comments & Corrections

SQLDatabaseMBS.ClientVersion as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 12.3 Yes Yes Yes Yes No
Function: Gets the DBMS client API version number.
Notes:
The higher word contains the major client version (the XX value in the XX.YY version number); the lower word contains the minor client version (the YY value in the XX.YY version number).

If an DBMS client was not set calling ClientVersion method will throw an exception.
(Read only property)

Feedback, Comments & Corrections

SQLDatabaseMBS.Connection as SQLConnectionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
Property SQL MBS SQL Plugin 9.3 Yes Yes Yes Yes No
Function: The connection for this database used in the background.
Notes:
Note that methods on this connection object can raise exceptions while methods on the SQLDatabaseMBS class sets the error properties.
(Read only property)

Feedback, Comments & Corrections

SQLDatabaseMBS.isAlive as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 12.3 Yes Yes Yes Yes No
Function: Returns the database server connection status for a particular connection object.
Notes:
Returns true if the database server is active and accessible; otherwise false.
This method uses the safe query execution for most supported DBMS-es. The query uses the well known database table or procedure (mysql_ping is used for MySQL). If the query fails the method returns false.
(Read only property)

Feedback, Comments & Corrections

SQLDatabaseMBS.isConnected as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 12.3 Yes Yes Yes Yes No
Function: Returns the connection state for a particular connection object.
Notes:
Returns true if connected; otherwise false.
(Read only property)

Feedback, Comments & Corrections

SQLDatabaseMBS.IsolationLevel as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 12.3 Yes Yes Yes Yes No
Function: The transaction isolation level.
Notes:
Use the kReadCommitted, kReadUncommitted, kRepeatableRead, kSerializable and kLevelUnknown constants.
(Read and Write property)

Feedback, Comments & Corrections

SQLDatabaseMBS.LastStatement as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 13.2 Yes Yes Yes Yes No
Function: The last executed SQL Statement.
Notes: (Read only property)

Feedback, Comments & Corrections

SQLDatabaseMBS.NativeAPI as Variant
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 16.1 Yes Yes Yes Yes No
Function: Returns a set of functions of native DBMS client API.
Notes:
Returns a SQLAPIMBS object.
(Read only property)

Feedback, Comments & Corrections

SQLDatabaseMBS.RaiseExceptions as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 14.1 Yes Yes Yes Yes No
Function: Whether to raise exceptions.
Notes:
Default is false which means we set error, ErrorCode and ErrorMessage properties and not raise SQLErrorExceptionMBS exception.
If you set to true, we do raise the exception and you have similar behavior as with SQLConnection class.
We recommend to use exceptions as they are not so easily ignored like an error property being true.
(Read and Write property)

Feedback, Comments & Corrections

SQLDatabaseMBS.Scrollable as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 14.2 Yes Yes Yes Yes No
Function: Whether to make internally created SQLCommand objects scrollable.
Notes:
Since plugin version 15.0, Scrollable is false by default.
(Read and Write property)

Feedback, Comments & Corrections

SQLDatabaseMBS.ServerVersion as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 12.3 Yes Yes Yes Yes No
Function: Gets the currently connected DBMS server version number.
Notes:
The higher word contains the major server version (the XX value in the XX.YY version number); the lower word contains the minor server version (the YY value in the XX.YY version number).
(Read only property)

Feedback, Comments & Corrections

SQLDatabaseMBS.ServerVersionString as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 12.3 Yes Yes Yes Yes No
Function: Gets the currently connected DBMS server version string.
Notes:
A server version string may contain some useful information about server brand, configuration and so on. It is a good idea to display this information in all your applications.
(Read only property)

Feedback, Comments & Corrections

SQLDatabaseMBS.SQLiteEncryptionKey as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 15.3 Yes Yes Yes Yes No
Function: The encryption key to use.
Example:
dim db as new SQLDatabaseMBS
db.SQLiteEncryptionKey = "Hello"
Notes:
This key is applied to the database after connecting. In case of an error, the plugin raises an exception. An empty key can be used for having no encryption.
Alternatively you can use SQLite3MBS.SetKey yourself.

The amount of key material actually used by the encryption extension depends on which variant of SEE you are using. With RC4, the first 256 byte of key are used. With the AES128, the first 16 bytes of the key are used. With AES256, the first 32 bytes of key are used.

If you specify a key that is shorter than the maximum key length, then the key material is repeated as many times as necessary to complete the key. If you specify a key that is larger than the maximum key length, then the excess key material is silently ignored.

The key must begin with an ASCII prefix to specify which algorithm to use. The prefix must be one of "rc4:", "aes128:", or "aes256:". The prefix is not used as part of the key sent into the encryption algorithm. So the real key should begin on the first byte after the prefix. If no prefix is given, we default to AES 128. To be compatible to Xojo (Real Studio), you can use AES128.

The string provided to the plugin is used with it's current encoding. So be sure you use right text encoding for what you want. e.g. using "Müller" as key in text encoding Windows ANSI will not open a database which used that key in UTF-8 encoding.

The Xojo database encryption in SQLiteDatabase class uses AES-128 OFB.
(Read and Write property)

Feedback, Comments & Corrections

SQLDatabaseMBS.Tag as Variant
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property SQL MBS SQL Plugin 14.0 Yes Yes Yes Yes No
Function: The tag property.
Notes:
You can store here whatever you like.
(Read and Write property)

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS SQL Plugin.




Links
MBS Xojo Chart Plugins