Skip to content

[Feature][Connector-V2]Jdbc chunk split add snapshotSplitColumn config #7794 #7840

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

Merged
Hisoka-X merged 31 commits into from
Nov 19, 2024
Merged

[Feature][Connector-V2]Jdbc chunk split add snapshotSplitColumn config #7794 #7840

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
fc75772
[Improve][Sls] Add sls sink connector、e2e、doc
Oct 14, 2024
1576162
[Improve][Sls] Add sls sink connector、e2e、doc
Oct 14, 2024
1a636d3
Merge branch 'dev' of https://github.com/apache/seatunnel into dev
Oct 14, 2024
87d749a
[Improve][Sls] Update sls sink e2e code style
Oct 14, 2024
69bf03c
[Improve][Sls] Add sls sink license header
Oct 14, 2024
1165447
[Feature][Connector-V2]Jdbc chunk split add “snapshot.split.column” p…
Oct 15, 2024
0c2676b
Merge branch 'dev' of https://github.com/apache/seatunnel into dev
Oct 15, 2024
7165bad
[Feature][Connector-V2]Jdbc chunk split add “snapshot.split.column” p…
Oct 15, 2024
f5c5ee8
[Feature][Connector-V2]Update mysql-cdc doc with params snapshot.spl…
Oct 15, 2024
8a0b6ba
[Feature][Connector-V2]Update snapshot.split.column type with map and…
Oct 15, 2024
401723e
[Feature][Connector-V2]Remove local test run println
Oct 15, 2024
f9c973a
[Feature][Connector-V2] code style
Oct 15, 2024
83020fd
[Feature][Connector-V2] SourceConfig remove getSplitColumn
Oct 15, 2024
9a87c8b
[Feature][Connector-V2] uniq_key_f add id
Oct 15, 2024
7be5d6d
[Feature][Connector-V2] add split column type check
Oct 15, 2024
afd9cd9
[Feature][Connector-V2] add split column type check
Oct 15, 2024
2cae910
Update seatunnel-connectors-v2/connector-cdc/connector-cdc-base/src/m…
XenosK Oct 16, 2024
edc6f70
Update seatunnel-connectors-v2/connector-cdc/connector-cdc-base/src/m…
XenosK Oct 16, 2024
275520d
Update seatunnel-connectors-v2/connector-cdc/connector-cdc-base/src/m…
XenosK Oct 16, 2024
fe8f7d3
[Feature][Connector-V2] boolean isUniqueKey
Oct 16, 2024
768ca66
[Feature][Connector-V2] StringUtils.isNotEmpty
Oct 16, 2024
1973c18
[Feature][Connector-V2] code style
Oct 16, 2024
08bd831
[Feature][Connector-V2] &&!xx replace &&xx==false
Oct 16, 2024
047665f
[Feature][Connector-V2] use mao replace properties for split coiumn
Oct 21, 2024
733d823
[Feature][Connector-V2] update snapshot.split.column location
Oct 23, 2024
1388c01
[Feature][Connector-V2] update doc
Oct 23, 2024
fa9ec16
[Feature][Connector-V2] update snapshotSplitColumn config e2e
Nov 1, 2024
5b2056f
[Feature][Connector-V2] update snapshotSplitColumn doc
Nov 11, 2024
307a617
Merge branch 'dev' of https://github.com/apache/seatunnel into dev
Nov 11, 2024
59730d0
[Feature][Connector-V2] update unique column function
Nov 13, 2024
4556bc6
[Feature][Connector-V2] update unique column function
Nov 15, 2024
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
3 changes: 2 additions & 1 deletion docs/en/connector-v2/source/MySQL-CDC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ When an initial consistent snapshot is made for large databases, your establishe

## Source Options

