Develop Your Own Connector

If you want to develop your own connector for the new SeaTunnel connector API (Connector V2), please check here.

Start Here

If you are building a new connector, use this page as the index and then branch to the relevant implementation guide:

• Source Connector Development for source-side design and implementation flow
• Sink Connector Development for sink-side commit and recovery design
• Plugin Discovery and Class Loading for packaging, SPI, and dependency isolation concerns
• Configuration And Option System for stable user-facing options
• CDC Pipeline Architecture if the connector participates in CDC-style pipelines

Architecture Reference

For detailed information on SeaTunnel's API design and engine architecture, see:

• Architecture Overview - Overall architecture and design principles
• Source Architecture - Deep dive into Source API design
• Sink Architecture - Deep dive into Sink API design
• Translation Layer - How connectors work across different engines
• Checkpoint Mechanism - Fault tolerance and state management

These documents will help you understand the underlying architecture and design patterns used in SeaTunnel connectors.