Ramp Migration Guide

Availability

Core Standard Plus Pro Enterprise Flex PyAirbyte

Connector type (beta)

Data replication Agent(learn more)

Support Level

Marketplace

Connector Version

0.3.0 (last updated 4 days ago)

Sync Success Rate

Medium

Usage Rate

Low

Data workers used

0.2 per sync (Learn more)

Definition ID

57e906dd-03c3-4d2a-8b4c-e3334acaf8b4

Upgrading to 1.0.0

Risk of permanent data loss

The upgrade asks you to clear the cards, transactions and reimbursements streams. Clearing deletes their data in your destination. The next sync reads back only the current version of each record: transactions and reimbursements from your start date onward, and cards without terminated cards, because Ramp doesn't return them. With an Append mode, the earlier copies of a record that Append kept don't come back. In any mode, records older than your start date and terminated cards don't come back. Back up these tables before you clear them if you need that data.

Version 1.0.0 declares the date and timestamp fields of the cards, transactions and reimbursements streams with their real types. Ramp returns these values in ISO 8601 format, but earlier versions declared them as plain strings, so destinations stored them as text and you had to cast them before filtering or joining by date. Every ISO 8601 date field of the other 15 streams was already typed when the stream was added.

What changed

These 13 fields change type. Destinations that type their columns change the matching columns from text to the new type.

Stream	Field	New type
cards	created_at	Timestamp with time zone
transactions	accounting_date	Timestamp with time zone
transactions	settlement_date	Timestamp with time zone
transactions	synced_at	Timestamp with time zone
transactions	updated_at	Timestamp with time zone
transactions	user_transaction_time	Timestamp with time zone
reimbursements	accounting_date	Timestamp with time zone
reimbursements	approved_at	Timestamp with time zone
reimbursements	created_at	Timestamp with time zone
reimbursements	submitted_at	Timestamp with time zone
reimbursements	synced_at	Timestamp with time zone
reimbursements	updated_at	Timestamp with time zone
reimbursements	transaction_date	Date

The values themselves don't change, and no field is added or removed. transactions.accounting_date and settlement_date are full timestamps despite their names, because that is what Ramp returns.

Three date-like fields stay strings because Ramp doesn't return them in ISO 8601 format: cards.expiration (MMYY, for example 0430) and business_balance.next_billing_date and prev_billing_date (MM/DD/YYYY).

Who is affected

Connections that sync at least one of the cards, transactions and reimbursements streams. Connections that sync none of them aren't affected.

Upgrade steps

1. Back up the cards, transactions and reimbursements tables if you need their current data. Step 3 clears them.
2. Upgrade the connector to 1.0.0.
3. Before the connection's next sync, refresh the source schema, and clear the cards, transactions and reimbursements streams. Don't skip the clear: not every destination can convert the existing text values to the new types in place. The connector upgrade guide below has the steps.
4. Sync the connection. The transactions and reimbursements streams re-read every record updated since your start date, or since 2019-01-01 if you didn't set one.

Update downstream queries

Update the SQL, dbt models, dashboards and exports that read the 13 fields above:

• Remove the casts and date-parsing functions you added to turn these columns into dates, such as CAST(updated_at AS TIMESTAMP), PARSE_TIMESTAMP or TO_TIMESTAMP.
• Replace string functions on these columns, such as LIKE '2026-%' or SUBSTRING(transaction_date, 1, 7), with date and timestamp functions.

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.