The tap-openweathermap
extractor
pulls data from
OpenWeatherMap 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
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-openweathermap extractor to your
project using
:meltano add -
Configure the tap-openweathermap
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-openweathermap --variant airbytemeltano config tap-openweathermap set --interactivemeltano config tap-openweathermap 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-openweathermap
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-openweathermap 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.appidairbyte_config.langairbyte_config.latairbyte_config.lonairbyte_config.unitsairbyte_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-openweathermap 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 Appid (airbyte_config.appid)
-
Environment variable:
TAP_OPENWEATHERMAP_AIRBYTE_CONFIG_APPID
Your OpenWeather API Key. See here. The key is case sensitive.
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set airbyte_config appid [value]Airbyte Config Lang (airbyte_config.lang)
-
Environment variable:
TAP_OPENWEATHERMAP_AIRBYTE_CONFIG_LANG
You can use lang parameter to get the output in your language. The contents of the description field will be translated. See here for the list of supported languages.
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set airbyte_config lang [value]Airbyte Config Lat (airbyte_config.lat)
-
Environment variable:
TAP_OPENWEATHERMAP_AIRBYTE_CONFIG_LAT
Latitude for which you want to get weather condition from. (min -90, max 90)
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set airbyte_config lat [value]Airbyte Config Lon (airbyte_config.lon)
-
Environment variable:
TAP_OPENWEATHERMAP_AIRBYTE_CONFIG_LON
Longitude for which you want to get weather condition from. (min -180, max 180)
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set airbyte_config lon [value]Airbyte Config Units (airbyte_config.units)
-
Environment variable:
TAP_OPENWEATHERMAP_AIRBYTE_CONFIG_UNITS
Units of measurement. standard, metric and imperial units are available. If you do not use the units parameter, standard units will be applied by default.
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set airbyte_config units [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_OPENWEATHERMAP_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-openweather
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_OPENWEATHERMAP_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_OPENWEATHERMAP_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-openweathermap set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_OPENWEATHERMAP_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_OPENWEATHERMAP_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-openweathermap set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_OPENWEATHERMAP_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-openweathermap set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_OPENWEATHERMAP_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-openweathermap 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}
