Skip to main content

GitBook Migration Guide

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable PyAirbyte
Connector type (beta)
Available Data replicationNot available Agent(learn more)
Support Level
Marketplace
Connector Version
0.0.64 (last updated 4 days ago)
Sync Success Rate
Low
Usage Rate
Low
Data workers used
0.2 per sync (Learn more)
Definition ID
d1fcdf3a-dcfd-4b2e-a32c-d8a7a2e9790c

Upgrading to 0.1.0​

Version 0.1.0 removes the insights_traffic stream.

What changed​

The insights_traffic stream, which read page-view counts from GET /v1/spaces/{spaceId}/insights/traffic, has been removed from the connector. The users, organizations, content, and org_members streams are unchanged.

Why this changed​

GitBook removed the GET /v1/spaces/{spaceId}/insights/traffic endpoint from its public API. The endpoint now returns 404 API operation not found and no longer appears in GitBook's published OpenAPI specification (https://api.gitbook.com/openapi.json). Site analytics are now exposed only through the org/site-scoped POST /v1/orgs/{organizationId}/sites/{siteId}/insights/events/aggregate endpoint, which requires an organization and site ID rather than a space ID and returns a different data shape, so it is not a drop-in replacement for this stream. Any sync that selected insights_traffic failed with a 404 error.

Who is affected​

Only connections that have the insights_traffic stream selected. Connections syncing only users, organizations, content, or org_members are not affected and require no action.

Required actions​

  1. Upgrade the connector to 0.1.0.
  2. Open the connection's Schema tab and refresh the source schema. The insights_traffic stream will disappear from the list; confirm the schema change.
  3. Optionally drop the insights_traffic table in your destination; the connector will no longer write to it.

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.

Was this page helpful?