-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
[api-draft][connector] Add simplified connector api #2041
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
...el-connectors/seatunnel-connectors-seatunnel/seatunnel-connector-seatunnel-common/pom.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!-- | ||
|
||
Licensed to the Apache Software Foundation (ASF) under one or more | ||
contributor license agreements. See the NOTICE file distributed with | ||
this work for additional information regarding copyright ownership. | ||
The ASF licenses this file to You under the Apache License, Version 2.0 | ||
(the "License"); you may not use this file except in compliance with | ||
the License. You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
|
||
--> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<parent> | ||
<artifactId>seatunnel-connectors-seatunnel</artifactId> | ||
<groupId>org.apache.seatunnel</groupId> | ||
<version>${revision}</version> | ||
</parent> | ||
<modelVersion>4.0.0</modelVersion> | ||
|
||
<artifactId>seatunnel-connector-seatunnel-common</artifactId> | ||
|
||
<properties> | ||
</properties> | ||
|
||
<dependencies> | ||
<dependency> | ||
<groupId>org.apache.seatunnel</groupId> | ||
<artifactId>seatunnel-api</artifactId> | ||
<version>${project.version}</version> | ||
</dependency> | ||
</dependencies> | ||
</project> |
59 changes: 59 additions & 0 deletions
59
...c/main/java/org/apache/seatunnel/connectors/seatunnel/common/sink/AbstractSimpleSink.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright ownership. | ||
* The ASF licenses this file to You under the Apache License, Version 2.0 | ||
* (the "License"); you may not use this file except in compliance with | ||
* the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.seatunnel.connectors.seatunnel.common.sink; | ||
|
||
import org.apache.seatunnel.api.serialization.Serializer; | ||
import org.apache.seatunnel.api.sink.SeaTunnelSink; | ||
import org.apache.seatunnel.api.sink.SinkAggregatedCommitter; | ||
import org.apache.seatunnel.api.sink.SinkCommitter; | ||
import org.apache.seatunnel.api.sink.SinkWriter; | ||
|
||
import java.io.IOException; | ||
import java.util.List; | ||
import java.util.Optional; | ||
|
||
public abstract class AbstractSimpleSink<T, StateT> implements SeaTunnelSink<T, StateT, Void, Void> { | ||
|
||
@Override | ||
public abstract AbstractSinkWriter<T, StateT> createWriter(SinkWriter.Context context) throws IOException; | ||
|
||
@Override | ||
public SinkWriter<T, Void, StateT> restoreWriter(SinkWriter.Context context, List<StateT> states) throws IOException { | ||
return createWriter(context); | ||
} | ||
|
||
@Override | ||
public final Optional<SinkCommitter<Void>> createCommitter() throws IOException { | ||
return Optional.empty(); | ||
} | ||
|
||
@Override | ||
public final Optional<Serializer<Void>> getCommitInfoSerializer() { | ||
return Optional.empty(); | ||
} | ||
|
||
@Override | ||
public final Optional<SinkAggregatedCommitter<Void, Void>> createAggregatedCommitter() throws IOException { | ||
return Optional.empty(); | ||
} | ||
|
||
@Override | ||
public final Optional<Serializer<Void>> getAggregatedCommitInfoSerializer() { | ||
return Optional.empty(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
...va/org/apache/seatunnel/connectors/seatunnel/common/source/AbstractSingleSplitReader.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright ownership. | ||
* The ASF licenses this file to You under the Apache License, Version 2.0 | ||
* (the "License"); you may not use this file except in compliance with | ||
* the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.seatunnel.connectors.seatunnel.common.source; | ||
|
||
import org.apache.seatunnel.api.source.SourceEvent; | ||
import org.apache.seatunnel.api.source.SourceReader; | ||
|
||
import java.util.Collections; | ||
import java.util.List; | ||
|
||
public abstract class AbstractSingleSplitReader<T> implements SourceReader<T, SingleSplit> { | ||
|
||
@Override | ||
public final List<SingleSplit> snapshotState(long checkpointId) throws Exception { | ||
return Collections.singletonList(new SingleSplit(snapshotStateToBytes(checkpointId))); | ||
} | ||
|
||
protected byte[] snapshotStateToBytes(long checkpointId) throws Exception { | ||
// default nothing | ||
return null; | ||
} | ||
|
||
@Override | ||
public final void addSplits(List<SingleSplit> splits) { | ||
if (splits.size() > 1) { | ||
throw new UnsupportedOperationException("The single-split reader don't support reading multiple splits"); | ||
} | ||
byte[] restoredState = splits.get(0).getState(); | ||
if (restoredState != null && restoredState.length > 0) { | ||
restoreState(restoredState); | ||
} | ||
} | ||
|
||
protected void restoreState(byte[] restoredState) { | ||
// default nothing | ||
} | ||
|
||
@Override | ||
public final void handleNoMoreSplits() { | ||
// nothing | ||
} | ||
|
||
@Override | ||
public void notifyCheckpointComplete(long checkpointId) throws Exception { | ||
// default nothing | ||
} | ||
|
||
@Override | ||
public final void handleSourceEvent(SourceEvent sourceEvent) { | ||
// nothing | ||
} | ||
} |
58 changes: 58 additions & 0 deletions
58
...va/org/apache/seatunnel/connectors/seatunnel/common/source/AbstractSingleSplitSource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright ownership. | ||
* The ASF licenses this file to You under the Apache License, Version 2.0 | ||
* (the "License"); you may not use this file except in compliance with | ||
* the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.seatunnel.connectors.seatunnel.common.source; | ||
|
||
import static com.google.common.base.Preconditions.checkArgument; | ||
|
||
import org.apache.seatunnel.api.serialization.DefaultSerializer; | ||
import org.apache.seatunnel.api.serialization.Serializer; | ||
import org.apache.seatunnel.api.source.SeaTunnelSource; | ||
import org.apache.seatunnel.api.source.SourceReader; | ||
import org.apache.seatunnel.api.source.SourceSplitEnumerator; | ||
|
||
public abstract class AbstractSingleSplitSource<T> implements SeaTunnelSource<T, SingleSplit, SingleSplitEnumeratorState> { | ||
|
||
@Override | ||
public final AbstractSingleSplitReader<T> createReader(SourceReader.Context readerContext) throws Exception { | ||
checkArgument(readerContext.getIndexOfSubtask() == 0, "Single split source allows only a single reader to be created."); | ||
return createReader(new SingleSplitReaderContext(readerContext)); | ||
} | ||
|
||
public abstract AbstractSingleSplitReader<T> createReader(SingleSplitReaderContext readerContext) throws Exception; | ||
|
||
@Override | ||
public final SourceSplitEnumerator<SingleSplit, SingleSplitEnumeratorState> createEnumerator(SourceSplitEnumerator.Context<SingleSplit> enumeratorContext) throws Exception { | ||
return new SingleSplitEnumerator(enumeratorContext); | ||
} | ||
|
||
@Override | ||
public final SourceSplitEnumerator<SingleSplit, SingleSplitEnumeratorState> restoreEnumerator(SourceSplitEnumerator.Context<SingleSplit> enumeratorContext, SingleSplitEnumeratorState checkpointState) throws Exception { | ||
return createEnumerator(enumeratorContext); | ||
} | ||
|
||
@Override | ||
public final Serializer<SingleSplitEnumeratorState> getEnumeratorStateSerializer() { | ||
return new DefaultSerializer<>(); | ||
} | ||
|
||
@Override | ||
public final Serializer<SingleSplit> getSplitSerializer() { | ||
return new DefaultSerializer<>(); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
xxxAware
is a better class name when there is only onesetXXX
method.Refer to
spring framewok
org.springframework.web.context.ServletConfigAware ``org.springframework.context.ApplicationContextAware
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This's good idea! Can you contribute to it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem