Skip to content

Commit

Permalink
📝 add docs for how to add normalization (#21563)
Browse files Browse the repository at this point in the history
* add docs

* add schema link

* update based on feedback
  • Loading branch information
pedroslopez authored Jan 19, 2023
1 parent c77970a commit 4991e95
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/connector-development/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,32 @@ The steps for updating an existing connector are the same as for building a new
3. Add any needed docs updates
4. Create a PR to get the connector published

## Adding normalization to a connector

In order to enable normalization for a destination connector, you'll need to set some fields on the destination definitions entry for the connector. This is done in the `airbyte-config/init/src/main/resources/seed/destination_definitions.yaml` file.

### New connectors
If you're adding normalization to a new connector, you'll need to first add a destination definitions entry:
1. Add a new connector definition in `airbyte-config/init/src/main/resources/seed/destination_definitions.yaml`. You can copy an existing entry and modify it to match your connector, generating a new UUIDv4 for the `destinationDefinitionId`.
2. Run the command `./gradlew :airbyte-config:init:processResources` to generate the seed spec yaml files, and commit the changes to the PR. See [this readme](https://github.com/airbytehq/airbyte/tree/master/airbyte-config/specs) for more information.

### Add normalization fields

Once you have a destination definitions entry, you'll need to add a `normaliationConfig` field to enable normalization.

Here's an example of normalization fields being set to enable normalization for the Postgres destination:

```yaml
normalizationConfig:
normalizationRepository: airbyte/normalization
normalizationTag: 0.2.25
normalizationIntegrationType: postgres
```
For more information about what these fields mean, see the [NormalizationDestinationDefinitionConfig](https://github.com/airbytehq/airbyte/blob/master/airbyte-config/config-models/src/main/resources/types/NormalizationDestinationDefinitionConfig.yaml) schema.
The presence of these fields will enable normalization for the connector, and determine which docker image will run.
## Publishing a connector
Once you've finished iterating on the changes to a connector as specified in its `README.md`, follow these instructions to ship the new version of the connector with Airbyte out of the box.
Expand Down

0 comments on commit 4991e95

Please sign in to comment.