| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>airflow.contrib.operators.qubole_operator — Airflow Documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../search.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.6 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../errors.html">Error Tracking</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">Python API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">Python API</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../operators.html">airflow.contrib.operators</a> »</li> |
| |
| <li>airflow.contrib.operators.qubole_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.qubole_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="sd">"""Qubole operator"""</span> |
| |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="k">import</span> <span class="n">Iterable</span> |
| <span class="kn">from</span> <span class="nn">airflow.models.baseoperator</span> <span class="k">import</span> <span class="n">BaseOperator</span><span class="p">,</span> <span class="n">BaseOperatorLink</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="kn">from</span> <span class="nn">airflow.contrib.hooks.qubole_hook</span> <span class="k">import</span> <span class="n">QuboleHook</span><span class="p">,</span> <span class="n">COMMAND_ARGS</span><span class="p">,</span> <span class="n">HYPHEN_ARGS</span><span class="p">,</span> \ |
| <span class="n">flatten_list</span><span class="p">,</span> <span class="n">POSITIONAL_ARGS</span> |
| |
| |
| <div class="viewcode-block" id="QDSLink"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QDSLink">[docs]</a><span class="k">class</span> <span class="nc">QDSLink</span><span class="p">(</span><span class="n">BaseOperatorLink</span><span class="p">):</span> |
| <span class="sd">"""Link to QDS"""</span> |
| <div class="viewcode-block" id="QDSLink.name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QDSLink.name">[docs]</a> <span class="n">name</span> <span class="o">=</span> <span class="s1">'Go to QDS'</span></div> |
| |
| <div class="viewcode-block" id="QDSLink.get_link"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QDSLink.get_link">[docs]</a> <span class="k">def</span> <span class="nf">get_link</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operator</span><span class="p">,</span> <span class="n">dttm</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">operator</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span><span class="o">.</span><span class="n">get_extra_links</span><span class="p">(</span><span class="n">operator</span><span class="p">,</span> <span class="n">dttm</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="QuboleOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator">[docs]</a><span class="k">class</span> <span class="nc">QuboleOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Execute tasks (commands) on QDS (https://qubole.com).</span> |
| |
| <span class="sd"> :param qubole_conn_id: Connection id which consists of qds auth_token</span> |
| <span class="sd"> :type qubole_conn_id: str</span> |
| |
| <span class="sd"> kwargs:</span> |
| <span class="sd"> :command_type: type of command to be executed, e.g. hivecmd, shellcmd, hadoopcmd</span> |
| <span class="sd"> :tags: array of tags to be assigned with the command</span> |
| <span class="sd"> :cluster_label: cluster label on which the command will be executed</span> |
| <span class="sd"> :name: name to be given to command</span> |
| <span class="sd"> :notify: whether to send email on command completion or not (default is False)</span> |
| |
| <span class="sd"> **Arguments specific to command types**</span> |
| |
| <span class="sd"> hivecmd:</span> |
| <span class="sd"> :query: inline query statement</span> |
| <span class="sd"> :script_location: s3 location containing query statement</span> |
| <span class="sd"> :sample_size: size of sample in bytes on which to run query</span> |
| <span class="sd"> :macros: macro values which were used in query</span> |
| <span class="sd"> :sample_size: size of sample in bytes on which to run query</span> |
| <span class="sd"> :hive-version: Specifies the hive version to be used. eg: 0.13,1.2,etc.</span> |
| <span class="sd"> prestocmd:</span> |
| <span class="sd"> :query: inline query statement</span> |
| <span class="sd"> :script_location: s3 location containing query statement</span> |
| <span class="sd"> :macros: macro values which were used in query</span> |
| <span class="sd"> hadoopcmd:</span> |
| <span class="sd"> :sub_commnad: must be one these ["jar", "s3distcp", "streaming"] followed by</span> |
| <span class="sd"> 1 or more args</span> |
| <span class="sd"> shellcmd:</span> |
| <span class="sd"> :script: inline command with args</span> |
| <span class="sd"> :script_location: s3 location containing query statement</span> |
| <span class="sd"> :files: list of files in s3 bucket as file1,file2 format. These files will be</span> |
| <span class="sd"> copied into the working directory where the qubole command is being</span> |
| <span class="sd"> executed.</span> |
| <span class="sd"> :archives: list of archives in s3 bucket as archive1,archive2 format. These</span> |
| <span class="sd"> will be unarchived into the working directory where the qubole command is</span> |
| <span class="sd"> being executed</span> |
| <span class="sd"> :parameters: any extra args which need to be passed to script (only when</span> |
| <span class="sd"> script_location is supplied)</span> |
| <span class="sd"> pigcmd:</span> |
| <span class="sd"> :script: inline query statement (latin_statements)</span> |
| <span class="sd"> :script_location: s3 location containing pig query</span> |
| <span class="sd"> :parameters: any extra args which need to be passed to script (only when</span> |
| <span class="sd"> script_location is supplied</span> |
| <span class="sd"> sparkcmd:</span> |
| <span class="sd"> :program: the complete Spark Program in Scala, R, or Python</span> |
| <span class="sd"> :cmdline: spark-submit command line, all required information must be specify</span> |
| <span class="sd"> in cmdline itself.</span> |
| <span class="sd"> :sql: inline sql query</span> |
| <span class="sd"> :script_location: s3 location containing query statement</span> |
| <span class="sd"> :language: language of the program, Scala, R, or Python</span> |
| <span class="sd"> :app_id: ID of an Spark job server app</span> |
| <span class="sd"> :arguments: spark-submit command line arguments</span> |
| <span class="sd"> :user_program_arguments: arguments that the user program takes in</span> |
| <span class="sd"> :macros: macro values which were used in query</span> |
| <span class="sd"> :note_id: Id of the Notebook to run</span> |
| <span class="sd"> dbtapquerycmd:</span> |
| <span class="sd"> :db_tap_id: data store ID of the target database, in Qubole.</span> |
| <span class="sd"> :query: inline query statement</span> |
| <span class="sd"> :macros: macro values which were used in query</span> |
| <span class="sd"> dbexportcmd:</span> |
| <span class="sd"> :mode: Can be 1 for Hive export or 2 for HDFS/S3 export</span> |
| <span class="sd"> :schema: Db schema name assumed accordingly by database if not specified</span> |
| <span class="sd"> :hive_table: Name of the hive table</span> |
| <span class="sd"> :partition_spec: partition specification for Hive table.</span> |
| <span class="sd"> :dbtap_id: data store ID of the target database, in Qubole.</span> |
| <span class="sd"> :db_table: name of the db table</span> |
| <span class="sd"> :db_update_mode: allowinsert or updateonly</span> |
| <span class="sd"> :db_update_keys: columns used to determine the uniqueness of rows</span> |
| <span class="sd"> :export_dir: HDFS/S3 location from which data will be exported.</span> |
| <span class="sd"> :fields_terminated_by: hex of the char used as column separator in the dataset</span> |
| <span class="sd"> :use_customer_cluster: To use cluster to run command</span> |
| <span class="sd"> :customer_cluster_label: the label of the cluster to run the command on</span> |
| <span class="sd"> :additional_options: Additional Sqoop options which are needed enclose options in</span> |
| <span class="sd"> double or single quotes e.g. '--map-column-hive id=int,data=string'</span> |
| <span class="sd"> dbimportcmd:</span> |
| <span class="sd"> :mode: 1 (simple), 2 (advance)</span> |
| <span class="sd"> :hive_table: Name of the hive table</span> |
| <span class="sd"> :schema: Db schema name assumed accordingly by database if not specified</span> |
| <span class="sd"> :hive_serde: Output format of the Hive Table</span> |
| <span class="sd"> :dbtap_id: data store ID of the target database, in Qubole.</span> |
| <span class="sd"> :db_table: name of the db table</span> |
| <span class="sd"> :where_clause: where clause, if any</span> |
| <span class="sd"> :parallelism: number of parallel db connections to use for extracting data</span> |
| <span class="sd"> :extract_query: SQL query to extract data from db. $CONDITIONS must be part</span> |
| <span class="sd"> of the where clause.</span> |
| <span class="sd"> :boundary_query: Query to be used get range of row IDs to be extracted</span> |
| <span class="sd"> :split_column: Column used as row ID to split data into ranges (mode 2)</span> |
| <span class="sd"> :use_customer_cluster: To use cluster to run command</span> |
| <span class="sd"> :customer_cluster_label: the label of the cluster to run the command on</span> |
| <span class="sd"> :additional_options: Additional Sqoop options which are needed enclose options in</span> |
| <span class="sd"> double or single quotes</span> |
| |
| <span class="sd"> .. note:</span> |
| |
| <span class="sd"> Following fields are template-supported : ``query``, ``script_location``,</span> |
| <span class="sd"> ``sub_command``, ``script``, ``files``, ``archives``, ``program``, ``cmdline``,</span> |
| <span class="sd"> ``sql``, ``where_clause``, ``extract_query``, ``boundary_query``, ``macros``,</span> |
| <span class="sd"> ``tags``, ``name``, ``parameters``, ``dbtap_id``, ``hive_table``, ``db_table``,</span> |
| <span class="sd"> ``split_column``, ``note_id``, ``db_update_keys``, ``export_dir``,</span> |
| <span class="sd"> ``partition_spec``, ``qubole_conn_id``, ``arguments``, ``user_program_arguments``.</span> |
| <span class="sd"> You can also use ``.txt`` files for template driven use cases.</span> |
| |
| <span class="sd"> .. note:</span> |
| |
| <span class="sd"> In QuboleOperator there is a default handler for task failures and retries,</span> |
| <span class="sd"> which generally kills the command running at QDS for the corresponding task</span> |
| <span class="sd"> instance. You can override this behavior by providing your own failure and retry</span> |
| <span class="sd"> handler in task definition.</span> |
| <span class="sd"> """</span> |
| |
| <div class="viewcode-block" id="QuboleOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'query'</span><span class="p">,</span> <span class="s1">'script_location'</span><span class="p">,</span> <span class="s1">'sub_command'</span><span class="p">,</span> <span class="s1">'script'</span><span class="p">,</span> <span class="s1">'files'</span><span class="p">,</span> |
| <span class="s1">'archives'</span><span class="p">,</span> <span class="s1">'program'</span><span class="p">,</span> <span class="s1">'cmdline'</span><span class="p">,</span> <span class="s1">'sql'</span><span class="p">,</span> <span class="s1">'where_clause'</span><span class="p">,</span> <span class="s1">'tags'</span><span class="p">,</span> |
| <span class="s1">'extract_query'</span><span class="p">,</span> <span class="s1">'boundary_query'</span><span class="p">,</span> <span class="s1">'macros'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">,</span> <span class="s1">'parameters'</span><span class="p">,</span> |
| <span class="s1">'dbtap_id'</span><span class="p">,</span> <span class="s1">'hive_table'</span><span class="p">,</span> <span class="s1">'db_table'</span><span class="p">,</span> <span class="s1">'split_column'</span><span class="p">,</span> <span class="s1">'note_id'</span><span class="p">,</span> |
| <span class="s1">'db_update_keys'</span><span class="p">,</span> <span class="s1">'export_dir'</span><span class="p">,</span> <span class="s1">'partition_spec'</span><span class="p">,</span> <span class="s1">'qubole_conn_id'</span><span class="p">,</span> |
| <span class="s1">'arguments'</span><span class="p">,</span> <span class="s1">'user_program_arguments'</span><span class="p">,</span> <span class="s1">'cluster_label'</span><span class="p">)</span> <span class="c1"># type: Iterable[str]</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.template_ext"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.template_ext">[docs]</a> <span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'.txt'</span><span class="p">,)</span> <span class="c1"># type: Iterable[str]</span></div> |
| <div class="viewcode-block" id="QuboleOperator.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#3064A1'</span></div> |
| <div class="viewcode-block" id="QuboleOperator.ui_fgcolor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.ui_fgcolor">[docs]</a> <span class="n">ui_fgcolor</span> <span class="o">=</span> <span class="s1">'#fff'</span></div> |
| <div class="viewcode-block" id="QuboleOperator.qubole_hook_allowed_args_list"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.qubole_hook_allowed_args_list">[docs]</a> <span class="n">qubole_hook_allowed_args_list</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'command_type'</span><span class="p">,</span> <span class="s1">'qubole_conn_id'</span><span class="p">,</span> <span class="s1">'fetch_logs'</span><span class="p">]</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.operator_extra_links"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.operator_extra_links">[docs]</a> <span class="n">operator_extra_links</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="n">QDSLink</span><span class="p">(),</span></div> |
| <span class="p">)</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">qubole_conn_id</span><span class="o">=</span><span class="s2">"qubole_default"</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">args</span> <span class="o">=</span> <span class="n">args</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span> <span class="o">=</span> <span class="n">kwargs</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">'qubole_conn_id'</span><span class="p">]</span> <span class="o">=</span> <span class="n">qubole_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="n">filtered_base_kwargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_filtered_args</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">QuboleOperator</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">filtered_base_kwargs</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_failure_callback</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">on_failure_callback</span> <span class="o">=</span> <span class="n">QuboleHook</span><span class="o">.</span><span class="n">handle_failure_retry</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_retry_callback</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">on_retry_callback</span> <span class="o">=</span> <span class="n">QuboleHook</span><span class="o">.</span><span class="n">handle_failure_retry</span> |
| |
| <div class="viewcode-block" id="QuboleOperator._get_filtered_args"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator._get_filtered_args">[docs]</a> <span class="k">def</span> <span class="nf">_get_filtered_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">all_kwargs</span><span class="p">):</span> |
| <span class="n">qubole_args</span> <span class="o">=</span> <span class="n">flatten_list</span><span class="p">(</span><span class="n">COMMAND_ARGS</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> <span class="o">+</span> <span class="n">HYPHEN_ARGS</span> <span class="o">+</span> \ |
| <span class="n">flatten_list</span><span class="p">(</span><span class="n">POSITIONAL_ARGS</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">qubole_hook_allowed_args_list</span> |
| <span class="k">return</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">value</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">all_kwargs</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">qubole_args</span><span class="p">}</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.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">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">context</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.on_kill"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.on_kill">[docs]</a> <span class="k">def</span> <span class="nf">on_kill</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ti</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</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">kill</span><span class="p">(</span><span class="n">ti</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">get_hook</span><span class="p">()</span><span class="o">.</span><span class="n">kill</span><span class="p">(</span><span class="n">ti</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.get_results"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.get_results">[docs]</a> <span class="k">def</span> <span class="nf">get_results</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ti</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fp</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">inline</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">delim</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">fetch</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="sd">"""get_results from Qubole"""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span><span class="o">.</span><span class="n">get_results</span><span class="p">(</span><span class="n">ti</span><span class="p">,</span> <span class="n">fp</span><span class="p">,</span> <span class="n">inline</span><span class="p">,</span> <span class="n">delim</span><span class="p">,</span> <span class="n">fetch</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.get_log"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.get_log">[docs]</a> <span class="k">def</span> <span class="nf">get_log</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ti</span><span class="p">):</span> |
| <span class="sd">"""get_log from Qubole"""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span><span class="o">.</span><span class="n">get_log</span><span class="p">(</span><span class="n">ti</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.get_jobs_id"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.get_jobs_id">[docs]</a> <span class="k">def</span> <span class="nf">get_jobs_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ti</span><span class="p">):</span> |
| <span class="sd">"""get jobs_id from Qubole"""</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span><span class="o">.</span><span class="n">get_jobs_id</span><span class="p">(</span><span class="n">ti</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.get_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.get_hook">[docs]</a> <span class="k">def</span> <span class="nf">get_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Reinitialising the hook, as some template fields might have changed"""</span> |
| <span class="k">return</span> <span class="n">QuboleHook</span><span class="p">(</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.__getattribute__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.__getattribute__">[docs]</a> <span class="k">def</span> <span class="nf">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">QuboleOperator</span><span class="o">.</span><span class="n">template_fields</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s1">''</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="QuboleOperator.__setattr__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_operator/index.html#airflow.contrib.operators.qubole_operator.QuboleOperator.__setattr__">[docs]</a> <span class="k">def</span> <span class="nf">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">QuboleOperator</span><span class="o">.</span><span class="n">template_fields</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
