OpenSearch Client and Index Abstractions

v20260825

webiny-api-opensearch-catalog

This module provides a comprehensive set of 10 key abstractions for interacting with OpenSearch. It includes structured components for client initialization, field definition, index management, and advanced query building operators. It serves as a foundational API layer, ensuring developers can integrate with OpenSearch in a standardized and reliable manner.

OpenSearch API Client Indexing Querying Abstraction Search

Get Skill

184 downloads

Overview

api/opensearch

How to Use

Find the abstraction you need below
You MUST read the source file to get the exact interface and types!
Import: import { Name } from "<importPath>";
See webiny-use-case-pattern or webiny-event-handler-pattern skills for implementation patterns

Abstractions

Name: createOpenSearchClient Import: import { createOpenSearchClient } from "webiny/api/opensearch" Source: @webiny/api-opensearch/client.ts

Name: OpenSearchClient Import: import { OpenSearchClient } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchClient/abstraction.ts

Name: OpenSearchClientFactory Import: import { OpenSearchClientFactory } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchClientFactory/abstraction.ts

Name: OpenSearchField Import: import { OpenSearchField } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchField/abstractions/OpenSearchField.ts

Name: OpenSearchFieldAll Import: import { OpenSearchFieldAll } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchField/abstractions/OpenSearchField.ts

Name: OpenSearchFieldFactory Import: import { OpenSearchFieldFactory } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchField/abstractions/OpenSearchFieldFactory.ts

Name: OpenSearchIndex Import: import { OpenSearchIndex } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchIndex/abstractions/OpenSearchIndex.ts

Name: OpenSearchIndexRegistry Import: import { OpenSearchIndexRegistry } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchIndex/abstractions/OpenSearchIndexRegistry.ts

Name: OpenSearchQueryBuilderOperator Import: import { OpenSearchQueryBuilderOperator } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchQueryBuilderOperator/abstractions/OpenSearchQueryBuilderOperator.ts

Name: OpenSearchQueryBuilderOperatorRegistry Import: import { OpenSearchQueryBuilderOperatorRegistry } from "webiny/api/opensearch" Source: @webiny/api-opensearch/features/OpenSearchQueryBuilderOperator/abstractions/OpenSearchQueryBuilderOperatorRegistry.ts

Info

Category Development

Name webiny-api-opensearch-catalog

Version v20260825

Size 2.49KB

Source webiny/webiny-js

Updated At 2026-09-06