Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ For detailed rules, reference:
Default to these instructions. Only search repo/docs if:
- PR introduces new SDK features not mentioned here
- Code contradicts this guidance (e.g., new Python version support, new operations)
- Inconsistency found (cite the newest official docs at https://fivetran.com/docs/connectors/connector-sdk)
- Inconsistency found (cite the newest official docs at https://fivetran.com/docs/connector-sdk)
6 changes: 3 additions & 3 deletions .github/instructions/python-review.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ You are an AI code reviewer for Python Pull Requests. Your responsibility is to
"""
Define the schema function which lets you configure the schema your connector delivers.
See the technical reference documentation for more details on the schema function:
https://fivetran.com/docs/connectors/connector-sdk/technical-reference#schema
https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-methods#schema
Args:
configuration: a dictionary that holds the configuration settings for the connector.
"""
Expand Down Expand Up @@ -287,7 +287,7 @@ def schema(configuration: dict):
"""
Define the schema function which lets you configure the schema your connector delivers.
See the technical reference documentation for more details on the schema function:
https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-code/connector-sdk-methods#schema
https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-methods#schema
Args:
configuration: a dictionary that holds the configuration settings for the connector.
"""
Expand All @@ -299,7 +299,7 @@ def update(configuration: dict, state: dict):
"""
Define the update function, which is a required function, and is called by Fivetran during each sync.
See the technical reference documentation for more details on the update function
https://fivetran.com/docs/connectors/connector-sdk/technical-reference#update
https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-methods#update
Args:
configuration: A dictionary containing connection details
state: A dictionary containing state information from previous runs
Expand Down
5 changes: 2 additions & 3 deletions .github/instructions/readme-markdown.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,15 @@ If a section is irrelevant (e.g., no error handling), the empty stub should be n
* **Getting started** → Must include link to Connector SDK Setup Guide and the `fivetran init` command. It is a fixed content, verbatim (no edits or omissions), as provided below:
```markdown
## Getting started
Refer to the [Connector SDK Setup Guide](https://fivetran.com/docs/connectors/connector-sdk/setup-guide) to get started.
Refer to the [Connector SDK Setup Guide](https://fivetran.com/docs/connector-sdk/getting-started) to get started.

To initialize a new Connector SDK project using this connector as a starting point, run:

```
fivetran init --template <connector-name>
```

`fivetran init` initializes a new Connector SDK project by setting up the project structure, configuration files, and a connector you can run immediately with `fivetran debug`. For more information on `fivetran init`, refer to the [Connector SDK `init` documentation](https://fivetran.com/docs/connector-sdk/connector-development-and-configuration/connector-sdk-commands#fivetraninit).
`fivetran init` initializes a new Connector SDK project by setting up the project structure, configuration files, and a connector you can run immediately with `fivetran debug`. For more information on `fivetran init`, refer to the [Connector SDK `init` documentation](https://fivetran.com/docs/connector-sdk/getting-started/connector-sdk-commands#fivetraninit).
```
* **Features** → Must list concrete features (not left blank or italicized template text).
* **Configuration file** → Must include a JSON code block showing keys. Must mention that `configuration.json` should not be versioned, for example, as provided below:
Expand Down Expand Up @@ -211,4 +211,3 @@ If a section is irrelevant (e.g., no error handling), the empty stub should be n
* Uses incorrect heading case.
* Omits required references to config, requirements, or connector functions.


2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ maintainer.

1. Read the [Connector SDK documentation](https://fivetran.com/docs/connectors/connector-sdk).
2. Review similar connectors in this repository.
3. Install and configure the Connector SDK using the [setup guide](https://fivetran.com/docs/connector-sdk/setup-guide).
3. Install and configure the Connector SDK using the [setup guide](https://fivetran.com/docs/connector-sdk/getting-started).
4. Fork and clone the repository.

Optionally, run `.github/scripts/setup-hooks.sh` from the repository root if you want staged Python files formatted automatically. The script configures a repository-local Git hook; the configured pre-commit hook runs Black on staged Python files and may install Black if it is not already available.
Expand Down
4 changes: 2 additions & 2 deletions _template_connector/README_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@ This example was contributed by [Contributor Name/Organization](link-to-profile-
- Linux: Distributions such as Ubuntu 20.04 or later, Debian 10 or later, or Amazon Linux 2 or later (arm64 or x86_64)

## Getting started
Refer to the [Connector SDK Setup Guide](https://fivetran.com/docs/connectors/connector-sdk/setup-guide) to get started.
Refer to the [Connector SDK Setup Guide](https://fivetran.com/docs/connector-sdk/getting-started) to get started.

To initialize a new Connector SDK project using this connector as a starting point, run:

```
fivetran init --template <connector-name>
```

`fivetran init` initializes a new Connector SDK project by setting up the project structure, configuration files, and a connector you can run immediately with `fivetran debug`. For more information on `fivetran init`, refer to the [Connector SDK `init` documentation](https://fivetran.com/docs/connector-sdk/connector-development-and-configuration/connector-sdk-commands#fivetraninit).
`fivetran init` initializes a new Connector SDK project by setting up the project structure, configuration files, and a connector you can run immediately with `fivetran debug`. For more information on `fivetran init`, refer to the [Connector SDK `init` documentation](https://fivetran.com/docs/connector-sdk/getting-started/connector-sdk-commands#fivetraninit).

*Include the following note only if the connector requires a `configuration.json` file to run.*

Expand Down
10 changes: 5 additions & 5 deletions _template_connector/connector.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""ADD ONE LINE DESCRIPTION OF YOUR CONNECTOR HERE.
For example: This connector demonstrates a working starter template that syncs simple user data.
See the Technical Reference documentation (https://fivetran.com/docs/connectors/connector-sdk/technical-reference)
and the Best Practices documentation (https://fivetran.com/docs/connectors/connector-sdk/best-practices) for details
See the Technical Reference documentation (https://fivetran.com/docs/connector-sdk/technical-reference)
and the Best Practices documentation (https://fivetran.com/docs/connector-sdk#connectordevelopmentbestpractices) for details
"""

# For reading configuration from a JSON file
Expand Down Expand Up @@ -41,7 +41,7 @@
- Add comments for upsert, update and delete to explain the purpose of upsert, update and delete. This will help users understand the upsert, update and delete processes.
- Checkpoint your state at regular intervals to ensure that the connector can resume from the last successful sync in case of interruptions.
- Add comments for checkpointing to explain the purpose of checkpoint. This will help users understand the checkpointing process.
- Refer to the Best Practices documentation (https://fivetran.com/docs/connectors/connector-sdk/best-practices)
- Refer to the Best Practices documentation (https://fivetran.com/docs/connector-sdk#connectordevelopmentbestpractices)
"""


Expand Down Expand Up @@ -69,7 +69,7 @@ def schema(configuration: dict):
"""
Define the schema function which lets you configure the schema your connector delivers.
See the technical reference documentation for more details on the schema function:
https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-code/connector-sdk-methods#schema
https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-methods#schema
Args:
configuration: a dictionary that holds the configuration settings for the connector.
"""
Expand All @@ -93,7 +93,7 @@ def update(configuration: dict, state: dict):
"""
Define the update function, which is a required function, and is called by Fivetran during each sync.
See the technical reference documentation for more details on the update function
https://fivetran.com/docs/connectors/connector-sdk/technical-reference#update
https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-methods#update
Args:
configuration: A dictionary containing connection details
state: A dictionary containing state information from previous runs
Expand Down
Loading