| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!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 — Airflow Documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <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/jira-links.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="stylesheet" href="../../../../../_static/graphviz.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../../_static/exampleinclude.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> |
| </script> |
| <style> |
| |
| </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.8 |
| </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 & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../executor/index.html">Executor</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="../../../../../errors.html">Error Tracking</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="../../../../../dag-serialization.html">DAG Serialization</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="../../../../../best-practices.html">Best Practices</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="../../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">Python API</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> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../configurations-ref.html">Configurations</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../../../index.html">Python API Reference</a> »</li> |
| |
| <li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a> »</li> |
| |
| <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.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="sig-prename descclassname">airflow.contrib.hooks.mongo_hook.</code><code class="sig-name descname">MongoHook</code><span class="sig-paren">(</span><em class="sig-param">conn_id='mongo_default'</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/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></p> |
| <p>If you want use DNS seedlist, set <cite>srv</cite> to True.</p> |
| <dl class="simple"> |
| <dt>ex.</dt><dd><p>{“srv”: true, “replicaSet”: “test”, “ssl”: true, “connectTimeoutMS”: 30000}</p> |
| </dd> |
| </dl> |
| <dl class="attribute"> |
| <dt id="airflow.contrib.hooks.mongo_hook.MongoHook.conn_type"> |
| <code class="sig-name 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="sig-name descname">__enter__</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/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="sig-name descname">__exit__</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">exc_type</em>, <em class="sig-param">exc_val</em>, <em class="sig-param">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="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/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="sig-name descname">close_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/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="sig-name descname">get_collection</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">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="sig-name descname">aggregate</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">aggregate_query</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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="sig-name descname">find</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">query</em>, <em class="sig-param">find_one=False</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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="sig-name descname">insert_one</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">doc</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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="sig-name descname">insert_many</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">docs</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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="sig-name descname">update_one</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">filter_doc</em>, <em class="sig-param">update_doc</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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.8)"><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.8)"><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.8)"><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.8)"><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="sig-name descname">update_many</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">filter_doc</em>, <em class="sig-param">update_doc</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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.8)"><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.8)"><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.8)"><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.8)"><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="sig-name descname">replace_one</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">doc</em>, <em class="sig-param">filter_doc=None</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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.8)"><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.8)"><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.8)"><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.8)"><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="sig-name descname">replace_many</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">docs</em>, <em class="sig-param">filter_docs=None</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">upsert=False</em>, <em class="sig-param">collation=None</em>, <em class="sig-param">**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.8)"><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.8)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.8)"><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.8)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.8)"><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.8)"><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.8)"><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.9.0)"><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.9.0)"><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="sig-name descname">delete_one</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">filter_doc</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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.8)"><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.8)"><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.8)"><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="sig-name descname">delete_many</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mongo_collection</em>, <em class="sig-param">filter_doc</em>, <em class="sig-param">mongo_db=None</em>, <em class="sig-param">**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.8)"><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.8)"><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.8)"><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>. |
| <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. |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| <!-- Theme Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-140539454-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| |
| |
| |
| </body> |
| </html> |