Source code for airflow.providers.apache.hive.transfers.hive_to_samba

#
# 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.
"""This module contains an operator to move data from Hive to Samba."""

from __future__ import annotations

from collections.abc import Sequence
from tempfile import NamedTemporaryFile
from typing import TYPE_CHECKING

from airflow.models import BaseOperator
from airflow.providers.apache.hive.hooks.hive import HiveServer2Hook
from airflow.providers.samba.hooks.samba import SambaHook
from airflow.utils.operator_helpers import context_to_airflow_vars

if TYPE_CHECKING:
    from airflow.utils.context import Context



[docs]
class HiveToSambaOperator(BaseOperator):
    """
    Execute hql code in a specific Hive database and load the results as a csv to a Samba location.

    :param hql: the hql to be exported. (templated)
    :param destination_filepath: the file path to where the file will be pushed onto samba
    :param samba_conn_id: reference to the samba destination
    :param hiveserver2_conn_id: Reference to the
        :ref: `Hive Server2 thrift service connection id <howto/connection:hiveserver2>`.
    """


[docs]
    template_fields: Sequence[str] = ("hql", "destination_filepath")


[docs]
    template_ext: Sequence[str] = (
        ".hql",
        ".sql",
    )


[docs]
    template_fields_renderers = {"hql": "hql"}


    def __init__(
        self,
        *,
        hql: str,
        destination_filepath: str,
        samba_conn_id: str = "samba_default",
        hiveserver2_conn_id: str = "hiveserver2_default",
        **kwargs,
    ) -> None:
        super().__init__(**kwargs)

[docs]
        self.hiveserver2_conn_id = hiveserver2_conn_id


[docs]
        self.samba_conn_id = samba_conn_id


[docs]
        self.destination_filepath = destination_filepath


[docs]
        self.hql = hql



[docs]
    def execute(self, context: Context):
        self.hql = self.hql.strip().rstrip(";")
        with NamedTemporaryFile() as tmp_file:
            self.log.info("Fetching file from Hive")
            hive = HiveServer2Hook(hiveserver2_conn_id=self.hiveserver2_conn_id)
            hive.to_csv(self.hql, csv_filepath=tmp_file.name, hive_conf=context_to_airflow_vars(context))
            self.log.info("Pushing to samba")
            samba = SambaHook(samba_conn_id=self.samba_conn_id)
            samba.push_from_local(self.destination_filepath, tmp_file.name)