MySQL Connection

MySQL database Connection.

Examples

mysql_connection_basic.yaml

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

mysql_connection_with_ssh_tunnel.yaml

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

mysql_connection_ssl.yaml

connection:
  mysql:
    database: my_database
    host: your-hostname
    user: your-username
    password: "${vaults.my_vault_name.password}"
    ssl:
      ca_cert: "${vaults.my_vault_name.server_certificate}"
      client_cert: "${vaults.my_vault_name.client_public_key_certificate}"
      client_key: "${vaults.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
description		string	No	Brief description of what the model does.
metadata			No	Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
name		string	Yes	The name of the model
ssh_tunnel		string	No
mysql			Yes

Property Details

Connection

Data source/sink Connection.

Property	Default	Type	Required	Description
connection		One of:   S3Connection   GcsConnection   AbfsConnection   LocalFileConnection   SnowflakeConnection   BigQueryConnection   MSSQLConnection   MySQLConnection   OracleConnection   PostgresConnection   HttpConnection   DuckDBConnection   SFTPConnection   DatabricksConnection	Yes	Data system Connection.

MySQLConnectionOptions

MySQL Connection options.

Property	Default	Type	Required	Description
user		string	Yes	User to use for the DB Connection.
password		string	No	Password to use for the DB Connection.
aws_iam_auth		AwsRoleBasedAuthentication	No	AWS IAM authentication to use for the DB Connection.
host		string	Yes	MySQL host.
database		string	Yes	MySQL database.
port		integer	No	MySQL port.
ssl		Any of:   boolean	No	SSL options for the MySQL Connection.

AwsRoleBasedAuthentication

Property	Default	Type	Required	Description
aws_access_key_id		string	No	AWS access key ID to use for the DB Connection. If not provided, the default credential chain will be used.
aws_secret_access_key		string	No	AWS secret access key to use for the DB Connection. If not provided, the default credential chain will be used.
region		string	No	AWS region to use for the DB Connection. If not provided, the default credential chain will be used.
role_arn		string	Yes	AWS Role ARN to use for the DB Connection. Required for AWS IAM authentication.

SSLOptions

Property	Default	Type	Required	Description
ca_cert		string	Yes	Server certificate for the MySQL Connection.
client_cert		string	Yes	Client public key for the MySQL Connection.
client_key		string	Yes	Client private key 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			No	The origin or source information for the resource.
source_event_uuid		string	No	Event UUID 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.