Connector SDK Connector Quickstart Setup Guide

Follow our guides to create a custom connection to integrate your data source with Fivetran using the Connector SDK.

Use this quickstart guide if you are already familiar with the Connector SDK. If this is your first time exploring the Connector SDK, follow our Detailed Guide.

Prerequisites

To connect your Connector SDK to Fivetran, you need:

• Your Fivetran REST API key.
• A Python development environment. We support Python version ≥3.9 and ≤3.12.
• A target data source you need to build a connector for and a way to use Python to connect to get the data you need. Most Python libraries can be used to help you achieve this.

See our Connector SDK GitHub repository for examples of how to use our Connector SDK.

Setup instructions

1. Set up or go to your Python development environment and create a directory for your new connector project. Create a virtual environment if you wish.

2. Install the Fivetran Connector SDK:

   pip install fivetran-connector-sdk
   

3. Review the provided examples.

4. Pick an example to use as a template.

5. Copy its code and paste it into a file in your connector project directory called connector.py.

6. Modify the code in connector.py to write your connector. Include a completed requirements.txt file if your code uses additional Python libraries.

7. Test the connector by running it locally:

   fivetran debug
   

   This test creates a local warehouse.db file, which is a Duck DB representation of the data that the connector delivers to your destination. This file is located in <root_directory>/files/warehouse.db.

8. Check your connector by reviewing the Duck DB warehouse.db file using DBeaver or using the DuckDB CLI commands.

9. Deploy the connector by running the following command:

   fivetran deploy --api-key <FIVETRAN-API-KEY> --destination <DESTINATION-NAME> --connection <CONNECTION-NAME>
   

   Your <FIVETRAN-API-KEY> is the base64-encoded {APIi-key}:{API-secret} used in all other Fivetran API calls. See our REST API documentation to learn where to find your API key.

   The <DESTINATION-NAME> identifies the destination you want your new connector to deliver to. It is the name of your destination in the Fivetran dashboard.

   The <CONNECTION_NAME> identifies the connection both in Fivetran’s Dashboard and for future updates. The connection name must conform to our naming conventions defined by the renaming rules, ensuring it matches the pattern and character set of transformed names.

Related articles

description Connector Overview

home Documentation Home