Class

# MySQLCommunityServer

<div class="rst-class">

forsearch

</div>

Database

<div class="rst-class">

forsearch

</div>

MySQL

<div class="rst-class">

forsearch

</div>

MariaDB

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

Used to connect to MySQL Community Edition databases.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                                          | Type                                | Read-Only | Shared |
|---------------------------------------------------------------|-------------------------------------|-----------|--------|
| `DatabaseName<mysqlcommunityserver.databasename>`             | `String</api/data_types/string>`    |           |        |
| `Host<mysqlcommunityserver.host>`                             | `String</api/data_types/string>`    |           |        |
| `MetaData<mysqlcommunityserver.metadata>`                     | `String</api/data_types/string>`    |           |        |
| `Password<mysqlcommunityserver.password>`                     | `String</api/data_types/string>`    |           |        |
| `Port<mysqlcommunityserver.port>`                             | `Integer</api/data_types/integer>`  |           |        |
| `SecureAuth<mysqlcommunityserver.secureauth>`                 | `Boolean</api/data_types/boolean>`  |           |        |
| `SSLAuthority<mysqlcommunityserver.sslauthority>`             | `FolderItem</api/files/folderitem>` |           |        |
| `SSLAuthorityFolder<mysqlcommunityserver.sslauthorityfolder>` | `FolderItem</api/files/folderitem>` |           |        |
| `SSLCertificate<mysqlcommunityserver.sslcertificate>`         | `FolderItem</api/files/folderitem>` |           |        |
| `SSLCipher<mysqlcommunityserver.sslcipher>`                   | `String</api/data_types/string>`    |           |        |
| `SSLEnabled<mysqlcommunityserver.sslenabled>`                 | `Boolean</api/data_types/boolean>`  |           |        |
| `SSLKey<mysqlcommunityserver.sslkey>`                         | `FolderItem</api/files/folderitem>` |           |        |
| `Tag<mysqlcommunityserver.tag>`                               | `Variant</api/data_types/variant>`  |           |        |
| `TimeOut<mysqlcommunityserver.timeout>`                       | `Integer</api/data_types/integer>`  |           |        |
| `UserName<mysqlcommunityserver.username>`                     | `String</api/data_types/string>`    |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                                            | Parameters                                                                                                                                             | Returns                                                            | Shared |
|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|--------|
| `AddRow<mysqlcommunityserver.addrow>`                           | tableName As `String</api/data_types/string>`, row As `DatabaseRow</api/databases/databaserow>`                                                        |                                                                    |        |
|                                                                 | tableName As `String</api/data_types/string>`, row As `DatabaseRow</api/databases/databaserow>`, idColumnName As `String</api/data_types/string>` = "" | `Integer</api/data_types/integer>`                                 |        |
| `AffectedRowCount<mysqlcommunityserver.affectedrowcount>`       |                                                                                                                                                        | `UInt64</api/data_types/additional_types/uint64>`                  |        |
| `BeginTransaction<mysqlcommunityserver.begintransaction>`       |                                                                                                                                                        |                                                                    |        |
| `Close<mysqlcommunityserver.close>`                             |                                                                                                                                                        |                                                                    |        |
| `CommitTransaction<mysqlcommunityserver.committransaction>`     |                                                                                                                                                        |                                                                    |        |
| `Connect<mysqlcommunityserver.connect>`                         |                                                                                                                                                        |                                                                    |        |
| `ExecuteSQL<mysqlcommunityserver.executesql>`                   | command As `String</api/data_types/string>`, `ParamArray</api/language/paramarray>` values() As `Variant</api/data_types/variant>`                     |                                                                    |        |
| `IsConnected<mysqlcommunityserver.isconnected>`                 |                                                                                                                                                        | `Boolean</api/data_types/boolean>`                                 |        |
| `Prepare<mysqlcommunityserver.prepare>`                         | statement As `String</api/data_types/string>`                                                                                                          | `MySQLPreparedSQLStatement</api/databases/mysqlpreparedstatement>` |        |
| `RollbackTransaction<mysqlcommunityserver.rollbacktransaction>` |                                                                                                                                                        |                                                                    |        |
| `SelectSQL<mysqlcommunityserver.selectsql>`                     | query As `String</api/data_types/string>`, `ParamArray</api/language/paramarray>` values() As `Variant</api/data_types/variant>`                       | `RowSet</api/databases/rowset>`                                    |        |
| `TableColumns<mysqlcommunityserver.tablecolumns>`               | tableName As `String</api/data_types/string>`                                                                                                          | `RowSet</api/databases/rowset>`                                    |        |
| `TableIndexes<mysqlcommunityserver.tableindexes>`               | tableName As `String</api/data_types/string>`                                                                                                          | `RowSet</api/databases/rowset>`                                    |        |
| `Tables<mysqlcommunityserver.tables>`                           |                                                                                                                                                        | `RowSet</api/databases/rowset>`                                    |        |

## Property descriptions

<div id="mysqlcommunityserver.databasename">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.DatabaseName

**DatabaseName** As `String</api/data_types/string>`

