The Native SDK for Connectors provides a couple of examples that show a general pattern, recommended by Snowflake, of creating new connectors as a Native Applications. From these examples, you will learn:
- how to create pull-based connectors (learn more about pull-based pattern)
- how to create push-based connectors (learn more about push-based pattern)
- how to implement the connector configuration mechanism
- how to implement the ingestion mechanism
- how to create an instance of the application in the Snowflake environment
- how to use the SnowSQL tool in connector development process
- Basic knowledge of Snowflake Native Apps
- Basic knowledge of SQL/Snowflake Scripting
- Snowflake user with
accountadmin
role
Before approaching example connectors, please take up the following steps or make sure that they are currently done:
- Install Java 11
- Install SnowSQL
- Configure SnowSQL
- allow using variables (
variable_substitution = True
) - exit on first error (
exit_on_error = True
)
- allow using variables (
├── connectors-native-sdk-example-java-github-connector
└── examples-basic
├── example-github-java-connector
├── example-github-python-connector
└── example-push-based-java-connector
In the connectors-native-sdk-example-java-github-connector you can find an example that shows how to implement a simple connector application based on the template which uses the Native SDK for Connectors Java library. This connector uses GitHub API to retrieve the data about issues from a repository. This example includes all the basic steps of the Native SDK for Connectors flow.
In the examples-basic you can find example connectors that had been introduced before the Native SDK for Connectors Java library was created, so that's why you need keep in mind that these examples do not use the SDK library. The goal of these connectors is to show the general concept of the connector application. You can find there the following examples: