User Guide

MySQL

Suggest Edits

🚧

Before integrating MySQL, please make sure that MySQL Server Time Zone Support is correctly enabled in your MySQL instance.

Lightup account setup

You'll need a user account that can query data and metadata for all tables you want to monitor. You might already have a user set up that will work, or you might need to create one. Grant the user sufficient privileges using security roles.

You can run the following MySQL commands to set up a role and the lightup user account, with the following adjustments:

  • You can use whatever role name you want (readaccess is just an example).
  • The lightup account needs SELECT privileges on all databases you want Lightup to see. You can do this globally using GRANT SELECT ON \*.\*. You can also do this per database with GRANT SELECT ON <database-name>.* commands, as shown in the example (testdata is an example database name). Or, you can grant SELECT only on specific schemas or tables by using more granular GRANT SELECT statements.
  • Substitute your own password for **redacted**.
CREATE ROLE readaccess;
GRANT SELECT ON testdata.* TO readaccess;
CREATE USER IF NOT EXISTS lightup IDENTIFIED BY '**redacted**' DEFAULT ROLE readaccess;

Connect to a MySQL datasource

  1. In the left pane select Datasources*
  2. In the main page select Create Datasource +.
  3. Enter a Datasource Name, then for Connector Type select MySQL.
  4. Under Configure connector, provide the following inputs:
  • Host Name - The hostname for the datasource (check the browser address bar; you want the string between // and /). Example: https://host.na.me/
  • Database Name - The name of the database you're connecting to. Each datasource can only connect to one database. If you need to connect to more than one, you'll need to create a datasource for each.
  • Username - Enter lightup.
  • Password - The username account's password.
  1. After entering the required settings and any optional settings that apply, below the Configure connector section select Test Connection.
  2. After a successful connection test, select Save.
  3. Your new datasource appears in the list of available datasources. By default, these are listed in alphabetical order, so you might have to scroll or change the sort order to see your new datasource.

Advanced/Schema scan frequency

You can adjust how often scans run for a datasource.

  • In section 3 - Advanced, select a value for Schema scan frequency: Hourly, Daily, or Weekly.

Query Governance

MySQL datasources support the Scheduling, Enable data storage, Maximum backfill duration, and Maximum distinct values settings. For steps, see Set query governance settings for a datasource.

Date/time data types

These MySQL date/time data types are supported:

  • DATE
  • DATETIME
  • TIMESTAMP

Object types

These MySQL object types are supported:

Supported Versions

  • MySQL 8

Updated 3 months ago