Sling
Slingdata.ioBlogGithubHelp!
  • Introduction
  • Sling CLI
    • Installation
    • Environment
    • Running Sling
    • Global Variables
    • CLI Pro
  • Sling Platform
    • Sling Platform
      • Architecture
      • Agents
      • Connections
      • Editor
      • API
      • Deploy from CLI
  • Concepts
    • Replications
      • Structure
      • Modes
      • Source Options
      • Target Options
      • Columns
      • Transforms
      • Runtime Variables
      • Tags & Wildcards
    • Hooks / Steps
      • Check
      • Command
      • Copy
      • Delete
      • Group
      • Http
      • Inspect
      • List
      • Log
      • Query
      • Replication
      • Store
    • Pipelines
    • Data Quality
      • Constraints
  • Examples
    • File to Database
      • Custom SQL
      • Incremental
    • Database to Database
      • Custom SQL
      • Incremental
      • Backfill
    • Database to File
      • Incremental
  • Connections
    • Database Connections
      • BigTable
      • BigQuery
      • Cloudflare D1
      • Clickhouse
      • DuckDB
      • MotherDuck
      • MariaDB
      • MongoDB
      • Elasticsearch
      • MySQL
      • Oracle
      • Postgres
      • Prometheus
      • Proton
      • Redshift
      • StarRocks
      • SQLite
      • SQL Server
      • Snowflake
      • Trino
    • Storage Connections
      • AWS S3
      • Azure Storage
      • Backblaze B2
      • Cloudflare R2
      • DigitalOcean Spaces
      • FTP
      • Google Storage
      • Local Storage
      • Min.IO
      • SFTP
      • Wasabi
Powered by GitBook
On this page
  • Setup
  • Using sling conns
  • Environment Variable
  • Sling Env File YAML
  • Database user creation
  1. Connections
  2. Database Connections

MySQL

Connect & Ingest data from / to a MySQL database

PreviousElasticsearchNextOracle

Last updated 5 days ago

Setup

The following credentials keys are accepted:

  • host (required) -> The hostname / ip of the instance

  • user (required) -> The username to access the instance

  • database (required) -> The database name of the instance

  • schema (optional) -> The default schema to use

  • password (optional) -> The password to access the instance

  • port (optional) -> The port of the instance. Default is 3306.

  • ssh_tunnel (optional) -> The URL of the SSH server you would like to use as a tunnel (example ssh://user:password@db.host:22)

  • ssh_private_key (optional) -> The private key to use to access a SSH server (raw string or path to file).

  • ssh_passphrase (optional) -> The passphrase to use to access a SSH server.

Additional Parameters. See for more details:

  • allow_all_files -> Allows using LOCAL DATA INFILE without restrictions (true or false)

  • allow_cleartext_passwords -> Permits sending passwords in clear text (true or false)

  • allow_fallback_to_plaintext -> Allows fallback to unencrypted connection if server doesn't support TLS (true or false)

  • allow_native_passwords -> Enables the native password authentication method (true or false)

  • allow_old_passwords -> Allows the old insecure password method (true or false)

  • charset -> Sets the charset for server-side prepared statements (e.g., utf8mb4)

  • check_conn_liveness -> Checks connection liveness before using it (true or false)

  • collation -> Sets the collation for server-side prepared statements (e.g., utf8mb4_general_ci)

  • client_found_rows -> Returns number of matching rows instead of rows changed (true or false)

  • columns_with_alias -> Prepares result columns as if they have an alias (true or false)

  • interpolate_params -> Interpolates placeholders instead of using prepared statements (true or false)

  • loc -> Sets the location for time.Time values (e.g., Local, UTC, or a time zone name)

  • time_truncate -> Truncates time values to the given precision (true or false)

  • max_allowed_packet -> Max packet size allowed (integer value in bytes)

  • multi_statements -> Allows multiple statements in one query (true or false)

  • parse_time -> Converts TIME/DATE/DATETIME to time.Time (true or false)

  • read_timeout -> I/O read timeout (duration string, e.g., 30s, 0.5m, 1h)

  • reject_read_only -> Rejects read-only connections (true or false)

  • server_pub_key -> Server public key name (string)

  • timeout -> Timeout for establishing connections (duration string, e.g., 30s, 0.5m, 1h)

  • write_timeout -> I/O write timeout (duration string, e.g., 30s, 0.5m, 1h)

  • connection_attributes -> Connection attributes to send to MySQL (comma-separated list of key-value pairs)

  • tls -> TLS configuration name (true, false, skip-verify, or custom when providing cert_* keys below)

Custom TLS Certificates:

  • cert_file (optional) -> the client certificate to use to access the instance via TLS (file path or raw)

  • cert_key_file (optional) -> the client key to use to access the instance via TLS (file path or raw)

  • cert_ca_file (optional) -> the client CA certificate to use to access the instance via TLS (file path or raw)

Using sling conns

Here are examples of setting a connection named MYSQL. We must provide the type=mysql property:

$ sling conns set MYSQL type=mysql host=<host> user=<user> database=<database> password=<password> port=<port> 

# OR use url
$ sling conns set MYSQL url="mysql://myuser:mypass@host.ip:3306/mydatabase?tls=skip-verify"

Environment Variable

export MYSQL='mysql://myuser:mypass@host.ip:3306/mydatabase?tls=skip-verify'
export MYSQL='{ type: mysql, user: "myuser", password: "mypass", host: "host.ip", port: 3306, database: "mydatabase", tls: "skip-verify" }'

Sling Env File YAML

connections:
  MYSQL:
    type: mysql
    host: <host>
    user: <user>
    port: <port>
    database: <database>
    schema: <schema>
    password: <password>

  MYSQL_URL:
    url: "mysql://myuser:mypass@host.ip:3306/mydatabase?tls=skip-verify"

Database user creation

To allow Sling to access your database, we need to create a user with the proper privileges. Please follow the steps below:

  1. First you'll need to login as a user with CREATE USER and GRANT OPTION privileges. Create a user sling (or whatever you prefer) by running :

    CREATE USER 'sling'@'%' IDENTIFIED BY '<password>';
  2. If you are planning to load data into this connection, you need to grant the following privileges to that user so we can create tables in schema sling:

    CREATE SCHEMA sling;
    GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, CREATE TEMPORARY TABLES, CREATE VIEW ON sling.* TO 'sling'@'%';
  3. If you are planning to extract data from this connection, you need to give permission to read the tables you'd like Sling to extract.

    -- To give read access to all tables in a specific schema
    GRANT SELECT ON <schema_name>.* TO  'sling'@'%';

See to learn more about the sling env.yaml file.

If you are facing issues connecting, please reach out to us at , on or open a Github Issue .

here
support@slingdata.io
discord
here
here