Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.4 / _modules / airflow / contrib / hooks / azure_cosmos_hook.html
blob: f0058893649bece28878e105061917e7b05712f8 [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.azure_cosmos_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>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> Airflow
</a>
<div class="version">
1.10.4
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<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"><a class="reference internal" href="../../../../_api/index.html">API Reference</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.azure_cosmos_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.azure_cosmos_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">import</span> <span class="nn">azure.cosmos.cosmos_client</span> <span class="k">as</span> <span class="nn">cosmos_client</span>
<span class="kn">from</span> <span class="nn">azure.cosmos.errors</span> <span class="k">import</span> <span class="n">HTTPFailure</span>
<span class="kn">import</span> <span class="nn">uuid</span>
<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowBadRequest</span>
<span class="kn">from</span> <span class="nn">airflow.hooks.base_hook</span> <span class="k">import</span> <span class="n">BaseHook</span>
<div class="viewcode-block" id="AzureCosmosDBHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook">[docs]</a><span class="k">class</span> <span class="nc">AzureCosmosDBHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Interacts with Azure CosmosDB.</span>
<span class="sd"> login should be the endpoint uri, password should be the master key</span>
<span class="sd"> optionally, you can use the following extras to default these values</span>
<span class="sd"> {&quot;database_name&quot;: &quot;&lt;DATABASE_NAME&gt;&quot;, &quot;collection_name&quot;: &quot;COLLECTION_NAME&quot;}.</span>
<span class="sd"> :param azure_cosmos_conn_id: Reference to the Azure CosmosDB connection.</span>
<span class="sd"> :type azure_cosmos_conn_id: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<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">azure_cosmos_conn_id</span><span class="o">=</span><span class="s1">&#39;azure_cosmos_default&#39;</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_id</span> <span class="o">=</span> <span class="n">azure_cosmos_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="bp">self</span><span class="o">.</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="bp">self</span><span class="o">.</span><span class="n">endpoint_uri</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">login</span>
<span class="bp">self</span><span class="o">.</span><span class="n">master_key</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">password</span>
<span class="bp">self</span><span class="o">.</span><span class="n">default_database_name</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">get</span><span class="p">(</span><span class="s1">&#39;database_name&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">default_collection_name</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">get</span><span class="p">(</span><span class="s1">&#39;collection_name&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cosmos_client</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="AzureCosmosDBHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.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"> Return a cosmos db 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">cosmos_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">cosmos_client</span>
<span class="c1"># Initialize the Python Azure Cosmos DB client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cosmos_client</span> <span class="o">=</span> <span class="n">cosmos_client</span><span class="o">.</span><span class="n">CosmosClient</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">endpoint_uri</span><span class="p">,</span> <span class="p">{</span><span class="s1">&#39;masterKey&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">master_key</span><span class="p">})</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cosmos_client</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.__get_database_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.__get_database_name">[docs]</a> <span class="k">def</span> <span class="nf">__get_database_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">db_name</span> <span class="o">=</span> <span class="n">database_name</span>
<span class="k">if</span> <span class="n">db_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">db_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_database_name</span>
<span class="k">if</span> <span class="n">db_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Database name must be specified&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">db_name</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.__get_collection_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.__get_collection_name">[docs]</a> <span class="k">def</span> <span class="nf">__get_collection_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">collection_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">coll_name</span> <span class="o">=</span> <span class="n">collection_name</span>
<span class="k">if</span> <span class="n">coll_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">coll_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default_collection_name</span>
<span class="k">if</span> <span class="n">coll_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Collection name must be specified&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">coll_name</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.does_collection_exist"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.does_collection_exist">[docs]</a> <span class="k">def</span> <span class="nf">does_collection_exist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">collection_name</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks if a collection exists in CosmosDB.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">collection_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Collection name cannot be None.&quot;</span><span class="p">)</span>
<span class="n">existing_container</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">QueryContainers</span><span class="p">(</span>
<span class="n">get_database_link</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">)),</span> <span class="p">{</span>
<span class="s2">&quot;query&quot;</span><span class="p">:</span> <span class="s2">&quot;SELECT * FROM r WHERE r.id=@id&quot;</span><span class="p">,</span>
<span class="s2">&quot;parameters&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span><span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;@id&quot;</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="n">collection_name</span><span class="p">}</span>
<span class="p">]</span>
<span class="p">}))</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">existing_container</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.create_collection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.create_collection">[docs]</a> <span class="k">def</span> <span class="nf">create_collection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">collection_name</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new collection in the CosmosDB database.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">collection_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Collection name cannot be None.&quot;</span><span class="p">)</span>
<span class="c1"># We need to check to see if this container already exists so we don&#39;t try</span>
<span class="c1"># to create it twice</span>
<span class="n">existing_container</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">QueryContainers</span><span class="p">(</span>
<span class="n">get_database_link</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">)),</span> <span class="p">{</span>
<span class="s2">&quot;query&quot;</span><span class="p">:</span> <span class="s2">&quot;SELECT * FROM r WHERE r.id=@id&quot;</span><span class="p">,</span>
<span class="s2">&quot;parameters&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span><span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;@id&quot;</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="n">collection_name</span><span class="p">}</span>
<span class="p">]</span>
<span class="p">}))</span>
<span class="c1"># Only create if we did not find it already existing</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">existing_container</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">CreateContainer</span><span class="p">(</span>
<span class="n">get_database_link</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">)),</span>
<span class="p">{</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="n">collection_name</span><span class="p">})</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.does_database_exist"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.does_database_exist">[docs]</a> <span class="k">def</span> <span class="nf">does_database_exist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">database_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks if a database exists in CosmosDB.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">database_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Database name cannot be None.&quot;</span><span class="p">)</span>
<span class="n">existing_database</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">QueryDatabases</span><span class="p">({</span>
<span class="s2">&quot;query&quot;</span><span class="p">:</span> <span class="s2">&quot;SELECT * FROM r WHERE r.id=@id&quot;</span><span class="p">,</span>
<span class="s2">&quot;parameters&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span><span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;@id&quot;</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="n">database_name</span><span class="p">}</span>
<span class="p">]</span>
<span class="p">}))</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">existing_database</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.create_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.create_database">[docs]</a> <span class="k">def</span> <span class="nf">create_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">database_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new database in CosmosDB.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">database_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Database name cannot be None.&quot;</span><span class="p">)</span>
<span class="c1"># We need to check to see if this database already exists so we don&#39;t try</span>
<span class="c1"># to create it twice</span>
<span class="n">existing_database</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">QueryDatabases</span><span class="p">({</span>
<span class="s2">&quot;query&quot;</span><span class="p">:</span> <span class="s2">&quot;SELECT * FROM r WHERE r.id=@id&quot;</span><span class="p">,</span>
<span class="s2">&quot;parameters&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span><span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;@id&quot;</span><span class="p">,</span> <span class="s2">&quot;value&quot;</span><span class="p">:</span> <span class="n">database_name</span><span class="p">}</span>
<span class="p">]</span>
<span class="p">}))</span>
<span class="c1"># Only create if we did not find it already existing</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">existing_database</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">CreateDatabase</span><span class="p">({</span><span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="n">database_name</span><span class="p">})</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.delete_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.delete_database">[docs]</a> <span class="k">def</span> <span class="nf">delete_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">database_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes an existing database in CosmosDB.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">database_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Database name cannot be None.&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">DeleteDatabase</span><span class="p">(</span><span class="n">get_database_link</span><span class="p">(</span><span class="n">database_name</span><span class="p">))</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.delete_collection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.delete_collection">[docs]</a> <span class="k">def</span> <span class="nf">delete_collection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">collection_name</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes an existing collection in the CosmosDB database.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">collection_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Collection name cannot be None.&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">DeleteContainer</span><span class="p">(</span>
<span class="n">get_collection_link</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">),</span> <span class="n">collection_name</span><span class="p">))</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.upsert_document"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.upsert_document">[docs]</a> <span class="k">def</span> <span class="nf">upsert_document</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">document</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">collection_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">document_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Inserts a new document (or updates an existing one) into an existing</span>
<span class="sd"> collection in the CosmosDB database.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Assign unique ID if one isn&#39;t provided</span>
<span class="k">if</span> <span class="n">document_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">document_id</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
<span class="k">if</span> <span class="n">document</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;You cannot insert a None document&quot;</span><span class="p">)</span>
<span class="c1"># Add document id if isn&#39;t found</span>
<span class="k">if</span> <span class="s1">&#39;id&#39;</span> <span class="ow">in</span> <span class="n">document</span><span class="p">:</span>
<span class="k">if</span> <span class="n">document</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">document</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">document_id</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">document</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">document_id</span>
<span class="n">created_document</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="o">.</span><span class="n">CreateItem</span><span class="p">(</span>
<span class="n">get_collection_link</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_collection_name</span><span class="p">(</span><span class="n">collection_name</span><span class="p">)),</span>
<span class="n">document</span><span class="p">)</span>
<span class="k">return</span> <span class="n">created_document</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.insert_documents"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.insert_documents">[docs]</a> <span class="k">def</span> <span class="nf">insert_documents</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">documents</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">collection_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Insert a list of new documents into an existing collection in the CosmosDB database.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">documents</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;You cannot insert empty documents&quot;</span><span class="p">)</span>
<span class="n">created_documents</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">single_document</span> <span class="ow">in</span> <span class="n">documents</span><span class="p">:</span>
<span class="n">created_documents</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">CreateItem</span><span class="p">(</span>
<span class="n">get_collection_link</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_collection_name</span><span class="p">(</span><span class="n">collection_name</span><span class="p">)),</span>
<span class="n">single_document</span><span class="p">))</span>
<span class="k">return</span> <span class="n">created_documents</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.delete_document"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.delete_document">[docs]</a> <span class="k">def</span> <span class="nf">delete_document</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">document_id</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">collection_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Delete an existing document out of a collection in the CosmosDB database.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">document_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Cannot delete a document without an id&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">DeleteItem</span><span class="p">(</span>
<span class="n">get_document_link</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_collection_name</span><span class="p">(</span><span class="n">collection_name</span><span class="p">),</span>
<span class="n">document_id</span><span class="p">))</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.get_document"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.get_document">[docs]</a> <span class="k">def</span> <span class="nf">get_document</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">document_id</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">collection_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get a document from an existing collection in the CosmosDB database.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">document_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;Cannot get a document without an id&quot;</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">ReadItem</span><span class="p">(</span>
<span class="n">get_document_link</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_collection_name</span><span class="p">(</span><span class="n">collection_name</span><span class="p">),</span>
<span class="n">document_id</span><span class="p">))</span>
<span class="k">except</span> <span class="n">HTTPFailure</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="AzureCosmosDBHook.get_documents"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.AzureCosmosDBHook.get_documents">[docs]</a> <span class="k">def</span> <span class="nf">get_documents</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql_string</span><span class="p">,</span> <span class="n">database_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">collection_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">partition_key</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get a list of documents from an existing collection in the CosmosDB database via SQL query.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">sql_string</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowBadRequest</span><span class="p">(</span><span class="s2">&quot;SQL query string cannot be None&quot;</span><span class="p">)</span>
<span class="c1"># Query them in SQL</span>
<span class="n">query</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">sql_string</span><span class="p">}</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">result_iterable</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="o">.</span><span class="n">QueryItems</span><span class="p">(</span>
<span class="n">get_collection_link</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_database_name</span><span class="p">(</span><span class="n">database_name</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__get_collection_name</span><span class="p">(</span><span class="n">collection_name</span><span class="p">)),</span>
<span class="n">query</span><span class="p">,</span>
<span class="n">partition_key</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">result_iterable</span><span class="p">)</span>
<span class="k">except</span> <span class="n">HTTPFailure</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span></div></div>
<div class="viewcode-block" id="get_database_link"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.get_database_link">[docs]</a><span class="k">def</span> <span class="nf">get_database_link</span><span class="p">(</span><span class="n">database_id</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">&quot;dbs/&quot;</span> <span class="o">+</span> <span class="n">database_id</span></div>
<div class="viewcode-block" id="get_collection_link"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.get_collection_link">[docs]</a><span class="k">def</span> <span class="nf">get_collection_link</span><span class="p">(</span><span class="n">database_id</span><span class="p">,</span> <span class="n">collection_id</span><span class="p">):</span>
<span class="k">return</span> <span class="n">get_database_link</span><span class="p">(</span><span class="n">database_id</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;/colls/&quot;</span> <span class="o">+</span> <span class="n">collection_id</span></div>
<div class="viewcode-block" id="get_document_link"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/azure_cosmos_hook/index.html#airflow.contrib.hooks.azure_cosmos_hook.get_document_link">[docs]</a><span class="k">def</span> <span class="nf">get_document_link</span><span class="p">(</span><span class="n">database_id</span><span class="p">,</span> <span class="n">collection_id</span><span class="p">,</span> <span class="n">document_id</span><span class="p">):</span>
<span class="k">return</span> <span class="n">get_collection_link</span><span class="p">(</span><span class="n">database_id</span><span class="p">,</span> <span class="n">collection_id</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;/docs/&quot;</span> <span class="o">+</span> <span class="n">document_id</span></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>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>