Skip to content

Document Elasticsearch/OpenSearch sink support and setup #987

@kwannoel

Description

@kwannoel

Context

Slack thread: https://slack.com/archives/C0AE8A81LE6/p1771087120973229

A user pinged directly in Slack, which suggests they could not find self-serve documentation for this connector workflow.

Problem

RisingWave appears to support Elasticsearch/OpenSearch sink integration in code, but there is no clear, user-facing documentation page that explains how to use it end to end.

Without a dedicated guide, users have to ask in Slack for basic usage and compatibility details, which increases support load and slows adoption.

Suggested Fix

Create a dedicated docs page for Elasticsearch/OpenSearch sink usage, and link it from the connector/navigation entry points.

Include:

  • Supported engines/versions (Elasticsearch vs OpenSearch) and any compatibility notes.
  • Required connector options and optional tuning parameters.
  • A complete SQL example for creating a sink.
  • Data type mapping and null/JSON behavior notes where relevant.
  • Error handling/troubleshooting tips (common auth, endpoint, and schema mismatch issues).

Also add cross-links from related sink/connector docs so the page is discoverable via navigation and search.

Existing Documentation
Codebase References

Related PRs in risingwave:

Source files:

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions