THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
Motivation
The goal of this FLIP is to add additional fields to Sink#InitContext to expose ExecutionConfig (or at least the ExecutionConfig#isObjectReuseEnabled) and JobID.
This is necessary to migrate the current JdbcSink to the SinkV2 (FLIP-239 -> FLINK-25421) more specifically in order to be able to reuse the current code:
- the JdbcOutputFormat which today uses RuntimeContext to get the ExecutionConfig#isObjectReuseEnabled.
- the SemanticXidGenerator (for Xa-Sink) needs JobID to create the Xid.
- the use of TypeInformation.createSerializer.
This would be necessary to another connectors as well.
Public Interfaces
- We want to extend the
Sink#InitContextto provide and ReadableExecutionConfig and JobID.
Proposed Changes
Option 1: Expose ExecutionConfig directly on InitContext
In this option we only expose the ExecutionConfig and the JobID.
InitContext
@PublicEvolving
public interface Sink<InputT> extends Serializable {
... current methods
@PublicEvolving
public interface InitContext {
... current methods
/**
* Returns the {@link ExecutionConfig} for the currently executing job.
*/
ExecutionConfig getExecutionConfig();
/**
* The ID of the current job. Note that Job ID can change in particular upon manual restart.
* The returned ID should NOT be used for any job management tasks.
*/
JobID getJobId();
}
}
Option 2: Expose ReadableExecutionConfig on InitContext
We propose to create a new interface ReadableExecutionConfig, making ExecutionConfig extending this interface, and adding a new method to TypeInformation.
With this option we have to change all the implementations of TypeInformation that exists (current exists 72 implementations)
ReadableExecutionConfig
@PublicEvolving
public interface ReadableExecutionConfig extends Serializable {
/** Returns whether object reuse has been enabled or disabled.*/
boolean isObjectReuseEnabled();
/** Another is/get methods needed, we should add all is/get methods from ExecutionConfig **/
...
}
ExecutionConfig
@Public
public class ExecutionConfig implements ReadableExecutionConfig, Archiveable<ArchivedExecutionConfig> {
/** Nothing to be done as methods should be the same (maybe put @Override on all), its only needed to implements the new interface **/
}
TypeInformation
@Public
public abstract class TypeInformation<T> implements Serializable {
/**
* Creates a serializer for the type.
* The serializer may use the ReadableExecutionConfig for parameterization.
*
* @param config The config used to parameterize the serializer.
* @return A serializer for this type.
*/
@PublicEvolving
public abstract TypeSerializer<T> createSerializer(ReadableExecutionConfig config);
}
InitContext
@PublicEvolving
public interface Sink<InputT> extends Serializable {
... current methods
@PublicEvolving
public interface InitContext {
... current methods
/**
* Returns the {@link ReadableExecutionConfig} for the currently executing job.
*/
ReadableExecutionConfig getReadableExecutionConfig();
/**
* The ID of the current job. Note that Job ID can change in particular upon manual restart.
* The returned ID should NOT be used for any job management tasks.
*/
JobID getJobId();
}
}
Compatibility, Deprecation, and Migration Plan
- The change only one additional method so no impact on existing code.
Test Plan
These simple API changes will be covered by extending unit and integration tests.
Rejected Alternatives
- None for the moment