The tap-wikipedia-pageviews
extractor
pulls data from
Wikipedia Pageviews 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-wikipedia-pageviews extractor to your
project using
:meltano add -
Configure the tap-wikipedia-pageviews
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-wikipedia-pageviewsmeltano config tap-wikipedia-pageviews set --interactivemeltano config tap-wikipedia-pageviews 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-wikipedia-pageviews
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-wikipedia-pageviews 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.accessairbyte_config.agentairbyte_config.articleairbyte_config.countryairbyte_config.endairbyte_config.projectairbyte_config.startairbyte_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-wikipedia-pageviews 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 Access (airbyte_config.access)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_CONFIG_ACCESS
If you want to filter by access method, use one of desktop, mobile-app or mobile-web. If you are interested in pageviews regardless of access method, use all-access.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_config access [value]Airbyte Config Agent (airbyte_config.agent)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_CONFIG_AGENT
If you want to filter by agent type, use one of user, automated or spider. If you are interested in pageviews regardless of agent type, use all-agents.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_config agent [value]Airbyte Config Article (airbyte_config.article)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_CONFIG_ARTICLE
The title of any article in the specified project. Any spaces should be replaced with underscores. It also should be URI-encoded, so that non-URI-safe characters like %, / or ? are accepted.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_config article [value]Airbyte Config Country (airbyte_config.country)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_CONFIG_COUNTRY
The ISO 3166-1 alpha-2 code of a country for which to retrieve top articles.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_config country [value]Airbyte Config End (airbyte_config.end)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_CONFIG_END
The date of the last day to include, in YYYYMMDD or YYYYMMDDHH format.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_config end [value]Airbyte Config Project (airbyte_config.project)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_CONFIG_PROJECT
If you want to filter by project, use the domain of any Wikimedia project.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_config project [value]Airbyte Config Start (airbyte_config.start)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_CONFIG_START
The date of the first day to include, in YYYYMMDD or YYYYMMDDHH format.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_config start [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-wikipedia-pageviews
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_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-wikipedia-pageviews set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-wikipedia-pageviews set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_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-wikipedia-pageviews set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_WIKIPEDIA_PAGEVIEWS_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-wikipedia-pageviews 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}
