Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Improve] Mark SeaTunnelPluginLifeCycle as deprecated #5625

Merged
merged 2 commits into from
Oct 16, 2023
Merged

[Improve] Mark SeaTunnelPluginLifeCycle as deprecated #5625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20f9062
[Improve] Mark `SeaTunnelPluginLifeCycle` as deprecated
Hisoka-X Oct 13, 2023
7723f42
update
Hisoka-X Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions seatunnel-api/src/main/java/org/apache/seatunnel/api/common/SeaTunnelPluginLifeCycle.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@
/**
* This interface is the life cycle of a plugin, after a plugin created, will execute prepare method
* to do some initialize operation.
*
* @deprecated SeaTunnel will not invoke prepare when init plugin, instead by {@link
* org.apache.seatunnel.api.table.factory.Factory}
*/
@Deprecated
public interface SeaTunnelPluginLifeCycle {

/**
Expand All @@ -31,6 +35,9 @@ public interface SeaTunnelPluginLifeCycle {
* @param pluginConfig plugin config.
* @throws PrepareFailException if plugin prepare failed, the {@link PrepareFailException} will
* throw.
* @deprecated SeaTunnel will not invoke prepare when init plugin, instead by {@link
* org.apache.seatunnel.api.table.factory.Factory}
*/
@Deprecated
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. But https://github.com/apache/seatunnel/blob/dev/seatunnel-api/src/main/java/org/apache/seatunnel/api/sink/SeaTunnelSink.java#L65 doesn't deprecated. Because we don't have a replacement yet

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it will be deprecated in the future

void prepare(Config pluginConfig) throws PrepareFailException;
}
2 changes: 2 additions & 0 deletions seatunnel-api/src/main/java/org/apache/seatunnel/api/sink/SeaTunnelSink.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,10 @@ public interface SeaTunnelSink<IN, StateT, CommitInfoT, AggregatedCommitInfoT>
* Set the row type info of sink row data. This method will be automatically called by
* translation.
*
* @deprecated instead by {@link org.apache.seatunnel.api.table.factory.Factory}
* @param seaTunnelRowType The row type info of sink.
*/
@Deprecated
void setTypeInfo(SeaTunnelRowType seaTunnelRowType);

/**
Expand Down
10 changes: 5 additions & 5 deletions seatunnel-api/src/main/java/org/apache/seatunnel/api/transform/SeaTunnelTransform.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,22 @@ default void open() {}
/**
* Set the data type info of input data.
*
* @deprecated instead by {@link org.apache.seatunnel.api.table.factory.Factory}
* @param inputDataType The data type info of upstream input.
*/
@Deprecated
void setTypeInfo(SeaTunnelDataType<T> inputDataType);

/**
* Get the data type of the records produced by this transform.
*
* @deprecated Please use {@link #getProducedCatalogTable}
* @return Produced data type.
*/
@Deprecated
SeaTunnelDataType<T> getProducedType();

/**
* Get the catalog table output by this transform
*
* @return
*/
/** Get the catalog table output by this transform */
CatalogTable getProducedCatalogTable();

/**
Expand Down