The tap-square
extractor
pulls data from
Square 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.
Alternate Implementations
- Airbyte
🥉
-
Hotglue
(default)
-
Stitch Data
🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-square extractor to your
project using
:meltano add -
Configure the tap-square
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-square --variant airbytemeltano config tap-square set --interactivemeltano config tap-square testNext 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-square
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-square 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.api_keyairbyte_config.credentials.client_idairbyte_config.credentials.client_secretairbyte_config.credentials.credentials_titleairbyte_config.credentials.refresh_tokenairbyte_config.include_deleted_objectsairbyte_config.is_sandboxairbyte_config.start_dateairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-square 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 Api Key (airbyte_config.credentials.api_key)
-
Environment variable:
TAP_SQUARE_AIRBYTE_CONFIG_CREDENTIALS_API_KEY
The API key for a Square application
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_config credentials.api_key [value]Airbyte Config Credentials Client Id (airbyte_config.credentials.client_id)
-
Environment variable:
TAP_SQUARE_AIRBYTE_CONFIG_CREDENTIALS_CLIENT_ID
The Square-issued ID of your application
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_config credentials.client_id [value]Airbyte Config Credentials Client Secret (airbyte_config.credentials.client_secret)
-
Environment variable:
TAP_SQUARE_AIRBYTE_CONFIG_CREDENTIALS_CLIENT_SECRET
The Square-issued application secret for your application
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_config credentials.client_secret [value]Airbyte Config Credentials Credentials Title (airbyte_config.credentials.credentials_title)
-
Environment variable:
TAP_SQUARE_AIRBYTE_CONFIG_CREDENTIALS_CREDENTIALS_TITLE
OAuth Credentials, API Key
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_config credentials.credentials_title [value]Airbyte Config Credentials Refresh Token (airbyte_config.credentials.refresh_token)
-
Environment variable:
TAP_SQUARE_AIRBYTE_CONFIG_CREDENTIALS_REFRESH_TOKEN
A refresh token generated using the above client ID and secret
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_config credentials.refresh_token [value]Airbyte Config Include Deleted Objects (airbyte_config.include_deleted_objects)
-
Environment variable:
TAP_SQUARE_AIRBYTE_CONFIG_INCLUDE_DELETED_OBJECTS
In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes)
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_config include_deleted_objects [value]Airbyte Config Is Sandbox (airbyte_config.is_sandbox)
-
Environment variable:
TAP_SQUARE_AIRBYTE_CONFIG_IS_SANDBOX
Determines whether to use the sandbox or production environment.
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_config is_sandbox [value]Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_SQUARE_AIRBYTE_CONFIG_START_DATE
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. If not set, all data will be replicated.
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_config start_date [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_SQUARE_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-square
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_SQUARE_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-square set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_SQUARE_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-square set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_SQUARE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-square set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_SQUARE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-square set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_SQUARE_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-square set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_SQUARE_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-square 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-yellow){kind=icon}
