MySQL Connection

Connection to a MySQL database.

Examples

mysql_connection_basic.yaml

connection:
  mysql:
    host: your-hostname
    user: your-username
    password: "${secret.my_vault_name.password}"

mysql_connection_with_ssh_tunnel.yaml

connection:
  mysql:
    host: your-hostname
    user: your-username
    password: "${secret.my_vault_name.password}"
    database: your-database
    port: 3307
  ssh_tunnel: your-ssh-tunnel-name

mysql_connection_ssl.yaml

connection:
  mysql:
    host: your-hostname
    user: your-username
    password: "${secret.my_vault_name.password}"
    ssl:
      ca_cert: "${secret.my_vault_name.server_certificate}"
      client_cert: "${secret.my_vault_name.client_public_key_certificate}"
      client_key: "${secret.my_vault_name.client_private_key}"

MySQLConnection

info

MySQLConnection is defined beneath the following ancestor nodes in the YAML structure:

• Connection

Below are the properties for the MySQLConnection. Each property links to the specific details section further down in this page.

Property	Default	Type	Required	Description
name		string	No	The name of the model
description		string	No	A brief description of what the model does.
metadata		ResourceMetadata	No	Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
ssh_tunnel		string	No
mysql		MySQLConnectionOptions	Yes	The MySQL connection options.

Property Details

Connection

A connection to a data source/sink.

Property	Default	Type	Required	Description
connection		One of:   S3Connection   GcsConnection   AbfsConnection   LocalFileConnection   SnowflakeConnection   BigQueryConnection   MSSQLConnection   MySQLConnection   OracleConnection   PostgresConnection   HttpConnection   DuckDBConnection   CustomPythonConnection   SynapseConnection	Yes	The connection to the data system.

MySQLConnectionOptions

MySQL connection options.

Property	Default	Type	Required	Description
host		string	Yes	The MySQL host to connect to.
user		string	Yes	The MySQL user to connect as.
password		string	Yes	The MySQL password to use for the connection.
database		string	No	The MySQL database to connect to.
port		integer	No	The MySQL port to connect to.
ssl		Any of:   boolean   SSLOptions	No	The SSL options to use for the MySQL connection.

SSLOptions

Property	Default	Type	Required	Description
ca_cert		string	Yes	The server certificate to use for the MySQL connection.
client_cert		string	Yes	The client public key to use for the MySQL connection.
client_key		string	Yes	The client private key to use for the MySQL connection.

ResourceMetadata

Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.

Property	Default	Type	Required	Description
source		ResourceLocation	No	The origin or source information for the resource.
source_event_uuid		string	No	UUID of the event that is associated with creation of this resource.

ResourceLocation

The origin or source information for the resource.

Property	Default	Type	Required	Description
path		string	Yes	Path within repository files where the resource is defined.
first_line_number		integer	No	First line number within path file where the resource is defined.