Adding a MariaDB Connection
Prerequisites
- A user with sufficient permissions is required to establish a connection with MariaDB.
- Zeenea traffic flows towards the database must be open.
The MariaDB driver is not delivered with the connector. Download the MariaDB driver related to your MariaDB 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://mariadb.com/downloads/connectors/connectors-data-access/.
A link to the configuration template can be found here: Zeenea Connector Downloads
Supported Versions
The MariaDB connector was developed and tested with version MariaDB 10. It is compatible with RDS versions of the Amazon Cloud service.
Installing the Plugin
From version 54 of the scanner, the MariaDB connector is presented as a plugin.
It can be downloaded here and requires 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 MariaDB 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 mariadb and this value must not be modified. |
connection.url | Database address (example: jdbc:mariadb://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
- Source Description
- Technical Data:
- Catalog: Source catalog
- Schema: Source schema
- Table: table name
- Type:
- BASE TABLE
- VIEW
- SYSTEM VIEW
- SYSTEM VERSIONED
- SEQUENCE
Field
Dataset field.
- Name
- Source Description
- 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 Identifier 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 | Identifier Key | Description |
---|---|---|
Dataset | code/schema/dataset name |
|
Field | code/schema/dataset name/field name |
|