Adding a MySQL Connection

Prerequisites

• A user with sufficient permissions is required to establish a connection with MySQL.
• Zeenea traffic flows towards the database must be open.

IMPORTANT

The MySQL driver is not delivered with the connector. Download the MySQL driver related to your MySQL instance and move it into the /lib-ext folder of your scanner. You will find the driver into sources provided by the editor on their website: https://dev.mysql.com/downloads/connector/j/

note

A link to the configuration template can be found here: Zeenea Connector Downloads.

Supported Versions

The MySQL module was developed and tested with version MySQL Server 8.0. It is compatible with the PolarDB versions of the Alibaba Cloud service as well as with the RDS and Aurora versions of the Amazon Cloud service.

Installing the Plugin

From version 54 of the scanner, the MySQL connector is presented as a plugin.

It can be downloaded here and requires a scanner version 64: Zeenea Connector Downloads

For more information on how to install a plugin, please refer to the following article: Installing and Configuring Connectors as a Plugin.

Declaring the Connection

Creating and configuring connectors is done through a dedicated configuration file located in the /connections folder of the relevant scanner. The scanner frequently checks for any change and resynchronises automatically.

Read more: Managing Connections

In order to establish a connection with a MySQL instance, specifying the following parameters in the dedicated file is required:

Parameter	Expected value
name	The name that will be displayed to catalog users for this connection.
code	The unique identifier of the connection on the Zeenea platform. Once registered on the platform, this code must not be modified or the connection will be considered as new and the old one removed from the scanner.
connector_id	The type of connector to be used for the connection. Here, the value must be Mysql and this value must not be modified.
connection.url	Database address (example: jdbc:mysql://host:3306/database)
connection.username	Username
connection.password	User password

User Permissions

In order to collect metadata, the running user's permissions must allow them to access and read databases that need cataloging.

Here, the user must have read access to objects from the INFORMATION_SCHEMA schema.

Data Extraction

To extract information, the connector runs requests on views from the INFORMATION_SCHEMA schema.

Collected Metadata

Inventory

Will collect the list of tables and views accessible by the user.

Dataset

A dataset can be a table or a view.

• Name: Concatenation schema name.object name (Object name: Table or view name)
• Source Description
• Technical Data:
  • Catalog: Source catalog
  • Schema: Source schema
  • Table: table name

Field

One per table field.

• Name: Field name
• Source Description: Source field description
• Type: Field type
• Can be null: Depending on field settings
• Multivalued: Not supported. Default value false.
• Primary key: Depending on the "Primary Key" field attribute
• Technical Data:
  • Technical Name
  • Native type: Field native type

Unique Identification Keys

A key is associated with each item of the catalog. When the object comes from an external system, the key is built and provided by the connector.

More information about unique identification keys in this documentation: Identification Keys.

Object	Identification Key	Description
Dataset	code/schema/object name	code: Unique identifier of the connection noted in the configuration file schema: Object schema object name: Table or view name
Field	code/schema/object name/field name	code: Unique identifier of the connection noted in the configuration file schema: Object schema object name: Table or view name field name