Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Remove extra '--' #20

Closed
wants to merge 6 commits into from
Closed

fix: Remove extra '--' #20

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8185fff
Remove extra '--'
SpaceCondor Jul 25, 2024
492cdf7
Fix docker regression, check for win32, update tests. Add flag for ig…
SpaceCondor Jul 29, 2024
e8ed648
Update ci.yml
SpaceCondor Jul 30, 2024
469ee9f
Add back sync tests, update pyproject.toml
SpaceCondor Jul 30, 2024
d6f028b
Remove 3.8 support as Airbyte CDK no longer supports it
SpaceCondor Jul 30, 2024
2f7f119
Update tests, use docker for testing docker mounts
SpaceCondor Jul 30, 2024
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
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,16 @@ Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.

## Configuration 📝

| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| airbyte_spec | True | None | Specification for the Airbyte source connector. This is a JSON object minimally containing the `image` key. The `tag` key is optional and defaults to `latest`. |
| airbyte_config | False | None | Configuration to pass through to the Airbyte source connector, this can be gleaned by running the the tap with the `--about` flag and the `--config` flag pointing to a file containing the `airbyte_spec` configuration. This is a JSON object. |
| docker_mounts | False | None | Docker mounts to mount to the container. Expects a list of maps containing source, target, and type as is documented in the docker --mount [documentation](https://docs.docker.com/storage/bind-mounts/#choose-the--v-or---mount-flag) |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth| False | None | The max depth to flatten schemas. |
| Setting | Required | Default | Description |
|:---------------------|:--------:|:-------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| airbyte_spec | True | None | Specification for the Airbyte source connector. This is a JSON object minimally containing the `image` key. The `tag` key is optional and defaults to `latest`. |
| airbyte_config | False | None | Configuration to pass through to the Airbyte source connector, this can be gleaned by running the the tap with the `--about` flag and the `--config` flag pointing to a file containing the `airbyte_spec` configuration. This is a JSON object. |
| docker_mounts | False | None | Docker mounts to mount to the container. Expects a list of maps containing source, target, and type as is documented in the docker --mount [documentation](https://docs.docker.com/storage/bind-mounts/#choose-the--v-or---mount-flag) |
| skip_native_check | False | False | Disables the check for natively executable sources. By default, AirByte sources are checked to see if they are able to be executed natively without using containers. This disables that check and forces them to run in containers. |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth | False | None | The max depth to flatten schemas. |


### Configure using environment variables ✏️
Expand Down Expand Up @@ -51,12 +52,12 @@ First, configure your tap by creating a configuration json file. In this example
"credentials": {
"access_token": "..."
},
"repositories": "z3z1ma/*",
"repositories": "z3z1ma/*"
}
}
```

Run the built in Airbyte connection test to validate your configuration like this where `github.json` represents the above config (note the choice of file name is purely for illustration):
Run the built-in Airbyte connection test to validate your configuration like this where `github.json` represents the above config (note the choice of file name is purely for illustration):

```bash
tap-airbyte --config ./github.json --test
Expand Down
Loading
Loading