Skip to main content

Pylon Migration Guide

Upgrading to 1.0.0​

Risk of permanent data loss

Clearing a stream deletes its data in your destination. Back up the affected tables before clearing. Before clearing issues or issue_messages, set Start Date (start_date) early enough to cover the history you need. By default, the connector only re-reads the last 30 days for these streams.

What changed​

Version 1.0.0 corrects the declared field types to match the Pylon API. Typed destinations previously nulled the string tags because the schema declared objects. Eight timestamp fields now have a date-time format.

StreamFieldOld typeNew type
accountstagsarray of objectsarray of strings
issuestagsarray of objectsarray of strings
accountscreated_atnullable stringnullable string, format: date-time
issuesfirst_response_timenullable stringnullable string, format: date-time
issuesresolution_timenullable stringnullable string, format: date-time
issueslatest_message_timenullable stringnullable string, format: date-time
issuessnoozed_until_timenullable stringnullable string, format: date-time
issue_messagestimestampnullable stringnullable string, format: date-time
custom_fieldscreated_atnullable stringnullable string, format: date-time
custom_fieldsupdated_atnullable stringnullable string, format: date-time

Who is affected​

Connections syncing accounts, issues, issue_messages or custom_fields are affected. Connections syncing none of these streams need no action.

Upgrade steps​

  1. If your destination is ClickHouse, you can check your server before upgrading by running SELECT CAST('2026-01-10T12:00:00Z' AS Nullable(DateTime64(3))). If it returns NULL, your server is affected, and you'll need the ClickHouse step below.
  2. Upgrade the connector to 1.0.0.
  3. Refresh the source schema and accept the changes.
  4. Destinations that can't change a column's type in place, such as S3 Data Lake and other Iceberg destinations, must clear the affected streams. Back up the affected tables first, before clearing. Before clearing issues or issue_messages, set Start Date (start_date) early enough to cover the history you need. The default only re-reads the last 30 days.
  5. If your destination is ClickHouse, existing values in the changed timestamp columns may be set to null during the upgrade, depending on your ClickHouse version. With Full Refresh | Overwrite, accounts and custom_fields are fully rewritten on the next sync. For issues and issue_messages, after upgrading: back up the tables, set Start Date (start_date) early enough to cover the history you need, then clear issues and issue_messages and sync again.
  6. Sync the connection.

With Full Refresh | Overwrite, accounts and custom_fields are fully rewritten on the next sync. With Full Refresh | Append, rows synced before the upgrade stay next to the new ones until you clear the stream. issue_messages uses full refresh but only re-reads messages for issues updated since Start Date, so it is limited like issues. issues is incremental. Rows synced before the upgrade keep nulled tags until the stream is cleared and synced again. To replace those tags, back up the table, set Start Date before the history you need, then clear issues and sync again.

Update downstream queries​

  • The 8 timestamp columns in the preceding table are now timestamp columns instead of text. Update SQL, dbt models and dashboards that treat them as text, for example string comparisons, LIKE, substrings or casts from strings.
  • tags on accounts and issues is now an array of strings. Update anything that expects objects, such as tags[0]:name, or that worked around the old null values.

Connector upgrade guide​

Review the following information to prepare for and execute your upgrade.

Review the changelog​

Before updating a connector, review the changelog to understand the changes and their potential impact on your existing connections. Find the changelog for any connector by navigating to the bottom of the documentation for that connector. Major version releases also include a migration guide.

Plan for major updates​

Major updates may require you to adjust connection settings or even make changes to your data pipelines. Allocate enough time and resources for this. Use the migration guide to ensure your transition process goes smoothly.

Airbyte provides tooling that guarantees safe connector version bumps and enforces automated version bumps for minor and patch updates. You always need to manually update for major version bumps.

Self-managed plans: pin a specific version if you can't update​

If you're unable to upgrade to the new version of a connector, you can pin that connector to a specific version.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Edit the entry for the connector you want to pin.

  3. Set the Default Version to the version you want to use.

Self-managed plans: update the local connector image​

If you self-manage Airbyte, you must manually update the connector image in your local registry before proceeding with the migration. Follow the steps below.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Find the connector you want to update in the list of connectors.

    note

    Airbyte lists two versions, the current in-use version and the latest version available.

  3. Click Change to update your OSS version to the latest available version.

Update the connector version​

Update each instance of the connector separately. If you have multiple instances of a connector, updating one doesn't affect the others.

  1. In the navigation bar:

    • If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.

    • If you're on any other plan, click Workspace settings > Sources/Destinations.

  2. Select the instance of the connector you wish to upgrade.

  3. Select Upgrade.

  4. Follow the prompt to confirm you are ready to upgrade to the new version.

Clear data from affected streams​

After upgrading a connector with a breaking change, you must refresh affected schemas and clear your data.

  1. In the nav bar, click Connections.

  2. Find the connection affected by the upgrade.

  3. Click the Schema tab.

  4. Click Refresh source schema (looks like ). When Airbyte finishes, it shows you any detected schema changes.

  5. Click OK.

  6. Click Save changes

  7. Clear the data for the streams affected by this upgrade.

Once the clear is complete, you can begin syncing your data again as usual.