| |
| |
| <!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="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Securing Connections" href="secure-connections.html" /> |
| <link rel="prev" title="Using Operators" href="operator.html" /> |
| |
| |
| <script src="../_static/js/modernizr.min.js"></script> |
| |
| </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 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.html">Using Operators</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="#google-cloud-platform">Google Cloud Platform</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#mysql">MySQL</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="write-logs.html">Writing Logs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="executor/use-celery.html">Scaling Out with Celery</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="executor/use-dask.html">Scaling Out with Dask</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="executor/use-mesos.html">Scaling Out with Mesos (community contributed)</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> |
| </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</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="../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">Experimental Rest API</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="../lineage.html">Lineage</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="../code.html">API Reference</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/manage-connections.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"> |
| |
| <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">Connenctions 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>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.</li> |
| <li>Choose the connection type with the <code class="docutils literal notranslate"><span class="pre">Conn</span> <span class="pre">Type</span></code> field.</li> |
| <li>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.</li> |
| <li>Click the <code class="docutils literal notranslate"><span class="pre">Save</span></code> button to create the connection.</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). 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>).</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="section" id="google-cloud-platform"> |
| <span id="connection-type-gcp"></span><h3>Google Cloud Platform<a class="headerlink" href="#google-cloud-platform" title="Permalink to this headline">¶</a></h3> |
| <p>The Google Cloud Platform connection type enables the <a class="reference internal" href="../integration.html#gcp"><span class="std std-ref">GCP Integrations</span></a>.</p> |
| <div class="section" id="authenticating-to-gcp"> |
| <h4>Authenticating to GCP<a class="headerlink" href="#authenticating-to-gcp" title="Permalink to this headline">¶</a></h4> |
| <p>There are two ways to connect to GCP using Airflow.</p> |
| <ol class="arabic simple"> |
| <li>Use <a class="reference external" href="https://google-auth.readthedocs.io/en/latest/reference/google.auth.html#google.auth.default">Application Default Credentials</a>, |
| such as via the metadata server when running on Google Compute Engine.</li> |
| <li>Use a <a class="reference external" href="https://cloud.google.com/docs/authentication/#service_accounts">service account</a> key |
| file (JSON format) on disk.</li> |
| </ol> |
| </div> |
| <div class="section" id="default-connection-ids"> |
| <h4>Default Connection IDs<a class="headerlink" href="#default-connection-ids" title="Permalink to this headline">¶</a></h4> |
| <p>The following connection IDs are used by default.</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal notranslate"><span class="pre">bigquery_default</span></code></dt> |
| <dd>Used by the <a class="reference internal" href="../integration.html#airflow.contrib.hooks.bigquery_hook.BigQueryHook" title="airflow.contrib.hooks.bigquery_hook.BigQueryHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">BigQueryHook</span></code></a> |
| hook.</dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">google_cloud_datastore_default</span></code></dt> |
| <dd>Used by the <a class="reference internal" href="../integration.html#airflow.contrib.hooks.datastore_hook.DatastoreHook" title="airflow.contrib.hooks.datastore_hook.DatastoreHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatastoreHook</span></code></a> |
| hook.</dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">google_cloud_default</span></code></dt> |
| <dd>Used by the |
| <a class="reference internal" href="../code.html#airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook" title="airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">GoogleCloudBaseHook</span></code></a>, |
| <a class="reference internal" href="../integration.html#airflow.contrib.hooks.gcp_dataflow_hook.DataFlowHook" title="airflow.contrib.hooks.gcp_dataflow_hook.DataFlowHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowHook</span></code></a>, |
| <a class="reference internal" href="../code.html#airflow.contrib.hooks.gcp_dataproc_hook.DataProcHook" title="airflow.contrib.hooks.gcp_dataproc_hook.DataProcHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcHook</span></code></a>, |
| <a class="reference internal" href="../integration.html#airflow.contrib.hooks.gcp_mlengine_hook.MLEngineHook" title="airflow.contrib.hooks.gcp_mlengine_hook.MLEngineHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLEngineHook</span></code></a>, and |
| <a class="reference internal" href="../integration.html#airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook" title="airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">GoogleCloudStorageHook</span></code></a> hooks.</dd> |
| </dl> |
| </div> |
| <div class="section" id="configuring-the-connection"> |
| <h4>Configuring the Connection<a class="headerlink" href="#configuring-the-connection" title="Permalink to this headline">¶</a></h4> |
| <dl class="docutils"> |
| <dt>Project Id (required)</dt> |
| <dd>The Google Cloud project ID to connect to.</dd> |
| <dt>Keyfile Path</dt> |
| <dd><p class="first">Path to a <a class="reference external" href="https://cloud.google.com/docs/authentication/#service_accounts">service account</a> key |
| file (JSON format) on disk.</p> |
| <p class="last">Not required if using application default credentials.</p> |
| </dd> |
| <dt>Keyfile JSON</dt> |
| <dd><p class="first">Contents of a <a class="reference external" href="https://cloud.google.com/docs/authentication/#service_accounts">service account</a> key |
| file (JSON format) on disk. It is recommended to <a class="reference internal" href="secure-connections.html"><span class="doc">Secure your connections</span></a> if using this method to authenticate.</p> |
| <p class="last">Not required if using application default credentials.</p> |
| </dd> |
| <dt>Scopes (comma separated)</dt> |
| <dd><p class="first">A list of comma-separated <a class="reference external" href="https://developers.google.com/identity/protocols/googlescopes">Google Cloud scopes</a> to |
| authenticate with.</p> |
| <div class="last admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">Scopes are ignored when using application default credentials. See |
| issue <a class="reference external" href="https://issues.apache.org/jira/browse/AIRFLOW-2522">AIRFLOW-2522</a>.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="section" id="mysql"> |
| <h3>MySQL<a class="headerlink" href="#mysql" title="Permalink to this headline">¶</a></h3> |
| <p>The MySQL connect type allows to connect with MySQL database.</p> |
| <div class="section" id="id3"> |
| <h4>Configuring the Connection<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4> |
| <dl class="docutils"> |
| <dt>Host (required)</dt> |
| <dd>The host to connect to.</dd> |
| <dt>Schema (optional)</dt> |
| <dd>Specify the schema name to be used in the database.</dd> |
| <dt>Login (required)</dt> |
| <dd>Specify the user name to connect.</dd> |
| <dt>Password (required)</dt> |
| <dd>Specify the password to connect.</dd> |
| <dt>Extra (optional)</dt> |
| <dd><p class="first">Specify the extra parameters (as json dictionary) that can be used in mysql |
| connection. The following parameters are supported:</p> |
| <ul class="simple"> |
| <li><strong>charset</strong>: specify charset of the connection</li> |
| <li><strong>cursor</strong>: one of “sscursor”, “dictcursor, “ssdictcursor” - specifies cursor class to be |
| used</li> |
| <li><strong>local_infile</strong>: controls MySQL’s LOCAL capability (permitting local data loading by |
| clients). See <a class="reference external" href="https://mysqlclient.readthedocs.io/user_guide.html">MySQLdb docs</a> |
| for details.</li> |
| <li><strong>unix_socket</strong>: UNIX socket used instead of the default socket</li> |
| <li><strong>ssl</strong>: Dictionary of SSL parameters that control connecting using SSL (those |
| parameters are server specific and should contain “ca”, “cert”, “key”, “capath”, |
| “cipher” parameters. See |
| <a class="reference external" href="https://mysqlclient.readthedocs.io/user_guide.html">MySQLdb docs</a> for details. |
| Note that in order to be useful in URL notation, this parameter might also be |
| a string where the SSL dictionary is a string-encoded JSON dictionary.</li> |
| </ul> |
| <p>Example “extras” field:</p> |
| <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="nt">"charset"</span><span class="p">:</span> <span class="s2">"utf8"</span><span class="p">,</span> |
| <span class="nt">"cursorclass"</span><span class="p">:</span> <span class="s2">"sscursor"</span><span class="p">,</span> |
| <span class="nt">"local_infile"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span> |
| <span class="nt">"unix_socket"</span><span class="p">:</span> <span class="s2">"/var/socket"</span><span class="p">,</span> |
| <span class="nt">"ssl"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"cert"</span><span class="p">:</span> <span class="s2">"/tmp/client-cert.pem"</span><span class="p">,</span> |
| <span class="nt">"ca"</span><span class="p">:</span> <span class="s2">"/tmp/server-ca.pem'"</span><span class="p">,</span> |
| <span class="nt">"key"</span><span class="p">:</span> <span class="s2">"/tmp/client-key.pem"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p>or</p> |
| <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="nt">"charset"</span><span class="p">:</span> <span class="s2">"utf8"</span><span class="p">,</span> |
| <span class="nt">"cursorclass"</span><span class="p">:</span> <span class="s2">"sscursor"</span><span class="p">,</span> |
| <span class="nt">"local_infile"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span> |
| <span class="nt">"unix_socket"</span><span class="p">:</span> <span class="s2">"/var/socket"</span><span class="p">,</span> |
| <span class="nt">"ssl"</span><span class="p">:</span> <span class="s2">"{\"cert\": \"/tmp/client-cert.pem\", \"ca\": \"/tmp/server-ca.pem\", \"key\": \"/tmp/client-key.pem\"}"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p>When specifying the connection as URI (in AIRFLOW_CONN_* variable) you should specify it |
| following the standard syntax of DB connections, where extras as passed as parameters |
| of the URI (note that all components of the URI should be URL-encoded).</p> |
| <p>For example:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mysql://mysql_user:XXXXXXXXXXXX@1.1.1.1:3306/mysqldb?ssl<span class="o">=</span>%7B%22cert%22%3A+%22%2Ftmp%2Fclient-cert.pem%22%2C+%22ca%22%3A+%22%2Ftmp%2Fserver-ca.pem%22%2C+%22key%22%3A+%22%2Ftmp%2Fclient-key.pem%22%7D |
| </pre></div> |
| </div> |
| <div class="last admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">If encounter UnicodeDecodeError while working with MySQL connection check |
| the charset defined is matched to the database charset.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="secure-connections.html" class="btn btn-neutral float-right" title="Securing Connections" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="operator.html" class="btn btn-neutral" title="Using Operators" 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>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <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/js/theme.js"></script> |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
