Package org.apache.iotdb.pipe.api

Interface PipeExtractor

All Superinterfaces:

AutoCloseable, PipePlugin

All Known Subinterfaces:

PipeSource

@Deprecated
public interface PipeExtractor
extends PipePlugin

Deprecated.

PipeExtractor (Deprecated since v1.3.0, renamed to PipeSource)

PipeExtractor is responsible for capturing Events from sources.

Various data sources can be supported by implementing different PipeExtractor classes.

The lifecycle of a PipeExtractor is as follows:

• When a collaboration task is created, the KV pairs of `WITH EXTRACTOR` clause in SQL are parsed and the validation method validate(PipeParameterValidator) will be called to validate the PipeParameters.
• Before the collaboration task starts, the method customize(PipeParameters, PipeExtractorRuntimeConfiguration) will be called to config the runtime behavior of the PipeExtractor.
• Then the method start() will be called to start the PipeExtractor.
• While the collaboration task is in progress, the method supply() will be called to capture Events from sources and then the Events will be passed to the PipeProcessor.
• The method AutoCloseable.close() will be called when the collaboration task is cancelled (the `DROP PIPE` command is executed).

Method Summary

Modifier and Type	Method	Description
void	customize(PipeParameters parameters, PipeExtractorRuntimeConfiguration configuration)	Deprecated. This method is mainly used to customize PipeExtractor.
void	start()	Deprecated. Start the PipeExtractor.
Event	supply()	Deprecated. Supply single Event from the PipeExtractor and the caller will send the Event to the PipeProcessor.
void	validate(PipeParameterValidator validator)	Deprecated. This method is mainly used to validate PipeParameters and it is executed before customize(PipeParameters, PipeExtractorRuntimeConfiguration) is called.

Methods inherited from interface java.lang.AutoCloseable

close

Method Details

validate

void validate(PipeParameterValidator validator)
       throws Exception

Deprecated.

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

Parameters:

validator - the validator used to validate PipeParameters

Throws:

Exception - if any PipeParameters is not valid

customize

void customize(PipeParameters parameters,
 PipeExtractorRuntimeConfiguration configuration)
        throws Exception

Deprecated.

This method is mainly used to customize PipeExtractor. 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 PipeExtractorRuntimeConfiguration.

This method is called after the method validate(PipeParameterValidator) is called.

Parameters:

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

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

Throws:

Exception - the user can throw errors if necessary

start

void start()
    throws Exception

Deprecated.

Start the PipeExtractor. After this method is called, Events should be ready to be supplied by supply(). This method is called after customize(PipeParameters, PipeExtractorRuntimeConfiguration) is called.

Throws:

Exception - the user can throw errors if necessary

supply

Event supply()
      throws Exception

Deprecated.

Supply single Event from the PipeExtractor and the caller will send the Event to the PipeProcessor. This method is called after start() is called.

Returns:

the Event to be supplied. the Event may be null if the PipeExtractor has no more Events at the moment, but the PipeExtractor is still running for more Events.

Throws:

Exception - the user can throw errors if necessary