The tap-cart
extractor
pulls data from
Cart.com that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-cart extractor to your
project using
:meltano add
-
Configure the tap-cart
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-cart
meltano config tap-cart set --interactive
meltano config tap-cart test
Next steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-cart
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-cart
settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
airbyte_config.credentials.access_token
airbyte_config.credentials.auth_type
airbyte_config.credentials.site_id
airbyte_config.credentials.store_name
airbyte_config.credentials.user_name
airbyte_config.credentials.user_secret
airbyte_config.start_date
airbyte_spec.image
airbyte_spec.tag
docker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-cart list
You can
override these settings or specify additional ones
in your meltano.yml
by adding the settings
key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Airbyte Config Credentials Access Token (airbyte_config.credentials.access_token)
-
Environment variable:
TAP_CART_AIRBYTE_CONFIG_CREDENTIALS_ACCESS_TOKEN
Access Token for making authenticated requests.
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_config credentials.access_token [value]
Airbyte Config Credentials Auth Type (airbyte_config.credentials.auth_type)
-
Environment variable:
TAP_CART_AIRBYTE_CONFIG_CREDENTIALS_AUTH_TYPE
CENTRAL_API_ROUTER, SINGLE_STORE_ACCESS_TOKEN
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_config credentials.auth_type [value]
Airbyte Config Credentials Site Id (airbyte_config.credentials.site_id)
-
Environment variable:
TAP_CART_AIRBYTE_CONFIG_CREDENTIALS_SITE_ID
You can determine a site provisioning site Id by hitting https://site.com/store/sitemonitor.aspx and reading the response param PSID
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_config credentials.site_id [value]
Airbyte Config Credentials Store Name (airbyte_config.credentials.store_name)
-
Environment variable:
TAP_CART_AIRBYTE_CONFIG_CREDENTIALS_STORE_NAME
The name of Cart.com Online Store. All API URLs start with https://[mystorename.com]/api/v1/, where [mystorename.com] is the domain name of your store.
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_config credentials.store_name [value]
Airbyte Config Credentials User Name (airbyte_config.credentials.user_name)
-
Environment variable:
TAP_CART_AIRBYTE_CONFIG_CREDENTIALS_USER_NAME
Enter your application's User Name
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_config credentials.user_name [value]
Airbyte Config Credentials User Secret (airbyte_config.credentials.user_secret)
-
Environment variable:
TAP_CART_AIRBYTE_CONFIG_CREDENTIALS_USER_SECRET
Enter your application's User Secret
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_config credentials.user_secret [value]
Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_CART_AIRBYTE_CONFIG_START_DATE
The date from which you'd like to replicate the data
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_config start_date [value]
Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_CART_AIRBYTE_SPEC_IMAGE
-
Default Value:
airbyte/source-cart
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_spec image [value]
Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_CART_AIRBYTE_SPEC_TAG
-
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-cart set airbyte_spec tag [value]
Docker Mounts (docker_mounts)
-
Environment variable:
TAP_CART_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-cart set docker_mounts [value]
Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_CART_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-cart set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_CART_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-cart set flattening_max_depth [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_CART_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-cart set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_CART_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-cart set stream_maps [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.