--- title: MySQL Integration Guide slug: litmusedge-v1/how-to-guides/integration-guides/mysql description: Learn how to set up the MySQL connector. docTags: createdAt: 2022-11-24T18:28:37.000Z --- Review the following guide for setting up an integration between Litmus Edge and a MySQL database. # Video :::Iframe{iframeHeight="0" code=""} ::: # User Scenario In this guide you will deploy a MySQL database container from Litmus Edge and then integrate with the database using the DB-MySQL connector. For your specific scenario you may use an external MySQL database to set up the integration. If using a database not deployed through Litmus Edge, you can use the following supported versions: - MySQL (4.1+) - MariaDB - Percona Server - Google CloudSQL - Sphinx (2.2.3+) For external MySQL databases, refer to the following to learn more: - [MySQL Docker Image](https://hub.docker.com/_/mysql) - [MySQL Documentation](https://dev.mysql.com/doc/) # Step 1: Add Device Follow the steps to [Connect a Device](docId:3eyAfPpweuVmBLCEy17sq). The device will be used to store tags that will be eventually used to create outbound topics in the connector. Make sure to select the **Enable Data Store** checkbox. # Step 2: Add Tags After connecting the device in Litmus Edge, you can [Add Tags](docId:8sE7z3PmRfwL1nmzcwaLX) to the device. Create tags that you want to use to create outbound topics for the connector. # Step 3: Add MySQL Marketplace Application :::hint{type="info"} **Note**: The version used in this guide for MySQL version is 8.0. See the [MySQL 8.0 Reference Manual](https://dev.mysql.com/doc/refman/8.0/en/) for more information. ::: **To add the MySQL Marketplace Application:** 1. In Litmus Edge, navigate to **Applications **> **Marketplace**. 2. Click **Marketplace List** and select **Default Marketplace Catalog**. 3. Click the **MySQL** application tile. 4. From the **Installation script version** drop-down list, select **latest**. 5. Configure the following parameters. - **Name**: Enter **MySQL**. - **Database**: Enter **sample**. - **User**: Enter **user**. - **Password**: Enter the user password. - **MySQL password**: Enter the same value as the *Password *parameter. 6. Click **Launch**. 7. Navigate to **Applications **> **Catalog Apps**. The MySQL application appears, pulls the image, and then starts the application. The MySQL application shows as running. 8. Navigate to **Applications **> **Containers**. The MySQL application Container is running. 9. Copy the IP address for the MySQL application. # Step 4: Add the DB - MySQL Connector Follow the steps to [Add a Connector](docId\:b7eMDh8AO2-NOqDHwPD7Y) and select the **DB - MySQL **provider. Configure the following parameters. - **Name**: Enter a name for the connector. - **Hostname**: Paste the IP address you copied in Step 3. - **Port**: The MySQL Server port. The default value is **3306**. - **Username**: Enter **user**. - **Password **(Optional): Enter the user password. - **Database**: Enter **sample**. - **Table**: Enter **test\_table**. If you are sending data to an existing table, use the corresponding name. - **Show Mapping**: If you want to send data to a custom table, select this check box and unselect *Create table*. See [Work with Tables in SQL Connectors (Create Table and Show Mapping)](docId\:Yj_sKBPP9J_TH3_qvC1Tm) to learn more. To add key/value pairs for the custom table, see [Configure Key/Value Pairs](docId\:Yj_sKBPP9J_TH3_qvC1Tm). - **Create table**: If you want to send data to an existing table in the default format, or you want to create a new table in the default format, select this checkbox and unselect *Show Mapping*. See [Work with Tables in SQL Connectors (Create Table and Show Mapping)](docId\:Yj_sKBPP9J_TH3_qvC1Tm) to learn more. - **Commit timeout**: Enter the transaction commit timeout in (ms). - **Max transaction size**: Enter the maximum number of messages before a transaction is committed, regardless of timeout parameter. - **Bulk insert count**: (Available for Litmus Edge version 3.11.1 and later) To enable this option, enter the number of messages to group together and send as one bulk insert statement. Enabling this option can improve how quickly data is processed when dealing with high volumes of tags. - **Throttling limit**: The maximum number of messages per second to be processed. The default value is zero, which means that there is no limit. - **Persistent storage**: When enabled, this will cause messages to undergo a store-and-forward procedure. Messages will be stored within Litmus Edge when cloud providers are online. - **Queue Mode**: Select the queue mode as **lifo **(last in first out) or **fifo **(first in first out). Selecting **lifo **means that the last data entry is processed first, and selecting **fifo **means the first data entry is processed first. # Step 5: Enable the Connector After adding the connector, click the toggle in the connector tile to enable it. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/UCTN6TwDoDpYB_nliMqgK_mysql.png" size="60" width="388" height="358" position="center" showCaption="false"} If you see a *Failed *status, you can review the [Connector Logs](docId:5hctoRLhgaX3Ikh_lvi0A) and relevant error messages. # Step 6: Create Topics for Connector You will now need to import the tags created in Step 2 as topics for the MySQL connector. The topics will be created as outbound topics. **To create outbound topics:** 1. Click the connector tile. The connector *Dashboard *appears. 2. Click the **Topics **tab. 3. Click the **Import from DeviceHub** tags icon. The *DeviceHub Import *dialog box appears. ![](https://api.archbee.com/api/optimize/xSuIWwMa6RnsbeD5Kdqd7-zaOGMDYbPZWYALvLBgotp-20250606-203859.png) After adding all required topics, navigate to the Integration overview page and ensure the connector is not disabled and still shows a CONNECTED status. # Step 7: Enable Topics To enable the topics, return to the *Topics* tab and click the **Enable all topics** icon. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Iq7BWYqGWueu4US73iBl3_image.png" size="80" width="1220" height="330" caption="Enable all topics icon" position="center" showCaption="true"} # Step 8: Make MySQL Queries You can now verify that you can view data through the terminal command window. Update the credentials, database name, and table name to your own specific configurations. **To make queries in the container terminal:** 1. In Litmus Edge, navigate to **Applications **>** Containers**. 2. Click the **Terminal **icon next to the MySQL container. The MySQL shell opens. 3. From the MySQL container terminal, enter `mysql -u user -p` and press **ENTER**. *Enter password: *appears. 4. Enter your user password, and then press **ENTER**. *Welcome to the MySQL monitor *appears. 5. Enter `show databases;`**, **and then press **ENTER**. The database name appears. 6. Enter `use sample;`, and then press **ENTER**. *Reading table information for completion of table and column names *appears in the console. 7. Enter `show tables;`, and then press **ENTER**. The table names for *sample *appear. 8. Enter `select * from test_table;` (or the table name you configured in Step 4), and press **ENTER**. Data appears from the imported tags for the connector. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/8ySxZhLyQ3WRBEtWPRdq2_applications-mysql-terminal-data.png" size="80" width="1619" height="744" caption="MySQL connection messages" position="center" showCaption="true"}