http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/kubernetes_pod_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/kubernetes_pod_operator.html b/_modules/airflow/contrib/operators/kubernetes_pod_operator.html index 07b5378..4fe38df 100644 --- a/_modules/airflow/contrib/operators/kubernetes_pod_operator.html +++ b/_modules/airflow/contrib/operators/kubernetes_pod_operator.html @@ -24,26 +24,17 @@ - - - <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> - - - - - - <link rel="index" title="Index" - href="../../../../genindex.html"/> - <link rel="search" title="Search" href="../../../../search.html"/> - <link rel="top" title="Airflow Documentation" href="../../../../index.html"/> - <link rel="up" title="Module code" href="../../../index.html"/> + <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" role="document"> +<body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> @@ -116,7 +107,7 @@ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <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> @@ -124,9 +115,10 @@ </nav> - <div class="wy-nav-content"> + <div class="rst-content"> + @@ -156,8 +148,6 @@ <li class="wy-breadcrumbs-aside"> - - </li> </ul> @@ -192,11 +182,15 @@ <span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes</span> <span class="k">import</span> <span class="n">kube_client</span><span class="p">,</span> <span class="n">pod_generator</span><span class="p">,</span> <span class="n">pod_launcher</span> <span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes.pod</span> <span class="k">import</span> <span class="n">Resources</span> <span class="kn">from</span> <span class="nn">airflow.utils.state</span> <span class="k">import</span> <span class="n">State</span> +<span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes.volume_mount</span> <span class="k">import</span> <span class="n">VolumeMount</span> <span class="c1"># noqa</span> +<span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes.volume</span> <span class="k">import</span> <span class="n">Volume</span> <span class="c1"># noqa</span> +<span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes.secret</span> <span class="k">import</span> <span class="n">Secret</span> <span class="c1"># noqa</span> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'templates_dict'</span><span class="p">,)</span> <span class="n">template_ext</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#ffefeb'</span> + <div class="viewcode-block" id="KubernetesPodOperator"><a class="viewcode-back" href="../../../../kubernetes.html#airflow.contrib.operators.kubernetes_pod_operator.KubernetesPodOperator">[docs]</a><span class="k">class</span> <span class="nc">KubernetesPodOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> <span class="sd">"""</span> <span class="sd"> Execute a task in a Kubernetes Pod</span> @@ -206,12 +200,16 @@ <span class="sd"> :type image: str</span> <span class="sd"> :param: namespace: the namespace to run within kubernetes</span> <span class="sd"> :type: namespace: str</span> -<span class="sd"> :param cmds: entrypoint of the container.</span> +<span class="sd"> :param cmds: entrypoint of the container. (templated)</span> <span class="sd"> The docker images's entrypoint is used if this is not provide.</span> -<span class="sd"> :type cmds: list</span> -<span class="sd"> :param arguments: arguments of to the entrypoint.</span> +<span class="sd"> :type cmds: list of str</span> +<span class="sd"> :param arguments: arguments of to the entrypoint. (templated)</span> <span class="sd"> The docker image's CMD is used if this is not provided.</span> -<span class="sd"> :type arguments: list</span> +<span class="sd"> :type arguments: list of str</span> +<span class="sd"> :param volume_mounts: volumeMounts for launched pod</span> +<span class="sd"> :type volume_mounts: list of VolumeMount</span> +<span class="sd"> :param volumes: volumes for launched pod. Includes ConfigMaps and PersistentVolumes</span> +<span class="sd"> :type volumes: list of Volume</span> <span class="sd"> :param labels: labels to apply to the Pod</span> <span class="sd"> :type labels: dict</span> <span class="sd"> :param startup_timeout_seconds: timeout in seconds to startup the pod</span> @@ -219,30 +217,48 @@ <span class="sd"> :param name: name of the task you want to run,</span> <span class="sd"> will be used to generate a pod id</span> <span class="sd"> :type name: str</span> -<span class="sd"> :param env_vars: Environment variables initialized in the container</span> +<span class="sd"> :param env_vars: Environment variables initialized in the container. (templated)</span> <span class="sd"> :type env_vars: dict</span> <span class="sd"> :param secrets: Kubernetes secrets to inject in the container,</span> <span class="sd"> They can be exposed as environment vars or files in a volume.</span> -<span class="sd"> :type secrets: list</span> +<span class="sd"> :type secrets: list of Secret</span> <span class="sd"> :param in_cluster: run kubernetes client with in_cluster configuration</span> <span class="sd"> :type in_cluster: bool</span> +<span class="sd"> :param cluster_context: context that points to kubernetes cluster.</span> +<span class="sd"> Ignored when in_cluster is True. If None, current-context is used.</span> +<span class="sd"> :type cluster_context: string</span> <span class="sd"> :param get_logs: get the stdout of the container as logs of the tasks</span> <span class="sd"> :type get_logs: bool</span> +<span class="sd"> :param affinity: A dict containing a group of affinity scheduling rules</span> +<span class="sd"> :type affinity: dict</span> +<span class="sd"> :param config_file: The path to the Kubernetes config file</span> +<span class="sd"> :type config_file: str</span> +<span class="sd"> :param xcom_push: If xcom_push is True, the content of the file</span> +<span class="sd"> /airflow/xcom/return.json in the container will also be pushed to an</span> +<span class="sd"> XCom when the container completes.</span> +<span class="sd"> :type xcom_push: bool</span> <span class="sd"> """</span> - <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'cmds'</span><span class="p">,</span> <span class="s1">'arguments'</span><span class="p">,</span> <span class="s1">'env_vars'</span><span class="p">)</span> + <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'cmds'</span><span class="p">,</span> <span class="s1">'arguments'</span><span class="p">,</span> <span class="s1">'env_vars'</span><span class="p">,</span> <span class="s1">'config_file'</span><span class="p">)</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">try</span><span class="p">:</span> - <span class="n">client</span> <span class="o">=</span> <span class="n">kube_client</span><span class="o">.</span><span class="n">get_kube_client</span><span class="p">(</span><span class="n">in_cluster</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">in_cluster</span><span class="p">)</span> + <span class="n">client</span> <span class="o">=</span> <span class="n">kube_client</span><span class="o">.</span><span class="n">get_kube_client</span><span class="p">(</span><span class="n">in_cluster</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">in_cluster</span><span class="p">,</span> + <span class="n">cluster_context</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster_context</span><span class="p">,</span> + <span class="n">config_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">)</span> <span class="n">gen</span> <span class="o">=</span> <span class="n">pod_generator</span><span class="o">.</span><span class="n">PodGenerator</span><span class="p">()</span> + <span class="k">for</span> <span class="n">mount</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">volume_mounts</span><span class="p">:</span> + <span class="n">gen</span><span class="o">.</span><span class="n">add_mount</span><span class="p">(</span><span class="n">mount</span><span class="p">)</span> + <span class="k">for</span> <span class="n">volume</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">volumes</span><span class="p">:</span> + <span class="n">gen</span><span class="o">.</span><span class="n">add_volume</span><span class="p">(</span><span class="n">volume</span><span class="p">)</span> + <span class="n">pod</span> <span class="o">=</span> <span class="n">gen</span><span class="o">.</span><span class="n">make_pod</span><span class="p">(</span> <span class="n">namespace</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> <span class="n">image</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">,</span> <span class="n">pod_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">cmds</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cmds</span><span class="p">,</span> <span class="n">arguments</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">arguments</span><span class="p">,</span> - <span class="n">labels</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">labels</span> + <span class="n">labels</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">labels</span><span class="p">,</span> <span class="p">)</span> <span class="n">pod</span><span class="o">.</span><span class="n">secrets</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">secrets</span> @@ -250,9 +266,11 @@ <span class="n">pod</span><span class="o">.</span><span class="n">image_pull_policy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">image_pull_policy</span> <span class="n">pod</span><span class="o">.</span><span class="n">annotations</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">annotations</span> <span class="n">pod</span><span class="o">.</span><span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">resources</span> + <span class="n">pod</span><span class="o">.</span><span class="n">affinity</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">affinity</span> - <span class="n">launcher</span> <span class="o">=</span> <span class="n">pod_launcher</span><span class="o">.</span><span class="n">PodLauncher</span><span class="p">(</span><span class="n">client</span><span class="p">)</span> - <span class="n">final_state</span> <span class="o">=</span> <span class="n">launcher</span><span class="o">.</span><span class="n">run_pod</span><span class="p">(</span> + <span class="n">launcher</span> <span class="o">=</span> <span class="n">pod_launcher</span><span class="o">.</span><span class="n">PodLauncher</span><span class="p">(</span><span class="n">kube_client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span> + <span class="n">extract_xcom</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">xcom_push</span><span class="p">)</span> + <span class="p">(</span><span class="n">final_state</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span> <span class="o">=</span> <span class="n">launcher</span><span class="o">.</span><span class="n">run_pod</span><span class="p">(</span> <span class="n">pod</span><span class="p">,</span> <span class="n">startup_timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">startup_timeout_seconds</span><span class="p">,</span> <span class="n">get_logs</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_logs</span><span class="p">)</span> @@ -260,6 +278,8 @@ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> <span class="s1">'Pod returned a failure: </span><span class="si">{state}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">state</span><span class="o">=</span><span class="n">final_state</span><span class="p">)</span> <span class="p">)</span> + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">xcom_push</span><span class="p">:</span> + <span class="k">return</span> <span class="n">result</span> <span class="k">except</span> <span class="n">AirflowException</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Pod Launching failed: </span><span class="si">{error}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">error</span><span class="o">=</span><span class="n">ex</span><span class="p">))</span> @@ -270,15 +290,21 @@ <span class="n">name</span><span class="p">,</span> <span class="n">cmds</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">arguments</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> + <span class="n">volume_mounts</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> + <span class="n">volumes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">env_vars</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">secrets</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">in_cluster</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> + <span class="n">cluster_context</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">startup_timeout_seconds</span><span class="o">=</span><span class="mi">120</span><span class="p">,</span> <span class="n">get_logs</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">image_pull_policy</span><span class="o">=</span><span class="s1">'IfNotPresent'</span><span class="p">,</span> <span class="n">annotations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">resources</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> + <span class="n">affinity</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> + <span class="n">config_file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> + <span class="n">xcom_push</span><span class="o">=</span><span class="kc">False</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">KubernetesPodOperator</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> @@ -290,18 +316,22 @@ <span class="bp">self</span><span class="o">.</span><span class="n">startup_timeout_seconds</span> <span class="o">=</span> <span class="n">startup_timeout_seconds</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> <span class="bp">self</span><span class="o">.</span><span class="n">env_vars</span> <span class="o">=</span> <span class="n">env_vars</span> <span class="ow">or</span> <span class="p">{}</span> + <span class="bp">self</span><span class="o">.</span><span class="n">volume_mounts</span> <span class="o">=</span> <span class="n">volume_mounts</span> <span class="ow">or</span> <span class="p">[]</span> + <span class="bp">self</span><span class="o">.</span><span class="n">volumes</span> <span class="o">=</span> <span class="n">volumes</span> <span class="ow">or</span> <span class="p">[]</span> <span class="bp">self</span><span class="o">.</span><span class="n">secrets</span> <span class="o">=</span> <span class="n">secrets</span> <span class="ow">or</span> <span class="p">[]</span> <span class="bp">self</span><span class="o">.</span><span class="n">in_cluster</span> <span class="o">=</span> <span class="n">in_cluster</span> + <span class="bp">self</span><span class="o">.</span><span class="n">cluster_context</span> <span class="o">=</span> <span class="n">cluster_context</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_logs</span> <span class="o">=</span> <span class="n">get_logs</span> <span class="bp">self</span><span class="o">.</span><span class="n">image_pull_policy</span> <span class="o">=</span> <span class="n">image_pull_policy</span> <span class="bp">self</span><span class="o">.</span><span class="n">annotations</span> <span class="o">=</span> <span class="n">annotations</span> <span class="ow">or</span> <span class="p">{}</span> - <span class="bp">self</span><span class="o">.</span><span class="n">resources</span> <span class="o">=</span> <span class="n">resources</span> <span class="ow">or</span> <span class="n">Resources</span><span class="p">()</span></div> + <span class="bp">self</span><span class="o">.</span><span class="n">affinity</span> <span class="o">=</span> <span class="n">affinity</span> <span class="ow">or</span> <span class="p">{}</span> + <span class="bp">self</span><span class="o">.</span><span class="n">xcom_push</span> <span class="o">=</span> <span class="n">xcom_push</span> + <span class="bp">self</span><span class="o">.</span><span class="n">resources</span> <span class="o">=</span> <span class="n">resources</span> <span class="ow">or</span> <span class="n">Resources</span><span class="p">()</span> + <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span> <span class="o">=</span> <span class="n">config_file</span></div> </pre></div> </div> - <div class="articleComments"> - - </div> + </div> <footer> @@ -313,7 +343,7 @@ </p> </div> - Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. </footer> @@ -332,6 +362,7 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../../', VERSION:'', + LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, @@ -344,19 +375,13 @@ - - - <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - + <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); + SphinxRtdTheme.Navigation.enable(true); }); - </script> - + </script> </body> </html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/mlengine_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/mlengine_operator.html b/_modules/airflow/contrib/operators/mlengine_operator.html index c7743c2..66bb281 100644 --- a/_modules/airflow/contrib/operators/mlengine_operator.html +++ b/_modules/airflow/contrib/operators/mlengine_operator.html @@ -24,26 +24,17 @@ - - - <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> - - - - - - <link rel="index" title="Index" - href="../../../../genindex.html"/> - <link rel="search" title="Search" href="../../../../search.html"/> - <link rel="top" title="Airflow Documentation" href="../../../../index.html"/> - <link rel="up" title="Module code" href="../../../index.html"/> + <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" role="document"> +<body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> @@ -116,7 +107,7 @@ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <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> @@ -124,9 +115,10 @@ </nav> - <div class="wy-nav-content"> + <div class="rst-content"> + @@ -156,8 +148,6 @@ <li class="wy-breadcrumbs-aside"> - - </li> </ul> @@ -264,11 +254,11 @@ <span class="sd"> for further documentation on the parameters.</span> <span class="sd"> :param project_id: The Google Cloud project name where the</span> -<span class="sd"> prediction job is submitted.</span> +<span class="sd"> prediction job is submitted. (templated)</span> <span class="sd"> :type project_id: string</span> <span class="sd"> :param job_id: A unique id for the prediction job on Google Cloud</span> -<span class="sd"> ML Engine.</span> +<span class="sd"> ML Engine. (templated)</span> <span class="sd"> :type job_id: string</span> <span class="sd"> :param data_format: The format of the input data.</span> @@ -277,32 +267,32 @@ <span class="sd"> :type data_format: string</span> <span class="sd"> :param input_paths: A list of GCS paths of input data for batch</span> -<span class="sd"> prediction. Accepting wildcard operator *, but only at the end.</span> +<span class="sd"> prediction. Accepting wildcard operator *, but only at the end. (templated)</span> <span class="sd"> :type input_paths: list of string</span> <span class="sd"> :param output_path: The GCS path where the prediction results are</span> -<span class="sd"> written to.</span> +<span class="sd"> written to. (templated)</span> <span class="sd"> :type output_path: string</span> <span class="sd"> :param region: The Google Compute Engine region to run the</span> -<span class="sd"> prediction job in.:</span> +<span class="sd"> prediction job in. (templated)</span> <span class="sd"> :type region: string</span> <span class="sd"> :param model_name: The Google Cloud ML Engine model to use for prediction.</span> <span class="sd"> If version_name is not provided, the default version of this</span> <span class="sd"> model will be used.</span> <span class="sd"> Should not be None if version_name is provided.</span> -<span class="sd"> Should be None if uri is provided.</span> +<span class="sd"> Should be None if uri is provided. (templated)</span> <span class="sd"> :type model_name: string</span> <span class="sd"> :param version_name: The Google Cloud ML Engine model version to use for</span> <span class="sd"> prediction.</span> -<span class="sd"> Should be None if uri is provided.</span> +<span class="sd"> Should be None if uri is provided. (templated)</span> <span class="sd"> :type version_name: string</span> <span class="sd"> :param uri: The GCS path of the saved model to use for prediction.</span> <span class="sd"> Should be None if model_name is provided.</span> -<span class="sd"> It should be a GCS path pointing to a tensorflow SavedModel.</span> +<span class="sd"> It should be a GCS path pointing to a tensorflow SavedModel. (templated)</span> <span class="sd"> :type uri: string</span> <span class="sd"> :param max_worker_count: The maximum number of workers to be used</span> @@ -451,7 +441,7 @@ <span class="sd"> Operator for managing a Google Cloud ML Engine model.</span> <span class="sd"> :param project_id: The Google Cloud project name to which MLEngine</span> -<span class="sd"> model belongs.</span> +<span class="sd"> model belongs. (templated)</span> <span class="sd"> :type project_id: string</span> <span class="sd"> :param model: A dictionary containing the information about the model.</span> @@ -516,13 +506,13 @@ <span class="sd"> :type project_id: string</span> <span class="sd"> :param model_name: The name of the Google Cloud ML Engine model that the version</span> -<span class="sd"> belongs to.</span> +<span class="sd"> belongs to. (templated)</span> <span class="sd"> :type model_name: string</span> -<span class="sd"> :param version_name: A name to use for the version being operated upon. If</span> -<span class="sd"> not None and the `version` argument is None or does not have a value for</span> +<span class="sd"> :param version_name: A name to use for the version being operated upon.</span> +<span class="sd"> If not None and the `version` argument is None or does not have a value for</span> <span class="sd"> the `name` key, then this will be populated in the payload for the</span> -<span class="sd"> `name` key.</span> +<span class="sd"> `name` key. (templated)</span> <span class="sd"> :type version_name: string</span> <span class="sd"> :param version: A dictionary containing the information about the version.</span> @@ -530,7 +520,7 @@ <span class="sd"> information about this version such as name, and deploymentUrl.</span> <span class="sd"> If the `operation` is `get` or `delete`, the `version` parameter</span> <span class="sd"> should contain the `name` of the version.</span> -<span class="sd"> If it is None, the only `operation` possible would be `list`.</span> +<span class="sd"> If it is None, the only `operation` possible would be `list`. (templated)</span> <span class="sd"> :type version: dict</span> <span class="sd"> :param operation: The operation to perform. Available operations are:</span> @@ -618,41 +608,42 @@ <span class="sd"> Operator for launching a MLEngine training job.</span> <span class="sd"> :param project_id: The Google Cloud project name within which MLEngine</span> -<span class="sd"> training job should run. This field could be templated.</span> +<span class="sd"> training job should run (templated).</span> <span class="sd"> :type project_id: string</span> <span class="sd"> :param job_id: A unique templated id for the submitted Google MLEngine</span> -<span class="sd"> training job.</span> +<span class="sd"> training job. (templated)</span> <span class="sd"> :type job_id: string</span> <span class="sd"> :param package_uris: A list of package locations for MLEngine training job,</span> <span class="sd"> which should include the main training program + any additional</span> -<span class="sd"> dependencies.</span> +<span class="sd"> dependencies. (templated)</span> <span class="sd"> :type package_uris: string</span> <span class="sd"> :param training_python_module: The Python module name to run within MLEngine</span> -<span class="sd"> training job after installing 'package_uris' packages.</span> +<span class="sd"> training job after installing 'package_uris' packages. (templated)</span> <span class="sd"> :type training_python_module: string</span> <span class="sd"> :param training_args: A list of templated command line arguments to pass to</span> -<span class="sd"> the MLEngine training program.</span> +<span class="sd"> the MLEngine training program. (templated)</span> <span class="sd"> :type training_args: string</span> <span class="sd"> :param region: The Google Compute Engine region to run the MLEngine training</span> -<span class="sd"> job in. This field could be templated.</span> +<span class="sd"> job in (templated).</span> <span class="sd"> :type region: string</span> -<span class="sd"> :param scale_tier: Resource tier for MLEngine training job.</span> +<span class="sd"> :param scale_tier: Resource tier for MLEngine training job. (templated)</span> <span class="sd"> :type scale_tier: string</span> -<span class="sd"> :param runtime_version: The Google Cloud ML runtime version to use for training.</span> +<span class="sd"> :param runtime_version: The Google Cloud ML runtime version to use for</span> +<span class="sd"> training. (templated)</span> <span class="sd"> :type runtime_version: string</span> -<span class="sd"> :param python_version: The version of Python used in training.</span> +<span class="sd"> :param python_version: The version of Python used in training. (templated)</span> <span class="sd"> :type python_version: string</span> <span class="sd"> :param job_dir: A Google Cloud Storage path in which to store training</span> -<span class="sd"> outputs and other data needed for training.</span> +<span class="sd"> outputs and other data needed for training. (templated)</span> <span class="sd"> :type job_dir: string</span> <span class="sd"> :param gcp_conn_id: The connection ID to use when fetching connection info.</span> @@ -782,9 +773,7 @@ </pre></div> </div> - <div class="articleComments"> - - </div> + </div> <footer> @@ -796,7 +785,7 @@ </p> </div> - Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. </footer> @@ -815,6 +804,7 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../../', VERSION:'', + LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, @@ -827,19 +817,13 @@ - - - <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - + <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); + SphinxRtdTheme.Navigation.enable(true); }); - </script> - + </script> </body> </html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/mongo_to_s3.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/mongo_to_s3.html b/_modules/airflow/contrib/operators/mongo_to_s3.html new file mode 100644 index 0000000..b57b2f8 --- /dev/null +++ b/_modules/airflow/contrib/operators/mongo_to_s3.html @@ -0,0 +1,337 @@ + + +<!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.mongo_to_s3 — 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.mongo_to_s3</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.mongo_to_s3</h1><div class="highlight"><pre> +<span></span><span class="c1"># -*- coding: utf-8 -*-</span> +<span class="c1">#</span> +<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span> +<span class="c1"># you may not use this file except in compliance with the License.</span> +<span class="c1"># 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, software</span> +<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> +<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +<span class="c1"># See the License for the specific language governing permissions and</span> +<span class="c1"># limitations under the License.</span> +<span class="kn">import</span> <span class="nn">json</span> + +<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.mongo_hook</span> <span class="k">import</span> <span class="n">MongoHook</span> +<span class="kn">from</span> <span class="nn">airflow.hooks.S3_hook</span> <span class="k">import</span> <span class="n">S3Hook</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">bson</span> <span class="k">import</span> <span class="n">json_util</span> + + +<div class="viewcode-block" id="MongoToS3Operator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.mongo_to_s3.MongoToS3Operator">[docs]</a><span class="k">class</span> <span class="nc">MongoToS3Operator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Mongo -> S3</span> +<span class="sd"> A more specific baseOperator meant to move data</span> +<span class="sd"> from mongo via pymongo to s3 via boto</span> + +<span class="sd"> things to note</span> +<span class="sd"> .execute() is written to depend on .transform()</span> +<span class="sd"> .transform() is meant to be extended by child classes</span> +<span class="sd"> to perform transformations unique to those operators needs</span> +<span class="sd"> """</span> + + <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'s3_key'</span><span class="p">,</span> <span class="s1">'mongo_query'</span><span class="p">]</span> + <span class="c1"># pylint: disable=too-many-instance-attributes</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">mongo_conn_id</span><span class="p">,</span> + <span class="n">s3_conn_id</span><span class="p">,</span> + <span class="n">mongo_collection</span><span class="p">,</span> + <span class="n">mongo_query</span><span class="p">,</span> + <span class="n">s3_bucket</span><span class="p">,</span> + <span class="n">s3_key</span><span class="p">,</span> + <span class="n">mongo_db</span><span class="o">=</span><span class="kc">None</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">MongoToS3Operator</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="c1"># Conn Ids</span> + <span class="bp">self</span><span class="o">.</span><span class="n">mongo_conn_id</span> <span class="o">=</span> <span class="n">mongo_conn_id</span> + <span class="bp">self</span><span class="o">.</span><span class="n">s3_conn_id</span> <span class="o">=</span> <span class="n">s3_conn_id</span> + <span class="c1"># Mongo Query Settings</span> + <span class="bp">self</span><span class="o">.</span><span class="n">mongo_db</span> <span class="o">=</span> <span class="n">mongo_db</span> + <span class="bp">self</span><span class="o">.</span><span class="n">mongo_collection</span> <span class="o">=</span> <span class="n">mongo_collection</span> + <span class="c1"># Grab query and determine if we need to run an aggregate pipeline</span> + <span class="bp">self</span><span class="o">.</span><span class="n">mongo_query</span> <span class="o">=</span> <span class="n">mongo_query</span> + <span class="bp">self</span><span class="o">.</span><span class="n">is_pipeline</span> <span class="o">=</span> <span class="kc">True</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span> + <span class="bp">self</span><span class="o">.</span><span class="n">mongo_query</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span> <span class="k">else</span> <span class="kc">False</span> + + <span class="c1"># S3 Settings</span> + <span class="bp">self</span><span class="o">.</span><span class="n">s3_bucket</span> <span class="o">=</span> <span class="n">s3_bucket</span> + <span class="bp">self</span><span class="o">.</span><span class="n">s3_key</span> <span class="o">=</span> <span class="n">s3_key</span> + + <span class="c1"># KWARGS</span> + <span class="bp">self</span><span class="o">.</span><span class="n">replace</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'replace'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> + +<div class="viewcode-block" id="MongoToS3Operator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.mongo_to_s3.MongoToS3Operator.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="sd">"""</span> +<span class="sd"> Executed by task_instance at runtime</span> +<span class="sd"> """</span> + <span class="n">s3_conn</span> <span class="o">=</span> <span class="n">S3Hook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">s3_conn_id</span><span class="p">)</span> + + <span class="c1"># Grab collection and execute query according to whether or not it is a pipeline</span> + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_pipeline</span><span class="p">:</span> + <span class="n">results</span> <span class="o">=</span> <span class="n">MongoHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_conn_id</span><span class="p">)</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span> + <span class="n">mongo_collection</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_collection</span><span class="p">,</span> + <span class="n">aggregate_query</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_query</span><span class="p">,</span> + <span class="n">mongo_db</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_db</span> + <span class="p">)</span> + + <span class="k">else</span><span class="p">:</span> + <span class="n">results</span> <span class="o">=</span> <span class="n">MongoHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_conn_id</span><span class="p">)</span><span class="o">.</span><span class="n">find</span><span class="p">(</span> + <span class="n">mongo_collection</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_collection</span><span class="p">,</span> + <span class="n">query</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_query</span><span class="p">,</span> + <span class="n">mongo_db</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_db</span> + <span class="p">)</span> + + <span class="c1"># Performs transform then stringifies the docs results into json format</span> + <span class="n">docs_str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stringify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">results</span><span class="p">))</span> + + <span class="c1"># Load Into S3</span> + <span class="n">s3_conn</span><span class="o">.</span><span class="n">load_string</span><span class="p">(</span> + <span class="n">string_data</span><span class="o">=</span><span class="n">docs_str</span><span class="p">,</span> + <span class="n">key</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">s3_key</span><span class="p">,</span> + <span class="n">bucket_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">s3_bucket</span><span class="p">,</span> + <span class="n">replace</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">replace</span> + <span class="p">)</span> + + <span class="k">return</span> <span class="kc">True</span></div> + + <span class="k">def</span> <span class="nf">_stringify</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">iterable</span><span class="p">,</span> <span class="n">joinable</span><span class="o">=</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Takes an iterable (pymongo Cursor or Array) containing dictionaries and</span> +<span class="sd"> returns a stringified version using python join</span> +<span class="sd"> """</span> + <span class="k">return</span> <span class="n">joinable</span><span class="o">.</span><span class="n">join</span><span class="p">(</span> + <span class="p">[</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">json_util</span><span class="o">.</span><span class="n">default</span><span class="p">)</span> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">iterable</span><span class="p">]</span> + <span class="p">)</span> + +<div class="viewcode-block" id="MongoToS3Operator.transform"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.mongo_to_s3.MongoToS3Operator.transform">[docs]</a> <span class="k">def</span> <span class="nf">transform</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">docs</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Processes pyMongo cursor and returns an iterable with each element being</span> +<span class="sd"> a JSON serializable dictionary</span> + +<span class="sd"> Base transform() assumes no processing is needed</span> +<span class="sd"> ie. docs is a pyMongo cursor of documents and cursor just</span> +<span class="sd"> needs to be passed through</span> + +<span class="sd"> Override this method for custom transformations</span> +<span class="sd"> """</span> + <span class="k">return</span> <span class="n">docs</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>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../../../', + VERSION:'', + LANGUAGE:'None', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../../_static/doctools.js"></script> + + + + <script type="text/javascript" src="../../../../_static/js/theme.js"></script> + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/mysql_to_gcs.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/mysql_to_gcs.html b/_modules/airflow/contrib/operators/mysql_to_gcs.html index 47346f5..8c8e80e 100644 --- a/_modules/airflow/contrib/operators/mysql_to_gcs.html +++ b/_modules/airflow/contrib/operators/mysql_to_gcs.html @@ -24,26 +24,17 @@ - - - <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> - - - - - - <link rel="index" title="Index" - href="../../../../genindex.html"/> - <link rel="search" title="Search" href="../../../../search.html"/> - <link rel="top" title="Airflow Documentation" href="../../../../index.html"/> - <link rel="up" title="Module code" href="../../../index.html"/> + <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" role="document"> +<body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> @@ -116,7 +107,7 @@ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <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> @@ -124,9 +115,10 @@ </nav> - <div class="wy-nav-content"> + <div class="rst-content"> + @@ -156,8 +148,6 @@ <li class="wy-breadcrumbs-aside"> - - </li> </ul> @@ -404,7 +394,7 @@ <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">col_val</span><span class="p">,</span> <span class="n">Decimal</span><span class="p">):</span> <span class="n">col_val</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">col_val</span><span class="p">)</span> <span class="k">elif</span> <span class="n">col_type_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">col_name</span><span class="p">)</span> <span class="o">==</span> <span class="s2">"BYTES"</span><span class="p">:</span> - <span class="n">col_val</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">urlsafe_b64encode</span><span class="p">(</span><span class="n">col_val</span><span class="p">)</span> + <span class="n">col_val</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">standard_b64encode</span><span class="p">(</span><span class="n">col_val</span><span class="p">)</span> <span class="k">if</span> <span class="n">PY3</span><span class="p">:</span> <span class="n">col_val</span> <span class="o">=</span> <span class="n">col_val</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'ascii'</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> @@ -450,7 +440,6 @@ <span class="n">FIELD_TYPE</span><span class="o">.</span><span class="n">NEWDECIMAL</span><span class="p">:</span> <span class="s1">'FLOAT'</span><span class="p">,</span> <span class="n">FIELD_TYPE</span><span class="o">.</span><span class="n">DOUBLE</span><span class="p">:</span> <span class="s1">'FLOAT'</span><span class="p">,</span> <span class="n">FIELD_TYPE</span><span class="o">.</span><span class="n">FLOAT</span><span class="p">:</span> <span class="s1">'FLOAT'</span><span class="p">,</span> - <span class="n">FIELD_TYPE</span><span class="o">.</span><span class="n">INT24</span><span class="p">:</span> <span class="s1">'INTEGER'</span><span class="p">,</span> <span class="n">FIELD_TYPE</span><span class="o">.</span><span class="n">LONG</span><span class="p">:</span> <span class="s1">'INTEGER'</span><span class="p">,</span> <span class="n">FIELD_TYPE</span><span class="o">.</span><span class="n">LONGLONG</span><span class="p">:</span> <span class="s1">'INTEGER'</span><span class="p">,</span> <span class="n">FIELD_TYPE</span><span class="o">.</span><span class="n">SHORT</span><span class="p">:</span> <span class="s1">'INTEGER'</span><span class="p">,</span> @@ -461,9 +450,7 @@ </pre></div> </div> - <div class="articleComments"> - - </div> + </div> <footer> @@ -475,7 +462,7 @@ </p> </div> - Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. </footer> @@ -494,6 +481,7 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../../', VERSION:'', + LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, @@ -506,19 +494,13 @@ - - - <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - + <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); + SphinxRtdTheme.Navigation.enable(true); }); - </script> - + </script> </body> </html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/postgres_to_gcs_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/postgres_to_gcs_operator.html b/_modules/airflow/contrib/operators/postgres_to_gcs_operator.html index 10c7d8f..4f75bad 100644 --- a/_modules/airflow/contrib/operators/postgres_to_gcs_operator.html +++ b/_modules/airflow/contrib/operators/postgres_to_gcs_operator.html @@ -24,26 +24,17 @@ - - - <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> - - - - - - <link rel="index" title="Index" - href="../../../../genindex.html"/> - <link rel="search" title="Search" href="../../../../search.html"/> - <link rel="top" title="Airflow Documentation" href="../../../../index.html"/> - <link rel="up" title="Module code" href="../../../index.html"/> + <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" role="document"> +<body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> @@ -116,7 +107,7 @@ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <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> @@ -124,9 +115,10 @@ </nav> - <div class="wy-nav-content"> + <div class="rst-content"> + @@ -156,8 +148,6 @@ <li class="wy-breadcrumbs-aside"> - - </li> </ul> @@ -178,9 +168,9 @@ <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">#</span> <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> -<span class="c1"># </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> @@ -418,9 +408,7 @@ </pre></div> </div> - <div class="articleComments"> - - </div> + </div> <footer> @@ -432,7 +420,7 @@ </p> </div> - Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. </footer> @@ -451,6 +439,7 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../../', VERSION:'', + LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, @@ -463,19 +452,13 @@ - - - <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - + <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); + SphinxRtdTheme.Navigation.enable(true); }); - </script> - + </script> </body> </html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/pubsub_operator.html ---------------------------------------------------------------------- diff --git a/_modules/airflow/contrib/operators/pubsub_operator.html b/_modules/airflow/contrib/operators/pubsub_operator.html index 99a540f..44fa17e 100644 --- a/_modules/airflow/contrib/operators/pubsub_operator.html +++ b/_modules/airflow/contrib/operators/pubsub_operator.html @@ -24,26 +24,17 @@ - - - <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> - - - - - - <link rel="index" title="Index" - href="../../../../genindex.html"/> - <link rel="search" title="Search" href="../../../../search.html"/> - <link rel="top" title="Airflow Documentation" href="../../../../index.html"/> - <link rel="up" title="Module code" href="../../../index.html"/> + <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" role="document"> +<body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> @@ -116,7 +107,7 @@ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <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> @@ -124,9 +115,10 @@ </nav> - <div class="wy-nav-content"> + <div class="rst-content"> + @@ -156,8 +148,6 @@ <li class="wy-breadcrumbs-aside"> - - </li> </ul> @@ -178,9 +168,9 @@ <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">#</span> <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> -<span class="c1"># </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> @@ -579,9 +569,8 @@ <span class="sd"> * 'data': a base64-encoded string</span> <span class="sd"> * 'attributes': {'key1': 'value1', ...}</span> <span class="sd"> Each message must contain at least a non-empty 'data' value</span> -<span class="sd"> or an attribute dict with at least one key. See</span> +<span class="sd"> or an attribute dict with at least one key (templated). See</span> <span class="sd"> https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage</span> -<span class="sd"> (templated)</span> <span class="sd"> :type messages: list</span> <span class="sd"> :param gcp_conn_id: The connection ID to use connecting to</span> <span class="sd"> Google Cloud Platform.</span> @@ -606,9 +595,7 @@ </pre></div> </div> - <div class="articleComments"> - - </div> + </div> <footer> @@ -620,7 +607,7 @@ </p> </div> - Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. </footer> @@ -639,6 +626,7 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../../', VERSION:'', + LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, @@ -651,19 +639,13 @@ - - - <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - + <script type="text/javascript" src="../../../../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); + SphinxRtdTheme.Navigation.enable(true); }); - </script> - + </script> </body> </html> \ No newline at end of file
