Create a MySQL Data Source

Follow these steps to connect to MySQL and create a MySQL data source:

  1. Configure User Access Rights

  2. Create a MySQL Data Source

Refer to Additional Information for additional performance tips and information about MySQL feature support.

Configure User Access Rights

We recommend that you create a dedicated user and user role for integration with the GoodData platform.

Steps:

  1. Create a user role and grant access rights:

    CREATE ROLE {role_name};
GRANT SELECT ON {database_name}.* TO {role_name};

  2. Create a user and grant it the user role:

    CREATE USER {user_name};
GRANT {role_name} TO {user_name};

  3. Make the user role default for the user:

    ALTER USER {user_name} DEFAULT ROLE {role_name};

Create a MySQL Data Source

Once you have configured your MySQL user’s access rights, you can proceed to create a MySQL data source that you can then connect to.

UI
API

Steps:

  1. On the home page switch to Data sources.

    data sources tab

  2. Click Connect data.

    connect data

  3. Select MySQL.

    select data source type

  4. Name your data source and fill in your MySQL credentials and click Connect:

    db cretentials

  5. Click Save.

    Your data source is created!

    db creation complete

Steps:

  1. Create a MySQL data source with the following API call:

    curl $HOST_URL/api/v1/entities/dataSources \
-H "Content-Type: application/vnd.gooddata.api+json" \
-H "Accept: application/vnd.gooddata.api+json" \
-H "Authorization: Bearer $API_TOKEN" \
-X POST \
-d '{
    "data": {
    "type": "dataSource",
    "id": "<unique_id_for_the_data_source>",
    "attributes": {
    "name": "<data_source_display_name>",
    "url": "jdbc:mysql:https://<MYSQL_HOST>:3306/<MYSQL_DBNAME>",
    "schema": "<MYSQL_DBNAME>",
    "type": "MYSQL",
    "username": "<MYSQL_USER>",
    "password": "<MYSQL_PASSWORD>"
}}}' | jq .

  2. To confirm that the data source has been created, ensure the server returns the following response:

    {
  "data": {
    "type": "dataSource",
    "id": "<unique_id_for_the_data_source>",
    "attributes": {
      "name": "<data_source_display_name>",
      "url": "jdbc:mysql:https://<MYSQL_HOST>:3306/<MYSQL_DBNAME>",
      "schema": "<MYSQL_DBNAME>",
      "type": "MYSQL",
      "username": "<MYSQL_USER>"
    }
  },
  "links": {
    "self": "$HOST_URL/api/v1/entities/dataSources/<unique_id_for_the_data_source>"
  }
}

Additional Information

Ensure you understand the following limitations and recommended practice.

Data Source Details

  • Typical JDBC URL may look like this:

    jdbc:mysql:https://<host>:<port>/<databaseName>

    For secured connection using SSL include ?sslMode=required.

    Note that we append the permitMysqlScheme=true parameter to all MySQL JDBC URL calls.

  • Basic authentication is supported. Specify user and password.

  • GoodData uses up-to-date drivers.

Unsupported Features and Limitations

GoodData does not currently support the following features:

  • The following functions are not supported:
    • MEDIAN
    • PERCENTILE
    • CORREL
    • COVAR
    • RSQ
    • SLOPE
    • INTERCEPT
  • Filtering by boolean columns is not supported
  • There are known issues when using SQL datasets with a MySQL database:
    • Converting a regular dataset into a SQL dataset generates an invalid query. You have to manually rewrite it to make it work.
    • SQL datasets are not supported if the query contains one of these data types: TINYINT, FLOAT, DECIMAL, DOUBLE UNSIGNED.
    • When converting to SQL dataset, the MySQL YEAR data type is converted to STRING.
  • We do not currently support multiple hosts for MySQL JDBC URLs.
ClickHouse
MariaDB