Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Create a MySQL metadata collector

Create a collector to import metadata from MySQL.

Before you begin

Before you begin, verify the following:

Procedure

  1. Navigate to All > Workflow Data Fabric > Workflow Data Fabric Home.

  2. Select the Connect Hub

Image omitted: wdf-connect-hub-icon.png
Connect Hub icon icon in the left sidebar.
  1. Select Create > Metadata collector.

  2. From the System list, select MySQL.

  3. From the Connection type list, select one of the following:

    1. Select New connection to configure a new connection.

    2. Select Existing connection to reuse an existing connection and select an existing connection from the Connections list.

      The configuration form is filled with details from the existing connection. The name is appended with the word Copy and sensitive details like password aren't copied.

  4. Complete the form.

    FieldDescription
    Connection nameUnique identifier for the connection. This field can't be modified once the connection is established.
    Short descriptionPurpose and details of the connection.
  5. Configure the authentication options.

    FieldDescription
    UsernameUsername to use to connect to the database.
    PasswordPassword of the databsase user.
  6. Configure the connection information.

FieldDescription
ServerHostname of the database server to connect to.
Server portPort of the database server \(if not the default\).
DatabaseName of the database to connect to. Specify multiple databases by adding one value per line.
Excluded databaseName or regular expression indicating databases not to catalog when the Database field is empty.Note: This parameter is ignored if the Database field is specified.
  1. Configure the statistics and sampling options.
FieldDescription
Enable column statistics collectionEnable harvesting of column statistics (that is, data profiling).Note: Enabling profiling can increase the collector’s runtime, as the collector must read table data to generate profiling metadata.
Target sample size for column statisticsNumber of rows sampled for computation of column statistics and string-value histograms. For example, to sample 1000 rows, set the parameter as: 1000.Default: 100000
Disable Lineage collectionSkip harvesting of intra-database lineage metadata.
Disable Extended Metadata collectionSkip harvesting of extended metadata for data asset types such as database, schema, table, columns functions, stored procedures, user defined types, synonyms. Basic metadata for these data asset types will still be harvested.
Enable Sample String Values collectionEnable sampling and storage of sample values for string-valued columns.
Exclude system functionsExclude harvesting of built-in system functions.
  1. Configure the connection and reliability options.
FieldDescription
Server environmentFriendly name for the environment in which your database server runs when the server name is localhost. Helps differentiate it from other environments.
Database IDUnique identifier for this database. Used to generate the database ID when the database name is not sufficiently unique.
JDBC propertiesJDBC driver properties to pass through to driver connection.
SQL parsing timeoutTimeout in seconds for SQL parsing during lineage collection. Default: 60
  1. Select Save.

Result

The metadata collector is created and appears on the Connectors page with a Configured status. It is now ready to connect to the source system and harvest metadata.

What to do next

After creating the collector, you can perform any of the following tasks:

Parent Topic:MySQL metadata collector