http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/1f06fa0e/_modules/airflow/contrib/operators/gcp_sql_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/gcp_sql_operator.html b/_modules/airflow/contrib/operators/gcp_sql_operator.html new file mode 100644 index 0000000..62c01b8 --- /dev/null +++ b/_modules/airflow/contrib/operators/gcp_sql_operator.html @@ -0,0 +1,737 @@ + + +<!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.operators.gcp_sql_operator — 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.operators.gcp_sql_operator</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.operators.gcp_sql_operator</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">from</span> <span class="nn">googleapiclient.errors</span> <span class="k">import</span> <span class="n">HttpError</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_sql_hook</span> <span class="k">import</span> <span class="n">CloudSqlHook</span> +<span class="kn">from</span> <span class="nn">airflow.contrib.utils.gcp_field_validator</span> <span class="k">import</span> <span class="n">GcpBodyFieldValidator</span> +<span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span> +<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> + +<span class="n">SETTINGS</span> <span class="o">=</span> <span class="s1">'settings'</span> +<span class="n">SETTINGS_VERSION</span> <span class="o">=</span> <span class="s1">'settingsVersion'</span> + +<span class="n">CLOUD_SQL_VALIDATION</span> <span class="o">=</span> <span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"name"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"settings"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"tier"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"backupConfiguration"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"binaryLogEnabled"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"enabled"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"replicationLogArchivingEnabled"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"startTime"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> + <span class="p">],</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"activationPolicy"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"authorizedGaeApplications"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"list"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"crashSafeReplicationEnabled"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"dataDiskSizeGb"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"dataDiskType"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"databaseFlags"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"list"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"ipConfiguration"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"authorizedNetworks"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"list"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"expirationTime"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"name"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"value"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> + <span class="p">],</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"ipv4Enabled"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"privateNetwork"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"requireSsl"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="p">],</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"locationPreference"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"followGaeApplication"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"zone"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="p">],</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"maintenanceWindow"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"hour"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"day"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"updateTrack"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="p">],</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"pricingPlan"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"replicationType"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"storageAutoResize"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"storageAutoResizeLimit"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"userLabels"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="p">]),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"databaseVersion"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"failoverReplica"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"name"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> + <span class="p">],</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"masterInstanceName"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"onPremisesConfiguration"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"region"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"replicaConfiguration"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"failoverTarget"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"mysqlReplicaConfiguration"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"caCertificate"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"clientCertificate"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"clientKey"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"connectRetryInterval"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"dumpFilePath"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"masterHeartbeatPeriod"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"password"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"sslCipher"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"username"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"verifyServerCertificate"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> + <span class="p">],</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="p">],</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> +<span class="p">]</span> +<span class="n">CLOUD_SQL_EXPORT_VALIDATION</span> <span class="o">=</span> <span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"exportContext"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"fileType"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"uri"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"databases"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"list"</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"sqlExportOptions"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"tables"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"list"</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"schemaOnly"</span><span class="p">)</span> + <span class="p">]),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"csvExportOptions"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"selectQuery"</span><span class="p">)</span> + <span class="p">])</span> + <span class="p">])</span> +<span class="p">]</span> +<span class="n">CLOUD_SQL_IMPORT_VALIDATION</span> <span class="o">=</span> <span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"importContext"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"fileType"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"uri"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"database"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"importUser"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"csvImportOptions"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"dict"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">fields</span><span class="o">=</span><span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"table"</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"columns"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">"list"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> + <span class="p">])</span> + <span class="p">])</span> +<span class="p">]</span> +<span class="n">CLOUD_SQL_DATABASE_INSERT_VALIDATION</span> <span class="o">=</span> <span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"instance"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"name"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"project"</span><span class="p">,</span> <span class="n">allow_empty</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span> +<span class="p">]</span> +<span class="n">CLOUD_SQL_DATABASE_PATCH_VALIDATION</span> <span class="o">=</span> <span class="p">[</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"instance"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"name"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"project"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"etag"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"charset"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> + <span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"collation"</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> +<span class="p">]</span> + + +<span class="k">class</span> <span class="nc">CloudSqlBaseOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Abstract base operator for Google Cloud SQL operators to inherit from.</span> + +<span class="sd"> :param project_id: Project ID of the Google Cloud Platform project to operate it.</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"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> +<span class="sd"> :type gcp_conn_id: str</span> +<span class="sd"> :param api_version: API version used (e.g. v1).</span> +<span class="sd"> :type api_version: str</span> +<span class="sd"> """</span> + <span class="nd">@apply_defaults</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">project_id</span><span class="p">,</span> + <span class="n">instance</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">api_version</span><span class="o">=</span><span class="s1">'v1beta4'</span><span class="p">,</span> + <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> + <span class="bp">self</span><span class="o">.</span><span class="n">instance</span> <span class="o">=</span> <span class="n">instance</span> + <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</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> + <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudSqlHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">)</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlBaseOperator</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'project_id' is empty"</span><span class="p">)</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'instance' is empty"</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_check_if_instance_exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</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">_hook</span><span class="o">.</span><span class="n">get_instance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="n">instance</span><span class="p">)</span> + <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> + <span class="n">status</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span> + <span class="k">if</span> <span class="n">status</span> <span class="o">==</span> <span class="mi">404</span><span class="p">:</span> + <span class="k">return</span> <span class="kc">False</span> + <span class="k">raise</span> <span class="n">e</span> + + <span class="k">def</span> <span class="nf">_check_if_db_exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">db_name</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">_hook</span><span class="o">.</span><span class="n">get_database</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">,</span> <span class="n">db_name</span><span class="p">)</span> + <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> + <span class="n">status</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span> + <span class="k">if</span> <span class="n">status</span> <span class="o">==</span> <span class="mi">404</span><span class="p">:</span> + <span class="k">return</span> <span class="kc">False</span> + <span class="k">raise</span> <span class="n">e</span> + + <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="k">pass</span> + + <span class="nd">@staticmethod</span> + <span class="k">def</span> <span class="nf">_get_settings_version</span><span class="p">(</span><span class="n">instance</span><span class="p">):</span> + <span class="k">return</span> <span class="n">instance</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">SETTINGS</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">SETTINGS_VERSION</span><span class="p">)</span> + + +<div class="viewcode-block" id="CloudSqlInstanceCreateOperator"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlInstanceCreateOperator</span><span class="p">(</span><span class="n">CloudSqlBaseOperator</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Creates a new Cloud SQL instance.</span> +<span class="sd"> If an instance with the same name exists, no action will be taken and</span> +<span class="sd"> the operator will succeed.</span> + +<span class="sd"> :param project_id: Project ID of the project to which the newly created Cloud SQL</span> +<span class="sd"> 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</span> +<span class="sd"> #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"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> +<span class="sd"> :type gcp_conn_id: str</span> +<span class="sd"> :param api_version: API version used (e.g. v1beta4).</span> +<span class="sd"> :type api_version: str</span> +<span class="sd"> :param validate_body: True if body should be validated, False otherwise.</span> +<span class="sd"> :type validate_body: bool</span> +<span class="sd"> """</span> + <span class="c1"># [START gcp_sql_create_template_fields]</span> + <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'instance'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">)</span> + <span class="c1"># [END gcp_sql_create_template_fields]</span> + + <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1beta4'</span><span class="p">,</span> + <span class="n">validate_body</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> + <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">body</span> + <span class="bp">self</span><span class="o">.</span><span class="n">validate_body</span> <span class="o">=</span> <span class="n">validate_body</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceCreateOperator</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">project_id</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">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="n">api_version</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceCreateOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'body' is empty"</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_body_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">validate_body</span><span class="p">:</span> + <span class="n">GcpBodyFieldValidator</span><span class="p">(</span><span class="n">CLOUD_SQL_VALIDATION</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">)</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span> + +<div class="viewcode-block" id="CloudSqlInstanceCreateOperator.execute"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceCreateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_validate_body_fields</span><span class="p">()</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_if_instance_exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">):</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">create_instance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span> + <span class="k">else</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="s2">"Cloud SQL instance with ID </span><span class="si">{}</span><span class="s2"> already exists. "</span> + <span class="s2">"Aborting create."</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">))</span> + <span class="k">return</span> <span class="kc">True</span></div></div> + + +<div class="viewcode-block" id="CloudSqlInstancePatchOperator"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstancePatchOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlInstancePatchOperator</span><span class="p">(</span><span class="n">CloudSqlBaseOperator</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 a partial update, so only included values for the settings will be</span> +<span class="sd"> updated.</span> + +<span class="sd"> In the request body, supply the relevant portions of an instance resource, according</span> +<span class="sd"> to the rules of patch semantics.</span> +<span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/how-tos/performance#patch</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"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> +<span class="sd"> :type gcp_conn_id: str</span> +<span class="sd"> :param api_version: API version used (e.g. v1beta4).</span> +<span class="sd"> :type api_version: str</span> +<span class="sd"> """</span> + <span class="c1"># [START gcp_sql_patch_template_fields]</span> + <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'instance'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">)</span> + <span class="c1"># [END gcp_sql_patch_template_fields]</span> + + <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1beta4'</span><span class="p">,</span> + <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">body</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstancePatchOperator</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">project_id</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">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="n">api_version</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstancePatchOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'body' is empty"</span><span class="p">)</span> + +<div class="viewcode-block" id="CloudSqlInstancePatchOperator.execute"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstancePatchOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_if_instance_exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">):</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Cloud SQL instance with ID </span><span class="si">{}</span><span class="s1"> does not exist. '</span> + <span class="s1">'Please specify another instance to patch.'</span> + <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">))</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">patch_instance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">)</span></div></div> + + +<div class="viewcode-block" id="CloudSqlInstanceDeleteOperator"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlInstanceDeleteOperator</span><span class="p">(</span><span class="n">CloudSqlBaseOperator</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 to be deleted.</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"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> +<span class="sd"> :type gcp_conn_id: str</span> +<span class="sd"> :param api_version: API version used (e.g. v1beta4).</span> +<span class="sd"> :type api_version: str</span> +<span class="sd"> """</span> + <span class="c1"># [START gcp_sql_delete_template_fields]</span> + <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'instance'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">)</span> + <span class="c1"># [END gcp_sql_delete_template_fields]</span> + + <span class="nd">@apply_defaults</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">project_id</span><span class="p">,</span> + <span class="n">instance</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">api_version</span><span class="o">=</span><span class="s1">'v1beta4'</span><span class="p">,</span> + <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceDeleteOperator</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">project_id</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">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="n">api_version</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> + +<div class="viewcode-block" id="CloudSqlInstanceDeleteOperator.execute"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceDeleteOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_if_instance_exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">):</span> + <span class="nb">print</span><span class="p">(</span><span class="s2">"Cloud SQL instance with ID </span><span class="si">{}</span><span class="s2"> does not exist. Aborting delete."</span> + <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">))</span> + <span class="k">return</span> <span class="kc">True</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">delete_instance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">)</span></div></div> + + +<div class="viewcode-block" id="CloudSqlInstanceDatabaseCreateOperator"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceDatabaseCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlInstanceDatabaseCreateOperator</span><span class="p">(</span><span class="n">CloudSqlBaseOperator</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_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 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"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> +<span class="sd"> :type gcp_conn_id: str</span> +<span class="sd"> :param api_version: API version used (e.g. v1beta4).</span> +<span class="sd"> :type api_version: str</span> +<span class="sd"> :param validate_body: Whether the body should be validated. Defaults to True.</span> +<span class="sd"> :type validate_body: bool</span> +<span class="sd"> """</span> + <span class="c1"># [START gcp_sql_db_create_template_fields]</span> + <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'instance'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">)</span> + <span class="c1"># [END gcp_sql_db_create_template_fields]</span> + + <span class="nd">@apply_defaults</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">project_id</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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1beta4'</span><span class="p">,</span> + <span class="n">validate_body</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> + <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">body</span> + <span class="bp">self</span><span class="o">.</span><span class="n">validate_body</span> <span class="o">=</span> <span class="n">validate_body</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceDatabaseCreateOperator</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">project_id</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">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="n">api_version</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceDatabaseCreateOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'body' is empty"</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_body_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">validate_body</span><span class="p">:</span> + <span class="n">GcpBodyFieldValidator</span><span class="p">(</span><span class="n">CLOUD_SQL_DATABASE_INSERT_VALIDATION</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">)</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span> + +<div class="viewcode-block" id="CloudSqlInstanceDatabaseCreateOperator.execute"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceDatabaseCreateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_validate_body_fields</span><span class="p">()</span> + <span class="n">database</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"name"</span><span class="p">)</span> + <span class="k">if</span> <span class="ow">not</span> <span class="n">database</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">error</span><span class="p">(</span><span class="s2">"Body doesn't contain 'name'. Cannot check if the"</span> + <span class="s2">" database already exists in the instance </span><span class="si">{}</span><span class="s2">."</span> + <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">))</span> + <span class="k">return</span> <span class="kc">False</span> + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_if_db_exists</span><span class="p">(</span><span class="n">database</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="s2">"Cloud SQL instance with ID </span><span class="si">{}</span><span class="s2"> already contains database"</span> + <span class="s2">" '</span><span class="si">{}</span><span class="s2">'. Aborting database insert."</span> + <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">,</span> <span class="n">database</span><span class="p">))</span> + <span class="k">return</span> <span class="kc">True</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">create_database</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span></div></div> + + +<div class="viewcode-block" id="CloudSqlInstanceDatabasePatchOperator"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceDatabasePatchOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlInstanceDatabasePatchOperator</span><span class="p">(</span><span class="n">CloudSqlBaseOperator</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Updates a resource containing information about a database inside a Cloud SQL</span> +<span class="sd"> instance using 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_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 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/patch#request-body</span> +<span class="sd"> :type body: dict</span> +<span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> +<span class="sd"> :type gcp_conn_id: str</span> +<span class="sd"> :param api_version: API version used (e.g. v1beta4).</span> +<span class="sd"> :type api_version: str</span> +<span class="sd"> :param validate_body: Whether the body should be validated. Defaults to True.</span> +<span class="sd"> :type validate_body: bool</span> +<span class="sd"> """</span> + <span class="c1"># [START gcp_sql_db_patch_template_fields]</span> + <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'instance'</span><span class="p">,</span> <span class="s1">'database'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> + <span class="s1">'api_version'</span><span class="p">)</span> + <span class="c1"># [END gcp_sql_db_patch_template_fields]</span> + + <span class="nd">@apply_defaults</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">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="n">body</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">api_version</span><span class="o">=</span><span class="s1">'v1beta4'</span><span class="p">,</span> + <span class="n">validate_body</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> + <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">database</span> <span class="o">=</span> <span class="n">database</span> + <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">body</span> + <span class="bp">self</span><span class="o">.</span><span class="n">validate_body</span> <span class="o">=</span> <span class="n">validate_body</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceDatabasePatchOperator</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">project_id</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">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="n">api_version</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceDatabasePatchOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'body' is empty"</span><span class="p">)</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'database' is empty"</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_body_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">validate_body</span><span class="p">:</span> + <span class="n">GcpBodyFieldValidator</span><span class="p">(</span><span class="n">CLOUD_SQL_DATABASE_PATCH_VALIDATION</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">)</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span> + +<div class="viewcode-block" id="CloudSqlInstanceDatabasePatchOperator.execute"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceDatabasePatchOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">_validate_body_fields</span><span class="p">()</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_if_db_exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">):</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"Cloud SQL instance with ID </span><span class="si">{}</span><span class="s2"> does not contain "</span> + <span class="s2">"database '</span><span class="si">{}</span><span class="s2">'. "</span> + <span class="s2">"Please specify another database to patch."</span> + <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">))</span> + <span class="k">else</span><span class="p">:</span> + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">patch_database</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">,</span> + <span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span></div></div> + + +<div class="viewcode-block" id="CloudSqlInstanceDatabaseDeleteOperator"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceDatabaseDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlInstanceDatabaseDeleteOperator</span><span class="p">(</span><span class="n">CloudSqlBaseOperator</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_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 to be deleted in the instance.</span> +<span class="sd"> :type database: str</span> +<span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> +<span class="sd"> :type gcp_conn_id: str</span> +<span class="sd"> :param api_version: API version used (e.g. v1beta4).</span> +<span class="sd"> :type api_version: str</span> +<span class="sd"> """</span> + <span class="c1"># [START gcp_sql_db_delete_template_fields]</span> + <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'instance'</span><span class="p">,</span> <span class="s1">'database'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> + <span class="s1">'api_version'</span><span class="p">)</span> + <span class="c1"># [END gcp_sql_db_delete_template_fields]</span> + + <span class="nd">@apply_defaults</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">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="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1beta4'</span><span class="p">,</span> + <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">database</span> <span class="o">=</span> <span class="n">database</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceDatabaseDeleteOperator</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">project_id</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">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">,</span> + <span class="n">api_version</span><span class="o">=</span><span class="n">api_version</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlInstanceDatabaseDeleteOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> + <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">:</span> + <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'database' is empty"</span><span class="p">)</span> + +<div class="viewcode-block" id="CloudSqlInstanceDatabaseDeleteOperator.execute"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.operators.gcp_sql_operator.CloudSqlInstanceDatabaseDeleteOperator.execute">[docs]</a> <span class="k">de
<TRUNCATED>
