Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.4 / _api / airflow / hooks / dbapi_hook / index.html
blob: f0405419471931e1949686405fc8cb7d338ac390 [file] [log] [blame]
<!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.hooks.dbapi_hook &mdash; 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.hooks.docker_hook" href="../docker_hook/index.html" />
<link rel="prev" title="airflow.hooks.base_hook" href="../base_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>
</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 &amp; 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 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../../contrib/hooks/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> &raquo;</li>
<li><a href="../../../index.html">API Reference</a> &raquo;</li>
<li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a> &raquo;</li>
<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.dbapi_hook</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../_sources/_api/airflow/hooks/dbapi_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.hooks.dbapi_hook">
<span id="airflow-hooks-dbapi-hook"></span><h1><a class="reference internal" href="#module-airflow.hooks.dbapi_hook" title="airflow.hooks.dbapi_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.dbapi_hook</span></code></a><a class="headerlink" href="#module-airflow.hooks.dbapi_hook" title="Permalink to this headline"></a></h1>
<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.hooks.dbapi_hook.DbApiHook">
<em class="property">class </em><code class="sig-prename descclassname">airflow.hooks.dbapi_hook.</code><code class="sig-name descname">DbApiHook</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="../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>
<p>Abstract base class for sql hooks.</p>
<dl class="attribute">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.conn_name_attr">
<code class="sig-name descname">conn_name_attr</code><em class="property"> :Optional[str]</em><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.conn_name_attr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.conn_name_attr" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.default_conn_name">
<code class="sig-name descname">default_conn_name</code><em class="property"> = default_conn_id</em><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.default_conn_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.default_conn_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.supports_autocommit">
<code class="sig-name descname">supports_autocommit</code><em class="property"> = False</em><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.supports_autocommit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.supports_autocommit" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.connector">
<code class="sig-name descname">connector</code><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.connector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.connector" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.get_conn">
<code class="sig-name descname">get_conn</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.get_conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.get_conn" title="Permalink to this definition"></a></dt>
<dd><p>Returns a connection object</p>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.get_uri">
<code class="sig-name descname">get_uri</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.get_uri"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.get_uri" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.get_sqlalchemy_engine">
<code class="sig-name descname">get_sqlalchemy_engine</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">engine_kwargs=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.get_sqlalchemy_engine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.get_sqlalchemy_engine" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.get_pandas_df">
<code class="sig-name descname">get_pandas_df</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">sql</em>, <em class="sig-param">parameters=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.get_pandas_df"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.get_pandas_df" title="Permalink to this definition"></a></dt>
<dd><p>Executes the sql and returns a pandas dataframe</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sql</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) – the sql statement to be executed (str) or a list of
sql statements to execute</p></li>
<li><p><strong>parameters</strong> (<em>mapping</em><em> or </em><em>iterable</em>) – The parameters to render the SQL query with.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.get_records">
<code class="sig-name descname">get_records</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">sql</em>, <em class="sig-param">parameters=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.get_records"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.get_records" title="Permalink to this definition"></a></dt>
<dd><p>Executes the sql and returns a set of records.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sql</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) – the sql statement to be executed (str) or a list of
sql statements to execute</p></li>
<li><p><strong>parameters</strong> (<em>mapping</em><em> or </em><em>iterable</em>) – The parameters to render the SQL query with.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.get_first">
<code class="sig-name descname">get_first</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">sql</em>, <em class="sig-param">parameters=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.get_first"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.get_first" title="Permalink to this definition"></a></dt>
<dd><p>Executes the sql and returns the first resulting row.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sql</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) – the sql statement to be executed (str) or a list of
sql statements to execute</p></li>
<li><p><strong>parameters</strong> (<em>mapping</em><em> or </em><em>iterable</em>) – The parameters to render the SQL query with.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.run">
<code class="sig-name descname">run</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">sql</em>, <em class="sig-param">autocommit=False</em>, <em class="sig-param">parameters=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.run" title="Permalink to this definition"></a></dt>
<dd><p>Runs a command or a list of commands. Pass a list of sql
statements to the sql parameter to get them to execute
sequentially</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sql</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) – the sql statement to be executed (str) or a list of
sql statements to execute</p></li>
<li><p><strong>autocommit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – What to set the connection’s autocommit setting to
before executing the query.</p></li>
<li><p><strong>parameters</strong> (<em>mapping</em><em> or </em><em>iterable</em>) – The parameters to render the SQL query with.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.set_autocommit">
<code class="sig-name descname">set_autocommit</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">conn</em>, <em class="sig-param">autocommit</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.set_autocommit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.set_autocommit" title="Permalink to this definition"></a></dt>
<dd><p>Sets the autocommit flag on the connection</p>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.get_autocommit">
<code class="sig-name descname">get_autocommit</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">conn</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.get_autocommit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.get_autocommit" title="Permalink to this definition"></a></dt>
<dd><p>Get autocommit setting for the provided connection.
Return True if conn.autocommit is set to True.
Return False if conn.autocommit is not set or set to False or conn
does not support autocommit.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>conn</strong> (<em>connection object.</em>) – Connection to get autocommit setting from.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>connection autocommit setting.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.get_cursor">
<code class="sig-name descname">get_cursor</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.get_cursor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.get_cursor" title="Permalink to this definition"></a></dt>
<dd><p>Returns a cursor</p>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.insert_rows">
<code class="sig-name descname">insert_rows</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">table</em>, <em class="sig-param">rows</em>, <em class="sig-param">target_fields=None</em>, <em class="sig-param">commit_every=1000</em>, <em class="sig-param">replace=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.insert_rows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.insert_rows" title="Permalink to this definition"></a></dt>
<dd><p>A generic way to insert a set of tuples into a table,
a new transaction is created every commit_every rows</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>table</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Name of the target table</p></li>
<li><p><strong>rows</strong> (<em>iterable of tuples</em>) – The rows to insert into the table</p></li>
<li><p><strong>target_fields</strong> (<em>iterable of strings</em>) – The names of the columns to fill in the table</p></li>
<li><p><strong>commit_every</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – The maximum number of rows to insert in one
transaction. Set to 0 to insert all rows in one transaction.</p></li>
<li><p><strong>replace</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Whether to replace instead of insert</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook._serialize_cell">
<em class="property">static </em><code class="sig-name descname">_serialize_cell</code><span class="sig-paren">(</span><em class="sig-param">cell</em>, <em class="sig-param">conn=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook._serialize_cell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook._serialize_cell" title="Permalink to this definition"></a></dt>
<dd><p>Returns the SQL literal of the cell as a string.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cell</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><em>object</em></a>) – The cell to insert into the table</p></li>
<li><p><strong>conn</strong> (<em>connection object</em>) – The database connection</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The serialized cell</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.bulk_dump">
<code class="sig-name descname">bulk_dump</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">table</em>, <em class="sig-param">tmp_file</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.bulk_dump"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.bulk_dump" title="Permalink to this definition"></a></dt>
<dd><p>Dumps a database table into a tab-delimited file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>table</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The name of the source table</p></li>
<li><p><strong>tmp_file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The path of the target file</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.hooks.dbapi_hook.DbApiHook.bulk_load">
<code class="sig-name descname">bulk_load</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">table</em>, <em class="sig-param">tmp_file</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/hooks/dbapi_hook.html#DbApiHook.bulk_load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.dbapi_hook.DbApiHook.bulk_load" title="Permalink to this definition"></a></dt>
<dd><p>Loads a tab-delimited file into a database table</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>table</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The name of the target table</p></li>
<li><p><strong>tmp_file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The path of the file to load into the table</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="../docker_hook/index.html" class="btn btn-neutral float-right" title="airflow.hooks.docker_hook" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../base_hook/index.html" class="btn btn-neutral float-left" title="airflow.hooks.base_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>