Connector SDK - Build Custom Connectors

Fivetran’s Connector SDK allows you to develop a custom data connector using Python and deploy it as an extension of Fivetran. Fivetran automatically manages running Connector SDK connections on your scheduled frequency and manages the required compute resources, eliminating the need for a third-party provider.

Connector SDK provides native support for many Fivetran features and relies on existing Fivetran technology. It also eliminates timeout and data size limitations seen in AWS Lambda.

---

Custom connector development process

Setup Guide

Setup guide for those getting started with or needing a refresher on the Connector SDK.

Working with Connector SDK

Learn about the SDK runtime environment and how to work with important entities.

Methods and Operations used by Connector SDK

Learn about the required object, methods, and operations used by Connector SDK.

When developing a custom connector using the Connector SDK, given that all prerequisites are in place, the high-level end state workflow is as follows:

1. You write code to extract data from your source and pass to the Fivetran Connector SDK.
2. Test your code locally.
3. Deploy the code to Fivetran to create your connection.
4. When running a sync, Fivetran runs your custom code so that it can extract data from your source and send it to Fivetran.
5. Fivetran then loads the data into your destination.

Follow our Connector SDK setup guide for custom connectors and visit our Connector SDK GitHub Repo to create a custom source connector and connect it with your destination using Fivetran.

Connector development best practices

To help you build a custom connector, we've prepared a list of best practices for you to follow:

• Optimizing performance when handling large datasets
• Consider centralizing deployment to a code deployment system
• Create your Git CI/CD pipeline
• Declare columns and data types
• Declare primary keys
• Upgrade your Fivetran Connector SDK
• Use a revision control system
• Use fivetran debug

TIP: Read our blog post, Fivetran Connector SDK: Custom data pipelines made easy, to learn more about the benefits of Connector SDK.

Key features of the Connector SDK

The Connector SDK supports many Fivetran features natively, as if the connector was developed by Fivetran, including:

• Column blocking
• Column hashing
• Data de-deduplication
• Destination ingestion optimizations
• Any connection method supported by Python libraries that you can include in your Python requirement.txt file

The following features are available for implementation in your custom code, but only if the source allows it:

• Incremental updates
• Updating and upserting data operations and soft deletion of data
• Table-level re-sync
• Multi-threading for fast extraction of data from the source
• Customizing the data schema delivered to your destination
• Defining data types in the schema used to deliver data to your destination
• Source data type inference. This applies only if you are not defining the data type to be used for a column in your code.
• Automatic schema updates. See our changing data type documentation for more information.
• Controlling the state and connection-level re-syncs of the connection
• Authenticating with OAuth 2.0 Client Credentials flow

Supported deployment models

We support the SaaS and Hybrid deployment models for the connector.

NOTE: You must have an Enterprise or Business Critical plan to use the Hybrid Deployment model.

The following diagram outlines the architecture of the Hybrid Deployment model for Connector SDK:

Use cases for custom connectors

The Connector SDK service is a good fit for the following use cases:

• Fivetran doesn't have a connector for your source or is unlikely to support it in the near future.
• You are using private APIs, custom applications, unsupported file formats or those that require pre-processing.
• You have sensitive data that needs filtering or anonymizing before entering the destination.
• You don't want to introduce a third party into your data pipeline (e.g., to host a custom function).

Connector SDK architecture

The following diagram provides a high-level overview of how connectors built using the Fivetran Connector SDK work:

The Connector SDK runtime environment executes your submitted Python script in an isolated environment. It installs the libraries listed in the requirements.txt file, and after installation, it runs the provided Python script and we pre-install the msodbcsql17 and msodbcsql18 drivers for connecting to Microsoft SQL server. We also pre-install libpq5 and libpq-dev, which is required to support psycopg and psycopg2, respectively. See the SQL Server example to learn how to use these pre-installed drivers and libraries.

