`airflow.secrets.local_filesystem`¶

Objects relating to retrieving connections and variables from local file

Module Contents¶

Retrieves Connection objects and Variables from local files

`get_connection_parameter_names`()	Returns `airflow.models.connection.Connection` constructor parameters.
`load_variables`(file_path)	Load variables from a text file.
`load_connections`(file_path)	This function is deprecated. Please use airflow.secrets.local_filesystem.load_connections_dict.",
`load_connections_dict`(file_path)	Load connection from text file.

`log`
`FILE_PARSERS`

airflow.secrets.local_filesystem.get_connection_parameter_names()[source]¶

airflow.secrets.local_filesystem.load_variables(file_path)[source]¶

Load variables from a text file.

JSON, YAML and .env files are supported.

Parameters: file_path (str) – The location of the file that will be processed.
Return type: Dict[str, List[str]]

airflow.secrets.local_filesystem.load_connections(file_path)[source]¶

This function is deprecated. Please use airflow.secrets.local_filesystem.load_connections_dict.”,

airflow.secrets.local_filesystem.load_connections_dict(file_path)[source]¶

Load connection from text file.

JSON, YAML and .env files are supported.

Returns: A dictionary where the key contains a connection ID and the value contains the connection.
Return type: Dict[str, airflow.models.connection.Connection]

class airflow.secrets.local_filesystem.LocalFilesystemBackend(variables_file_path=None, connections_file_path=None)[source]¶

Bases: airflow.secrets.base_secrets.BaseSecretsBackend, airflow.utils.log.logging_mixin.LoggingMixin

Retrieves Connection objects and Variables from local files

JSON, YAML and .env files are supported.

Parameters

variables_file_path (Optional[str]) – File location with variables data.
connections_file_path (Optional[str]) – File location with connection data.

get_connection(conn_id)[source]¶

Return connection object with a given conn_id.

Tries get_conn_value first and if not implemented, tries get_conn_uri

get_connections(conn_id)[source]¶

Return connection object with a given conn_id.

get_variable(key)[source]¶

Return value for Airflow Variable