| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Managing Connections — Airflow Documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../_static/language_data.js"></script> |
| <script type="text/javascript" src="../../_static/jira-links.js"></script> |
| |
| <script type="text/javascript" src="../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/exampleinclude.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Amazon Web Services Connection" href="aws.html" /> |
| <link rel="prev" title="Creating a custom Operator" href="../custom-operator.html" /> |
| |
| <script> |
| </script> |
| <style> |
| |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.8 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">How-to Guides</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../set-config.html">Setting Configuration Options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../initialize-database.html">Initializing a Database Backend</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../operator/index.html">Using Operators</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../custom-operator.html">Creating a custom Operator</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Managing Connections</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#creating-a-connection-with-the-ui">Creating a Connection with the UI</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#editing-a-connection-with-the-ui">Editing a Connection with the UI</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#creating-a-connection-with-environment-variables">Creating a Connection with Environment Variables</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#connection-types">Connection Types</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="aws.html">Amazon Web Services Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gcp.html">Google Cloud Platform Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gcp_sql.html">Google Cloud SQL Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="grpc.html">gRPC</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="mysql.html">MySQL Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="oracle.html">Oracle Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="postgres.html">PostgresSQL Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="ssh.html">SSH Connection</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../secure-connections.html">Securing Connections</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../secure-connections.html#rotating-encryption-keys">Rotating encryption keys</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../write-logs.html">Writing Logs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../run-behind-proxy.html">Running Airflow behind a reverse proxy</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../run-with-systemd.html">Running Airflow with systemd</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../run-with-upstart.html">Running Airflow with upstart</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../use-test-config.html">Using the Test Mode Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../check-health.html">Checking Airflow Health Status</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../define_extra_link.html">Define an operator extra link</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../email-config.html">Email Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tracking-user-activity.html">Tracking User Activity</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../cli-completion.html">Using the Command Line Interface</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../executor/index.html">Executor</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../errors.html">Error Tracking</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../dag-serialization.html">DAG Serialization</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../best-practices.html">Best Practices</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../_api/index.html">Python API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../configurations-ref.html">Configurations</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../index.html">Docs</a> »</li> |
| |
| <li><a href="../index.html">How-to Guides</a> »</li> |
| |
| <li>Managing Connections</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../_sources/howto/connection/index.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <blockquote> |
| <div></div></blockquote> |
| <div class="section" id="managing-connections"> |
| <h1>Managing Connections<a class="headerlink" href="#managing-connections" title="Permalink to this headline">¶</a></h1> |
| <p>Airflow needs to know how to connect to your environment. Information |
| such as hostname, port, login and passwords to other systems and services is |
| handled in the <code class="docutils literal notranslate"><span class="pre">Admin->Connections</span></code> section of the UI. The pipeline code you |
| will author will reference the ‘conn_id’ of the Connection objects.</p> |
| <img alt="../../_images/connections.png" src="../../_images/connections.png" /> |
| <p>Connections can be created and managed using either the UI or environment |
| variables.</p> |
| <p>See the <a class="reference internal" href="../../concepts.html#concepts-connections"><span class="std std-ref">Connections Concepts</span></a> documentation for |
| more information.</p> |
| <div class="section" id="creating-a-connection-with-the-ui"> |
| <h2>Creating a Connection with the UI<a class="headerlink" href="#creating-a-connection-with-the-ui" title="Permalink to this headline">¶</a></h2> |
| <p>Open the <code class="docutils literal notranslate"><span class="pre">Admin->Connections</span></code> section of the UI. Click the <code class="docutils literal notranslate"><span class="pre">Create</span></code> link |
| to create a new connection.</p> |
| <img alt="../../_images/connection_create.png" src="../../_images/connection_create.png" /> |
| <ol class="arabic simple"> |
| <li><p>Fill in the <code class="docutils literal notranslate"><span class="pre">Conn</span> <span class="pre">Id</span></code> field with the desired connection ID. It is |
| recommended that you use lower-case characters and separate words with |
| underscores.</p></li> |
| <li><p>Choose the connection type with the <code class="docutils literal notranslate"><span class="pre">Conn</span> <span class="pre">Type</span></code> field.</p></li> |
| <li><p>Fill in the remaining fields. See |
| <a class="reference internal" href="#manage-connections-connection-types"><span class="std std-ref">Connection Types</span></a> for a description of the fields |
| belonging to the different connection types.</p></li> |
| <li><p>Click the <code class="docutils literal notranslate"><span class="pre">Save</span></code> button to create the connection.</p></li> |
| </ol> |
| </div> |
| <div class="section" id="editing-a-connection-with-the-ui"> |
| <h2>Editing a Connection with the UI<a class="headerlink" href="#editing-a-connection-with-the-ui" title="Permalink to this headline">¶</a></h2> |
| <p>Open the <code class="docutils literal notranslate"><span class="pre">Admin->Connections</span></code> section of the UI. Click the pencil icon next |
| to the connection you wish to edit in the connection list.</p> |
| <img alt="../../_images/connection_edit.png" src="../../_images/connection_edit.png" /> |
| <p>Modify the connection properties and click the <code class="docutils literal notranslate"><span class="pre">Save</span></code> button to save your |
| changes.</p> |
| </div> |
| <div class="section" id="creating-a-connection-with-environment-variables"> |
| <h2>Creating a Connection with Environment Variables<a class="headerlink" href="#creating-a-connection-with-environment-variables" title="Permalink to this headline">¶</a></h2> |
| <p>Connections in Airflow pipelines can be created using environment variables. |
| The environment variable needs to have a prefix of <code class="docutils literal notranslate"><span class="pre">AIRFLOW_CONN_</span></code> for |
| Airflow with the value in a URI format to use the connection properly.</p> |
| <p>When referencing the connection in the Airflow pipeline, the <code class="docutils literal notranslate"><span class="pre">conn_id</span></code> |
| should be the name of the variable without the prefix. For example, if the |
| <code class="docutils literal notranslate"><span class="pre">conn_id</span></code> is named <code class="docutils literal notranslate"><span class="pre">postgres_master</span></code> the environment variable should be |
| named <code class="docutils literal notranslate"><span class="pre">AIRFLOW_CONN_POSTGRES_MASTER</span></code> (note that the environment variable |
| must be all uppercase).</p> |
| <p>Airflow assumes the value returned from the environment variable to be in a URI |
| format (e.g. <code class="docutils literal notranslate"><span class="pre">postgres://user:password@localhost:5432/master</span></code> or |
| <code class="docutils literal notranslate"><span class="pre">s3://accesskey:secretkey@S3</span></code>). The underscore character is not allowed |
| in the scheme part of URI, so it must be changed to a hyphen character |
| (e.g. <code class="docutils literal notranslate"><span class="pre">google-compute-platform</span></code> if <code class="docutils literal notranslate"><span class="pre">conn_type</span></code> is <code class="docutils literal notranslate"><span class="pre">google_compute_platform</span></code>). |
| Query parameters are parsed to one-dimensional dict and then used to fill extra.</p> |
| </div> |
| <div class="section" id="connection-types"> |
| <span id="manage-connections-connection-types"></span><h2>Connection Types<a class="headerlink" href="#connection-types" title="Permalink to this headline">¶</a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="aws.html">Amazon Web Services Connection</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="gcp.html">Google Cloud Platform Connection</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="gcp_sql.html">Google Cloud SQL Connection</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="grpc.html">gRPC</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="mysql.html">MySQL Connection</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="oracle.html">Oracle Connection</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="postgres.html">PostgresSQL Connection</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="ssh.html">SSH Connection</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="aws.html" class="btn btn-neutral float-right" title="Amazon Web Services Connection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../custom-operator.html" class="btn btn-neutral float-left" title="Creating a custom Operator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| <!-- Theme Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-140539454-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| |
| |
| |
| </body> |
| </html> |
