Skip to content

Commit 8f269a9

Browse files
maxenglandermaxenglander
authored
rename vitess to planetscale in package names and artifacts (#3)
I want to make it as easy as possible for users to try out the PlanetScale connector with Debezium Server. Debezium Server comes bundled with the connector for Vitess, and I don't want users to have to remove or replace that JAR in order to use ours. So: * Produce `-planetscale` artifacts instead of `-vitess`. * Rename `vitess` package names to `planetscale`. * Define a `PlanetScaleConnector` class that extends the `VitessConnector` with no additions or changes. This way our JAR can live alongside the Vitess one without any class conflicts, and users can specify they want to use the PlanetScale connector with: ``` debezium.source.connector.class=io.debezium.connector.planetscale.PlanetScaleConnector ``` Other Vitess-oriented configs will remain unchanged, e.g.: ``` debezium.source.vitess.keyspace=<planetscale-database-name> ``` Signed-off-by: Max Englander <[email protected]>
1 parent bd58cfb commit 8f269a9

File tree

84 files changed

+188
-176
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+188
-176
lines changed

‎README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@
99
Copyright Debezium Authors.
1010
Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
1111

12-
# Debezium Connector Vitess
12+
# Debezium Connector PlanetScale
1313

1414
Debezium is an open source project that provides a low latency data streaming platform for change data capture (CDC).
1515

16-
This repository contains incubating connector for [Vitess](https://vitess.io/) which is in an **early stage of its development**.
17-
You are encouraged to explore this connector and test it, but it is not recommended yet for production usage.
18-
E.g. the format of emitted messages may change, specific features may not be implemented yet etc.
16+
This repository contains PlanetScale's fork of the incubating connector for
17+
[Vitess](https://vitess.io/) which is in an **early stage of its development**.
18+
You are encouraged to explore this connector and test it, but it is not
19+
recommended yet for production usage. E.g. the format of emitted messages may
20+
change, specific features may not be implemented yet etc.
1921

2022
## Supported Features
2123

‎pom.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
</parent>
99

1010
<modelVersion>4.0.0</modelVersion>
11-
<artifactId>debezium-connector-vitess</artifactId>
11+
<artifactId>debezium-connector-planetscale</artifactId>
1212
<version>2.4.0.Final</version>
13-
<name>Debezium Connector for Vitess</name>
13+
<name>Debezium Connector for PlanetScale</name>
1414
<packaging>jar</packaging>
1515

1616
<properties>

‎src/main/java/io/debezium/connector/vitess/Filters.java ‎src/main/java/io/debezium/connector/planetscale/Filters.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.Arrays;
99
import java.util.List;

‎src/main/java/io/debezium/connector/vitess/Module.java ‎src/main/java/io/debezium/connector/planetscale/Module.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,26 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.Properties;
99

1010
import io.debezium.util.IoUtil;
1111

1212
public class Module {
13-
private static final Properties INFO = IoUtil.loadProperties(Module.class, "io/debezium/connector/vitess/build.version");
13+
private static final Properties INFO = IoUtil.loadProperties(Module.class, "io/debezium/connector/planetscale/build.version");
1414

1515
public static String version() {
1616
return INFO.getProperty("version");
1717
}
1818

1919
/** @return name of the connector plugin */
2020
public static String name() {
21-
return "vitess";
21+
return "planetscale";
2222
}
2323

2424
/** @return context name used in log MDC and JMX metrics */
2525
public static String contextName() {
26-
return "Vitess";
26+
return "PlanetScale";
2727
}
2828
}

‎src/main/java/io/debezium/connector/planetscale/PlanetScaleConnector.java

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/*
2+
* Copyright Debezium Authors.
3+
*
4+
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
5+
*/
6+
package io.debezium.connector.planetscale;
7+
8+
/** PlanetScale Connector entry point */
9+
public class PlanetScaleConnector extends VitessConnector {
10+
}

‎src/main/java/io/debezium/connector/vitess/SourceInfo.java ‎src/main/java/io/debezium/connector/planetscale/SourceInfo.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.time.Instant;
99

‎src/main/java/io/debezium/connector/vitess/TableTopicNamingStrategy.java ‎src/main/java/io/debezium/connector/planetscale/TableTopicNamingStrategy.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.Properties;
99

‎src/main/java/io/debezium/connector/vitess/VStreamCopyCompletedEventException.java ‎src/main/java/io/debezium/connector/planetscale/VStreamCopyCompletedEventException.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
/**
99
* Used to signal that Debezium should not continue consuming the streaming event source after encountering a COPY_COMPLETED VEvent from the VStream and when snapshot.mode=initial_only.

‎src/main/java/io/debezium/connector/vitess/Vgtid.java ‎src/main/java/io/debezium/connector/planetscale/Vgtid.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.ArrayList;
99
import java.util.List;

‎src/main/java/io/debezium/connector/vitess/VitessChangeEventSourceFactory.java ‎src/main/java/io/debezium/connector/planetscale/VitessChangeEventSourceFactory.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

8-
import io.debezium.connector.vitess.connection.ReplicationConnection;
8+
import io.debezium.connector.planetscale.connection.ReplicationConnection;
99
import io.debezium.jdbc.DefaultMainConnectionProvidingConnectionFactory;
1010
import io.debezium.pipeline.ErrorHandler;
1111
import io.debezium.pipeline.EventDispatcher;

‎src/main/java/io/debezium/connector/vitess/VitessChangeRecordEmitter.java ‎src/main/java/io/debezium/connector/planetscale/VitessChangeRecordEmitter.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.List;
99
import java.util.Objects;
@@ -14,7 +14,7 @@
1414
import org.slf4j.LoggerFactory;
1515

1616
import io.debezium.connector.base.ChangeEventQueue;
17-
import io.debezium.connector.vitess.connection.ReplicationMessage;
17+
import io.debezium.connector.planetscale.connection.ReplicationMessage;
1818
import io.debezium.data.Envelope;
1919
import io.debezium.pipeline.EventDispatcher;
2020
import io.debezium.relational.Column;

‎src/main/java/io/debezium/connector/vitess/VitessConnector.java ‎src/main/java/io/debezium/connector/planetscale/VitessConnector.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.sql.Timestamp;
99
import java.time.Instant;
@@ -32,7 +32,7 @@
3232

3333
import io.debezium.config.Configuration;
3434
import io.debezium.connector.common.RelationalBaseSourceConnector;
35-
import io.debezium.connector.vitess.connection.VitessReplicationConnection;
35+
import io.debezium.connector.planetscale.connection.VitessReplicationConnection;
3636
import io.debezium.relational.RelationalDatabaseConnectorConfig;
3737
import io.debezium.relational.Tables;
3838
import io.debezium.util.Strings;

‎src/main/java/io/debezium/connector/vitess/VitessConnectorConfig.java ‎src/main/java/io/debezium/connector/planetscale/VitessConnectorConfig.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.io.FileInputStream;
99
import java.io.IOException;
@@ -40,8 +40,8 @@
4040
import io.debezium.config.Field;
4141
import io.debezium.config.Field.ValidationOutput;
4242
import io.debezium.connector.SourceInfoStructMaker;
43-
import io.debezium.connector.vitess.connection.BasicAuthenticationInterceptor;
44-
import io.debezium.connector.vitess.connection.VitessTabletType;
43+
import io.debezium.connector.planetscale.connection.BasicAuthenticationInterceptor;
44+
import io.debezium.connector.planetscale.connection.VitessTabletType;
4545
import io.debezium.jdbc.JdbcConfiguration;
4646
import io.debezium.relational.ColumnFilterMode;
4747
import io.debezium.relational.HistorizedRelationalDatabaseConnectorConfig;

‎src/main/java/io/debezium/connector/vitess/VitessConnectorTask.java ‎src/main/java/io/debezium/connector/planetscale/VitessConnectorTask.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.List;
99
import java.util.stream.Collectors;
@@ -17,9 +17,9 @@
1717
import io.debezium.config.Field;
1818
import io.debezium.connector.base.ChangeEventQueue;
1919
import io.debezium.connector.common.BaseSourceTask;
20-
import io.debezium.connector.vitess.connection.ReplicationConnection;
21-
import io.debezium.connector.vitess.connection.VitessReplicationConnection;
22-
import io.debezium.connector.vitess.metrics.VitessChangeEventSourceMetricsFactory;
20+
import io.debezium.connector.planetscale.connection.ReplicationConnection;
21+
import io.debezium.connector.planetscale.connection.VitessReplicationConnection;
22+
import io.debezium.connector.planetscale.metrics.VitessChangeEventSourceMetricsFactory;
2323
import io.debezium.pipeline.ChangeEventSourceCoordinator;
2424
import io.debezium.pipeline.DataChangeEvent;
2525
import io.debezium.pipeline.ErrorHandler;

‎src/main/java/io/debezium/connector/vitess/VitessDDLEmitter.java ‎src/main/java/io/debezium/connector/planetscale/VitessDDLEmitter.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.Objects;
99
import java.util.function.Predicate;
@@ -13,7 +13,7 @@
1313
import org.slf4j.Logger;
1414
import org.slf4j.LoggerFactory;
1515

16-
import io.debezium.connector.vitess.connection.ReplicationMessage;
16+
import io.debezium.connector.planetscale.connection.ReplicationMessage;
1717
import io.debezium.pipeline.EventDispatcher;
1818
import io.debezium.relational.Table;
1919
import io.debezium.relational.TableId;

‎src/main/java/io/debezium/connector/vitess/VitessDatabaseSchema.java ‎src/main/java/io/debezium/connector/planetscale/VitessDatabaseSchema.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import org.apache.kafka.connect.data.Schema;
99
import org.slf4j.Logger;

‎src/main/java/io/debezium/connector/vitess/VitessErrorHandler.java ‎src/main/java/io/debezium/connector/planetscale/VitessErrorHandler.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import org.slf4j.Logger;
99
import org.slf4j.LoggerFactory;

‎src/main/java/io/debezium/connector/vitess/VitessEventMetadataProvider.java ‎src/main/java/io/debezium/connector/planetscale/VitessEventMetadataProvider.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.time.Instant;
99
import java.util.Map;

‎src/main/java/io/debezium/connector/vitess/VitessOffsetContext.java ‎src/main/java/io/debezium/connector/planetscale/VitessOffsetContext.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.time.Instant;
99
import java.util.HashMap;
@@ -15,7 +15,7 @@
1515
import org.slf4j.LoggerFactory;
1616

1717
import io.debezium.connector.SnapshotRecord;
18-
import io.debezium.connector.vitess.connection.VitessReplicationConnection;
18+
import io.debezium.connector.planetscale.connection.VitessReplicationConnection;
1919
import io.debezium.pipeline.CommonOffsetContext;
2020
import io.debezium.pipeline.spi.OffsetContext;
2121
import io.debezium.pipeline.txmetadata.TransactionContext;

‎src/main/java/io/debezium/connector/vitess/VitessPartition.java ‎src/main/java/io/debezium/connector/planetscale/VitessPartition.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.Collections;
99
import java.util.Map;

‎src/main/java/io/debezium/connector/vitess/VitessSchemaFactory.java ‎src/main/java/io/debezium/connector/planetscale/VitessSchemaFactory.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import io.debezium.schema.SchemaFactory;
99

‎src/main/java/io/debezium/connector/vitess/VitessSnapshotChangeEventSource.java ‎src/main/java/io/debezium/connector/planetscale/VitessSnapshotChangeEventSource.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.List;
99
import java.util.Map;

‎src/main/java/io/debezium/connector/vitess/VitessSourceInfoStructMaker.java ‎src/main/java/io/debezium/connector/planetscale/VitessSourceInfoStructMaker.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import org.apache.kafka.connect.data.Schema;
99
import org.apache.kafka.connect.data.Struct;
@@ -20,7 +20,7 @@ public class VitessSourceInfoStructMaker extends AbstractSourceInfoStructMaker<S
2020
public void init(String connector, String version, CommonConnectorConfig connectorConfig) {
2121
super.init(connector, version, connectorConfig);
2222
this.schema = commonSchemaBuilder()
23-
.name("io.debezium.connector.vitess.Source")
23+
.name("io.debezium.connector.planetscale.Source")
2424
.field(SourceInfo.KEYSPACE_NAME_KEY, Schema.STRING_SCHEMA)
2525
.field(SourceInfo.TABLE_NAME_KEY, Schema.STRING_SCHEMA)
2626
.field(SourceInfo.SHARD_KEY, Schema.STRING_SCHEMA)

‎src/main/java/io/debezium/connector/vitess/VitessStreamingChangeEventSource.java ‎src/main/java/io/debezium/connector/planetscale/VitessStreamingChangeEventSource.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.util.Objects;
99
import java.util.concurrent.atomic.AtomicReference;
@@ -12,10 +12,10 @@
1212
import org.slf4j.LoggerFactory;
1313

1414
import io.debezium.connector.SnapshotRecord;
15-
import io.debezium.connector.vitess.VitessConnectorConfig.SnapshotMode;
16-
import io.debezium.connector.vitess.connection.ReplicationConnection;
17-
import io.debezium.connector.vitess.connection.ReplicationMessage;
18-
import io.debezium.connector.vitess.connection.ReplicationMessageProcessor;
15+
import io.debezium.connector.planetscale.VitessConnectorConfig.SnapshotMode;
16+
import io.debezium.connector.planetscale.connection.ReplicationConnection;
17+
import io.debezium.connector.planetscale.connection.ReplicationMessage;
18+
import io.debezium.connector.planetscale.connection.ReplicationMessageProcessor;
1919
import io.debezium.pipeline.ErrorHandler;
2020
import io.debezium.pipeline.EventDispatcher;
2121
import io.debezium.pipeline.source.spi.StreamingChangeEventSource;

‎src/main/java/io/debezium/connector/vitess/VitessTableIdToStringMapper.java ‎src/main/java/io/debezium/connector/planetscale/VitessTableIdToStringMapper.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import io.debezium.relational.Selectors.TableIdToStringMapper;
99
import io.debezium.relational.TableId;

‎src/main/java/io/debezium/connector/vitess/VitessTaskContext.java ‎src/main/java/io/debezium/connector/planetscale/VitessTaskContext.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import io.debezium.connector.common.CdcSourceTaskContext;
99

‎src/main/java/io/debezium/connector/vitess/VitessTopicSelector.java ‎src/main/java/io/debezium/connector/planetscale/VitessTopicSelector.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import io.debezium.relational.TableId;
99
import io.debezium.schema.TopicSelector;

‎src/main/java/io/debezium/connector/vitess/VitessType.java ‎src/main/java/io/debezium/connector/planetscale/VitessType.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.sql.Types;
99
import java.util.ArrayList;

‎src/main/java/io/debezium/connector/vitess/VitessValueConverter.java ‎src/main/java/io/debezium/connector/planetscale/VitessValueConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess;
6+
package io.debezium.connector.planetscale;
77

88
import java.math.BigDecimal;
99
import java.util.List;

‎src/main/java/io/debezium/connector/vitess/connection/BasicAuthenticationInterceptor.java ‎src/main/java/io/debezium/connector/planetscale/connection/BasicAuthenticationInterceptor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
55
*/
6-
package io.debezium.connector.vitess.connection;
6+
package io.debezium.connector.planetscale.connection;
77

88
import java.util.Base64;
99

0 commit comments

Comments
 (0)