| |
| |
| |
| |
| |
| <!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.datastore_hook — 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 & 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> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../hooks.html">airflow.contrib.hooks</a> »</li> |
| |
| <li>airflow.contrib.hooks.datastore_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.datastore_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"># "License"); 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"># "AS IS" 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="c1">#</span> |
| |
| <span class="kn">import</span> <span class="nn">time</span> |
| |
| <span class="kn">from</span> <span class="nn">googleapiclient.discovery</span> <span class="k">import</span> <span class="n">build</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span> |
| |
| |
| <div class="viewcode-block" id="DatastoreHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook">[docs]</a><span class="k">class</span> <span class="nc">DatastoreHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Interact with Google Cloud Datastore. This hook uses the Google Cloud Platform connection.</span> |
| |
| <span class="sd"> This object is not threads safe. If you want to make multiple requests</span> |
| <span class="sd"> simultaneously, you will need to create a hook per thread.</span> |
| |
| <span class="sd"> :param api_version: The version of the API it is going to connect to.</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</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">datastore_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_datastore_default'</span><span class="p">,</span> |
| <span class="n">delegate_to</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">DatastoreHook</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">datastore_conn_id</span><span class="p">,</span> <span class="n">delegate_to</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="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| |
| <div class="viewcode-block" id="DatastoreHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.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="n">version</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Establishes a connection to the Google API.</span> |
| |
| <span class="sd"> :return: a Google Cloud Datastore service object.</span> |
| <span class="sd"> :rtype: Resource</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">version</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="c1"># Back-compat</span> |
| <span class="n">version</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> |
| <span class="n">http_authorized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_authorize</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">build</span><span class="p">(</span><span class="s1">'datastore'</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">http</span><span class="o">=</span><span class="n">http_authorized</span><span class="p">,</span> |
| <span class="n">cache_discovery</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.allocate_ids"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.allocate_ids">[docs]</a> <span class="k">def</span> <span class="nf">allocate_ids</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">partial_keys</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Allocate IDs for incomplete keys.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/rest/v1/projects/allocateIds</span> |
| |
| <span class="sd"> :param partial_keys: a list of partial keys.</span> |
| <span class="sd"> :type partial_keys: list</span> |
| <span class="sd"> :return: a list of full keys.</span> |
| <span class="sd"> :rtype: list</span> |
| <span class="sd"> """</span> |
| <span class="n">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="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">allocateIds</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="p">{</span><span class="s1">'keys'</span><span class="p">:</span> <span class="n">partial_keys</span><span class="p">})</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</span><span class="p">[</span><span class="s1">'keys'</span><span class="p">]</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.begin_transaction"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.begin_transaction">[docs]</a> <span class="k">def</span> <span class="nf">begin_transaction</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Begins a new transaction.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/rest/v1/projects/beginTransaction</span> |
| |
| <span class="sd"> :return: a transaction handle.</span> |
| <span class="sd"> :rtype: str</span> |
| <span class="sd"> """</span> |
| <span class="n">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="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">beginTransaction</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="p">{})</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">]</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.commit"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.commit">[docs]</a> <span class="k">def</span> <span class="nf">commit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Commit a transaction, optionally creating, deleting or modifying some entities.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/rest/v1/projects/commit</span> |
| |
| <span class="sd"> :param body: the body of the commit request.</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :return: the response body of the commit request.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">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="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">commit</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.lookup"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.lookup">[docs]</a> <span class="k">def</span> <span class="nf">lookup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">keys</span><span class="p">,</span> <span class="n">read_consistency</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">transaction</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Lookup some entities by key.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/rest/v1/projects/lookup</span> |
| |
| <span class="sd"> :param keys: the keys to lookup.</span> |
| <span class="sd"> :type keys: list</span> |
| <span class="sd"> :param read_consistency: the read consistency to use. default, strong or eventual.</span> |
| <span class="sd"> Cannot be used with a transaction.</span> |
| <span class="sd"> :type read_consistency: str</span> |
| <span class="sd"> :param transaction: the transaction to use, if any.</span> |
| <span class="sd"> :type transaction: str</span> |
| <span class="sd"> :return: the response body of the lookup request.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">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="n">body</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'keys'</span><span class="p">:</span> <span class="n">keys</span><span class="p">}</span> |
| <span class="k">if</span> <span class="n">read_consistency</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="s1">'readConsistency'</span><span class="p">]</span> <span class="o">=</span> <span class="n">read_consistency</span> |
| <span class="k">if</span> <span class="n">transaction</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="s1">'transaction'</span><span class="p">]</span> <span class="o">=</span> <span class="n">transaction</span> |
| <span class="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">lookup</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.rollback"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.rollback">[docs]</a> <span class="k">def</span> <span class="nf">rollback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">transaction</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Roll back a transaction.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/rest/v1/projects/rollback</span> |
| |
| <span class="sd"> :param transaction: the transaction to roll back.</span> |
| <span class="sd"> :type transaction: str</span> |
| <span class="sd"> """</span> |
| <span class="n">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="n">conn</span><span class="o">.</span><span class="n">projects</span><span class="p">()</span><span class="o">.</span><span class="n">rollback</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="p">{</span><span class="s1">'transaction'</span><span class="p">:</span> <span class="n">transaction</span><span class="p">}</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.run_query"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.run_query">[docs]</a> <span class="k">def</span> <span class="nf">run_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Run a query for entities.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/rest/v1/projects/runQuery</span> |
| |
| <span class="sd"> :param body: the body of the query request.</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :return: the batch of query results.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">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="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">runQuery</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</span><span class="p">[</span><span class="s1">'batch'</span><span class="p">]</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.get_operation"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.get_operation">[docs]</a> <span class="k">def</span> <span class="nf">get_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets the latest state of a long-running operation.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/data/rest/v1/projects.operations/get</span> |
| |
| <span class="sd"> :param name: the name of the operation resource.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :return: a resource operation instance.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">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="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">operations</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.delete_operation"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.delete_operation">[docs]</a> <span class="k">def</span> <span class="nf">delete_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes the long-running operation.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/data/rest/v1/projects.operations/delete</span> |
| |
| <span class="sd"> :param name: the name of the operation resource.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :return: none if successful.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">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="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">operations</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.poll_operation_until_done"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.poll_operation_until_done">[docs]</a> <span class="k">def</span> <span class="nf">poll_operation_until_done</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">polling_interval_in_seconds</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Poll backup operation state until it's completed.</span> |
| |
| <span class="sd"> :param name: the name of the operation resource</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param polling_interval_in_seconds: The number of seconds to wait before calling another request.</span> |
| <span class="sd"> :type polling_interval_in_seconds: int</span> |
| <span class="sd"> :return: a resource operation instance.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_operation</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> |
| |
| <span class="n">state</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">'metadata'</span><span class="p">][</span><span class="s1">'common'</span><span class="p">][</span><span class="s1">'state'</span><span class="p">]</span> |
| <span class="k">if</span> <span class="n">state</span> <span class="o">==</span> <span class="s1">'PROCESSING'</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Operation is processing. Re-polling state in </span><span class="si">{}</span><span class="s1"> seconds'</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">polling_interval_in_seconds</span><span class="p">))</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">polling_interval_in_seconds</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">result</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.export_to_storage_bucket"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.export_to_storage_bucket">[docs]</a> <span class="k">def</span> <span class="nf">export_to_storage_bucket</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="n">namespace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">entity_filter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Export entities from Cloud Datastore to Cloud Storage for backup.</span> |
| |
| <span class="sd"> .. note::</span> |
| <span class="sd"> Keep in mind that this requests the Admin API not the Data API.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/admin/rest/v1/projects/export</span> |
| |
| <span class="sd"> :param bucket: The name of the Cloud Storage bucket.</span> |
| <span class="sd"> :type bucket: str</span> |
| <span class="sd"> :param namespace: The Cloud Storage namespace path.</span> |
| <span class="sd"> :type namespace: str</span> |
| <span class="sd"> :param entity_filter: Description of what data from the project is included in the export.</span> |
| <span class="sd"> :type entity_filter: dict</span> |
| <span class="sd"> :param labels: Client-assigned labels.</span> |
| <span class="sd"> :type labels: dict of str</span> |
| <span class="sd"> :return: a resource operation instance.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">admin_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="n">output_uri_prefix</span> <span class="o">=</span> <span class="s1">'gs://'</span> <span class="o">+</span> <span class="s1">'/'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">[</span><span class="n">bucket</span><span class="p">,</span> <span class="n">namespace</span><span class="p">]))</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">entity_filter</span><span class="p">:</span> |
| <span class="n">entity_filter</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">labels</span><span class="p">:</span> |
| <span class="n">labels</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="n">body</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'outputUrlPrefix'</span><span class="p">:</span> <span class="n">output_uri_prefix</span><span class="p">,</span> |
| <span class="s1">'entityFilter'</span><span class="p">:</span> <span class="n">entity_filter</span><span class="p">,</span> |
| <span class="s1">'labels'</span><span class="p">:</span> <span class="n">labels</span><span class="p">,</span> |
| <span class="p">}</span> |
| <span class="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">admin_conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">export</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</span></div> |
| |
| <div class="viewcode-block" id="DatastoreHook.import_from_storage_bucket"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook.import_from_storage_bucket">[docs]</a> <span class="k">def</span> <span class="nf">import_from_storage_bucket</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">namespace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">entity_filter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Import a backup from Cloud Storage to Cloud Datastore.</span> |
| |
| <span class="sd"> .. note::</span> |
| <span class="sd"> Keep in mind that this requests the Admin API not the Data API.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/datastore/docs/reference/admin/rest/v1/projects/import</span> |
| |
| <span class="sd"> :param bucket: The name of the Cloud Storage bucket.</span> |
| <span class="sd"> :type bucket: str</span> |
| <span class="sd"> :param file: the metadata file written by the projects.export operation.</span> |
| <span class="sd"> :type file: str</span> |
| <span class="sd"> :param namespace: The Cloud Storage namespace path.</span> |
| <span class="sd"> :type namespace: str</span> |
| <span class="sd"> :param entity_filter: specify which kinds/namespaces are to be imported.</span> |
| <span class="sd"> :type entity_filter: dict</span> |
| <span class="sd"> :param labels: Client-assigned labels.</span> |
| <span class="sd"> :type labels: dict of str</span> |
| <span class="sd"> :return: a resource operation instance.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">admin_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="n">input_url</span> <span class="o">=</span> <span class="s1">'gs://'</span> <span class="o">+</span> <span class="s1">'/'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">[</span><span class="n">bucket</span><span class="p">,</span> <span class="n">namespace</span><span class="p">,</span> <span class="n">file</span><span class="p">]))</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">entity_filter</span><span class="p">:</span> |
| <span class="n">entity_filter</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">labels</span><span class="p">:</span> |
| <span class="n">labels</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="n">body</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'inputUrl'</span><span class="p">:</span> <span class="n">input_url</span><span class="p">,</span> |
| <span class="s1">'entityFilter'</span><span class="p">:</span> <span class="n">entity_filter</span><span class="p">,</span> |
| <span class="s1">'labels'</span><span class="p">:</span> <span class="n">labels</span><span class="p">,</span> |
| <span class="p">}</span> |
| <span class="n">resp</span> <span class="o">=</span> <span class="p">(</span><span class="n">admin_conn</span> |
| <span class="o">.</span><span class="n">projects</span><span class="p">()</span> |
| <span class="o">.</span><span class="n">import_</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span> |
| <span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="n">resp</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> |