By default, we host and run your Connector SDK connection in GCP, Fivetran's default infrastructure provider, in the region that you have configured in your destination. If you are on our Enterprise or Business Critical plan, you have the option to choose a cloud service provider and cloud region. In that case, we will host and run your code in the cloud provider and region you selected for the rest of your Fivetran infrastructure.

Secret management

Configuration values are stored securely and encrypted in the same way as other Fivetran connections' credentials. See our Data and Credential Encryption documentation for more details. To pass configuration values to Fivetran for use in your code, you can either provide them in the setup form after you have deployed your project, or upload them using the configuration.json file. Fivetran does not store this file and we suggest that you delete it from your project after deploying the project. Fivetran reads the values, encrypts them, and stores them securely. The values are only available to your code at runtime. You can confidently use configuration.json to pass any credentials required to run your connection, like a key required to make an API call.

Support for hosted Python environments

You can use a hosted Python environment, such as Jupyter Notebook, to test Python libraries and approaches to validate how you are going to connect to your data source and manipulate the response data ready for sending to Fivetran.

However, you need to send the actual connector.py file to Fivetran because we execute it in our infrastructure each time a sync is triggered. As such, it needs to be a standalone Python script or a set of scripts that are called from your connector.py file.

NOTE: See Technical Reference for a list of supported methods, operations, and fivetran-connector-sdk commands.

Connector SDK vs. Fivetran alternatives

Besides Connector SDK, we offer native connectors and development programs that cover a wide range of ELT use cases. For a better understanding of what best fits your needs, see the sections below.

Connector SDK vs. Functions vs. Lite connectors

Lite connectors are API-based connectors that Fivetran builds by request. They are generally for SaaS services that produce a non-dynamic schema.

In contrast, you or your engineering team build connectors using a cloud function service or the Connector SDK documented on this page and then deploy them to run either on your cloud service infrastructure or on Fivetran's infrastructure.

The following table summarizes the key differences between connectors built in our By Request program, using a Cloud Function, and using Connector SDK:

Connector SDK vs. Partner-Built connectors

Partner-Built connectors are built by Fivetran partners using our Partner SDK and are available for all Fivetran customers. The Partner SDK supports the following types of connectors:

• Source connectors
• Destination connectors

You build custom connectors using the Connector SDK, which are only available for you to use. Our Connector SDK only supports building source connectors.

Limitations

The Connector SDK doesn't support the following features:

• Webhooks for receiving event data
• History Mode
• Table-level re-syncs from the Fivetran dashboard
• Powered by Fivetran
• Private Networking
• Authorization via API
• Fivetran data models

You cannot create a Connector SDK connection by using the Create a Connection endpoint in the Fivetran REST API. You can still manage the connection using all other endpoints available in the Connection resource.

Support and resources for connector development

Our Support Team triages all tickets submitted though the Support Portal:

• If the issue is with the Fivetran platform, our Support Team will work with you on the issue until it is resolved.
• If the issue is with the connection’s custom code or logic, our Professional Services Team can assist you.

NOTE: The scope of our Customer Support Team's assistance is limited when it comes to troubleshooting custom code issues.

If you need assistance in developing a custom Connector SDK connector, our Services team can help. Contact your Account Representative to use existing service hours you may already have or submit a support request to get started with our Services team.

Additional connector development resources

See the links below for additional resources on Connector SDK connector development:

• Visit our Connector SDK GitHub repo for more details.
• Download the fivetran-connector-sdk PyPI package to set up Connector SDK on your local machine.
• Follow our ready-to-deploy examples to deploy a connection quickly.
• Learn how to build a Fivetran connector in less than an hour with Connector SDK and Anthropic’s Claude AI
• Try our fivetran-api-playground to explore various sample API endpoints on your local machine, helping you better understand the complexities of real-world APIs.
• For any issues with the development process, see our Connector SDK Troubleshooting documentation.

Usage and pricing

Connector SDK is available on all pricing plans. It uses Monthly Active Rows (MAR) to calculate usage, just like any other Fivetran connector.

To calculate the MAR for a table in your Connector SDK, see How to Count Daily MAR Usage per Table.