http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/1f06fa0e/_modules/airflow/contrib/hooks/gcp_sql_hook.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/hooks/gcp_sql_hook.html b/_modules/airflow/contrib/hooks/gcp_sql_hook.html new file mode 100644 index 0000000..9428e74 --- /dev/null +++ b/_modules/airflow/contrib/hooks/gcp_sql_hook.html @@ -0,0 +1,474 @@ + + +<!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.gcp_sql_hook — Airflow Documentation</title> + + + + + + + + + + + + + + + + <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 src="../../../../_static/js/modernizr.min.js"></script> + +</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 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 & 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="../../../../lineage.html">Lineage</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="../../../../code.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> »</li> + + <li><a href="../../../index.html">Module code</a> »</li> + + <li>airflow.contrib.hooks.gcp_sql_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.gcp_sql_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="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</span> <span class="k">import</span> <span class="n">AirflowException</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> + +<span class="c1"># Number of retries - used by googleapiclient method calls to perform retries</span> +<span class="c1"># For requests that are "retriable"</span> +<span class="n">NUM_RETRIES</span> <span class="o">=</span> <span class="mi">5</span> + +<span class="c1"># Time to sleep between active checks of the operation results</span> +<span class="n">TIME_TO_SLEEP_IN_SECONDS</span> <span class="o">=</span> <span class="mi">1</span> + + +<span class="k">class</span> <span class="nc">CloudSqlOperationStatus</span><span class="p">:</span> + <span class="n">PENDING</span> <span class="o">=</span> <span class="s2">"PENDING"</span> + <span class="n">RUNNING</span> <span class="o">=</span> <span class="s2">"RUNNING"</span> + <span class="n">DONE</span> <span class="o">=</span> <span class="s2">"DONE"</span> + <span class="n">UNKNOWN</span> <span class="o">=</span> <span class="s2">"UNKNOWN"</span> + + +<span class="c1"># noinspection PyAbstractClass</span> +<div class="viewcode-block" id="CloudSqlHook"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Hook for Google Cloud SQL APIs.</span> +<span class="sd"> """</span> + <span class="n">_conn</span> <span class="o">=</span> <span class="kc">None</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">api_version</span><span class="p">,</span> + <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_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="nb">super</span><span class="p">(</span><span class="n">CloudSqlHook</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">gcp_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">api_version</span> <span class="o">=</span> <span class="n">api_version</span> + +<div class="viewcode-block" id="CloudSqlHook.get_conn"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.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">"""</span> +<span class="sd"> Retrieves connection to Cloud SQL.</span> + +<span class="sd"> :return: Google Cloud SQL services object.</span> +<span class="sd"> :rtype: dict</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">_conn</span><span class="p">:</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">_conn</span> <span class="o">=</span> <span class="n">build</span><span class="p">(</span><span class="s1">'sqladmin'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_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">_conn</span></div> + +<div class="viewcode-block" id="CloudSqlHook.get_instance"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.get_instance">[docs]</a> <span class="k">def</span> <span class="nf">get_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">instance</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Retrieves a resource containing information about a Cloud SQL instance.</span> + +<span class="sd"> :param project_id: Project ID of the project that contains the instance.</span> +<span class="sd"> :type project_id: str</span> +<span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> +<span class="sd"> :type instance: str</span> +<span class="sd"> :return: A Cloud SQL instance resource.</span> +<span class="sd"> :rtype: dict</span> +<span class="sd"> """</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">instances</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> + <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> + <span class="n">instance</span><span class="o">=</span><span class="n">instance</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="n">NUM_RETRIES</span><span class="p">)</span></div> + +<div class="viewcode-block" id="CloudSqlHook.create_instance"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.create_instance">[docs]</a> <span class="k">def</span> <span class="nf">create_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Creates a new Cloud SQL instance.</span> + +<span class="sd"> :param project_id: Project ID of the project to which the newly created</span> +<span class="sd"> Cloud SQL instances should belong.</span> +<span class="sd"> :type project_id: str</span> +<span class="sd"> :param body: Body required by the Cloud SQL insert API, as described in</span> +<span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/instances/insert#request-body</span> +<span class="sd"> :type body: dict</span> +<span class="sd"> :return: True if the operation succeeded, raises an error otherwise</span> +<span class="sd"> :rtype: bool</span> +<span class="sd"> """</span> + <span class="n">response</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">instances</span><span class="p">()</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span> + <span class="n">project</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="n">NUM_RETRIES</span><span class="p">)</span> + <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">)</span></div> + +<div class="viewcode-block" id="CloudSqlHook.patch_instance"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.patch_instance">[docs]</a> <span class="k">def</span> <span class="nf">patch_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">instance</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Updates settings of a Cloud SQL instance.</span> + +<span class="sd"> Caution: This is not a partial update, so you must include values for</span> +<span class="sd"> all the settings that you want to retain.</span> + +<span class="sd"> :param project_id: Project ID of the project that contains the instance.</span> +<span class="sd"> :type project_id: str</span> +<span class="sd"> :param body: Body required by the Cloud SQL patch API, as described in</span> +<span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/instances/patch#request-body</span> +<span class="sd"> :type body: dict</span> +<span class="sd"> :param instance: Cloud SQL instance ID. This does not include the project ID.</span> +<span class="sd"> :type instance: str</span> +<span class="sd"> :return: True if the operation succeeded, raises an error otherwise</span> +<span class="sd"> :rtype: bool</span> +<span class="sd"> """</span> + <span class="n">response</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">instances</span><span class="p">()</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span> + <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> + <span class="n">instance</span><span class="o">=</span><span class="n">instance</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="n">NUM_RETRIES</span><span class="p">)</span> + <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">)</span></div> + +<div class="viewcode-block" id="CloudSqlHook.delete_instance"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.delete_instance">[docs]</a> <span class="k">def</span> <span class="nf">delete_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">instance</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Deletes a Cloud SQL instance.</span> + +<span class="sd"> :param project_id: Project ID of the project that contains the instance.</span> +<span class="sd"> :type project_id: str</span> +<span class="sd"> :param instance: Cloud SQL instance ID. This does not include the project ID.</span> +<span class="sd"> :type instance: str</span> +<span class="sd"> :return: True if the operation succeeded, raises an error otherwise</span> +<span class="sd"> :rtype: bool</span> +<span class="sd"> """</span> + <span class="n">response</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">instances</span><span class="p">()</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span> + <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> + <span class="n">instance</span><span class="o">=</span><span class="n">instance</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="n">NUM_RETRIES</span><span class="p">)</span> + <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">)</span></div> + +<div class="viewcode-block" id="CloudSqlHook.get_database"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.get_database">[docs]</a> <span class="k">def</span> <span class="nf">get_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">database</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Retrieves a database resource from a Cloud SQL instance.</span> + +<span class="sd"> :param project_id: Project ID of the project that contains the instance.</span> +<span class="sd"> :type project_id: str</span> +<span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> +<span class="sd"> :type instance: str</span> +<span class="sd"> :param database: Name of the database in the instance.</span> +<span class="sd"> :type database: str</span> +<span class="sd"> :return: A Cloud SQL database resource, as described in</span> +<span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/databases#resource</span> +<span class="sd"> :rtype: dict</span> +<span class="sd"> """</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">databases</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> + <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> + <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> + <span class="n">database</span><span class="o">=</span><span class="n">database</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="n">NUM_RETRIES</span><span class="p">)</span></div> + +<div class="viewcode-block" id="CloudSqlHook.create_database"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.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">project</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Creates a new database inside a Cloud SQL instance.</span> + +<span class="sd"> :param project: Project ID of the project that contains the instance.</span> +<span class="sd"> :type project: str</span> +<span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> +<span class="sd"> :type instance: str</span> +<span class="sd"> :param body: The request body, as described in</span> +<span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/databases/insert#request-body</span> +<span class="sd"> :type body: dict</span> +<span class="sd"> :return: True if the operation succeeded, raises an error otherwise</span> +<span class="sd"> :rtype: bool</span> +<span class="sd"> """</span> + <span class="n">response</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">databases</span><span class="p">()</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span> + <span class="n">project</span><span class="o">=</span><span class="n">project</span><span class="p">,</span> + <span class="n">instance</span><span class="o">=</span><span class="n">instance</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="n">NUM_RETRIES</span><span class="p">)</span> + <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">)</span></div> + +<div class="viewcode-block" id="CloudSqlHook.patch_database"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.patch_database">[docs]</a> <span class="k">def</span> <span class="nf">patch_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Updates a database resource inside a Cloud SQL instance.</span> +<span class="sd"> This method supports patch semantics.</span> +<span class="sd"> See: https://cloud.google.com/sql/docs/mysql/admin-api/how-tos/performance#patch</span> + +<span class="sd"> :param project: Project ID of the project that contains the instance.</span> +<span class="sd"> :type project: str</span> +<span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> +<span class="sd"> :type instance: str</span> +<span class="sd"> :param database: Name of the database to be updated in the instance.</span> +<span class="sd"> :type database: str</span> +<span class="sd"> :param body: The request body, as described in</span> +<span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/databases/insert#request-body</span> +<span class="sd"> :type body: dict</span> +<span class="sd"> :return: True if the operation succeeded, raises an error otherwise</span> +<span class="sd"> :rtype: bool</span> +<span class="sd"> """</span> + <span class="n">response</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">databases</span><span class="p">()</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span> + <span class="n">project</span><span class="o">=</span><span class="n">project</span><span class="p">,</span> + <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> + <span class="n">database</span><span class="o">=</span><span class="n">database</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="n">NUM_RETRIES</span><span class="p">)</span> + <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">)</span></div> + +<div class="viewcode-block" id="CloudSqlHook.delete_database"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.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">project</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">database</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Deletes a database from a Cloud SQL instance.</span> + +<span class="sd"> :param project: Project ID of the project that contains the instance.</span> +<span class="sd"> :type project: str</span> +<span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> +<span class="sd"> :type instance: str</span> +<span class="sd"> :param database: Name of the database to be deleted in the instance.</span> +<span class="sd"> :type database: str</span> +<span class="sd"> :return: True if the operation succeeded, raises an error otherwise</span> +<span class="sd"> :rtype: bool</span> +<span class="sd"> """</span> + <span class="n">response</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">databases</span><span class="p">()</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span> + <span class="n">project</span><span class="o">=</span><span class="n">project</span><span class="p">,</span> + <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> + <span class="n">database</span><span class="o">=</span><span class="n">database</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="n">NUM_RETRIES</span><span class="p">)</span> + <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">)</span></div> + + <span class="k">def</span> <span class="nf">_wait_for_operation_to_complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Waits for the named operation to complete - checks status of the</span> +<span class="sd"> asynchronous call.</span> + +<span class="sd"> :param project_id: Project ID of the project that contains the instance.</span> +<span class="sd"> :type project_id: str</span> +<span class="sd"> :param operation_name: name of the operation</span> +<span class="sd"> :type operation_name: str</span> +<span class="sd"> :return: response returned by the operation</span> +<span class="sd"> :rtype: dict</span> +<span class="sd"> """</span> + <span class="n">service</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> + <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> + <span class="n">operation_response</span> <span class="o">=</span> <span class="n">service</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">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> + <span class="n">operation</span><span class="o">=</span><span class="n">operation_name</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="n">NUM_RETRIES</span><span class="p">)</span> + <span class="k">if</span> <span class="n">operation_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"status"</span><span class="p">)</span> <span class="o">==</span> <span class="n">CloudSqlOperationStatus</span><span class="o">.</span><span class="n">DONE</span><span class="p">:</span> + <span class="n">error</span> <span class="o">=</span> <span class="n">operation_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"error"</span><span class="p">)</span> + <span class="k">if</span> <span class="n">error</span><span class="p">:</span> + <span class="c1"># Extracting the errors list as string and trimming square braces</span> + <span class="n">error_msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">error</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"errors"</span><span class="p">))[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span> + <span class="c1"># No meaningful info to return from the response in case of success</span> + <span class="k">return</span> <span class="kc">True</span> + <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">TIME_TO_SLEEP_IN_SECONDS</span><span class="p">)</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" 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/js/theme.js"></script> + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/1f06fa0e/_modules/airflow/contrib/hooks/gcs_hook.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/hooks/gcs_hook.html b/_modules/airflow/contrib/hooks/gcs_hook.html index c4896fb..a72ac0d 100644 --- a/_modules/airflow/contrib/hooks/gcs_hook.html +++ b/_modules/airflow/contrib/hooks/gcs_hook.html @@ -185,7 +185,10 @@ <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> <span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span> +<span class="kn">import</span> <span class="nn">gzip</span> <span class="k">as</span> <span class="nn">gz</span> +<span class="kn">import</span> <span class="nn">shutil</span> <span class="kn">import</span> <span class="nn">re</span> +<span class="kn">import</span> <span class="nn">os</span> <div class="viewcode-block" id="GoogleCloudStorageHook"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook">[docs]</a><span class="k">class</span> <span class="nc">GoogleCloudStorageHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span> @@ -332,7 +335,8 @@ <span class="k">return</span> <span class="n">downloaded_file_bytes</span></div> <span class="c1"># pylint:disable=redefined-builtin</span> -<div class="viewcode-block" id="GoogleCloudStorageHook.upload"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook.upload">[docs]</a> <span class="k">def</span> <span class="nf">upload</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="nb">object</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">mime_type</span><span class="o">=</span><span class="s1">'application/octet-stream'</span><span class="p">):</span> +<div class="viewcode-block" id="GoogleCloudStorageHook.upload"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook.upload">[docs]</a> <span class="k">def</span> <span class="nf">upload</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="nb">object</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> + <span class="n">mime_type</span><span class="o">=</span><span class="s1">'application/octet-stream'</span><span class="p">,</span> <span class="n">gzip</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> <span class="sd">"""</span> <span class="sd"> Uploads a local file to Google Cloud Storage.</span> @@ -343,15 +347,31 @@ <span class="sd"> :param filename: The local file path to the file to be uploaded.</span> <span class="sd"> :type filename: string</span> <span class="sd"> :param mime_type: The MIME type to set when uploading the file.</span> -<span class="sd"> :type mime_type: string</span> +<span class="sd"> :type mime_type: str</span> +<span class="sd"> :param gzip: Option to compress file for upload</span> +<span class="sd"> :type gzip: bool</span> <span class="sd"> """</span> <span class="n">service</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> + + <span class="k">if</span> <span class="n">gzip</span><span class="p">:</span> + <span class="n">filename_gz</span> <span class="o">=</span> <span class="n">filename</span> <span class="o">+</span> <span class="s1">'.gz'</span> + + <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f_in</span><span class="p">:</span> + <span class="k">with</span> <span class="n">gz</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">filename_gz</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f_out</span><span class="p">:</span> + <span class="n">shutil</span><span class="o">.</span><span class="n">copyfileobj</span><span class="p">(</span><span class="n">f_in</span><span class="p">,</span> <span class="n">f_out</span><span class="p">)</span> + <span class="n">filename</span> <span class="o">=</span> <span class="n">filename_gz</span> + <span class="n">media</span> <span class="o">=</span> <span class="n">MediaFileUpload</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">mime_type</span><span class="p">)</span> + <span class="k">try</span><span class="p">:</span> <span class="n">service</span> \ <span class="o">.</span><span class="n">objects</span><span class="p">()</span> \ <span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">bucket</span><span class="o">=</span><span class="n">bucket</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="nb">object</span><span class="p">,</span> <span class="n">media_body</span><span class="o">=</span><span class="n">media</span><span class="p">)</span> \ <span class="o">.</span><span class="n">execute</span><span class="p">()</span> + + <span class="c1"># Clean up gzip file</span> + <span class="k">if</span> <span class="n">gzip</span><span class="p">:</span> + <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">return</span> <span class="kc">True</span> <span class="k">except</span> <span class="n">errors</span><span class="o">.</span><span class="n">HttpError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> <span class="k">if</span> <span class="n">ex</span><span class="o">.</span><span class="n">resp</span><span class="p">[</span><span class="s1">'status'</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'404'</span><span class="p">:</span> @@ -638,15 +658,16 @@ <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">'Creating Bucket: </span><span class="si">%s</span><span class="s1">; Location: </span><span class="si">%s</span><span class="s1">; Storage Class: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">bucket_name</span><span class="p">,</span> <span class="n">location</span><span class="p">,</span> <span class="n">storage_class</span><span class="p">)</span> - <span class="k">assert</span> <span class="n">storage_class</span> <span class="ow">in</span> <span class="n">storage_classes</span><span class="p">,</span> \ - <span class="s1">'Invalid value (</span><span class="si">{}</span><span class="s1">) passed to storage_class. Value should be '</span> \ - <span class="s1">'one of </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">storage_class</span><span class="p">,</span> <span class="n">storage_classes</span><span class="p">)</span> + <span class="k">if</span> <span class="n">storage_class</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">storage_classes</span><span class="p">:</span> + <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> + <span class="s1">'Invalid value (</span><span class="si">{}</span><span class="s1">) passed to storage_class. Value should be '</span> + <span class="s1">'one of </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">storage_class</span><span class="p">,</span> <span class="n">storage_classes</span><span class="p">))</span> - <span class="k">assert</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">'[a-zA-Z0-9]+'</span><span class="p">,</span> <span class="n">bucket_name</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span> \ - <span class="s1">'Bucket names must start with a number or letter.'</span> + <span class="k">if</span> <span class="ow">not</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">'[a-zA-Z0-9]+'</span><span class="p">,</span> <span class="n">bucket_name</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span> + <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Bucket names must start with a number or letter.'</span><span class="p">)</span> - <span class="k">assert</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">'[a-zA-Z0-9]+'</span><span class="p">,</span> <span class="n">bucket_name</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]),</span> \ - <span class="s1">'Bucket names must end with a number or letter.'</span> + <span class="k">if</span> <span class="ow">not</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">'[a-zA-Z0-9]+'</span><span class="p">,</span> <span class="n">bucket_name</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]):</span> + <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Bucket names must end with a number or letter.'</span><span class="p">)</span> <span class="n">service</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">bucket_resource</span> <span class="o">=</span> <span class="p">{</span> @@ -726,20 +747,13 @@ - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'../../../../', - VERSION:'', - LANGUAGE:'None', - COLLAPSE_INDEX:false, - FILE_SUFFIX:'.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt' - }; - </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" 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> +
