Source code for airflow.providers.cloudant.hooks.cloudant

#
# 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.
"""Hook for Cloudant."""

from __future__ import annotations

import sys
from typing import TYPE_CHECKING, Any

if sys.version_info < (3, 10):
    from airflow.providers.cloudant.cloudant_fake import CloudantV1, CouchDbSessionAuthenticator
else:
    from ibmcloudant import CloudantV1, CouchDbSessionAuthenticator

from airflow.exceptions import AirflowException
from airflow.hooks.base import BaseHook

if TYPE_CHECKING:
    from airflow.models import Connection


[docs]class CloudantHook(BaseHook): """ Interact with Cloudant. This class is a thin wrapper around the cloudant python library. .. seealso:: the latest documentation `here <https://python-cloudant.readthedocs.io/en/latest/>`_. :param cloudant_conn_id: The connection id to authenticate and get a session object from cloudant. """
[docs] conn_name_attr = "cloudant_conn_id"
[docs] default_conn_name = "cloudant_default"
[docs] conn_type = "cloudant"
[docs] hook_name = "Cloudant"
@classmethod
[docs] def get_ui_field_behaviour(cls) -> dict[str, Any]: """Return custom field behaviour.""" return { "hidden_fields": ["schema", "port", "extra"], "relabeling": {"host": "Account", "login": "Username (or API Key)"}, }
def __init__(self, cloudant_conn_id: str = default_conn_name) -> None: super().__init__() self.cloudant_conn_id = cloudant_conn_id
[docs] def get_conn(self) -> CloudantV1: """ Create an authenticated service object for connection to the Cloudant service. .. note:: In the connection form: - 'host' equals the 'Account' (required) - 'login' equals the 'Username (or API Key)' (required) - 'password' equals the 'Password' (required) :return: a CloudantV1 service object backed by a session-based user/password authenticator. """ conn = self.get_connection(self.cloudant_conn_id) self._validate_connection(conn) authenticator = CouchDbSessionAuthenticator(username=conn.login, password=conn.password) service = CloudantV1(authenticator=authenticator) service.set_service_url(f"https://{conn.host}.cloudant.com") return service
@staticmethod def _validate_connection(conn: Connection) -> None: missing_params = [] for conn_param in ["host", "login", "password"]: if not getattr(conn, conn_param): missing_params.append(conn_param) if missing_params: raise AirflowException( f"Missing connection parameter{'s' if len(missing_params) > 1 else ''}: {', '.join(missing_params)}" )

Was this entry helpful?