| |
| |
| |
| |
| <!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>airflow.contrib.hooks.salesforce_hook — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <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/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="index" title="Index" href="../../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../../search.html" /> |
| <link rel="next" title="airflow.contrib.hooks.segment_hook" href="../segment_hook/index.html" /> |
| <link rel="prev" title="airflow.contrib.hooks.sagemaker_hook" href="../sagemaker_hook/index.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| <script type="application/javascript"> |
| window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; |
| ga("create", "UA-140539454-1", "auto"); |
| ga("send", "pageview"); |
| </script> |
| <script async src="https://www.google-analytics.com/analytics.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 class="version"> |
| 1.10.4 |
| </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"><a class="reference internal" href="../../../../../howto/index.html">How-to Guides</a></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="../../../../../metrics.html">Metrics</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="../../../../../changelog.html">Changelog</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 current"><a class="reference internal" href="../../../../index.html">API Reference</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#operators">Operators</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#hooks-packages">Hooks packages</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="../../../hooks/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a></li> |
| <li class="toctree-l4 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#models">Models</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#core-and-community-package">Core and community package</a></li> |
| </ul> |
| </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">API Reference</a> »</li> |
| |
| <li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a> »</li> |
| |
| <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.salesforce_hook</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../../../_sources/_api/airflow/contrib/hooks/salesforce_hook/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"> |
| |
| <div class="section" id="module-airflow.contrib.hooks.salesforce_hook"> |
| <span id="airflow-contrib-hooks-salesforce-hook"></span><h1><a class="reference internal" href="#module-airflow.contrib.hooks.salesforce_hook" title="airflow.contrib.hooks.salesforce_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.salesforce_hook</span></code></a><a class="headerlink" href="#module-airflow.contrib.hooks.salesforce_hook" title="Permalink to this headline">¶</a></h1> |
| <p><p>This module contains a Salesforce Hook |
| which allows you to connect to your Salesforce instance, |
| retrieve data from it, and write that data to a file |
| for other uses.</p> |
| <dl class="simple"> |
| <dt>NOTE: this hook also relies on the simple_salesforce package:</dt><dd><p><a class="reference external" href="https://github.com/simple-salesforce/simple-salesforce">https://github.com/simple-salesforce/simple-salesforce</a></p> |
| </dd> |
| </dl> |
| </p> |
| <div class="section" id="module-contents"> |
| <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> |
| <dl class="class"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.salesforce_hook.</code><code class="sig-name descname">SalesforceHook</code><span class="sig-paren">(</span><em class="sig-param">conn_id</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../../../hooks/base_hook/index.html#airflow.hooks.base_hook.BaseHook" title="airflow.hooks.base_hook.BaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.hooks.base_hook.BaseHook</span></code></a></p> |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook.sign_in"> |
| <code class="sig-name descname">sign_in</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook.sign_in"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook.sign_in" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sign into Salesforce.</p> |
| <p>If we have already signed it, this will just return the original object</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook.make_query"> |
| <code class="sig-name descname">make_query</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">query</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook.make_query"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook.make_query" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Make a query to Salesforce. Returns result in dictionary</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>query</strong> – The query to make to Salesforce</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook.describe_object"> |
| <code class="sig-name descname">describe_object</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook.describe_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook.describe_object" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get the description of an object from Salesforce.</p> |
| <p>This description is the object’s schema |
| and some extra metadata that Salesforce stores for each object</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>obj</strong> – Name of the Salesforce object |
| that we are getting a description of.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook.get_available_fields"> |
| <code class="sig-name descname">get_available_fields</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook.get_available_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook.get_available_fields" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get a list of all available fields for an object.</p> |
| <p>This only returns the names of the fields.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook._build_field_list"> |
| <em class="property">static </em><code class="sig-name descname">_build_field_list</code><span class="sig-paren">(</span><em class="sig-param">fields</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook._build_field_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook._build_field_list" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook.get_object_from_salesforce"> |
| <code class="sig-name descname">get_object_from_salesforce</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">obj</em>, <em class="sig-param">fields</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook.get_object_from_salesforce"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook.get_object_from_salesforce" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get all instances of the <cite>object</cite> from Salesforce. |
| For each model, only get the fields specified in fields.</p> |
| <dl class="simple"> |
| <dt>All we really do underneath the hood is run:</dt><dd><p>SELECT <fields> FROM <obj>;</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook._to_timestamp"> |
| <em class="property">classmethod </em><code class="sig-name descname">_to_timestamp</code><span class="sig-paren">(</span><em class="sig-param">cls</em>, <em class="sig-param">col</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook._to_timestamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook._to_timestamp" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Convert a column of a dataframe to UNIX timestamps if applicable</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>col</strong> – A Series object representing a column of a dataframe.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.salesforce_hook.SalesforceHook.write_object_to_file"> |
| <code class="sig-name descname">write_object_to_file</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">query_results</em>, <em class="sig-param">filename</em>, <em class="sig-param">fmt='csv'</em>, <em class="sig-param">coerce_to_timestamp=False</em>, <em class="sig-param">record_time_added=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/salesforce_hook.html#SalesforceHook.write_object_to_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.salesforce_hook.SalesforceHook.write_object_to_file" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Write query results to file.</p> |
| <dl class="simple"> |
| <dt>Acceptable formats are:</dt><dd><ul class="simple"> |
| <li><dl class="simple"> |
| <dt>csv:</dt><dd><p>comma-separated-values file. This is the default format.</p> |
| </dd> |
| </dl> |
| </li> |
| <li><dl class="simple"> |
| <dt>json:</dt><dd><p>JSON array. Each element in the array is a different row.</p> |
| </dd> |
| </dl> |
| </li> |
| <li><dl class="simple"> |
| <dt>ndjson:</dt><dd><p>JSON array but each element is new-line delimited |
| instead of comma delimited like in <cite>json</cite></p> |
| </dd> |
| </dl> |
| </li> |
| </ul> |
| </dd> |
| </dl> |
| <p>This requires a significant amount of cleanup. |
| Pandas doesn’t handle output to CSV and json in a uniform way. |
| This is especially painful for datetime types. |
| Pandas wants to write them as strings in CSV, |
| but as millisecond Unix timestamps.</p> |
| <p>By default, this function will try and leave all values as |
| they are represented in Salesforce. |
| You use the <cite>coerce_to_timestamp</cite> flag to force all datetimes |
| to become Unix timestamps (UTC). |
| This is can be greatly beneficial as it will make all of your |
| datetime fields look the same, |
| and makes it easier to work with in other database environments</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>query_results</strong> – the results from a SQL query</p></li> |
| <li><p><strong>filename</strong> – the name of the file where the data |
| should be dumped to</p></li> |
| <li><p><strong>fmt</strong> – the format you want the output in. |
| <em>Default:</em> csv.</p></li> |
| <li><p><strong>coerce_to_timestamp</strong> – True if you want all datetime fields to be |
| converted into Unix timestamps. |
| False if you want them to be left in the |
| same format as they were in Salesforce. |
| Leaving the value as False will result |
| in datetimes being strings. |
| <em>Defaults to False</em></p></li> |
| <li><p><strong>record_time_added</strong> – <em>(optional)</em> True if you want to add a |
| Unix timestamp field to the resulting data |
| that marks when the data |
| was fetched from Salesforce. |
| <em>Default: False</em>.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../segment_hook/index.html" class="btn btn-neutral float-right" title="airflow.contrib.hooks.segment_hook" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../sagemaker_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.sagemaker_hook" 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"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
