Socket

Socket sink connector

Support Those Engines

Spark
Flink
SeaTunnel Zeta

Key features

• exactly-once

Description

Used to send data to Socket Server. Both support streaming and batch mode.

For example, if the data from upstream is [age: 12, name: jared], the content send to socket server is the following: {"name":"jared","age":17}

Sink Options

Name	Type	Required	Default	Description
host	String	Yes		socket server host
port	Integer	Yes		socket server port
max_retries	Integer	No	3	The number of retries to send record failed
common-options		No	-	Source plugin common parameters, please refer to Source Common Options for details

Task Example

This is randomly generated data written to the Socket side

env {
  parallelism = 1
  job.mode = "STREAMING"
}

source {
  FakeSource {
    plugin_output = "fake"
    schema = {
      fields {
        name = "string"
        age = "int"
      }
    }
  }
}

sink {
  Socket {
    host = "localhost"
    port = 9999
  }
}

• Start a port listening

nc -l -v 9999

• Start a SeaTunnel task

• Socket Server Console print data

{"name":"jared","age":17}

Changelog

Change Log

Change	Commit	Version
[Feature][Restapi] Allow metrics information to be associated to logical plan nodes (#7786)	https://github.com/apache/seatunnel/commit/6b7c53d03	2.3.9
[Improve] Remove use SeaTunnelSink::getConsumedType method and mark it as deprecated (#5755)	https://github.com/apache/seatunnel/commit/8de740810	2.3.4
[Improve][build] Give the maven module a human readable name (#4114)	https://github.com/apache/seatunnel/commit/d7cd60105	2.3.1
[Improve][Project] Code format with spotless plugin. (#4101)	https://github.com/apache/seatunnel/commit/a2ab16656	2.3.1
[Feature][Connector] add get source method to all source connector (#3846)	https://github.com/apache/seatunnel/commit/417178fb8	2.3.1
[Hotfix][OptionRule] Fix option rule about all connectors (#3592)	https://github.com/apache/seatunnel/commit/226dc6a11	2.3.0
[Improve][Connector-V2][Socket] Unified exception for socket source & sink connector (#3511)	https://github.com/apache/seatunnel/commit/581292f21	2.3.0
[feature][connector][socket] Add Socket Connector Option Rules (#3317)	https://github.com/apache/seatunnel/commit/b85317bcb	2.3.0
[Improve][all] change Log to @Slf4j (#3001)	https://github.com/apache/seatunnel/commit/6016100f1	2.3.0-beta
[DEV][Api] Replace SeaTunnelContext with JobContext and remove singleton pattern (#2706)	https://github.com/apache/seatunnel/commit/cbf82f755	2.2.0-beta
[#2606]Dependency management split (#2630)	https://github.com/apache/seatunnel/commit/fc047be69	2.2.0-beta
[Feature][Connector-V2] Socket Connector Sink (#2549)	https://github.com/apache/seatunnel/commit/94f4600a4	2.2.0-beta
[api-draft][Optimize] Optimize module name (#2062)	https://github.com/apache/seatunnel/commit/f79e3112b	2.2.0-beta