Google Git
Sign in
apache / airflow-site / f5f5e08d2dcdf2162f0d624b8252cbac02b717da / . / docs-archive / apache-airflow / 1.10.5 / _modules / airflow / contrib / hooks / mongo_hook.html
blob: b346e50cd5b46c732753d35e85cf5f92ee2b1cab [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" />
<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>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-140539454-1']);
_gaq.push(['_trackPageview']);
</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.5
</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>
<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 Reference</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">REST API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../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"><a class="reference internal" href="../../../../_api/index.html">Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</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> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li><a href="../hooks.html">airflow.contrib.hooks</a> &raquo;</li>
<li>airflow.contrib.hooks.mongo_hook</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for airflow.contrib.hooks.mongo_hook</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="kn">from</span> <span class="nn">ssl</span> <span class="k">import</span> <span class="n">CERT_NONE</span>
<span class="kn">from</span> <span class="nn">airflow.hooks.base_hook</span> <span class="k">import</span> <span class="n">BaseHook</span>
<span class="kn">from</span> <span class="nn">pymongo</span> <span class="k">import</span> <span class="n">MongoClient</span><span class="p">,</span> <span class="n">ReplaceOne</span>
<div class="viewcode-block" id="MongoHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook">[docs]</a><span class="k">class</span> <span class="nc">MongoHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> PyMongo Wrapper to Interact With Mongo Database</span>
<span class="sd"> Mongo Connection Documentation</span>
<span class="sd"> https://docs.mongodb.com/manual/reference/connection-string/index.html</span>
<span class="sd"> You can specify connection string options in extra field of your connection</span>
<span class="sd"> https://docs.mongodb.com/manual/reference/connection-string/index.html#connection-string-options</span>
<span class="sd"> If you want use DNS seedlist, set `srv` to True.</span>
<span class="sd"> ex.</span>
<span class="sd"> {&quot;srv&quot;: true, &quot;replicaSet&quot;: &quot;test&quot;, &quot;ssl&quot;: true, &quot;connectTimeoutMS&quot;: 30000}</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="MongoHook.conn_type"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.conn_type">[docs]</a> <span class="n">conn_type</span> <span class="o">=</span> <span class="s1">&#39;mongo&#39;</span></div>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn_id</span><span class="o">=</span><span class="s1">&#39;mongo_default&#39;</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">MongoHook</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">source</span><span class="o">=</span><span class="s1">&#39;mongo&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mongo_conn_id</span> <span class="o">=</span> <span class="n">conn_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">connection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connection</span><span class="p">(</span><span class="n">conn_id</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">extras</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">extra_dejson</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">srv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;srv&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="n">scheme</span> <span class="o">=</span> <span class="s1">&#39;mongodb+srv&#39;</span> <span class="k">if</span> <span class="n">srv</span> <span class="k">else</span> <span class="s1">&#39;mongodb&#39;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">uri</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">{scheme}</span><span class="s1">://</span><span class="si">{creds}{host}{port}</span><span class="s1">/</span><span class="si">{database}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">scheme</span><span class="o">=</span><span class="n">scheme</span><span class="p">,</span>
<span class="n">creds</span><span class="o">=</span><span class="s1">&#39;</span><span class="si">{}</span><span class="s1">:</span><span class="si">{}</span><span class="s1">@&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">login</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">password</span>
<span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">login</span> <span class="k">else</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
<span class="n">host</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">host</span><span class="p">,</span>
<span class="n">port</span><span class="o">=</span><span class="s1">&#39;&#39;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">port</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="s1">&#39;:</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">port</span><span class="p">),</span>
<span class="n">database</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">schema</span>
<span class="p">)</span>
<div class="viewcode-block" id="MongoHook.__enter__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.__enter__">[docs]</a> <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span></div>
<div class="viewcode-block" id="MongoHook.__exit__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.__exit__">[docs]</a> <span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">close_conn</span><span class="p">()</span></div>
<div class="viewcode-block" id="MongoHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.get_conn">[docs]</a> <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Fetches PyMongo Client</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span>
<span class="c1"># Mongo Connection Options dict that is unpacked when passed to MongoClient</span>
<span class="n">options</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span>
<span class="c1"># If we are using SSL disable requiring certs from specific hostname</span>
<span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;ssl&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="n">options</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">&#39;ssl_cert_reqs&#39;</span><span class="p">:</span> <span class="n">CERT_NONE</span><span class="p">})</span>
<span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="n">MongoClient</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">uri</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span></div>
<div class="viewcode-block" id="MongoHook.close_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.close_conn">[docs]</a> <span class="k">def</span> <span class="nf">close_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span>
<span class="k">if</span> <span class="n">client</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">client</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="MongoHook.get_collection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.get_collection">[docs]</a> <span class="k">def</span> <span class="nf">get_collection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Fetches a mongo collection object for querying.</span>
<span class="sd"> Uses connection schema as DB unless specified.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">mongo_db</span> <span class="o">=</span> <span class="n">mongo_db</span> <span class="k">if</span> <span class="n">mongo_db</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">schema</span>
<span class="n">mongo_conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
<span class="k">return</span> <span class="n">mongo_conn</span><span class="o">.</span><span class="n">get_database</span><span class="p">(</span><span class="n">mongo_db</span><span class="p">)</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.aggregate"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.aggregate">[docs]</a> <span class="k">def</span> <span class="nf">aggregate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">aggregate_query</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Runs an aggregation pipeline and returns the results</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.aggregate</span>
<span class="sd"> https://api.mongodb.com/python/current/examples/aggregation.html</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_query</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.find"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.find">[docs]</a> <span class="k">def</span> <span class="nf">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">find_one</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Runs a mongo find query and returns the results</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.find</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">if</span> <span class="n">find_one</span><span class="p">:</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">find_one</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.insert_one"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.insert_one">[docs]</a> <span class="k">def</span> <span class="nf">insert_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">doc</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Inserts a single document into a mongo collection</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.insert_one</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">insert_one</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.insert_many"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.insert_many">[docs]</a> <span class="k">def</span> <span class="nf">insert_many</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">docs</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Inserts many docs into a mongo collection.</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.insert_many</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">insert_many</span><span class="p">(</span><span class="n">docs</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.update_one"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.update_one">[docs]</a> <span class="k">def</span> <span class="nf">update_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">filter_doc</span><span class="p">,</span> <span class="n">update_doc</span><span class="p">,</span>
<span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Updates a single document in a mongo collection.</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.update_one</span>
<span class="sd"> :param mongo_collection: The name of the collection to update.</span>
<span class="sd"> :type mongo_collection: str</span>
<span class="sd"> :param filter_doc: A query that matches the documents to update.</span>
<span class="sd"> :type filter_doc: dict</span>
<span class="sd"> :param update_doc: The modifications to apply.</span>
<span class="sd"> :type update_doc: dict</span>
<span class="sd"> :param mongo_db: The name of the database to use.</span>
<span class="sd"> Can be omitted; then the database from the connection string is used.</span>
<span class="sd"> :type mongo_db: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">update_one</span><span class="p">(</span><span class="n">filter_doc</span><span class="p">,</span> <span class="n">update_doc</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.update_many"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.update_many">[docs]</a> <span class="k">def</span> <span class="nf">update_many</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">filter_doc</span><span class="p">,</span> <span class="n">update_doc</span><span class="p">,</span>
<span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Updates one or more documents in a mongo collection.</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.update_many</span>
<span class="sd"> :param mongo_collection: The name of the collection to update.</span>
<span class="sd"> :type mongo_collection: str</span>
<span class="sd"> :param filter_doc: A query that matches the documents to update.</span>
<span class="sd"> :type filter_doc: dict</span>
<span class="sd"> :param update_doc: The modifications to apply.</span>
<span class="sd"> :type update_doc: dict</span>
<span class="sd"> :param mongo_db: The name of the database to use.</span>
<span class="sd"> Can be omitted; then the database from the connection string is used.</span>
<span class="sd"> :type mongo_db: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">update_many</span><span class="p">(</span><span class="n">filter_doc</span><span class="p">,</span> <span class="n">update_doc</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.replace_one"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.replace_one">[docs]</a> <span class="k">def</span> <span class="nf">replace_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">doc</span><span class="p">,</span> <span class="n">filter_doc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Replaces a single document in a mongo collection.</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.replace_one</span>
<span class="sd"> .. note::</span>
<span class="sd"> If no ``filter_doc`` is given, it is assumed that the replacement</span>
<span class="sd"> document contain the ``_id`` field which is then used as filters.</span>
<span class="sd"> :param mongo_collection: The name of the collection to update.</span>
<span class="sd"> :type mongo_collection: str</span>
<span class="sd"> :param doc: The new document.</span>
<span class="sd"> :type doc: dict</span>
<span class="sd"> :param filter_doc: A query that matches the documents to replace.</span>
<span class="sd"> Can be omitted; then the _id field from doc will be used.</span>
<span class="sd"> :type filter_doc: dict</span>
<span class="sd"> :param mongo_db: The name of the database to use.</span>
<span class="sd"> Can be omitted; then the database from the connection string is used.</span>
<span class="sd"> :type mongo_db: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">filter_doc</span><span class="p">:</span>
<span class="n">filter_doc</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;_id&#39;</span><span class="p">:</span> <span class="n">doc</span><span class="p">[</span><span class="s1">&#39;_id&#39;</span><span class="p">]}</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">replace_one</span><span class="p">(</span><span class="n">filter_doc</span><span class="p">,</span> <span class="n">doc</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.replace_many"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.replace_many">[docs]</a> <span class="k">def</span> <span class="nf">replace_many</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">docs</span><span class="p">,</span>
<span class="n">filter_docs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">upsert</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">collation</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Replaces many documents in a mongo collection.</span>
<span class="sd"> Uses bulk_write with multiple ReplaceOne operations</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.bulk_write</span>
<span class="sd"> .. note::</span>
<span class="sd"> If no ``filter_docs``are given, it is assumed that all</span>
<span class="sd"> replacement documents contain the ``_id`` field which are then</span>
<span class="sd"> used as filters.</span>
<span class="sd"> :param mongo_collection: The name of the collection to update.</span>
<span class="sd"> :type mongo_collection: str</span>
<span class="sd"> :param docs: The new documents.</span>
<span class="sd"> :type docs: list[dict]</span>
<span class="sd"> :param filter_docs: A list of queries that match the documents to replace.</span>
<span class="sd"> Can be omitted; then the _id fields from docs will be used.</span>
<span class="sd"> :type filter_docs: list[dict]</span>
<span class="sd"> :param mongo_db: The name of the database to use.</span>
<span class="sd"> Can be omitted; then the database from the connection string is used.</span>
<span class="sd"> :type mongo_db: str</span>
<span class="sd"> :param upsert: If ``True``, perform an insert if no documents</span>
<span class="sd"> match the filters for the replace operation.</span>
<span class="sd"> :type upsert: bool</span>
<span class="sd"> :param collation: An instance of</span>
<span class="sd"> :class:`~pymongo.collation.Collation`. This option is only</span>
<span class="sd"> supported on MongoDB 3.4 and above.</span>
<span class="sd"> :type collation: pymongo.collation.Collation</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">filter_docs</span><span class="p">:</span>
<span class="n">filter_docs</span> <span class="o">=</span> <span class="p">[{</span><span class="s1">&#39;_id&#39;</span><span class="p">:</span> <span class="n">doc</span><span class="p">[</span><span class="s1">&#39;_id&#39;</span><span class="p">]}</span> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">docs</span><span class="p">]</span>
<span class="n">requests</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">ReplaceOne</span><span class="p">(</span>
<span class="n">filter_docs</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
<span class="n">docs</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
<span class="n">upsert</span><span class="o">=</span><span class="n">upsert</span><span class="p">,</span>
<span class="n">collation</span><span class="o">=</span><span class="n">collation</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">docs</span><span class="p">))</span>
<span class="p">]</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">bulk_write</span><span class="p">(</span><span class="n">requests</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.delete_one"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.delete_one">[docs]</a> <span class="k">def</span> <span class="nf">delete_one</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">filter_doc</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes a single document in a mongo collection.</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.delete_one</span>
<span class="sd"> :param mongo_collection: The name of the collection to delete from.</span>
<span class="sd"> :type mongo_collection: str</span>
<span class="sd"> :param filter_doc: A query that matches the document to delete.</span>
<span class="sd"> :type filter_doc: dict</span>
<span class="sd"> :param mongo_db: The name of the database to use.</span>
<span class="sd"> Can be omitted; then the database from the connection string is used.</span>
<span class="sd"> :type mongo_db: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">delete_one</span><span class="p">(</span><span class="n">filter_doc</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="MongoHook.delete_many"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/mongo_hook/index.html#airflow.contrib.hooks.mongo_hook.MongoHook.delete_many">[docs]</a> <span class="k">def</span> <span class="nf">delete_many</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mongo_collection</span><span class="p">,</span> <span class="n">filter_doc</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes one or more documents in a mongo collection.</span>
<span class="sd"> https://api.mongodb.com/python/current/api/pymongo/collection.html#pymongo.collection.Collection.delete_many</span>
<span class="sd"> :param mongo_collection: The name of the collection to delete from.</span>
<span class="sd"> :type mongo_collection: str</span>
<span class="sd"> :param filter_doc: A query that matches the documents to delete.</span>
<span class="sd"> :type filter_doc: dict</span>
<span class="sd"> :param mongo_db: The name of the database to use.</span>
<span class="sd"> Can be omitted; then the database from the connection string is used.</span>
<span class="sd"> :type mongo_db: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">collection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_collection</span><span class="p">(</span><span class="n">mongo_collection</span><span class="p">,</span> <span class="n">mongo_db</span><span class="o">=</span><span class="n">mongo_db</span><span class="p">)</span>
<span class="k">return</span> <span class="n">collection</span><span class="o">.</span><span class="n">delete_many</span><span class="p">(</span><span class="n">filter_doc</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<div class="footer">This page uses <a href="https://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com. Check our
<a href="../../../../privacy_notice.html">Privacy Policy</a>
for more details.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
var nodes = document.documentElement.childNodes;
var i = -1;
var node;
do {
i++;
node = nodes[i]
} while(node.nodeType !== Node.ELEMENT_NODE);
node.appendChild(ga);
})();
</script>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>