How to configure Doris as a destination in Mage to write data to a Doris database table, including SSH tunnel and optional connection settings.
Key | Description | Example Value | Required |
---|---|---|---|
database | Name of the Doris database to export data to. | demo | ✅ |
host | Hostname or IP address of your Doris database server. | mage.abc.us-west-2.rds.amazonaws.com | ✅ |
port | Port number on which Doris is listening. The default is usually 9030 . | 9030 | ✅ |
username | Username used to connect to the Doris database. Must have permission to read and write data. | root | ✅ |
password | Password for the above user. | abc123... | ✅ |
table | Name of the destination table in Doris that Mage will create or write to. | dim_users_v1 | ✅ |
connection_method | Method used to connect to Doris. Choose between direct or ssh_tunnel . | direct or ssh_tunnel | ✅ |
ssh_host | (Optional) Bastion host IP or DNS if using SSH tunnel. | 123.45.67.89 | ❌ |
ssh_port | (Optional) Port of the bastion host. Defaults to 22 . | 22 | ❌ |
ssh_username | (Optional) Username to authenticate with the bastion server. | bastion_user | ❌ |
ssh_password | (Optional) Password for SSH authentication. Required if not using a private key. | password | ❌ |
ssh_pkey | (Optional) Path to or contents of private key file used for SSH authentication. | /path/to/private/key.pem | ❌ |
conn_kwargs | (Optional) Additional MySQL connection options as a dictionary. | {"ssl_ca": "CARoot.pem"} | ❌ |
use_lowercase | (Optional) Whether to convert column names to lowercase. | true or false | ❌ |
Key | Description | Example Value | Required |
---|---|---|---|
skip_schema_creation | If true , Mage will not run the CREATE SCHEMA command. Useful if the schema already exists. Related issue | true | ❌ |
lower_case | If true , Mage will enforce lowercase column names. Default is true . | true | ❌ |
conn_kwargs
is especially helpful if you need to enable SSL or set advanced connection options.connection_method
to ssh_tunnel
and provide the appropriate ssh_host
, ssh_username
, and either ssh_password
or ssh_pkey
depending on your authentication method.
ssh_pkey
parameter to provide the file path or content of the SSH private key. This is recommended over using ssh_password
.
conn_kwargs
parameter to pass MySQL-compatible SSL options like ssl_ca
, ssl_cert
, and ssl_key
.
overwrite
mode?use_lowercase
and lower_case
?use_lowercase
applies during export, while lower_case
can be used to enforce this behavior globally. We recommend keeping them consistent.