target_sql

Home >> Targets >> sql

SQL

Executes SQL scripts.

{
    "deploy": {
        "targets": [
            {
                "type": "sql",
                "name": "My SQL server",
                "description": "My SQL target",
                
                "engine": "mysql",
                "options": {
                    "host": "mysql.example.com",
                    "user": "dbUser",
                    "password": "P@assword123!", 
                    "database": "myDatabase"
                }
            }
        ]
    }
}

Name	Description
encoding	The text encoding of the SQL files. Default: utf8
engine	The engine to use. Default: mysql
options	The options for the connection.
sqlFilesOnly	Use .sql files only or not. Default: (true)
transformer*	The path to the script that transforms data before it is executed.
transformerOptions	Optional data for the transformer script.

^{* supports placeholders}

engine

Name	Description
mysql	MySQL
sql	Microsoft SQL

options

MySQL

Name	Description
database	The database to connect to.
host	The host. Default: 127.0.0.1
port	The TCP port. Default: 3306
password	The password.
rejectUnauthorized	Reject untrusted SSL connections or not.
user	The username. Default: root

SQL (Microsoft SQL)

Name	Description
database	The database to connect to.
driver	The driver to use (for more information s. mssql). Default: tedious
encrypt	Encrypt the connection or not. Default: (false)
host	The host. Default: 127.0.0.1
port	The TCP port. Default: 1433
password	The password.
user	The username. Default: sa