Required Declarations

This section outlines the required declarations for Fivetran Connector SDK connectors, including necessary imports and the essential Connector object.

Required imports

# Import required classes from fivetran_connector_sdk
from fivetran_connector_sdk import Connector
# For supporting Data operations like upsert(), update(), delete() and checkpoint()
from fivetran_connector_sdk import Operations as op
# For enabling Logs in your connector code
from fivetran_connector_sdk import Logging as log
<other imports required by your connector>

Description

• Connector - needed to create Connector object by passing supported methods update() and schema().
• Operations — supports data operations like upsert(), update(), delete(), and checkpoint().
• Logging — enables connector logs.
• <other imports required by your connector> - any additional libraries or modules your connector needs. Remember to include them in your requirements.txt or pyproject.toml file if necessary.

Setup form helpers

This is required only if you define a setup form.

To import the setup form helpers:

from fivetran_connector_sdk import ConfigurationForm
from fivetran_connector_sdk import Test
from fivetran_connector_sdk import form_field

• ConfigurationForm — defines setup form fields and setup tests.
• form_field — provides supported setup form field types.
• Test — returns success or failure results from setup test functions.

Required object: Connector

Your connector must declare a Connector object.

connector = Connector(update=update, schema=schema)

If you only implement update():

connector = Connector(update=update)

If you implement an optional setup form:

connector = Connector(
    update=update,
    schema=schema,
    configuration_form=configuration_form,
)