Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.3 / _api / airflow / contrib / hooks / mongo_hook / index.html
blob: 5f2f1be098cb06c7d5b3cc7cd66cea256a965b0c [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.contrib.hooks.mongo_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.contrib.hooks.openfaas_hook" href="../openfaas_hook/index.html" />
<link rel="prev" title="airflow.contrib.hooks.jira_hook" href="../jira_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.3
</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"><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> &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.contrib.hooks</span></code></a> &raquo;</li>
<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.mongo_hook</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../../_sources/_api/airflow/contrib/hooks/mongo_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.mongo_hook">
<span id="airflow-contrib-hooks-mongo-hook"></span><h1><a class="reference internal" href="#module-airflow.contrib.hooks.mongo_hook" title="airflow.contrib.hooks.mongo_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.mongo_hook</span></code></a><a class="headerlink" href="#module-airflow.contrib.hooks.mongo_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.contrib.hooks.mongo_hook.MongoHook">
<em class="property">class </em><code class="descclassname">airflow.contrib.hooks.mongo_hook.</code><code class="descname">MongoHook</code><span class="sig-paren">(</span><em>conn_id='mongo_default'</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook" 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>
<p>PyMongo Wrapper to Interact With Mongo Database
Mongo Connection Documentation
<a class="reference external" href="https://docs.mongodb.com/manual/reference/connection-string/index.html">https://docs.mongodb.com/manual/reference/connection-string/index.html</a>
You can specify connection string options in extra field of your connection
<a class="reference external" href="https://docs.mongodb.com/manual/reference/connection-string/index.html#connection-string-options">https://docs.mongodb.com/manual/reference/connection-string/index.html#connection-string-options</a>
ex. <code class="docutils literal notranslate"><span class="pre">{replicaSet:</span> <span class="pre">test,</span> <span class="pre">ssl:</span> <span class="pre">True,</span> <span class="pre">connectTimeoutMS:</span> <span class="pre">30000}</span></code></p>
<dl class="attribute">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.conn_type">
<code class="descname">conn_type</code><em class="property"> = mongo</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.conn_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.conn_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.__enter__">
<code class="descname">__enter__</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.__enter__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.__enter__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.__exit__">
<code class="descname">__exit__</code><span class="sig-paren">(</span><em>self</em>, <em>exc_type</em>, <em>exc_val</em>, <em>exc_tb</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.__exit__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.__exit__" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.get_conn">
<code class="descname">get_conn</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.get_conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.get_conn" title="Permalink to this definition"></a></dt>
<dd><p>Fetches PyMongo Client</p>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.close_conn">
<code class="descname">close_conn</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.close_conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.close_conn" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.get_collection">
<code class="descname">get_collection</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>mongo_db=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.get_collection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.get_collection" title="Permalink to this definition"></a></dt>
<dd><p>Fetches a mongo collection object for querying.</p>
<p>Uses connection schema as DB unless specified.</p>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.aggregate">
<code class="descname">aggregate</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>aggregate_query</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.aggregate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.aggregate" title="Permalink to this definition"></a></dt>
<dd><p>Runs an aggregation pipeline and returns the results
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.aggregate">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.aggregate</a>
<a class="reference external" href="https://api.mongodb.com/python/current/examples/aggregation.html">https://api.mongodb.com/python/current/examples/aggregation.html</a></p>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.find">
<code class="descname">find</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>query</em>, <em>find_one=False</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.find" title="Permalink to this definition"></a></dt>
<dd><p>Runs a mongo find query and returns the results
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.find">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.find</a></p>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.insert_one">
<code class="descname">insert_one</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>doc</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.insert_one"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.insert_one" title="Permalink to this definition"></a></dt>
<dd><p>Inserts a single document into a mongo collection
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.insert_one">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.insert_one</a></p>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.insert_many">
<code class="descname">insert_many</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>docs</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.insert_many"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.insert_many" title="Permalink to this definition"></a></dt>
<dd><p>Inserts many docs into a mongo collection.
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.insert_many">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.insert_many</a></p>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.update_one">
<code class="descname">update_one</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>filter_doc</em>, <em>update_doc</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.update_one"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.update_one" title="Permalink to this definition"></a></dt>
<dd><p>Updates a single document in a mongo collection.
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.update_one">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.update_one</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mongo_collection</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 collection to update.</p></li>
<li><p><strong>filter_doc</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A query that matches the documents to update.</p></li>
<li><p><strong>update_doc</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – The modifications to apply.</p></li>
<li><p><strong>mongo_db</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 database to use.
Can be omitted; then the database from the connection string is used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.update_many">
<code class="descname">update_many</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>filter_doc</em>, <em>update_doc</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.update_many"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.update_many" title="Permalink to this definition"></a></dt>
<dd><p>Updates one or more documents in a mongo collection.
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.update_many">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.update_many</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mongo_collection</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 collection to update.</p></li>
<li><p><strong>filter_doc</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A query that matches the documents to update.</p></li>
<li><p><strong>update_doc</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – The modifications to apply.</p></li>
<li><p><strong>mongo_db</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 database to use.
Can be omitted; then the database from the connection string is used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.replace_one">
<code class="descname">replace_one</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>doc</em>, <em>filter_doc=None</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.replace_one"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.replace_one" title="Permalink to this definition"></a></dt>
<dd><p>Replaces a single document in a mongo collection.
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.replace_one">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.replace_one</a></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If no <code class="docutils literal notranslate"><span class="pre">filter_doc</span></code> is given, it is assumed that the replacement
document contain the <code class="docutils literal notranslate"><span class="pre">_id</span></code> field which is then used as filters.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mongo_collection</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 collection to update.</p></li>
<li><p><strong>doc</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – The new document.</p></li>
<li><p><strong>filter_doc</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A query that matches the documents to replace.
Can be omitted; then the _id field from doc will be used.</p></li>
<li><p><strong>mongo_db</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 database to use.
Can be omitted; then the database from the connection string is used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.replace_many">
<code class="descname">replace_many</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>docs</em>, <em>filter_docs=None</em>, <em>mongo_db=None</em>, <em>upsert=False</em>, <em>collation=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.replace_many"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.replace_many" title="Permalink to this definition"></a></dt>
<dd><p>Replaces many documents in a mongo collection.</p>
<p>Uses bulk_write with multiple ReplaceOne operations
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.bulk_write">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.bulk_write</a></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If no <code class="docutils literal notranslate"><span class="pre">filter_docs``are</span> <span class="pre">given,</span> <span class="pre">it</span> <span class="pre">is</span> <span class="pre">assumed</span> <span class="pre">that</span> <span class="pre">all</span>
<span class="pre">replacement</span> <span class="pre">documents</span> <span class="pre">contain</span> <span class="pre">the</span> <span class="pre">``_id</span></code> field which are then
used as filters.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mongo_collection</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 collection to update.</p></li>
<li><p><strong>docs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em>]</em>) – The new documents.</p></li>
<li><p><strong>filter_docs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em>]</em>) – A list of queries that match the documents to replace.
Can be omitted; then the _id fields from docs will be used.</p></li>
<li><p><strong>mongo_db</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 database to use.
Can be omitted; then the database from the connection string is used.</p></li>
<li><p><strong>upsert</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – If <code class="docutils literal notranslate"><span class="pre">True</span></code>, perform an insert if no documents
match the filters for the replace operation.</p></li>
<li><p><strong>collation</strong> (<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collation.html#pymongo.collation.Collation" title="(in PyMongo v3.7.2)"><em>pymongo.collation.Collation</em></a>) – An instance of
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collation.html#pymongo.collation.Collation" title="(in PyMongo v3.7.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Collation</span></code></a>. This option is only
supported on MongoDB 3.4 and above.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.delete_one">
<code class="descname">delete_one</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>filter_doc</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.delete_one"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.delete_one" title="Permalink to this definition"></a></dt>
<dd><p>Deletes a single document in a mongo collection.
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.delete_one">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.delete_one</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mongo_collection</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 collection to delete from.</p></li>
<li><p><strong>filter_doc</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A query that matches the document to delete.</p></li>
<li><p><strong>mongo_db</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 database to use.
Can be omitted; then the database from the connection string is used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.mongo_hook.MongoHook.delete_many">
<code class="descname">delete_many</code><span class="sig-paren">(</span><em>self</em>, <em>mongo_collection</em>, <em>filter_doc</em>, <em>mongo_db=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/mongo_hook.html#MongoHook.delete_many"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.mongo_hook.MongoHook.delete_many" title="Permalink to this definition"></a></dt>
<dd><p>Deletes one or more documents in a mongo collection.
<a class="reference external" href="https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.delete_many">https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.delete_many</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mongo_collection</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 collection to delete from.</p></li>
<li><p><strong>filter_doc</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A query that matches the documents to delete.</p></li>
<li><p><strong>mongo_db</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 database to use.
Can be omitted; then the database from the connection string is used.</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="../openfaas_hook/index.html" class="btn btn-neutral float-right" title="airflow.contrib.hooks.openfaas_hook" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../jira_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.jira_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>