> The name of the database to open.
>
> The DatabaseName is typically used to identify the specific database to use on the server.
>
> This code connects to a database called "BaseballLeague":
>
> ``` xojo
> Var db As New MySQLDatabase
>
> db.Host = "192.168.1.172"
> db.Port = 5432
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
>
> Try
>   db.Connect
>   ' Use the database
> Catch error As DatabaseException
>   ' DB Connection error
>   MessageBox(error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.host">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.Host

**Host** As `String</api/data_types/string>`

> The database host name or IP address of the database server.
>
> This examples connects to a database called "BaseballLeague":
>
> ``` xojo
> Var db As New MySQLDatabase
>
> db.Host = "192.168.1.172"
> db.Port = 5432
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
>
> Try
>   db.Connect
>   ' Use the database
> Catch error As DatabaseException
>   ' DB Connection error
>   MessageBox(error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.metadata">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.MetaData

**MetaData** As `String</api/data_types/string>`

> Used to store custom data that doesn't belong in the other properties.

<div id="mysqlcommunityserver.password">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.Password

**Password** As `String</api/data_types/string>`

> The password that is required for access to the database. Typically used in conjunction with `UserName<mysqlcommunityserver.username>`.
>
> This examples connects to a database called "BaseballLeague":
>
> ``` xojo
> Var db As New MySQLDatabase
>
> db.Host = "192.168.1.172"
> db.Port = 5432
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
>
> Try
>   db.Connect
>   ' Use the database
> Catch error As DatabaseException
>   ' DB Connection error
>   MessageBox(error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.port">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.Port

**Port** As `Integer</api/data_types/integer>`

> The port to use to connect to the MySQL Community Server database. The default is 3306.
>
> ``` xojo
> ' db is a MySQLCommunityServer
> db.Port = 3400
> ```

<div id="mysqlcommunityserver.secureauth">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.SecureAuth

**SecureAuth** As `Boolean</api/data_types/boolean>`

> This property allows users to authenticate using old password hashes (i.e. pre-4.1.1 authentication protocol) if needed. It is True by default.

<div id="mysqlcommunityserver.sslauthority">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.SSLAuthority

**SSLAuthority** As `FolderItem</api/files/folderitem>`

> Specifies the authority certificate file. This property is ignored if an SSL connection is not made.
>
> You can securely connect to MySQL using the SSLMode and associated properties:
>
> ``` xojo
> Var db As New MySQLCommunityServer
>
> db.Host = "192.168.1.172"
> db.Port = 3306
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
> db.SSLEnabled = True
>
> ' Specify SSL key file
> db.SSLKey = New FolderItem("MySQLKeyFile", FolderItem.PathModes.Native)
>
> ' Specify SSL certificate file
> db.SSLCertificate = New FolderItem("MySQLCertificateFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority file
> db.SSLAuthority = New FolderItem("MySQLAuthFileFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority directory
> db.SSLAuthorityFolder = New FolderItem("SSLCACertFile", FolderItem.PathModes.Native)
>
> ' Specify SSL cipher
> Var cipher As String = "DHE-RSA-AES256-SHA"
> db.SSLCipher = cipher
>
> Try
>   db.Connect
> Catch error As DatabaseException
>   MessageBox("Connection failed. Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.sslauthorityfolder">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.SSLAuthorityFolder

**SSLAuthorityFolder** As `FolderItem</api/files/folderitem>`

> The path to a folder that contains trusted SSL CA certificates in PEM format. This property is ignored if an SSL connection is not made.
>
> You can securely connect to MySQL using the SSLEnabled and associated properties:
>
> ``` xojo
> Var db As New MySQLCommunityServer
>
> db.Host = "192.168.1.172"
> db.Port = 3306
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
> db.SSLEnabled = True
>
> ' Specify SSL key file
> db.SSLKey = New FolderItem("MySQLKeyFile", FolderItem.PathModes.Native)
>
> ' Specify SSL certificate file
> db.SSLCertificate = New FolderItem("MySQLCertificateFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority file
> db.SSLAuthority = New FolderItem("MySQLAuthFileFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority directory
> db.SSLAuthorityFolder = New FolderItem("SSLCACertFile", FolderItem.PathModes.Native)
>
> ' Specify SSL cipher
> Var cipher As String = "DHE-RSA-AES256-SHA"
> db.SSLCipher = cipher
>
> Try
>   db.Connect
> Catch error As DatabaseException
>   System.Beep
>   MessageBox("Connection failed. Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.sslcertificate">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.SSLCertificate

**SSLCertificate** As `FolderItem</api/files/folderitem>`

> Specifies the file for the client SSL certificate. This property is ignored if an SSL connection is not made.
>
> You can securely connect to MySQL using the SSLMode and associated properties:
>
> ``` xojo
> Var db As New MySQLCommunityServer
>
> db.Host = "192.168.1.172"
> db.Port = 3306
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
> db.SSLEnabled = True
>
> ' Specify SSL key file
> db.SSLKey = New FolderItem("MySQLKeyFile", FolderItem.PathModes.Native)
>
> ' Specify SSL certificate file
> db.SSLCertificate = New FolderItem("MySQLCertificateFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority file
> db.SSLAuthority = New FolderItem("MySQLAuthFileFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority directory
> db.SSLAuthorityFolder = New FolderItem("SSLCACertFile", FolderItem.PathModes.Native)
>
> ' Specify SSL cipher
> Var cipher As String = "DHE-RSA-AES256-SHA"
> db.SSLCipher = cipher
>
> Try
>   db.Connect
> Catch error As DatabaseException
>   MessageBox("Connection failed. Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.sslcipher">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.SSLCipher

**SSLCipher** As `String</api/data_types/string>`

> A list of permissible ciphers to use for SSL encryption. This property is ignored if an SSL connection is not made.
>
> You can securely connect to MySQL using the SSLMode and associated properties:
>
> ``` xojo
> Var db As New MySQLCommunityServer
>
> db.Host = "192.168.1.172"
> db.Port = 3306
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
> db.SSLEnabled = True
>
> ' Specify SSL key file
> db.SSLKey = New FolderItem("MySQLKeyFile", FolderItem.PathModes.Native)
>
> ' Specify SSL certificate file
> db.SSLCertificate = New FolderItem("MySQLCertificateFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority file
> db.SSLAuthority = New FolderItem("MySQLAuthFileFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority directory
> db.SSLAuthorityFolder = New FolderItem("SSLCACertFile", FolderItem.PathModes.Native)
>
> ' Specify SSL cipher
> Var cipher As String = "DHE-RSA-AES256-SHA"
> db.SSLCipher = cipher
>
> Try
>   db.Connect
> Catch error As DatabaseException
>   MessageBox("Connection failed. Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.sslenabled">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.SSLEnabled

**SSLEnabled** As `Boolean</api/data_types/boolean>`

> Set to `True</api/language/true>` to enable an SSL connection.
>
> You can securely connect to MySQL using SSLEnabled and associated properties:
>
> ``` xojo
> Var db As New MySQLCommunityServer
>
> db.Host = "192.168.1.172"
> db.Port = 3306
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
> db.SSLEnabled = True
>
> ' Specify SSL key file
> db.SSLKey = New FolderItem("MySQLKeyFile", FolderItem.PathModes.Native)
>
> ' Specify SSL certificate file
> db.SSLCertificate = New FolderItem("MySQLCertificateFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority file
> db.SSLAuthority = New FolderItem("MySQLAuthFileFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority directory
> db.SSLAuthorityFolder = New FolderItem("SSLCACertFile", FolderItem.PathModes.Native)
>
> ' Specify SSL cipher
> Var cipher As String = "DHE-RSA-AES256-SHA"
> db.SSLCipher = cipher
>
> Try
>   db.Connect
> Catch error As DatabaseException
>   System.Beep
>   MessageBox("Connection failed. Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.sslkey">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.SSLKey

**SSLKey** As `FolderItem</api/files/folderitem>`

> Specifies the key file. This property is ignored if an SSL connection is not made.
>
> You can securely connect to MySQL using the SSLMode and associated properties:
>
> ``` xojo
> Var db As New MySQLCommunityServer
>
> db.Host = "192.168.1.172"
> db.Port = 3306
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
> db.SSLEnabled = True
>
> ' Specify SSL key file
> db.SSLKey = New FolderItem("MySQLKeyFile", FolderItem.PathModes.Native)
>
> ' Specify SSL certificate file
> db.SSLCertificate = New FolderItem("MySQLCertificateFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority file
> db.SSLAuthority = New FolderItem("MySQLAuthFileFile", FolderItem.PathModes.Native)
>
> ' Specify SSL authority directory
> db.SSLAuthorityFolder = New FolderItem("SSLCACertFile", FolderItem.PathModes.Native)
>
> ' Specify SSL cipher
> Var cipher As String = "DHE-RSA-AES256-SHA"
> db.SSLCipher = cipher
>
> Try
>   db.Connect
> Catch error As DatabaseException
>   MessageBox("Connection failed. Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.tag">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.Tag

**Tag** As `Variant</api/data_types/variant>`

> Used to store any value you wish to associated with this instance of the database.

<div id="mysqlcommunityserver.timeout">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.TimeOut

**TimeOut** As `Integer</api/data_types/integer>`

> The connection timeout value (seconds). The default is `15`.
>
> ``` xojo
> ' db is a MySQLCommunityServer database
> db.TimeOut = 60
> ```

<div id="mysqlcommunityserver.username">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.UserName

**UserName** As `String</api/data_types/string>`

> The username that is required for access to the database.
>
> This code connects to a database called "BaseballLeague":
>
> ``` xojo
> Var db As New MySQLDatabase
>
> db.Host = "192.168.1.172"
> db.Port = 5432
> db.DatabaseName = "BaseballLeague"
> db.UserName = "broberts"
> db.Password = "streborb"
>
> Try
>   db.Connect
>   ' Use the database
> Catch error As DatabaseException
>   ' DB Connection error
>   MessageBox(error.Message)
> End Try
> ```

## Method descriptions

<div id="mysqlcommunityserver.addrow">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

mysqlcommunityserver.AddRow

**AddRow**(tableName As `String</api/data_types/string>`, row As `DatabaseRow</api/databases/databaserow>`)

> Inserts *row* as a new row in *tableName*.
>
> Always look for a `DatabaseException</api/exceptions/databaseexception>` to verify whether or not the data was added.
>
> This code adds a row to an existing Team table with the columns "Name", "Coach" and "City". It's assumed that the variable db contains an active <span class="title-ref">Database</span> connection:
>
> ``` xojo
> Var row As New DatabaseRow
>
> ' ID will be updated automatically
> row.Column("Name") = "Penguins"
> row.Column("Coach") = "Bob Roberts"
> row.Column("City") = "Boston"
>
> Try  
>   db.AddRow("Team", row)
> Catch error As DatabaseException
>   MessageBox("DB Error: " + error.Message)
> End Try
> ```

**AddRow**(tableName As `String</api/data_types/string>`, row As `DatabaseRow</api/databases/databaserow>`, idColumnName As `String</api/data_types/string>` = "") As `Integer</api/data_types/integer>`

> Inserts *row* as a new row in *tableName* returning the newly assigned ID in the *idColumnName* column.
>
> Always look for a `DatabaseException</api/exceptions/databaseexception>` to verify whether or not the data was added.
>
> <div class="important">
>
> <div class="title">
>
> Important
>
> </div>
>
> Passing in the *idColumnName* is not supported by MySQL versions 8.4 or earlier.
>
> </div>
>
> This code adds a row to an existing Team table with the columns "Name", "Coach" and "City" and returns the primary key created by and assigned to the primary key column (id in this case). It's assumed that the variable db contains an active <span class="title-ref">Database</span> connection:
>
> ``` xojo
> Var row As New DatabaseRow
>
> ' ID will be updated automatically
> row.Column("Name") = "Penguins"
> row.Column("Coach") = "Bob Roberts"
> row.Column("City") = "Boston"
>
> Var primaryKey As Integer
>
> Try  
>   primaryKey = db.AddRow("Team", row, "id")
> Catch error As DatabaseException
>   MessageBox("DB Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.affectedrowcount">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.AffectedRowCount

**AffectedRowCount** As `UInt64</api/data_types/additional_types/uint64>`

> Returns the number of rows that were modified by the most recent `ExecuteSQL<mysqlcommunityserver.executesql>` statement.
>
> Get the number of rows that were changed by an `UPDATE` statement:
>
> ``` xojo
> ' db is a previously connected MySQLCommunityServer
> db.ExecuteSQL("UPDATE Team SET City = 'Boston' Where Coach = 'Bob Roberts'")
>
> Var changeCount As UInt64
> changeCount = db.AffectedRowCount
> ```

<div id="mysqlcommunityserver.begintransaction">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.BeginTransaction

**BeginTransaction**

> Creates a new transaction. Changes to the database made after this call can be saved with `CommitTransaction<mysqlcommunityserver.committransaction>` or undone with `RollbackTransaction<mysqlcommunityserver.rollbacktransaction>`.
>
> A `DatabaseException</api/exceptions/databaseexception>` will be raised if the transaction could not begin or another transaction is already in progress.
>
> You typically want to Commit changes after ensuring there were no database errors:
>
> ``` xojo
> ' Prior DB code has run
>
> Try
>   DB.BeginTransaction
>   DB.ExecuteSQL("CREATE TABLE AddressBook name VARCHAR, email VARCHAR")
>   DB.CommitTransaction
> Catch error As DatabaseException
>   MessageBox("Error: " + error.Message)
>   DB.RollbackTransaction
> End Try
> ```

<div id="mysqlcommunityserver.close">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.Close

**Close**

> Closes or disconnects the database.
>
> Calling Close does not issue a Commit, but some databases will automatically Commit changes in a transaction when you Close the connection and some database will automatically Rollback changes in a transaction when the connection is closed. Refer to the documentation for your database to check what its behavior is.
>
> For desktop apps, you will often Connect to the database when the app starts and Close it when the app quits.
>
> For web apps, you usually Connect to the database when the Session starts and Close it when the Session quits.
>
> This code in the App.Closing event handler closes a previously connected database:
>
> ``` xojo
> DB.Close ' DB is a property on App
> ```

<div id="mysqlcommunityserver.committransaction">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.CommitTransaction

**CommitTransaction**

> Commits an open transaction. This permanently saves changes to the database.
>
> A `DatabaseException</api/exceptions/databaseexception>` will be raised if the transaction could not be committed.
>
> You have to have an open transaction to be able to use CommitTransation. Use `BeginTransaction<mysqlcommunityserver.begintransaction>` to begin a transaction:
>
> ``` xojo
> DB.BeginTransaction
> ```
>
> You typically want to commit changes after ensuring there were no database errors:
>
> ``` xojo
> ' Prior DB code has run
>
> Try
>   DB.CommitTransaction
> Catch error As DatabaseException
>   MessageBox("Error: " + error.Message)
>   DB.RollbackTransaction
> End Try
> ```

<div id="mysqlcommunityserver.connect">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.Connect

**Connect**

> Connects to the database so that you can begin using it.
>
> <div class="warning">
>
> <div class="title">
>
> Warning
>
> </div>
>
> A `DatabaseException</api/exceptions/databaseexception>` will be raised if the connection could not be made.
>
> </div>
>
> This example connects to the database object in the variable db:
>
> ``` xojo
> Try  
>   db.Connect
>   MessageBox("Connected!")
> Catch error As DatabaseException
>   MessageBox("Error connecting to the database: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.executesql">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.ExecuteSQL

**ExecuteSQL**(command As `String</api/data_types/string>`, `ParamArray</api/language/paramarray>` values() As `Variant</api/data_types/variant>`)

> Used to execute an SQL *command*. Use this for commands that do not return any data, such as `CREATE TABLE` or `INSERT`. The *command* parameter contains the SQL statement.
>
> Passing values as parameters protects your database by automatically creating a `MySQLPreparedStatement</api/databases/mysqlpreparedstatement>`.
>
> <div class="tip">
>
> <div class="title">
>
> Tip
>
> </div>
>
> You can also pass an `array</api/language/array>` of values as the first and only parameter instead of a `ParamArray</api/language/paramarray>`. This array **must** be of type `Variant</api/data_types/variant>`.
>
> </div>
>
> <div class="warning">
>
> <div class="title">
>
> Warning
>
> </div>
>
> A `DatabaseException</api/exceptions/databaseexception>` will be raised if the SQL passed is invalid or if an error occurs.
>
> </div>
>
> In this example, the database is being updated without the use of parameters and thus leaves the database vulnerable to a `SQL injection attack</topics/databases/protecting_your_database_from_attack>`:
>
> ``` xojo
> ' Updates a table in a database (db)
> Var sql As String = "UPDATE Customer SET City='" + CityField.Text + "' WHERE PostalCode='" + PostalCodeField.Text + "'"
>
> Try
>   db.ExecuteSQL(sql)
> Catch error As DatabaseException
>   MessageBox("DB Error: " + error.Message)
> End Try
> ```
>
> Here's the same example but using parameters which protects you against a `SQL injection attack</topics/databases/protecting_your_database_from_attack>`:
>
> ``` xojo
> ' Updates a table in a database (db)
> Var sql As String = "UPDATE Customer SET City=? WHERE PostalCode=?"
>
> Try
>   db.ExecuteSQL(sql, CityField.Text, PostalCode.Text)
> Catch error As DatabaseException
>   MessageBox("DB Error: " + error.Message)
> End Try
> ```
>
> The parameter values can also be passed in as a variant array:
>
> ``` xojo
> Var sql As String = "UPDATE Customer SET City=? WHERE PostalCode=?"
> Var values(1) As Variant
>
> values(0) = CityField.Text
> values(1) = PostalCode.Text
>
> Try
>   db.ExecuteSQL(sql, values)
> Catch error As DatabaseException
>   MessageBox("DB Error: " + error.Message)
> End Try
> ```
>
> This code creates the *Team* table:
>
> ``` xojo
> ' db is a database
> Var sql As String = "CREATE TABLE Team (ID INTEGER NOT NULL, Name TEXT, Coach TEXT, City TEXT, PRIMARY KEY(ID));"
>
> Try  
>   db.ExecuteSQL(sql)
>   MessageBox("Team table created successfully.")
> Catch error As DatabaseException
>   MessageBox("DB Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.isconnected">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.IsConnected

**IsConnected** As `Boolean</api/data_types/boolean>`

> Returns `True</api/language/true>` if the connection to the database is still active.

<div id="mysqlcommunityserver.prepare">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.Prepare

**Prepare**(statement As `String</api/data_types/string>`) As `PreparedSQLStatement</api/databases/preparedsqlstatement>`

> Creates a PreparedSQLStatement using the SQL *statement* for use with the `MySQLPreparedStatement</api/databases/mysqlpreparedstatement>` class. A prepared statement is an SQL statement with parameters that has been pre-processed by the database so that it can be executed more quickly if it is re-used with different parameters. Prepared statements also mitigate the risk of SQL injection in web apps.
>
> If the provided SQL statement has an error, a `DatabaseException</api/exceptions/databaseexception>` will occur when you call `SelectSQL<mysqlcommunityserver.selectsql>` or `ExecuteSQL<mysqlcommunityserver.executesql>`.
>
> [SQL Injection](http://en.wikipedia.org/wiki/SQL_injection) is a way to attack database-driven applications.
>
> To create a prepared statement for MySQL:
>
> ``` xojo
> ' db is a previously connected MySQLDatabase object
>
> Var ps As MySQLPreparedStatement
> ps = db.Prepare("SELECT * FROM Country WHERE code = ?")
> ```

<div id="mysqlcommunityserver.rollbacktransaction">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.RollbackTransaction

**RollbackTransaction**

> Cancels an open transaction restoring the database to the state it was in before the transaction began.
>
> A `DatabaseException</api/exceptions/databaseexception>` will be raised if the rollback could not be completed.
>
> You will generally want to rollback database changes if a `DatabaseException</api/exceptions/databaseexception>` occurs within the transaction.
>
> <div class="important">
>
> <div class="title">
>
> Important
>
> </div>
>
> While rolling back a transaction restores the database to its previous state, it has no impact on the data you access in a `RowSet</api/databases/rowset>`. To update the `RowSet</api/databases/rowset>` so that its data matches the database, you will need to re-query the database to recreate the `RowSet</api/databases/rowset>`.
>
> </div>
>
> You have to have an open transaction to be able to use Rollback. Call `BeginTransaction<mysqlcommunityserver.begintransaction>` to begin a transaction:
>
> ``` xojo
> DB.BeginTransaction
> ```
>
> This code uses rollback to revert database changes in a transaction when an error occurs:
>
> ``` xojo
> ' Prior DB code has run
>
> Try
>   db.CommitTransaction
> Catch error As DatabaseException
>   MessageBox("Error: " + error.Message)
>   db.RollbackTransaction
> End If
> ```

<div id="mysqlcommunityserver.selectsql">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.SelectSQL

**SelectSQL**(query As `String</api/data_types/string>`, `ParamArray</api/language/paramarray>` values() As `Variant</api/data_types/variant>`) As `RowSet</api/databases/rowset>`

> Executes a SQL `SELECT` statement and returns the results in a `RowSet</api/databases/rowset>`. The *query* contains the SQL statement.
>
> Passing values as parameters protects your database by automatically creating a `MySQLPreparedStatement</api/databases/mysqlpreparedstatement>`.
>
> <div class="tip">
>
> <div class="title">
>
> Tip
>
> </div>
>
> You can also pass an `array</api/language/array>` of values as the first and only parameter instead of a `ParamArray</api/language/paramarray>`. This array **must** be of type `Variant</api/data_types/variant>`.
>
> </div>
>
> <div class="warning">
>
> <div class="title">
>
> Warning
>
> </div>
>
> A `DatabaseException</api/exceptions/databaseexception>` will be raised if the SQL passed is invalid or if an error occurs.
>
> </div>
>
> This sample adds the names of all customers in a particular postal code to a ListBox. It passes the entire SQL select as a single statement and appends the value from a `TextField</api/user_interface/desktop/desktoptextfield>` called PostalCode, leaving the database vulnerable to an `SQL injection attack</topics/databases/protecting_your_database_from_attack>`:
>
> ``` xojo
> ' db is a valid connection to a database
> Var rowsFound As RowSet
>
> Try
>   rowsFound = db.SelectSQL("SELECT * FROM Customer WHERE PostalCode=" + PostalCode.Text)
>   For Each row As DatabaseRow In rowsFound
>     ListBox1.AddRow(row.Column("Name").StringValue)
>   Next
>   rowsFound.Close
> Catch error As DatabaseException
>   MessageBox("Error: " + error.Message)
> End Try
> ```
>
> This is the same code as above but instead it uses a **value identifier (?)** and then passes the value in separately to avoid a [SQL injection attack](https://en.wikipedia.org/wiki/SQL_injection):
>
> ``` xojo
> ' db is a valid connection to a database
> Var rowsFound As RowSet
>
> Try
>   rowsFound = db.SelectSQL("SELECT * FROM Customer WHERE PostalCode=?", PostalCode.Text)
>   For Each row As DatabaseRow In rowsFound
>     ListBox1.AddRow(row.Column("Name").StringValue)
>   Next
>   rowsFound.Close
> Catch error As DatabaseException
>   MessageBox("Error: " + error.Message)
> End Try
> ```
>
> Multiple values can be passed to SelectSQL. In this example, Age and PostalCode are both `DesktopTextField</api/user_interface/desktop/desktoptextfield>` controls:
>
> ``` xojo
> ' db is a valid connection to a database
> Var rowsFound As RowSet
>
> Try
>   rowsFound = db.SelectSQL("SELECT * FROM Customer WHERE Age=? AND PostalCode=?", Age.Value, PostalCode.Text)
>   For Each row As DatabaseRow In rowsFound
>     ListBox1.AddRow(row.Column("Name").StringValue)
>   Next
>   rowsFound.Close
> Catch error As DatabaseException
>   MessageBox("Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.tablecolumns">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.TableColumns

**TableColumns**(tableName As `String</api/data_types/string>`) As `RowSet</api/databases/rowset>`

> Returns a `RowSet</api/databases/rowset>` with information about all the columns (fields) in the specified *tableName*.
>
> <div class="note">
>
> <div class="title">
>
> Note
>
> </div>
>
> If an error occurs, a `DatabaseException</api/exceptions/databaseexception>` will be raised.
>
> </div>
>
> TableColumns returns a `RowSet</api/databases/rowset>` with these columns:
>
> - ColumnName: A string that is the name of the column.
> - FieldType: An integer that describes the type of the column (refer to the table below).
> - IsPrimary: A boolean that indicates if the column is part of the primary key.
> - NotNull: A boolean that indicates if the column can be set to `NULL`.
> - Length: An integer that describes the length of the field (for some text fields), the precision of numeric data (for some numeric fields) or the default value for a field (for SQLite columns).
> - cid: (SQLite Only) The ID of the column.
>
> This table identifies the Column Type based on the **FieldType** `Integer</api/data_types/integer>`:
>
> | Field Type            | Value | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
> |-----------------------|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
> | Null                  | 0     | Denotes the absence of any value, i.e., a missing value.                                                                                                                                                                                                                                                                                                                                                                                                     |
> | Byte                  | 1     | Stores the byte representation of a character string.                                                                                                                                                                                                                                                                                                                                                                                                        |
> | SmallInt              | 2     | A numeric data type with no fractional part. The maximum number of digits is implementation-specific, but is usually less than or equal to INTEGER. SQLite supports 4-byte smallints. If you are using another data source, check the documentation of your data source.                                                                                                                                                                                     |
> | Integer               | 3     | A numeric data type with no fractional part. The maximum number of digits is implementation-specific. SQLite supports 8-byte integer columns and the FieldType evaluates to 19 (64-bit integer).                                                                                                                                                                                                                                                             |
> | Char                  | 4     | Stores alphabetic data, in which you specify the maximum number of characters for the field, i.e., CHAR (20) for a 20 character field. If a record contains fewer than the maximum number of characters for the field, the remaining characters will be padded with blanks.                                                                                                                                                                                  |
> | Text or VarChar       | 5     | Stores alphabetic data, in which the number of characters vary from record to record, but you don't want to pad the unused characters with blanks. For example, VARCHAR (20) specifies a VARCHAR field with a maximum length of 20 characters.                                                                                                                                                                                                               |
> | Float                 | 6     | Stores floating-point numeric values with a precision that you specify, i.e., FLOAT (5).                                                                                                                                                                                                                                                                                                                                                                     |
> | Double                | 7     | Stores double-precision floating-point numbers.                                                                                                                                                                                                                                                                                                                                                                                                              |
> | Date                  | 8     | Stores year, month, and day values of a date in the format YYYY-MM-DD. The year value is four digits; the month and day values are two digits.                                                                                                                                                                                                                                                                                                               |
> | Time                  | 9     | Stores hour, minute, and second values of a time in the format HH:MM:SS. The hours and minutes are two digits. The seconds values is also two digits, may include a optional fractional part, e.g., 09:55:25.248. The default length of the fractional part is zero.                                                                                                                                                                                         |
> | TimeStamp             | 10    | Stores both date and time information in the format YYYY-MM-DD HH:MM:SS. The lengths of the components of a TimeStamp are the same as for Time and Date, except that the default length of the fractional part of the time component is six digits rather than zero. If a TimeStamp values has no fractional component, then its length is 19 digits If it has a fractional component, its length is 20 digits, plus the length of the fractional component. |
> | Currency              | 11    | This is a 64-bit fixed-point number format that holds 15 digits to the left of the decimal point and 4 digits to the right.                                                                                                                                                                                                                                                                                                                                  |
> | Boolean               | 12    | Stores the values of TRUE or FALSE.                                                                                                                                                                                                                                                                                                                                                                                                                          |
> | Decimal               | 13    | Stores a numeric value that can have both an integral and fractional part. You specify the total number of digits and the number of digits to the right of the decimal place, i.e., DECIMAL (5.2) specifies a decimal field that can contain values up to 999.99. DECIMAL (5) specifies a field that can contain values up to 99,999.                                                                                                                        |
> | Binary                | 14    | Stores code, images, and hexadecimal data. Consult the documentation of your data source for information on the maximum size of a Binary field.                                                                                                                                                                                                                                                                                                              |
> | Long Text (Blob)      | 15    | Stores a text object. Consult the documentation of your data source for information on the maximum size of a Blob.                                                                                                                                                                                                                                                                                                                                           |
> | Long VarBinary (Blob) | 16    | Stores a binary object. SQLite supports blobs of up to any size. Furthermore, a blob can be stored in a column of any declared data affinity. If you are using another data source, check the documentation of your data source.                                                                                                                                                                                                                             |
> | MacPICT               | 17    | Stores a Macintosh PICT image. SQLite does not support this data type. Use a Blob to store images.                                                                                                                                                                                                                                                                                                                                                           |
> | String                | 18    | Text up to about 2 billion bytes. The same as VarChar.                                                                                                                                                                                                                                                                                                                                                                                                       |
> | Int64                 | 19    | Stores a 64-bit integer. Integer fields in SQLite are 64 bits and FieldType returns 19.                                                                                                                                                                                                                                                                                                                                                                      |
> | Unknown               | 255   | Unrecognized data type.                                                                                                                                                                                                                                                                                                                                                                                                                                      |
>
> <div class="note">
>
> <div class="title">
>
> Note
>
> </div>
>
> Depending upon the version you are using, only a subset of these types may be supported.
>
> </div>
>
> The following code creates a table and then display each column name one at a time:
>
> ``` xojo
> 'db  is a valid database connection
>   Try
>     db.ExecuteSQL("CREATE TABLE Invoices (ID INTEGER, CustID INTEGER, Amount Double, Note TEXT)")
>
>     Var columns As RowSet = db.TableColumns("Invoices")
>
>     For Each c As DatabaseRow In columns
>       MessageBox("Column: " + c.Column("ColumnName").StringValue)
>     Next
>   Catch error As IOException
>     MessageBox("The database could not be created: " + error.Message)
>   Catch error As DatabaseException
>     MessageBox("Database error: " + error.Message)
>   End Try
> ```

<div id="mysqlcommunityserver.tableindexes">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.TableIndexes

**TableIndexes**(tableName As `String</api/data_types/string>`) As `RowSet</api/databases/rowset>`

> Returns a `RowSet</api/databases/rowset>` containing the list of indexes for the passed TableName. Returns `Nil</api/language/nil>` if the table has no indexes or the database source does not support indexes.
>
> A `DatabaseException</api/exceptions/databaseexception>` will be raised if an error occurs.
>
> The `RowSet</api/databases/rowset>` returns one row for each index on the table and it has one field: IndexName As `String</api/data_types/string>`.
>
> This code displays the indexes for the "Invoices" table (if it exists) in the specified database:
>
> ``` xojo
> Try
>   db.Connect
>   Var indexRS As RowSet
>   indexRS = db.TableIndexes("Invoices") ' A table with indexes in the db
>   For Each row As DatabaseRow In indexRS
>     MessageBox("Index: " + row.ColumnAt(0).StringValue)
>   Next
>   indexRS.Close
> Catch error As NilObjectException
>   MessageBox("This database has no indexes.")
> Catch error As DatabaseException
>   MessageBox("Could not connect to database. Error: " + error.Message)
> End Try
> ```

<div id="mysqlcommunityserver.tables">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MySQLCommunityServer.Tables

**Tables** As `RowSet</api/databases/rowset>`

> Returns a `RowSet</api/databases/rowset>` with a list of all tables in the database.
>
> A `DatabaseException</api/exceptions/databaseexception>` will be raised if an error occurs.
>
> Tables returns a `RowSet</api/databases/rowset>` with one field: TableName As `String</api/data_types/string>`.
>
> The following code gets and displays the table names for the connected database:
>
> ``` xojo
> ' App.db is a connected database
> Var tables As RowSet = App.db.Tables
>
> Try
>   For Each row As DatabaseRow In tables
>     MessageBox(row.ColumnAt(0).StringValue)
>   Next
>   tables.Close
> Catch error As NilObjectException
>   MessageBox("This database has no tables.")
> End Try
> ```

## Notes

In order to use this class, you must have the MySQLCommunityPlugin database plug-in in your plugins folder. This class connects to the MySQL Community Edition database server. It is the open-source version of MySQL that is freely available. Please refer to the [MySQL products](http://www.mysql.com/products/) page which clarifies the differences between the various editions of MySQL.

The MySQLCommunityPlugin database uses a [GPL](http://www.gnu.org/licenses/gpl.html) license, which may have ramifications for any software that uses it. Please be sure to review the GPL carefully. The plugin itself, GPL license and the full source code for the MySQLCommunityPlugin is included with your installation.

MySQL Community Edition server is also GPL, for more information refer to the [MySQL Community Edition](http://www.mysql.com/products/community/) page.

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

<span class="title-ref">MySQLCommunityServer</span> supports only the MoveNext `RowSet</api/databases/rowset>` navigation method.

Also refer to the [official MySQL documentation](http://dev.mysql.com/doc/).

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Xojo Cloud

To access MySQL databases from web apps running on Xojo Cloud, you will first have to use the `FirewallPort</api/xojocloud/firewallport>` class to open the port used to connect to MySQL, which is usually 3306.

``` xojo
Var fwp As New XojoCloud.FirewallPort(3306, XojoCloud.FirewallPort.Direction.Outgoing)

fwp.Open ' This call is synchronous

If fwp.isOpen Then
  ' Do what you need to do
End If
```

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Rowset updates

MySQL cannot guarantee the contents of a `RowSet</api/databases/rowset>` after issuing an `SaveRow<rowset.saverow>` call (after having previously called `EditRow<rowset.editrow>`). This means you should not try to modify the contents of a RowSet in a loop. Instead select just the single record you wish to modify.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Threading

`SelectSQL<database.selectsql>` and `ExecuteSQL<database.executesql>` statements do not block when called from within `Threads</api/language/threading/thread>`.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Encoding

Note that the MySQL plugin returns strings without a specified encoding. If this is causing problems, you will need to define the encoding on the results returned from the `RowSet</api/databases/rowset>`:

``` xojo
Var dbString As String

' rs is a RowSet returned by SQLSelect
dbString = rs.Column("ColumnName").StringValue.DefineEncoding(Encodings.UTF8)
```

If your database name has characters in it that require special encoding you can try setting the encoding yourself like this:

``` xojo
MyDB.ExecuteSQL("set names utf8 collate utf8_general_ci")
MyDB.ExecuteSQL("set character set utf8")
MyDB.ExecuteSQL("use dbname")
```

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Security

To establish a secure connection, set `SSLEnabled<mysqlcommunityserver.sslenabled>` to `True</api/language/true>` and assign the other SSL properties. Depending on the server setup, you may need to set some or all of those properties. For more information, see [this page](http://dev.mysql.com/doc/refman/5.7/en/ssl-connections.html).

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Linux notes

There may be patches that you need to install for Linux. MySQL compiles the libraries using the Intel compiler and this sometimes requires additional support libraries from MySQL. They are available at <http://dev.mysql.com/downloads/os-linux.html>.

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### MariaDB

MariaDB is a "drop-in" replacement for MySQL. You can read more about it at their web site: <http://mariadb.org/>

The <span class="title-ref">MySQLCommunityServer</span> plugin can be used to connect to MariaDB.

## Sample code

This code establishes a connection to MySQL database:

``` xojo
Var db As New MySQLCommunityServer

db.Host = "192.168.1.172"
db.Port = 3306
db.DatabaseName = "BaseballLeague"
db.UserName = "broberts"
db.Password = "streborb"
db.SSLEnabled = True

' Specify SSL key file
db.SSLKey = New FolderItem("MySQLKeyFile", FolderItem.PathModes.Native)

' Specify SSL certificate file
db.SSLCertificate = New FolderItem("MySQLCertificateFile", FolderItem.PathModes.Native)

' Specify SSL authority file
db.SSLAuthority = New FolderItem("MySQLAuthFileFile", FolderItem.PathModes.Native)

' Specify SSL authority directory
db.SSLAuthorityFolder = New FolderItem("SSLCACertFile", FolderItem.PathModes.Native)

' Specify SSL cipher
Var cipher As String = "DHE-RSA-AES256-SHA"
db.SSLCipher = cipher

Try
  db.Connect
Catch error As DatabaseException
  System.Beep
  MessageBox "Connection failed. Error: " + error.Message
End Try
```

## Compatibility

|                       |                       |
|-----------------------|-----------------------|
| **Project Types**     | Console, Desktop, Web |
| **Operating Systems** | All                   |

<div class="seealso">

`Database</api/databases/database>` parent class; `MySQLPreparedStatement</api/databases/mysqlpreparedstatement>`, `RowSet</api/databases/rowset>` classes

</div>
