Skip to content

feature(connector)sdk): Adding probe to API, database and s3 example#518

Open
fivetran-sahilkhirwal wants to merge 6 commits intomainfrom
sahil/add-auth-probes
Open

feature(connector)sdk): Adding probe to API, database and s3 example#518
fivetran-sahilkhirwal wants to merge 6 commits intomainfrom
sahil/add-auth-probes

Conversation

@fivetran-sahilkhirwal
Copy link
Contributor

@fivetran-sahilkhirwal fivetran-sahilkhirwal commented Feb 13, 2026

Jira ticket

Closes https://fivetran.atlassian.net/browse/RD-1161619

Description of Change

For referencing the github example in the Concepts docs, Added probe to examples

  • One for API
  • One for Database ( SQL server )
  • One for file connections ( AWS S3 )

Testing

  • authentication/api_key
Screenshot 2026-02-13 at 23 41 30 Screenshot 2026-02-13 at 23 41 30
  • authentication/certificates
Screenshot 2026-02-15 at 21 38 23 Screenshot 2026-02-15 at 21 41 17

Checklist

Some tips and links to help validate your PR:

  • Tested the connector with fivetran debug command.
  • Added/Updated example-specific README.md file, see the README template for the required structure and guidelines.
  • Followed Python Coding Standards, refer here

@fivetran-sahilkhirwal fivetran-sahilkhirwal self-assigned this Feb 13, 2026
@fivetran-sahilkhirwal fivetran-sahilkhirwal requested a review from a team as a code owner February 13, 2026 21:47
Copilot AI review requested due to automatic review settings February 13, 2026 21:47
@fivetran-sahilkhirwal fivetran-sahilkhirwal changed the title feature(connector)sdk): Adding probe to API, database and s3 connection feature(connector)sdk): Adding probe to API, database and s3 example Feb 13, 2026
@github-actions github-actions bot added the size/XL PR size: extra large label Feb 13, 2026
@github-actions
Copy link

github-actions bot commented Feb 13, 2026

🧹 Python Code Quality Check

✅ No issues found in Python Files.

🔍 See how this check works

This comment is auto-updated with every commit.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds “probe” (connectivity validation) steps to several Connector SDK examples (API key auth, SQL Server, and S3 certificate retrieval) so the examples can be referenced from Concepts docs with clearer fail-fast behavior.

Changes:

  • Added S3 connectivity probing and refactored S3 certificate retrieval helper usage in the AWS certificate example.
  • Added an API probe + retry/backoff logic to the API key authentication example.
  • Added a SQL Server connection probe and refactored the SQL Server connector to batch-fetch rows and checkpoint periodically.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 17 comments.

Show a summary per file
File Description
examples/common_patterns_for_connectors/authentication/certificate/retrieve_from_aws/connector.py Adds S3 probing, refactors S3 client/cert retrieval, introduces constants/checkpoint interval.
examples/common_patterns_for_connectors/authentication/certificate/retrieve_from_aws/aws_client.py Adds an S3Client.probe() helper for testing S3 connectivity.
examples/common_patterns_for_connectors/authentication/api_key/connector.py Adds API probe and retry/backoff behavior for API calls; updates main debug block comments.
examples/common_patterns_for_connectors/authentication/api_key/configuration.json Updates api_key to use angle-bracket placeholder format.
connectors/sql_server/connector.py Adds DB probe + batching/checkpointing refactor and improves docstrings/logging.

@github-actions github-actions bot added size/L PR size: Large and removed size/XL PR size: extra large labels Feb 13, 2026
@github-actions github-actions bot added size/XL PR size: extra large and removed size/L PR size: Large labels Feb 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XL PR size: extra large

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant