Technical Reference

This Connector SDK Technical Reference covers the following topics:

• On this page:
  • Connector SDK requirements
  • Python setup notes
  • Limitations and modes of operation.
• On separate pages, it also covers the following detailed sections:
  • Connector SDK CLI Commands
  • Connector SDK Code Reference
    • Required declarations
    • Supported Methods
    • Supported Operations
    • Connector SDK Logging
  • Connector SDK Supported Data Type

Requirements

• Python installed on your system (local or virtual environment)
• Compatible versions: see Python version support
• The Connector SDK PyPI package: fivetran-connector-sdk

To install the Fivetran Connector SDK package, run the following command:

pip install fivetran-connector-sdk

Python setup notes

Python may be global or managed in a virtual environment (venv). To verify your setup:

python --version

To activate a virtual environment:

• in macOS/Linux:

  python -m venv .venv
  source .venv/bin/activate
  

• in Windows (PowerShell):

  python -m venv .venv
  .venv\Scripts\Activate.ps1
  

• in Windows (Command Prompt):

  python -m venv .venv
  .venv\Scripts\activate.bat
  

Related tutorials

See our Using Environment Variables With the Connector SDK for details on how to use environment variables.

Limitations and notes

History mode

Currently, the Connector SDK does not support History Mode. You can mimic its behavior by including a timestamp column as part of a composite primary key.

Hybrid Deployment

If you are using a destination set up for Hybrid Deployment model, you can specify a custom hybrid agent (different from that used by the destination) using the CLI parameter --hybrid-deployment-agent-id <ID>. For more information about deploying your custom connector, see Deply Your Custom Connector section.

System behavior

• Fivetran infers schema when not defined.
• The None values are inferred as NULL and NaN values are inferred as FLOAT.
• Long syncs should periodically call checkpoint() to persist state.