From 261188482f69a816ea02eb8830e0012069f9d152 Mon Sep 17 00:00:00 2001 From: Vojtech Juranek Date: Tue, 31 May 2022 14:42:20 +0200 Subject: [PATCH] DBZ-5045 Remove deprecated SCHEMA_WHITELIST --- .../connector/mysql/MySqlConnectorConfig.java | 1 - .../oracle/OracleConnectorConfig.java | 1 - .../postgresql/PostgresConnectorIT.java | 5 ++-- .../postgresql/TablesWithoutPrimaryKeyIT.java | 4 ++-- .../sqlserver/SqlServerConnectorConfig.java | 1 - .../RelationalDatabaseConnectorConfig.java | 24 ++++--------------- .../relational/RelationalTableFilters.java | 5 +--- 7 files changed, 9 insertions(+), 32 deletions(-) diff --git a/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlConnectorConfig.java b/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlConnectorConfig.java index 8a9834458..29310638c 100644 --- a/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlConnectorConfig.java +++ b/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlConnectorConfig.java @@ -952,7 +952,6 @@ public static GtidNewChannelPosition parse(String value, String defaultValue) { private static final ConfigDefinition CONFIG_DEFINITION = HistorizedRelationalDatabaseConnectorConfig.CONFIG_DEFINITION.edit() .name("MySQL") .excluding( - SCHEMA_WHITELIST, SCHEMA_INCLUDE_LIST, SCHEMA_BLACKLIST, SCHEMA_EXCLUDE_LIST, diff --git a/debezium-connector-oracle/src/main/java/io/debezium/connector/oracle/OracleConnectorConfig.java b/debezium-connector-oracle/src/main/java/io/debezium/connector/oracle/OracleConnectorConfig.java index 4875ceef7..3d324239c 100644 --- a/debezium-connector-oracle/src/main/java/io/debezium/connector/oracle/OracleConnectorConfig.java +++ b/debezium-connector-oracle/src/main/java/io/debezium/connector/oracle/OracleConnectorConfig.java @@ -482,7 +482,6 @@ public class OracleConnectorConfig extends HistorizedRelationalDatabaseConnector private static final ConfigDefinition CONFIG_DEFINITION = HistorizedRelationalDatabaseConnectorConfig.CONFIG_DEFINITION.edit() .name("Oracle") .excluding( - SCHEMA_WHITELIST, SCHEMA_INCLUDE_LIST, SCHEMA_BLACKLIST, SCHEMA_EXCLUDE_LIST, diff --git a/debezium-connector-postgres/src/test/java/io/debezium/connector/postgresql/PostgresConnectorIT.java b/debezium-connector-postgres/src/test/java/io/debezium/connector/postgresql/PostgresConnectorIT.java index 940addc9c..808948050 100644 --- a/debezium-connector-postgres/src/test/java/io/debezium/connector/postgresql/PostgresConnectorIT.java +++ b/debezium-connector-postgres/src/test/java/io/debezium/connector/postgresql/PostgresConnectorIT.java @@ -229,7 +229,6 @@ public void shouldValidateConfiguration() throws Exception { validateConfigField(validatedConfig, PostgresConnectorConfig.SSL_CLIENT_KEY, null); validateConfigField(validatedConfig, PostgresConnectorConfig.SSL_CLIENT_KEY_PASSWORD, null); validateConfigField(validatedConfig, PostgresConnectorConfig.SSL_ROOT_CERT, null); - validateConfigField(validatedConfig, PostgresConnectorConfig.SCHEMA_WHITELIST, null); validateConfigField(validatedConfig, PostgresConnectorConfig.SCHEMA_INCLUDE_LIST, null); validateConfigField(validatedConfig, PostgresConnectorConfig.SCHEMA_BLACKLIST, null); validateConfigField(validatedConfig, PostgresConnectorConfig.SCHEMA_EXCLUDE_LIST, null); @@ -403,7 +402,7 @@ public void shouldConsumeMessagesFromSnapshotOld() throws Exception { .with(PostgresConnectorConfig.SNAPSHOT_MODE, SnapshotMode.INITIAL.getValue()) .with(PostgresConnectorConfig.MAX_QUEUE_SIZE, recordCount / 2) .with(PostgresConnectorConfig.MAX_BATCH_SIZE, 10) - .with(PostgresConnectorConfig.SCHEMA_WHITELIST, "s1"); + .with(PostgresConnectorConfig.SCHEMA_INCLUDE_LIST, "s1"); start(PostgresConnector.class, configBuilder.build()); assertConnectorIsRunning(); @@ -1208,7 +1207,7 @@ public void shouldRemoveWhiteSpaceCharsOld() throws Exception { Configuration.Builder configBuilder = TestHelper.defaultConfig() .with(PostgresConnectorConfig.SNAPSHOT_MODE, SnapshotMode.INITIAL.getValue()) .with(PostgresConnectorConfig.DROP_SLOT_ON_STOP, Boolean.TRUE) - .with(PostgresConnectorConfig.SCHEMA_WHITELIST, "s1") + .with(PostgresConnectorConfig.SCHEMA_INCLUDE_LIST, "s1") .with(PostgresConnectorConfig.TABLE_INCLUDE_LIST, tableWhitelistWithWhitespace); start(PostgresConnector.class, configBuilder.build()); diff --git a/debezium-connector-postgres/src/test/java/io/debezium/connector/postgresql/TablesWithoutPrimaryKeyIT.java b/debezium-connector-postgres/src/test/java/io/debezium/connector/postgresql/TablesWithoutPrimaryKeyIT.java index 6703f9adc..b0f0a72a2 100644 --- a/debezium-connector-postgres/src/test/java/io/debezium/connector/postgresql/TablesWithoutPrimaryKeyIT.java +++ b/debezium-connector-postgres/src/test/java/io/debezium/connector/postgresql/TablesWithoutPrimaryKeyIT.java @@ -67,7 +67,7 @@ public void shouldProcessFromSnapshotOld() throws Exception { start(PostgresConnector.class, TestHelper.defaultConfig() .with(PostgresConnectorConfig.SNAPSHOT_MODE, SnapshotMode.INITIAL_ONLY) - .with(PostgresConnectorConfig.SCHEMA_WHITELIST, "nopk") + .with(PostgresConnectorConfig.SCHEMA_INCLUDE_LIST, "nopk") .build()); assertConnectorIsRunning(); @@ -126,7 +126,7 @@ public void shouldProcessFromStreaming() throws Exception { public void shouldProcessFromStreamingOld() throws Exception { start(PostgresConnector.class, TestHelper.defaultConfig() .with(PostgresConnectorConfig.SNAPSHOT_MODE, SnapshotMode.NEVER) - .with(PostgresConnectorConfig.SCHEMA_WHITELIST, "nopk") + .with(PostgresConnectorConfig.SCHEMA_INCLUDE_LIST, "nopk") .build()); assertConnectorIsRunning(); waitForStreamingToStart(); diff --git a/debezium-connector-sqlserver/src/main/java/io/debezium/connector/sqlserver/SqlServerConnectorConfig.java b/debezium-connector-sqlserver/src/main/java/io/debezium/connector/sqlserver/SqlServerConnectorConfig.java index b8acf4225..94c545b1a 100644 --- a/debezium-connector-sqlserver/src/main/java/io/debezium/connector/sqlserver/SqlServerConnectorConfig.java +++ b/debezium-connector-sqlserver/src/main/java/io/debezium/connector/sqlserver/SqlServerConnectorConfig.java @@ -361,7 +361,6 @@ public static SnapshotIsolationMode parse(String value, String defaultValue) { INCREMENTAL_SNAPSHOT_CHUNK_SIZE, INCREMENTAL_SNAPSHOT_ALLOW_SCHEMA_CHANGES) .excluding( - SCHEMA_WHITELIST, SCHEMA_INCLUDE_LIST, SCHEMA_BLACKLIST, SCHEMA_EXCLUDE_LIST) diff --git a/debezium-core/src/main/java/io/debezium/relational/RelationalDatabaseConnectorConfig.java b/debezium-core/src/main/java/io/debezium/relational/RelationalDatabaseConnectorConfig.java index 2b7f22961..73937dceb 100644 --- a/debezium-core/src/main/java/io/debezium/relational/RelationalDatabaseConnectorConfig.java +++ b/debezium-core/src/main/java/io/debezium/relational/RelationalDatabaseConnectorConfig.java @@ -65,7 +65,6 @@ public abstract class RelationalDatabaseConnectorConfig extends CommonConnectorC public static final String COLUMN_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG = "\"column.include.list\" is already specified"; public static final String COLUMN_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG = "\"column.whitelist\" is already specified"; public static final String SCHEMA_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG = "\"schema.include.list\" is already specified"; - public static final String SCHEMA_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG = "\"schema.whitelist\" is already specified"; public static final String DATABASE_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG = "\"database.include.list\" is already specified"; public static final String DATABASE_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG = "\"database.whitelist\" is already specified"; @@ -358,20 +357,6 @@ public static DecimalHandlingMode parse(String value, String defaultValue) { .withDependents(TABLE_INCLUDE_LIST_NAME) .withDescription("The schemas for which events should be captured"); - /** - * Old, backwards-compatible "whitelist" property. - */ - @Deprecated - public static final Field SCHEMA_WHITELIST = Field.create("schema.whitelist") - .withDisplayName("Deprecated: Include Schemas") - .withType(Type.LIST) - .withWidth(Width.LONG) - .withImportance(Importance.LOW) - .withValidation(Field::isListOfRegex) - .withDependents(TABLE_INCLUDE_LIST_NAME) - .withInvisibleRecommender() - .withDescription("The schemas for which events should be captured (deprecated, use \"" + SCHEMA_INCLUDE_LIST.name() + "\" instead)"); - /** * A comma-separated list of regular expressions that match schema names to be excluded from monitoring. * Must not be used with {@link #SCHEMA_INCLUDE_LIST}. @@ -572,7 +557,6 @@ public static DecimalHandlingMode parse(String value, String defaultValue) { TABLE_INCLUDE_LIST, TABLE_EXCLUDE_LIST, TABLE_IGNORE_BUILTIN, - SCHEMA_WHITELIST, SCHEMA_INCLUDE_LIST, SCHEMA_BLACKLIST, SCHEMA_EXCLUDE_LIST, @@ -684,7 +668,7 @@ public String schemaExcludeList() { } public String schemaIncludeList() { - return getConfig().getFallbackStringProperty(SCHEMA_INCLUDE_LIST, SCHEMA_WHITELIST); + return getConfig().getString(SCHEMA_INCLUDE_LIST); } public String tableExcludeList() { @@ -799,11 +783,11 @@ public Heartbeat createHeartbeat(TopicSelector topic } private static int validateSchemaBlacklist(Configuration config, Field field, Field.ValidationOutput problems) { - String whitelist = config.getFallbackStringPropertyWithWarning(SCHEMA_INCLUDE_LIST, SCHEMA_WHITELIST); + String includeList = config.getString(SCHEMA_INCLUDE_LIST); String blacklist = config.getFallbackStringPropertyWithWarning(SCHEMA_EXCLUDE_LIST, SCHEMA_BLACKLIST); - if (whitelist != null && blacklist != null) { - problems.accept(SCHEMA_BLACKLIST, blacklist, SCHEMA_WHITELIST_ALREADY_SPECIFIED_ERROR_MSG); + if (includeList != null && blacklist != null) { + problems.accept(SCHEMA_BLACKLIST, blacklist, SCHEMA_INCLUDE_LIST_ALREADY_SPECIFIED_ERROR_MSG); return 1; } return 0; diff --git a/debezium-core/src/main/java/io/debezium/relational/RelationalTableFilters.java b/debezium-core/src/main/java/io/debezium/relational/RelationalTableFilters.java index 7a8d0e158..6081d1cf0 100644 --- a/debezium-core/src/main/java/io/debezium/relational/RelationalTableFilters.java +++ b/debezium-core/src/main/java/io/debezium/relational/RelationalTableFilters.java @@ -44,10 +44,7 @@ public RelationalTableFilters(Configuration config, TableFilter systemTablesFilt config.getFallbackStringProperty( RelationalDatabaseConnectorConfig.DATABASE_EXCLUDE_LIST, RelationalDatabaseConnectorConfig.DATABASE_BLACKLIST)) - .includeSchemas( - config.getFallbackStringProperty( - RelationalDatabaseConnectorConfig.SCHEMA_INCLUDE_LIST, - RelationalDatabaseConnectorConfig.SCHEMA_WHITELIST)) + .includeSchemas(config.getString(RelationalDatabaseConnectorConfig.SCHEMA_INCLUDE_LIST)) .excludeSchemas( config.getFallbackStringProperty( RelationalDatabaseConnectorConfig.SCHEMA_EXCLUDE_LIST,