This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new e9bf127 Add doc warning about connections added via envvars (#17915)
e9bf127 is described below
commit e9bf127a651794b533f30a77dc171e0ea5052b4f
Author: Ruben Laguna <[email protected]>
AuthorDate: Mon Aug 30 18:52:58 2021 +0200
Add doc warning about connections added via envvars (#17915)
Closes #17852
---
docs/apache-airflow/howto/connection.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/apache-airflow/howto/connection.rst
b/docs/apache-airflow/howto/connection.rst
index d95766b..1d6fda9 100644
--- a/docs/apache-airflow/howto/connection.rst
+++ b/docs/apache-airflow/howto/connection.rst
@@ -186,6 +186,12 @@ So if your connection id is ``my_prod_db`` then the
variable name should be ``AI
Connections set using Environment Variables would not appear in the
Airflow UI but you will
be able to use them in your DAG file.
+.. warning::
+
+ Connections created this way will not show up in the Airflow UI or using
``airflow connections list``.
+ You can use ``airflow connections get {CONN_ID}`` if you already know the
``CONN_ID``
+
+
The value of this environment variable must use airflow's URI format for
connections. See the section
:ref:`Generating a Connection URI <generating_connection_uri>` for more
details.