fivetran-connector-sdk Commands
The following CLI commands are available in the fivetran-connector-sdk PyPI package.
CLI (Command-Line Interface) is a text-based interface that lets you run commands directly in a terminal or console to perform tasks. In the context of Connector SDK, you use the CLI to configure, test, or deploy your custom connectors.
fivetran deploy
Deploys your code to Fivetran, creating or updating a connection. If the connection does not exist, it creates one. If the connection with the same name already exists, it prompts you to confirm whether to overwrite it.
Signature
fivetran deploy [OPTIONS]
Parameters
| Flag | Required | Description |
|---|---|---|
--api-key <BASE_64_ENCODED_API_KEY> | Yes | Fivetran API key for deployment. |
--destination <DESTINATION_NAME> | Yes | Destination name in your account. |
--connection <CONNECTION_NAME> | Yes | Connection name in your destination. |
--configuration | Optional | JSON file defining configuration values. |
--force | Optional | Automatically answers prompts (Yes/No). |
--python <Python version number> , --python-version <Python version number> | Optional | Python runtime version. |
--version <SDK version number> | Optional | fivetran-connector-sdk runtime version. |
--hybrid-deployment-agent-id <ID> | Optional | Specify non-default hybrid agent. |
"<project path>" | Optional | Specify non-default project path, absolute or relative. When omitted, command runs in current directory. |
Example
fivetran deploy --api-key <API_KEY> --destination Snowflake --connection my_connection
Notes
- Missing required parameters trigger prompts to provide them. Omitting configuration also trigger a confirmation prompt.
- Defaults can be set via environment variables.
fivetran debug
Runs and debugs connector code locally. It tests and troubleshoots the connection's behavior with the source's actual data and generates a local warehouse.db file, a DuckDB representation of the data delivered by the connection to the destination. This process internally emulates Fivetran's core.
Signature
fivetran debug [OPTIONS]
Parameters
| Flag | Required | Description |
|---|---|---|
--configuration | Optional | Specifies configuration for local run. |
"<project path>" | Optional | Specify non-default project path, absolute or relative. When omitted, command runs in current directory |
--version <SDK version number> | Optional | fivetran-connector-sdk runtime version. |
--version <SDK version number> | Optional | fivetran-connector-sdk runtime version. |
Example
fivetran debug "/Users/fivetran/connector_sdk/sample_connector"
fivetran reset
Deletes the current local state.json and warehouse.db file. It allows to re-run fivetran debug from scratch.
Signature
fivetran reset [OPTIONS]
Parameters
| Flag | Required | Description |
|---|---|---|
"<project path>" | Optional | Specify non-default project path, absolute or relative. When omitted, command runs in current directory |
Example
fivetran reset
Use to simulate an initial historical sync.
fivetran version
Displays installed SDK version. Version is required for getting support from Fivetran and troubleshooting issues.
fivetran version # This format works.
fivetran --version # This format works as well.
fivetran --help
Lists all available commands and parameters.
fivetran --help