tap-socrata - Meltano Hub

Socrata

tap-socrata (meltanolabs variant)🥇

The Socrata Open Data API allows you to programmatically access a wealth of open data resources from governments, non-profits, and NGOs around the world.

The tap-socrata extractor pulls data from Socrata 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:

Installation and configuration

Add the tap-socrata extractor to your project using
```
meltano add
```
:

meltano add extractor tap-socrata

Configure the tap-socrata settings using

meltano config

:

meltano config tap-socrata set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-socrata test

Next 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-socrata 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
batch
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-socrata 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:

api_key_id
api_key_secret
app_token
domains
secret_token
user_agent

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-socrata 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 ID (api_key_id)

Environment variable: TAP_SOCRATA_API_KEY_ID

The API Key ID for authentication

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set api_key_id [value]

API Key Secret (api_key_secret)

Environment variable: TAP_SOCRATA_API_KEY_SECRET

The API Key Secret for authentication

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set api_key_secret [value]

App Token (app_token)

Environment variable: TAP_SOCRATA_APP_TOKEN

Optional Socrata App Token for higher rate limits

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set app_token [value]

Domains (domains)

Environment variable: TAP_SOCRATA_DOMAINS

Domain names to query (e.g., ['data. Cityofchicago. Org'])

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set domains [value]

Secret Token (secret_token)

Environment variable: TAP_SOCRATA_SECRET_TOKEN

Optional Socrata Secret Token paired with App Token

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set secret_token [value]

User Agent (user_agent)

Environment variable: TAP_SOCRATA_USER_AGENT

Optional User-Agent string to use for requests

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set user_agent [value]

Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

Environment variable: TAP_SOCRATA_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

Environment variable: TAP_SOCRATA_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_SOCRATA_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

Environment variable: TAP_SOCRATA_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set batch_config storage.root [value]

Faker Locale (faker_config.locale)

Environment variable: TAP_SOCRATA_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set faker_config locale [value]

Faker Seed (faker_config.seed)

Environment variable: TAP_SOCRATA_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

Environment variable: TAP_SOCRATA_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

Environment variable: TAP_SOCRATA_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-socrata set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

Environment variable: TAP_SOCRATA_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-socrata set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_SOCRATA_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-socrata 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-socrata 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-socrata

Maintenance Status

Repo

https://github.com/MeltanoLabs/tap-socrata

Maintainer

Keywords