#
# 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
from functools import cached_property
from typing import TYPE_CHECKING, Any
from urllib import parse
from deprecated import deprecated
from elasticsearch import Elasticsearch
from airflow.exceptions import AirflowProviderDeprecationWarning
from airflow.hooks.base import BaseHook
from airflow.providers.common.sql.hooks.sql import DbApiHook
if TYPE_CHECKING:
from airflow.models.connection import Connection as AirflowConnection
[docs]def connect(
host: str = "localhost",
port: int = 9200,
user: str | None = None,
password: str | None = None,
scheme: str = "http",
**kwargs: Any,
) -> ESConnection:
return ESConnection(host, port, user, password, scheme, **kwargs)
[docs]class ESConnection:
"""wrapper class for elasticsearch.Elasticsearch."""
def __init__(
self,
host: str = "localhost",
port: int = 9200,
user: str | None = None,
password: str | None = None,
scheme: str = "http",
**kwargs: Any,
):
self.host = host
self.port = port
self.user = user
self.password = password
self.scheme = scheme
self.kwargs = kwargs
netloc = f"{host}:{port}"
self.url = parse.urlunparse((scheme, netloc, "/", None, None, None))
if user and password:
self.es = Elasticsearch(self.url, http_auth=(user, password), **self.kwargs)
else:
self.es = Elasticsearch(self.url, **self.kwargs)
[docs]class ElasticsearchSQLHook(DbApiHook):
"""
Interact with Elasticsearch through the elasticsearch-dbapi.
This hook uses the Elasticsearch conn_id.
:param elasticsearch_conn_id: The :ref:`ElasticSearch connection id <howto/connection:elasticsearch>`
used for Elasticsearch credentials.
"""
[docs] conn_name_attr = "elasticsearch_conn_id"
[docs] default_conn_name = "elasticsearch_default"
[docs] conn_type = "elasticsearch"
[docs] hook_name = "Elasticsearch"
def __init__(self, schema: str = "http", connection: AirflowConnection | None = None, *args, **kwargs):
super().__init__(*args, **kwargs)
self.schema = schema
self.connection = connection
[docs] def get_conn(self) -> ESConnection:
"""Return an elasticsearch connection object."""
conn_id = getattr(self, self.conn_name_attr)
conn = self.connection or self.get_connection(conn_id)
conn_args = {
"host": conn.host,
"port": conn.port,
"user": conn.login or None,
"password": conn.password or None,
"scheme": conn.schema or "http",
}
if conn.extra_dejson.get("http_compress", False):
conn_args["http_compress"] = bool(["http_compress"])
if conn.extra_dejson.get("timeout", False):
conn_args["timeout"] = conn.extra_dejson["timeout"]
return connect(**conn_args)
[docs] def get_uri(self) -> str:
conn_id = getattr(self, self.conn_name_attr)
conn = self.connection or self.get_connection(conn_id)
login = ""
if conn.login:
login = f"{conn.login}:{conn.password}@"
host = conn.host
if conn.port is not None:
host += f":{conn.port}"
uri = f"{conn.conn_type}+{conn.schema}://{login}{host}/"
extras_length = len(conn.extra_dejson)
if not extras_length:
return uri
uri += "?"
for arg_key, arg_value in conn.extra_dejson.items():
extras_length -= 1
uri += f"{arg_key}={arg_value}"
if extras_length:
uri += "&"
return uri
@deprecated(
reason="Please use `airflow.providers.elasticsearch.hooks.elasticsearch.ElasticsearchSQLHook`.",
category=AirflowProviderDeprecationWarning,
)
[docs]class ElasticsearchHook(ElasticsearchSQLHook):
"""
This class is deprecated and was renamed to ElasticsearchSQLHook.
Please use :class:`airflow.providers.elasticsearch.hooks.elasticsearch.ElasticsearchSQLHook`.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
[docs]class ElasticsearchPythonHook(BaseHook):
"""
Interacts with Elasticsearch. This hook uses the official Elasticsearch Python Client.
:param hosts: list: A list of a single or many Elasticsearch instances. Example: ["http://localhost:9200"]
:param es_conn_args: dict: Additional arguments you might need to enter to connect to Elasticsearch.
Example: {"ca_cert":"/path/to/cert", "basic_auth": "(user, pass)"}
"""
def __init__(self, hosts: list[Any], es_conn_args: dict | None = None):
super().__init__()
self.hosts = hosts
self.es_conn_args = es_conn_args or {}
def _get_elastic_connection(self):
"""Return the Elasticsearch client."""
client = Elasticsearch(self.hosts, **self.es_conn_args)
return client
@cached_property
[docs] def get_conn(self):
"""Return the Elasticsearch client (cached)."""
return self._get_elastic_connection()
[docs] def search(self, query: dict[Any, Any], index: str = "_all") -> dict:
"""
Return results matching a query using Elasticsearch DSL.
:param index: str: The index you want to query
:param query: dict: The query you want to run
:returns: dict: The response 'hits' object from Elasticsearch
"""
es_client = self.get_conn
result = es_client.search(index=index, body=query)
return result["hits"]