Source code for airflow.providers.apache.pig.operators.pig

#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

import re
from collections.abc import Sequence
from typing import TYPE_CHECKING, Any

from airflow.models import BaseOperator
from airflow.providers.apache.pig.hooks.pig import PigCliHook

if TYPE_CHECKING:
    from airflow.utils.context import Context


[docs]class PigOperator(BaseOperator):
    """
    Executes pig script.

    :param pig: the pig latin script to be executed. (templated)
    :param pig_cli_conn_id: reference to the Hive database
    :param pigparams_jinja_translate: when True, pig params-type templating
        ${var} gets translated into jinja-type templating {{ var }}. Note that
        you may want to use this along with the
        ``DAG(user_defined_macros=myargs)`` parameter. View the DAG
        object documentation for more details.
    :param pig_opts: pig options, such as: -x tez, -useHCatalog, ... - space separated list
    :param pig_properties: pig properties, additional pig properties passed as list
    """

[docs]    template_fields: Sequence[str] = ("pig", "pig_opts", "pig_properties")
[docs]    template_ext: Sequence[str] = (
        ".pig",
        ".piglatin",
    )
[docs]    ui_color = "#f0e4ec"

    def __init__(
        self,
        *,
        pig: str,
        pig_cli_conn_id: str = "pig_cli_default",
        pigparams_jinja_translate: bool = False,
        pig_opts: str | None = None,
        pig_properties: list[str] | None = None,
        **kwargs: Any,
    ) -> None:
        super().__init__(**kwargs)
        self.pigparams_jinja_translate = pigparams_jinja_translate
        self.pig = pig
        self.pig_cli_conn_id = pig_cli_conn_id
        self.pig_opts = pig_opts
        self.pig_properties = pig_properties
        self.hook: PigCliHook | None = None

[docs]    def prepare_template(self):
        if self.pigparams_jinja_translate:
            self.pig = re.sub(r"(\$([a-zA-Z_][a-zA-Z0-9_]*))", r"{{ \g<2> }}", self.pig)

[docs]    def execute(self, context: Context):
        self.log.info("Executing: %s", self.pig)
        self.hook = PigCliHook(pig_cli_conn_id=self.pig_cli_conn_id, pig_properties=self.pig_properties)
        self.hook.run_cli(pig=self.pig, pig_opts=self.pig_opts)

[docs]    def on_kill(self):
        self.hook.kill()