airflow.providers.opensearch.hooks.opensearch¶

类¶

`OpenSearchClientArguments`	OpenSearch 客户端的类型化参数。
`OpenSearchHook`	为 OpenSearch 客户端提供一个薄包装器。

模块内容¶

class airflow.providers.opensearch.hooks.opensearch.OpenSearchClientArguments[source]¶

基类: TypedDict

OpenSearch 客户端的类型化参数。

hosts: str | list[dict] | None[source]¶

use_ssl: bool[source]¶

verify_certs: bool[source]¶

connection_class: type[opensearchpy.Connection] | None[source]¶

http_auth: tuple[str, str][source]¶

class airflow.providers.opensearch.hooks.opensearch.OpenSearchHook(open_search_conn_id, log_query, open_search_conn_class=RequestsHttpConnection, **kwargs)[source]¶

基类: airflow.hooks.base.BaseHook

为 OpenSearch 客户端提供一个薄包装器。

参数:

open_search_conn_id (str) – 用于 OpenSearch 的连接
log_query (bool) – 是否记录用于 OpenSearch 的查询

conn_name_attr = 'opensearch_conn_id'[source]¶

default_conn_name = 'opensearch_default'[source]¶

conn_type = 'opensearch'[source]¶

hook_name = 'OpenSearch Hook'[source]¶

conn_id[source]¶

log_query[source]¶

use_ssl = False[source]¶

verify_certs = False[source]¶

connection_class[source]¶

property conn[source]¶

property client: opensearchpy.OpenSearch[source]¶

此函数旨在用于转发高级客户端对象的 Operators。

search(query, index_name, **kwargs)[source]¶

对已连接的 OpenSearch 集群运行搜索查询。

参数:

query (dict) – 用于对 OpenSearch 进行搜索的查询。
index_name (str) – 要搜索的索引名称

index(document, index_name, doc_id, **kwargs)[source]¶

在 OpenSearch 上索引一个文档。

参数:

document (dict) – 文档的字典表示
index_name (str) – 与此文档关联的索引名称
doc_id (int) – 将用于标识索引上文档的数字标识符。

delete(index_name, query=None, doc_id=None)[source]¶

通过查询或文档 id 从索引中删除。

参数:

index_name (str) – 要从中删除的索引名称
query (dict | None) – 如果通过查询删除，则为用于标识要删除文档的查询的字典表示。
doc_id (int | None) – 要删除文档的标识符。

classmethod get_ui_field_behaviour()[source]¶

返回 OpenSearch 连接的自定义 UI 字段行为。