Player Unknown's Battlegrounds API

tap-pubg (autoidm variant)🥇

PlayerUnknown's Battlegrounds API

The tap-pubg extractor pulls data from Player Unknown's Battlegrounds 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-pubg extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-pubg
  3. Configure the tap-pubg settings using
    meltano config
    :
  4. meltano config tap-pubg set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-pubg test

Next steps

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

Capabilities

The current capabilities for tap-pubg 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-pubg 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-pubg 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.

API Key (api_key)

  • Environment variable: TAP_PUBG_API_KEY

The token to authenticate against the API service


Configure this setting directly using the following Meltano command:

meltano config tap-pubg set api_key [value]

Platform (platform)

  • Environment variable: TAP_PUBG_PLATFORM

Platform, ie steam


Configure this setting directly using the following Meltano command:

meltano config tap-pubg set platform [value]

Player Names (player_names)

  • Environment variable: TAP_PUBG_PLAYER_NAMES

Player Names you'd like to pull


Configure this setting directly using the following Meltano command:

meltano config tap-pubg set player_names [value]
Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_PUBG_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-pubg set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_PUBG_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-pubg set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

  • Environment variable: TAP_PUBG_STREAM_MAPS

Config object for stream maps capability.


Configure this setting directly using the following Meltano command:

meltano config tap-pubg 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?

If you're having trouble getting the tap-pubg 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-pubg

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/AutoIDM/tap-pubg
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • AutoIDM

Keywords

  • apimeltano_sdk