Package org.apache.iotdb.pipe.api

Interface PipeSink

All Superinterfaces:

AutoCloseable, PipeConnector, PipePlugin

public interface PipeSink
extends PipeConnector

PipeSink

PipeSink is responsible for sending Events to sinks.

Various network protocols can be supported by implementing different PipeSink classes.

The lifecycle of a PipeSink is as follows:

• When a collaboration task is created, the KV pairs of `WITH SINK` clause in SQL are parsed and the validation method validate(PipeParameterValidator) will be called to validate the parameters.
• Before the collaboration task starts, the method customize(PipeParameters, PipeSinkRuntimeConfiguration) will be called to configure the runtime behavior of the PipeSink and the method handshake() will be called to create a connection with sink.
• While the collaboration task is in progress:
  • PipeSource captures the Events and wraps them into three types of Event instances.
  • PipeProcessor processes the Event and then passes them to the PipeSink.
  • PipeSink serializes the Events into binaries and send them to sinks. The following 3 methods will be called: transfer(TabletInsertionEvent), transfer(TsFileInsertionEvent) and transfer(Event).
• When the collaboration task is cancelled (the `DROP PIPE` command is executed), the AutoCloseable.close() method will be called.

In addition, the method heartbeat() will be called periodically to check whether the connection with sink is still alive. The method handshake() will be called to create a new connection with the sink when the method heartbeat() throws exceptions.

Method Summary

Modifier and Type	Method	Description
void	customize(PipeParameters parameters, PipeSinkRuntimeConfiguration configuration)	This method is mainly used to customize PipeSink.
void	handshake()	This method is used to create a connection with sink.
void	heartbeat()	This method will be called periodically to check whether the connection with sink is still alive.
void	transfer(TabletInsertionEvent tabletInsertionEvent)	This method is used to transfer the TabletInsertionEvent.
default void	transfer(TsFileInsertionEvent tsFileInsertionEvent)	This method is used to transfer the TsFileInsertionEvent.
void	transfer(Event event)	This method is used to transfer the generic Events, including HeartbeatEvent.
void	validate(PipeParameterValidator validator)	This method is mainly used to validate PipeParameters and it is executed before customize(PipeParameters, PipeSinkRuntimeConfiguration) is called.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.apache.iotdb.pipe.api.PipeConnector

customize

Method Details

validate

void validate(PipeParameterValidator validator)
       throws Exception

This method is mainly used to validate PipeParameters and it is executed before customize(PipeParameters, PipeSinkRuntimeConfiguration) is called.

Specified by:

validate in interface PipeConnector

Parameters:

validator - the validator used to validate PipeParameters

Throws:

Exception - if any of PipeParameters is not valid

customize

void customize(PipeParameters parameters,
 PipeSinkRuntimeConfiguration configuration)
        throws Exception

This method is mainly used to customize PipeSink. In this method, the user can do the following things:

• Use PipeParameters to parse key-value pair attributes entered by the user.
• Set the running configurations in PipeSinkRuntimeConfiguration.

This method is called after the method validate(PipeParameterValidator) is called and before the method handshake() is called.

Parameters:

parameters - used to parse the input PipeParameters entered by the user

configuration - used to set the required properties of the running PipeSink

Throws:

Exception - the user can throw errors if necessary

handshake

void handshake()
        throws Exception

This method is used to create a connection with sink. This method will be called after the method customize(PipeParameters, PipeSinkRuntimeConfiguration) is called or will be called when the method heartbeat() throws exceptions.

Specified by:

handshake in interface PipeConnector

Throws:

Exception - if the connection is failed to be created

heartbeat

void heartbeat()
        throws Exception

This method will be called periodically to check whether the connection with sink is still alive.

Specified by:

heartbeat in interface PipeConnector

Throws:

Exception - if the connection dies

transfer

void transfer(TabletInsertionEvent tabletInsertionEvent)
       throws Exception

This method is used to transfer the TabletInsertionEvent.

Specified by:

transfer in interface PipeConnector

Parameters:

tabletInsertionEvent - TabletInsertionEvent to be transferred

Throws:

PipeConnectionException - if the connection is broken

Exception - the user can throw errors if necessary

transfer

default void transfer(TsFileInsertionEvent tsFileInsertionEvent)
               throws Exception

This method is used to transfer the TsFileInsertionEvent.

Specified by:

transfer in interface PipeConnector

Parameters:

tsFileInsertionEvent - TsFileInsertionEvent to be transferred

Throws:

PipeConnectionException - if the connection is broken

Exception - the user can throw errors if necessary

transfer

void transfer(Event event)
       throws Exception

This method is used to transfer the generic Events, including HeartbeatEvent.

Specified by:

transfer in interface PipeConnector

Parameters:

event - Event to be transferred

Throws:

PipeConnectionException - if the connection is broken

Exception - the user can throw errors if necessary