8000 update: Debezium connector updates by harshini-rangaswamy · Pull Request #869 · aiven/aiven-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

update: Debezium connector updates #869

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
merged 5 commits into from
Jun 13, 2025
Merged

update: Debezium connector updates #869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c953991
fix: conflicts
harshini-rangaswamy Jun 13, 2025
241ef8e
update: content
harshini-rangaswamy May 23, 2025
552db3b
update: add limition
harshini-rangaswamy May 28, 2025
fcdd8f2
update: content
harshini-rangaswamy Jun 13, 2025
b6930bd
update: info
harshini-rangaswamy Jun 13, 2025
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
56 changes: 28 additions & 28 deletions docs/products/kafka/kafka-connect/howto/manage-connector-versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,55 +29,52 @@ service configuration.
- Multi-version support is available for all connectors where Aiven has published and
supports more than one version. Support will continue to expand as new versions are
released.
- If no version is set, the latest available version is used.
- Refer to [Check available connector versions](#check-available-connector-versions) to
- Set a specific version to prevent automatic upgrades. If not set, the latest published
version is used.
- See [Check available connector versions](#check-available-connector-versions) to
confirm which versions are supported before setting a version.

:::warning
Breaking changes may exist between different connector versions. These changes often
involve updates to configuration parameters, such as the removal of deprecated parameters
Breaking changes may exist between different connector versions. These changes often
involve updates to configuration parameters, such as the removal of deprecated parameters
or the introduction of new ones.
Before upgrading:
- Review the connector release notes for details on changes.
- Always test a connector version change in a non-production environment before applying it
in production.
:::

## Supported connectors and versions

:::note
All versions listed in the table are supported unless explicitly noted otherwise.
Aiven supports multiple Debezium versions through multi-version support, including
versions 1.9.7, 2.5.0, 2.7.4, and 3.1.0.

To prevent automatic upgrades during maintenance, pin the connector version using
the `plugin_versions` property.

If you use Debezium for PostgreSQL with version 1.9.7 and the `wal2json` format, do not
upgrade to version 2.0 or later until you migrate to `pgoutput`.

For upgrade steps, see [Set a connector version](#set-version).
:::


| Connector | Versions |
|---------------------|-----------------------|
| Debezium | `2.5.0` (recommended) <br /> `1.9.7` (deprecated) |
| JDBC | `6.10.0` (recommended) <br /> `6.9.0` (deprecated) |
| Snowflake | `2.3.0` (recommended) <br /> `2.2.0` |
## Limitations

Connector version selection is available in the Aiven Console only
for [dedicated Apache Kafka Connect services](/docs/products/kafka/kafka-connect/get-started#apache_kafka_connect_dedicated_cluster).

:::tip
This is a partial list of connectors, and it may change as new versions are released. To
view the most up-to-date versions, see
[Check available connector versions](#check-available-connector-versions).
:::
If you enabled [Apache Kafka Connect](/docs/products/kafka/kafka-connect/howto/enable-connect)
as part of an Aiven for Apache Kafka service, use the [Aiven API](https://api.aiven.io/doc/),
[Aiven CLI](/docs/tools/cli), or
[Aiven Provider for Terraform](https://registry.terraform.io/providers/aiven/aiven/latest/docs)
to set the connector version.

:::note
If you are using version `1.9.7` of the Debezium connector, you can upgrade to
version `2.5.0` without raising a support ticket. To upgrade, set version `2.5.0` in
your configuration. For details, see [Set a connector version](#set-version).
:::

## Prerequisites

- [Aiven for Apache Kafka® service](/docs/products/kafka/kafka-connect/howto/enable-connect)
with a [dedicated Aiven for Apache Kafka Connect® service](/docs/products/kafka/kafka-connect/get-started#apache_kafka_connect_dedicated_cluster)
enabled

:::note
Multi-version support is only available for dedicated Apache Kafka Connect services.
:::
- [Aiven CLI](/docs/tools/cli)
- [Aiven API](/docs/tools/api)
- [Aiven Provider for Terraform](/docs/tools/terraform)
Expand Down Expand Up @@ -184,10 +181,14 @@ Changing the connector version restarts the Apache Kafka Connect service and rel
all plugins. This process can take several minutes.
:::


<Tabs groupId="check-method">
<TabItem value="console" label="Aiven Console" default>

:::note
Connector version selection in the Aiven Console is available only for
[dedicated Apache Kafka Connect services](/docs/products/kafka/kafka-connect/get-started#apache_kafka_connect_dedicated_cluster).
:::

1. In your Aiven for Apache Kafka Connect service, click <ConsoleLabel name="Connectors"/>.
1. In the **Enabled connectors** section, locate the connector to update.
1. Click <ConsoleLabel name="actions"/> > **Change connector version**.
Expand Down Expand Up @@ -289,7 +290,6 @@ After setting a version, confirm that the correct version is in use.
```bash
curl -X GET "https://api.aiven.io/v1/project/<project_name>/service/<service_name>" \
-H "Authorization: Bearer <api_token>"

```

1. Review the `plugin_versions` property in the response to verify the set version.
Expand Down
2 changes: 1 addition & 1 deletion external/terraform-provider
Open in desktop
Submodule terraform-provider updated 241 files
21 changes: 13 additions & 8 deletions static/includes/debezium-breakingchange.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
:::note
**Breaking changes in Debezium 2.5**
Aiven supports multiple Debezium versions through multi-version support, including
versions 1.9.7, 2.5.0, 2.7.4, and 3.1.0.

Debezium version 2.5 introduces changes to the connector's configuration and behavior.
New setups [default to version 2.5](https://debezium.io/releases/2.5/release-notes),
while existing setups using version 1.9 remain on that version for stability.
Debezium 2.5 introduced changes to connector configuration and behavior. To prevent
unintentional upgrades during maintenance updates, pin the connector version using the
`plugin_versions` configuration property.
For details, see [Manage connector versions](/docs/products/kafka/kafka-connect/howto/manage-connector-versions).

If you are using version 1.9.7, you can upgrade to version 2.5.0 using the
[multi-version support](/docs/products/kafka/kafka-connect/howto/manage-connector-versions)
without raising a support ticket. Ensure compatibility by testing version 2.5
configurations before upgrading.
If you use Debezium for PostgreSQL version 1.9.7 with the `wal2json` replication format,
do not upgrade to version 2.0 or later until you migrate to a supported format such as
`pgoutput`.

To upgrade from version 1.9.7, use multi-version support to test your configuration
before applying changes in production.

For further assistance, contact [Aiven support](mailto:support@aiven.io).

:::
0