airflow.providers.opensearch.operators.opensearch

类

OpenSearchQueryOperator

在 OpenSearch 集群上对给定索引运行查询搜索并返回结果。

OpenSearchCreateIndexOperator

在 OpenSearch 集群上创建具有给定索引名称的新索引。

OpenSearchAddDocumentOperator

向给定索引添加新文档或覆盖现有文档。

模块内容

class airflow.providers.opensearch.operators.opensearch.OpenSearchQueryOperator(*, query=None, search_object=None, index_name=None, opensearch_conn_id='opensearch_default', opensearch_conn_class=RequestsHttpConnection, log_query=True, **kwargs)[source]

Bases: airflow.models.BaseOperator

在 OpenSearch 集群上对给定索引运行查询搜索并返回结果。

另请参阅

有关如何使用此 Operator 的更多信息，请查阅指南：在 OpenSearch 索引上运行查询

参数:

  • query (dict | None) – 一个字典形式的 OpenSearch DSL 查询。

  • search_object (Any | None) – 来自 opensearch-dsl 的 Search 对象。

  • index_name (str | None) – 用于搜索文档的索引名称。

  • opensearch_conn_id (str) – 要使用的 OpenSearch 连接

  • opensearch_conn_class (type[opensearchpy.Connection] | None) – 要使用的 OpenSearch 连接类

  • log_query (bool) – 是否记录使用的查询。默认为 True 并记录使用的查询。

template_fields: collections.abc.Sequence[str] = ['query'][source]
query = None[source]
index_name = None[source]
opensearch_conn_id = 'opensearch_default'[source]
opensearch_conn_class[source]
log_query = True[source]
search_object = None[source]
property hook: airflow.providers.opensearch.hooks.opensearch.OpenSearchHook[source]

获取 OpenSearchHook 的实例。

execute(context)[source]

在 OpenSearch 集群上对给定索引或 Search 对象执行搜索。

class airflow.providers.opensearch.operators.opensearch.OpenSearchCreateIndexOperator(*, index_name, index_body, opensearch_conn_id='opensearch_default', **kwargs)[source]

Bases: airflow.models.BaseOperator

在 OpenSearch 集群上创建具有给定索引名称的新索引。

另请参阅

有关如何使用此 Operator 的更多信息，请查阅指南：在 OpenSearch 中创建索引

参数:

  • index_name (str) – 要创建的索引名称。

  • index_body (dict[str, Any]) – 定义索引设置的字典

  • opensearch_conn_id (str) – 要使用的 OpenSearch 连接

index_name[source]
index_body[source]
opensearch_conn_id = 'opensearch_default'[source]
property hook: airflow.providers.opensearch.hooks.opensearch.OpenSearchHook[source]

获取 OpenSearchHook 的实例。

execute(context)[source]

在 OpenSearch 集群上创建一个索引。

class airflow.providers.opensearch.operators.opensearch.OpenSearchAddDocumentOperator(*, index_name=None, document=None, doc_id=None, doc_class=None, opensearch_conn_id='opensearch_default', **kwargs)[source]

Bases: airflow.models.BaseOperator

向给定索引添加新文档或覆盖现有文档。

另请参阅

有关如何使用此 Operator 的更多信息，请查阅指南：向 OpenSearch 中的索引添加文档

参数:

  • index_name (str | None) – 要放入文档的索引名称。

  • document (dict[str, Any] | None) – 文档的字典表示形式。

  • document_id – 文档在索引中的 ID。

  • doc_class (Any | None) – 使用 opensearch-dsl 的 Document 子类对象

  • opensearch_conn_id (str) – 要使用的 OpenSearch 连接

index_name = None[source]
document = None[source]
doc_id = None[source]
doc_class = None[source]
opensearch_conn_id = 'opensearch_default'[source]
property hook: airflow.providers.opensearch.hooks.opensearch.OpenSearchHook[source]

获取 OpenSearchHook 的实例。

execute(context)[source]

将文档保存到 OpenSearch 集群上的给定索引。

此条目有帮助吗？