| Name | Type | Required | Default | Description |
| Name | Type | Required | Default | Description |
|------------------------------------------------|----------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| base-url | String | Yes | - | The URL of the JDBC connection. Refer to a case: `jdbc:mysql://localhost:3306:3306/test`. |
| username | String | Yes | - | Name of the database to use when connecting to the database server. |
Expand All @@ -184,6 +184,7 @@ When an initial consistent snapshot is made for large databases, your establishe
| stop.specific-offset.file | String | No | - | Stop from the specified binlog file name. **Note, This option is required when the `stop.mode` option used `specific`.** |
| stop.specific-offset.pos | Long | No | - | Stop from the specified binlog file position. **Note, This option is required when the `stop.mode` option used `specific`.** |
| snapshot.split.size | Integer | No | 8096 | The split size (number of rows) of table snapshot, captured tables are split into multiple splits when read the snapshot of table. |
| snapshot.split.column | String | No | - | The split column (must be unique key) of table snapshot, captured tables are split into multiple splits when read the snapshot of table. |
| snapshot.fetch.size | Integer | No | 1024 | The maximum fetch size for per poll when read table snapshot. |
| server-id | String | No | - | A numeric ID or a numeric ID range of this database client, The numeric ID syntax is like `5400`, the numeric ID range syntax is like '5400-5408'. <br/> Every ID must be unique across all currently-running database processes in the MySQL cluster. This connector joins the <br/> MySQL cluster as another server (with this unique ID) so it can read the binlog. <br/> By default, a random number is generated between 6500 and 2,148,492,146, though we recommend setting an explicit value. |
| server-time-zone | String | No | UTC | The session time zone in database server. If not set, then ZoneId.systemDefault() is used to determine the server time zone. |
Expand Down
3 changes: 3 additions & 0 deletions ...-base/src/main/java/org/apache/seatunnel/connectors/cdc/base/config/BaseSourceConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ public abstract class BaseSourceConfig implements SourceConfig {
@Getter protected final StopConfig stopConfig;

@Getter protected final int splitSize;
@Getter protected final String splitColumn;

@Getter protected final double distributionFactorUpper;
@Getter protected final double distributionFactorLower;
Expand All @@ -50,6 +51,7 @@ public BaseSourceConfig(
StartupConfig startupConfig,
StopConfig stopConfig,
int splitSize,
String splitColumn,
double distributionFactorUpper,
double distributionFactorLower,
int sampleShardingThreshold,
Expand All @@ -59,6 +61,7 @@ public BaseSourceConfig(
this.startupConfig = startupConfig;
this.stopConfig = stopConfig;
this.splitSize = splitSize;
this.splitColumn = splitColumn;
this.distributionFactorUpper = distributionFactorUpper;
this.distributionFactorLower = distributionFactorLower;
this.sampleShardingThreshold = sampleShardingThreshold;
Expand Down
2 changes: 2 additions & 0 deletions ...-base/src/main/java/org/apache/seatunnel/connectors/cdc/base/config/JdbcSourceConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public JdbcSourceConfig(
List<String> databaseList,
List<String> tableList,
int splitSize,
String splitColumn,
double distributionFactorUpper,
double distributionFactorLower,
int sampleShardingThreshold,
Expand All @@ -70,6 +71,7 @@ public JdbcSourceConfig(
startupConfig,
stopConfig,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down
7 changes: 7 additions & 0 deletions ...rc/main/java/org/apache/seatunnel/connectors/cdc/base/config/JdbcSourceConfigFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public abstract class JdbcSourceConfigFactory implements SourceConfig.Factory<Jd
JdbcSourceOptions.SAMPLE_SHARDING_THRESHOLD.defaultValue();
protected int inverseSamplingRate = JdbcSourceOptions.INVERSE_SAMPLING_RATE.defaultValue();
protected int splitSize = SourceOptions.SNAPSHOT_SPLIT_SIZE.defaultValue();
protected String splitColumn = SourceOptions.SNAPSHOT_SPLIT_COLUMN.defaultValue();;
protected int fetchSize = SourceOptions.SNAPSHOT_FETCH_SIZE.defaultValue();
protected String serverTimeZone = JdbcSourceOptions.SERVER_TIME_ZONE.defaultValue();
protected long connectTimeoutMillis = JdbcSourceOptions.CONNECT_TIMEOUT_MS.defaultValue();
Expand All @@ -65,6 +66,11 @@ public JdbcSourceConfigFactory hostname(String hostname) {
return this;
}

public JdbcSourceConfigFactory splitColumn(String splitColumn) {
this.splitColumn = splitColumn;
return this;
}

/** Integer port number of the database server. */
public JdbcSourceConfigFactory port(int port) {
this.port = port;
Expand Down Expand Up @@ -239,6 +245,7 @@ public JdbcSourceConfigFactory fromReadonlyConfig(ReadonlyConfig config) {
this.sampleShardingThreshold = config.get(JdbcSourceOptions.SAMPLE_SHARDING_THRESHOLD);
this.inverseSamplingRate = config.get(JdbcSourceOptions.INVERSE_SAMPLING_RATE);
this.splitSize = config.get(SourceOptions.SNAPSHOT_SPLIT_SIZE);
this.splitColumn = config.get(SourceOptions.SNAPSHOT_SPLIT_COLUMN);
this.fetchSize = config.get(SourceOptions.SNAPSHOT_FETCH_SIZE);
this.serverTimeZone = config.get(JdbcSourceOptions.SERVER_TIME_ZONE);
this.connectTimeoutMillis = config.get(JdbcSourceOptions.CONNECT_TIMEOUT_MS);
Expand Down
20 changes: 20 additions & 0 deletions ...src/main/java/org/apache/seatunnel/connectors/cdc/base/dialect/JdbcDataSourceDialect.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,26 @@ default List<ConstraintKey> getUniqueKeys(JdbcConnection jdbcConnection, TableId
.collect(Collectors.toList());
}

default Boolean isUniqueKey(JdbcConnection jdbcConnection, TableId tableId, String columnName)
throws SQLException {
boolean isUnique = false;
if (null != columnName) {
DatabaseMetaData metaData = jdbcConnection.connection().getMetaData();
ResultSet resultSet =
metaData.getIndexInfo(
tableId.catalog(), tableId.schema(), tableId.table(), false, false);

while (resultSet.next()) {
if (columnName.equalsIgnoreCase(resultSet.getString("COLUMN_NAME"))
&& resultSet.getBoolean("NON_UNIQUE") == false) {
isUnique = true;
break;
}
}
}
return isUnique;
}

default List<ConstraintKey> getConstraintKeys(JdbcConnection jdbcConnection, TableId tableId)
throws SQLException {
DatabaseMetaData metaData = jdbcConnection.connection().getMetaData();
Expand Down
9 changes: 8 additions & 1 deletion ...cdc-base/src/main/java/org/apache/seatunnel/connectors/cdc/base/option/SourceOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ public class SourceOptions {
.withDescription(
"The split size (number of rows) of table snapshot, captured tables are split into multiple splits when read the snapshot of table.");

public static final Option<String> SNAPSHOT_SPLIT_COLUMN =
Options.key("snapshot.split.column")
.stringType()
.noDefaultValue()
.withDescription(
"The split column of table snapshot, captured tables are split into multiple splits when read the snapshot of table.");

public static final Option<Integer> SNAPSHOT_FETCH_SIZE =
Options.key("snapshot.fetch.size")
.intType()
Expand Down Expand Up @@ -111,7 +118,7 @@ public class SourceOptions {
public static OptionRule.Builder getBaseRule() {
return OptionRule.builder()
.optional(FORMAT)
.optional(SNAPSHOT_SPLIT_SIZE, SNAPSHOT_FETCH_SIZE)
.optional(SNAPSHOT_SPLIT_SIZE, SNAPSHOT_FETCH_SIZE, SNAPSHOT_SPLIT_COLUMN)
.optional(INCREMENTAL_PARALLELISM)
.optional(DEBEZIUM_PROPERTIES);
}
Expand Down
21 changes: 18 additions & 3 deletions ...unnel/connectors/cdc/base/source/enumerator/splitter/AbstractJdbcSourceChunkSplitter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,12 +379,28 @@ protected SnapshotSplit createSnapshotSplit(
protected Column getSplitColumn(
JdbcConnection jdbc, JdbcDataSourceDialect dialect, TableId tableId)
throws SQLException {
Optional<PrimaryKey> primaryKey = dialect.getPrimaryKey(jdbc, tableId);
Column splitColumn = null;
Table table = dialect.queryTableSchema(jdbc, tableId).getTable();

// first , compare user defined split column is in the primary key or unique key
String sc = null;
try {
sc = sourceConfig.getSplitColumn();
} catch (Exception e) {
log.error("Config splitColumn get exception in {}:{}", tableId, e);
}
Boolean isUniqueKey = dialect.isUniqueKey(jdbc, tableId, sc);
if (isUniqueKey) {
Column column = table.columnWithName(sc);
return column;
} else {
log.warn("Config splitColumn not exists or not unique key for table {}", tableId);
}

Optional<PrimaryKey> primaryKey = dialect.getPrimaryKey(jdbc, tableId);
if (primaryKey.isPresent()) {
List<String> pkColumns = primaryKey.get().getColumnNames();

Table table = dialect.queryTableSchema(jdbc, tableId).getTable();
for (String pkColumn : pkColumns) {
Column column = table.columnWithName(pkColumn);
if (isEvenlySplitColumn(column)) {
Expand All @@ -400,7 +416,6 @@ protected Column getSplitColumn(

List<ConstraintKey> uniqueKeys = dialect.getUniqueKeys(jdbc, tableId);
if (!uniqueKeys.isEmpty()) {
Table table = dialect.queryTableSchema(jdbc, tableId).getTable();
for (ConstraintKey uniqueKey : uniqueKeys) {
List<ConstraintKey.ConstraintKeyColumn> uniqueKeyColumns =
uniqueKey.getColumnNames();
Expand Down
2 changes: 2 additions & 0 deletions ...in/java/org/apache/seatunnel/connectors/seatunnel/cdc/mysql/config/MySqlSourceConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ public MySqlSourceConfig(
List<String> databaseList,
List<String> tableList,
int splitSize,
String splitColumn,
double distributionFactorUpper,
double distributionFactorLower,
int sampleShardingThreshold,
Expand All @@ -64,6 +65,7 @@ public MySqlSourceConfig(
databaseList,
tableList,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down
1 change: 1 addition & 0 deletions .../org/apache/seatunnel/connectors/seatunnel/cdc/mysql/config/MySqlSourceConfigFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ public MySqlSourceConfig create(int subtaskId) {
databaseList,
tableList,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down
2 changes: 2 additions & 0 deletions .../java/org/apache/seatunnel/connectors/seatunnel/cdc/oracle/config/OracleSourceConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public OracleSourceConfig(
List<String> databaseList,
List<String> tableList,
int splitSize,
String splitColumn,
double distributionFactorUpper,
double distributionFactorLower,
int sampleShardingThreshold,
Expand All @@ -72,6 +73,7 @@ public OracleSourceConfig(
databaseList,
tableList,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down
1 change: 1 addition & 0 deletions ...rg/apache/seatunnel/connectors/seatunnel/cdc/oracle/config/OracleSourceConfigFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ public OracleSourceConfig create(int subtask) {
databaseList,
tableList,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down
2 changes: 2 additions & 0 deletions ...a/org/apache/seatunnel/connectors/seatunnel/cdc/postgres/config/PostgresSourceConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ public PostgresSourceConfig(
List<String> databaseList,
List<String> tableList,
int splitSize,
String splitColumn,
double distributionFactorUpper,
double distributionFactorLower,
int sampleShardingThreshold,
Expand All @@ -59,6 +60,7 @@ public PostgresSourceConfig(
databaseList,
tableList,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down
1 change: 1 addition & 0 deletions ...pache/seatunnel/connectors/seatunnel/cdc/postgres/config/PostgresSourceConfigFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ public PostgresSourceConfig create(int subtask) {
databaseList,
tableList,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down
2 changes: 2 additions & 0 deletions ...org/apache/seatunnel/connectors/seatunnel/cdc/sqlserver/config/SqlServerSourceConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ public SqlServerSourceConfig(
List<String> databaseList,
List<String> tableList,
int splitSize,
String splitColumn,
double distributionFactorUpper,
double distributionFactorLower,
int sampleShardingThreshold,
Expand All @@ -64,6 +65,7 @@ public SqlServerSourceConfig(
databaseList,
tableList,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down
1 change: 1 addition & 0 deletions ...che/seatunnel/connectors/seatunnel/cdc/sqlserver/config/SqlServerSourceConfigFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ public SqlServerSourceConfig create(int subtask) {
databaseList,
tableList,
splitSize,
splitColumn,
distributionFactorUpper,
distributionFactorLower,
sampleShardingThreshold,
Expand Down