airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From san...@apache.org
Subject incubator-airflow git commit: [AIRFLOW-530] Update docs to reflect connection environment var has to be in uppercase
Date Sat, 01 Oct 2016 07:33:59 GMT
Repository: incubator-airflow
Updated Branches:
  refs/heads/master 84f6599a6 -> c02425d48


[AIRFLOW-530] Update docs to reflect connection environment var has to be in uppercase

Dear Airflow Maintainers,

Please accept this PR that addresses the following
issues:
https://issues.apache.org/jira/browse/AIRFLOW-530

Right now, the documentation does not clearly
state that connection names are converted to
uppercase form when searched in the environment
(https://github.com/apache/incubator-airflow/blob/
master/airflow/hooks/base_hook.py#L60-L60).
This is confusing as the best practice in Airflow
seems to be to define connections in lower case
form.

Closes #1811 from danielzohar/connection_env_var


Project: http://git-wip-us.apache.org/repos/asf/incubator-airflow/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-airflow/commit/c02425d4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-airflow/tree/c02425d4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-airflow/diff/c02425d4

Branch: refs/heads/master
Commit: c02425d4839b557ad27c328886fb9367c013b1fb
Parents: 84f6599
Author: Daniel Zohar <i@danielzohar.com>
Authored: Sat Oct 1 00:33:50 2016 -0700
Committer: Siddharth Anand <siddharthanand@yahoo.com>
Committed: Sat Oct 1 00:33:50 2016 -0700

----------------------------------------------------------------------
 docs/concepts.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-airflow/blob/c02425d4/docs/concepts.rst
----------------------------------------------------------------------
diff --git a/docs/concepts.rst b/docs/concepts.rst
index 82d5248..e27de26 100644
--- a/docs/concepts.rst
+++ b/docs/concepts.rst
@@ -329,10 +329,11 @@ variables from the operating system. The environment variable needs
to be
 prefixed with ``AIRFLOW_CONN_`` to be considered a connection. When
 referencing the connection in the Airflow pipeline, the ``conn_id`` should
 be the name of the variable without the prefix. For example, if the ``conn_id``
-is named ``POSTGRES_MASTER`` the environment variable should be named
-``AIRFLOW_CONN_POSTGRES_MASTER``. Airflow assumes the value returned
-from the environment variable to be in a URI format
-(e.g. ``postgres://user:password@localhost:5432/master``).
+is named ``postgres_master`` the environment variable should be named
+``AIRFLOW_CONN_POSTGRES_MASTER`` (note that the environment variable must be
+all uppercase). Airflow assumes the value returned from the environment
+variable to be in a URI format (e.g.
+``postgres://user:password@localhost:5432/master``).
 
 Queues
 ======


Mime
View raw message