MySQL

This connector is used to query a MySQL database using SQL.

Connection configuration

Two connection modes are available: password and connection_string.

Password mode

NameMandatoryDefaultDescription
modenopasswordConnection mode: password or connectionstring
hostnameyesServer hostname or IP address
databaseyesDatabase name
usernameyesUsername
passwordyesPassword
portno3306Port number
requiresecure_transportnofalseEnable SSL/TLS transport

Connection string mode

NameMandatoryDefaultDescription
modeyesMust be connectionstring
connectionstringyesSQLAlchemy connection string

Example (password mode)

connections:
  mysql_connection:
    type: mysql
    hostname: my-server.database.windows.net
    database: my_database
    username: my_user
    password: $var.mysql_password
    port: 3306

Example (connection string mode)

connections:
  mysql_connection:
    type: mysql
    mode: connection_string
    connection_string: mysql+pymysql://user:password@host:3306/database

Test case configuration

NameMandatoryDefaultDescription
queryyesSQL query to execute

Example

Example MySQL:
  source:
    type: mysql
    connection: mysql_connection
    query: |
      SELECT *
      FROM employees
      WHERE hire_date < '2000-01-01'
  expected:
    type: csv
    path: data/employeesbefore2000.csv

Requirements

  • pip install pymysql (included in ploosh full installation)