NHL Stats API

tap-nhl (bicks-bapa-roob variant)

The tap-nhl extractor pulls data from NHL Stats API that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-nhl extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-nhl
  3. Configure the tap-nhl settings using
    meltano config
    :
  4. meltano config tap-nhl set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-nhl test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-nhl 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:

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-nhl 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:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-nhl 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.

Start Date (start_date)

  • Environment variable: TAP_NHL_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.


Configure this setting directly using the following Meltano command:

meltano config tap-nhl set start_date [value]

Api Url (api_url)

  • Environment variable: TAP_NHL_API_URL

The url for the API service


Configure this setting directly using the following Meltano command:

meltano config tap-nhl set api_url [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_NHL_STREAM_MAPS

Config object for stream maps capability.


Configure this setting directly using the following Meltano command:

meltano config tap-nhl set stream_maps [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_NHL_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-nhl set stream_map_config [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_NHL_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-nhl set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_NHL_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-nhl set flattening_max_depth [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-nhl extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-nhl

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/bicks-bapa-roob/tap-nhl
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • bicks-bapa-roob

Meltano Stats

  • Projects (Last 3 Months)

Keywords

  • meltano_sdk