Status

Current state: ["Under Discussion"]

...

...

...

...

...

Released: <Flink Version>

...

Motivation

To support connectors in avoiding overwriting non-target columns with null values when processing partial column updates, we propose adding information on the target column list to DynamicTableSink#Context.

...

Let's explain the scenario further, denormalized table(or the commonly known 'wide table') model is a common data modeling method, which connects multiple tables to form a unified wide table to improve query and analysis efficiency.
The data of wide denormalized table comes from different source tables. When writing or updating data, it usually adopts the mode of specifying the column list to write.

For example, there is a wide denormalized table t1 which has a primary key `a`:

...

where column b, c, d from s1 table, column e, f, g from s2 table,
by different processing data from the source table s1 and s2,  the two insertions specify a different column list written to the wide denormalized table, ideally the two insertions will not affect each others' column

...

The current connector implementor has no way of knowing that the last three fields were added by the planner and not from real user data. The user has to declare several different schemas (containing only partial column information and no overlap except for the primary key) to get around the current problem. 

By adding targetColumnList target column list information to the DynamicTableSink#Context, this problem can be solved.

...

Add new getTargetColumns to DynamicTableSink#Context.

        /**
         * Returns an {@link Optional} array of column index paths related to user specified target
 column list or an
     * column list or * empty array{@link Optional#empty()} when not specified. The array indices are 0-based
 and support composite columns
     * and support composite *columns within (possibly nested) structures.
         *
         * <p>This information comes from the column list of the DML clause, e.g., for a sink table
         * t1 which schema is: {@code a STRING, b ROW < b1 INT, b2 STRING>, c BIGINT}
         *
         * <ul>
         *   <li>insert: 'insert into t1(a, b.b2) ...', the column list will be 'a, b.b2', and will
         *       return {@code [[0], [1, 1]]}. The columnstatement list'insert willinto betarget empty for 'insert into targetselect ...' without
         *       specifying a column list will select ...'.return {@link Optional#empty()}.
         *   <li>update: 'update target set a=1, b.b1=2 where ...', the column list will be 'a,
         *       b.b1', will return {@code [[0], [1, 0]]}.
         * </ul>
         *
         * <p>Note: will always return empty array for the delete statement because it has no column
         * list.
         */
            intOptional<int[][]> getTargetColumns();

Proposed Changes

...

Note: currently nested columns in column list of an insert/update statement is unsupported (as described in FLINK-31301 & FLINK-31344), so we can make this flip support simple columns first and then support nested columns after FLINK-31301 & FLINK-31344 fixed. 

Compatibility, Deprecation, and Migration Plan

...