`airflow.models.connection`¶

Module Contents¶

Classes¶

Connection

Placeholder to store information about different database instances connection information.

Functions¶

sanitize_conn_id(conn_id[, max_length])

Sanitizes the connection id and allows only specific characters to be within.

Attributes¶

`log`
`RE_SANITIZE_CONN_ID`
`CONN_ID_MAX_LEN`

airflow.models.connection.log[source]¶

airflow.models.connection.RE_SANITIZE_CONN_ID[source]¶

airflow.models.connection.CONN_ID_MAX_LEN: int = 250[source]¶

airflow.models.connection.sanitize_conn_id(conn_id, max_length=CONN_ID_MAX_LEN)[source]¶

Sanitizes the connection id and allows only specific characters to be within.

Namely, it allows alphanumeric characters plus the symbols #,!,-,_,.,:,,/ and () from 1 and up to 250 consecutive matches. If desired, the max length can be adjusted by setting max_length.

You can try to play with the regex here: https://regex101.com/r/69033B/1

The character selection is such that it prevents the injection of javascript or executable bits to avoid any awkward behaviour in the front-end.

Parameters

conn_id (str | None) – The connection id to sanitize.
max_length – The max length of the connection ID, by default it is 250.

Returns

the sanitized string, None otherwise.

Return type

str | None

class airflow.models.connection.Connection(conn_id=None, conn_type=None, description=None, host=None, login=None, password=None, schema=None, port=None, extra=None, uri=None)[source]¶

Bases: airflow.models.base.Base, airflow.utils.log.logging_mixin.LoggingMixin

Placeholder to store information about different database instances connection information.

The idea here is that scripts use references to database instances (conn_id) instead of hard coding hostname, logins and passwords when using operators or hooks.

See also

For more information on how to use this class, see: Managing Connections

Parameters

conn_id (str | None) – The connection ID.
conn_type (str | None) – The connection type.
description (str | None) – The connection description.
host (str | None) – The host.
login (str | None) – The login.
password (str | None) – The password.
schema (str | None) – The schema.
port (int | None) – The port number.
extra (str | dict | None) – Extra metadata. Non-standard data such as private/SSH keys can be saved here. JSON encoded object.
uri (str | None) – URI address describing connection parameters.