Upgrade the Data Transforms SDK

Upgrading the SDK version in your data transforms project ensures compatibility with the latest features and fixes. This guide provides step-by-step instructions to upgrade the SDK version for all supported SDK languages.

Prerequisites

Before upgrading, check the compatibility matrix to ensure the new SDK version is compatible with your Redpanda version.

Upgrade your local SDK version

  • Go

  • Rust

  • JavaScript

  1. Open your project’s root directory.

  2. Run the following command to update the SDK:

    go get github.com/redpanda-data/redpanda/src/transform-sdk/go/transform@v<version>

  3. Clean up the go.mod and go.sum files:

    go mod tidy

  1. Open the Cargo.toml file in your project’s root directory. This file specifies the dependencies for your Rust project.

  2. Locate the line that specifies the Redpanda SDK version. It will look something like this:

    [dependencies]
redpanda-transform-sdk = "<version>"

  3. Change the version to the one you want to upgrade to.

  4. Run the following command to update the dependencies:

    cargo update -p redpanda-transform-sdk

  1. Open the package.json file in your project’s root directory.

  2. Locate the line that specifies the data transforms SDK version. It will look something like this:

    {
  "dependencies": {
    "@redpanda-data/transform-sdk": "<version>"
  },
}

  3. Run the following command to update the SDK:

    npm install --save @redpanda-data/transform-sdk@<version>

  4. Verify the update by checking the package.json file, the package-lock.json file, and the node_modules/ directory.

Next steps

Run your tests to ensure everything works correctly with the new SDK version.