File

tap-file (airbyte variant)🥈

Extracts data from files using smart_open

The tap-file extractor pulls data from File that can then be sent to a destination using a loader.

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

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

Next steps

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

Capabilities

The current capabilities for tap-file 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-file 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-file 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 Spec Image (airbyte_spec.image)

  • Environment variable: TAP_FILE_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-file

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_FILE_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_FILE_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-file set docker_mounts [value]

Airbyte Config Dataset Name (airbyte_config.dataset_name)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_DATASET_NAME

The Name of the final table to replicate this file into (should include letters, numbers dash and underscores only).


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config dataset_name [value]

Airbyte Config Format (airbyte_config.format)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_FORMAT

The Format of the file which should be replicated (Warning: some formats may be experimental, please refer to the docs).


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config format [value]

Airbyte Config Reader Options (airbyte_config.reader_options)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_READER_OPTIONS

This should be a string in JSON format. It depends on the chosen file format to provide additional options and tune its behavior.


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config reader_options [value]

Airbyte Config Url (airbyte_config.url)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_URL

The URL path to access the file which should be replicated.


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config url [value]

Airbyte Config Provider Storage (airbyte_config.provider.storage)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_STORAGE

HTTPS, GCS, S3, AzBlob, SSH, SCP, SFTP, local


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.storage [value]

Airbyte Config Provider User Agent (airbyte_config.provider.user_agent)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_USER_AGENT

Add User-Agent to request


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.user_agent [value]

Airbyte Config Provider Service Account Json (airbyte_config.provider.service_account_json)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_SERVICE_ACCOUNT_JSON

In order to access private Buckets stored on Google Cloud, this connector would need a service account json credentials with the proper permissions as described here. Please generate the credentials.json file and copy/paste its content to this field (expecting JSON formats). If accessing publicly available data, this field is not necessary.


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.service_account_json [value]

Airbyte Config Provider AWS Access Key Id (airbyte_config.provider.aws_access_key_id)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_AWS_ACCESS_KEY_ID

In order to access private Buckets stored on AWS S3, this connector would need credentials with the proper permissions. If accessing publicly available data, this field is not necessary.


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.aws_access_key_id [value]

Airbyte Config Provider AWS Secret Access Key (airbyte_config.provider.aws_secret_access_key)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_AWS_SECRET_ACCESS_KEY

In order to access private Buckets stored on AWS S3, this connector would need credentials with the proper permissions. If accessing publicly available data, this field is not necessary.


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.aws_secret_access_key [value]

Airbyte Config Provider Storage Account (airbyte_config.provider.storage_account)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_STORAGE_ACCOUNT

The globally unique name of the storage account that the desired blob sits within. See here for more details.


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.storage_account [value]

Airbyte Config Provider Sas Token (airbyte_config.provider.sas_token)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_SAS_TOKEN

To access Azure Blob Storage, this connector would need credentials with the proper permissions. One option is a SAS (Shared Access Signature) token. If accessing publicly available data, this field is not necessary.


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.sas_token [value]

Airbyte Config Provider Shared Key (airbyte_config.provider.shared_key)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_SHARED_KEY

To access Azure Blob Storage, this connector would need credentials with the proper permissions. One option is a storage account shared key (aka account key or access key). If accessing publicly available data, this field is not necessary.


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.shared_key [value]

Airbyte Config Provider User (airbyte_config.provider.user)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_USER

, ,


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.user [value]

Airbyte Config Provider Password (airbyte_config.provider.password)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_PASSWORD

, ,


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.password [value]

Airbyte Config Provider Host (airbyte_config.provider.host)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_HOST

, ,


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.host [value]

Airbyte Config Provider Port (airbyte_config.provider.port)

  • Environment variable: TAP_FILE_AIRBYTE_CONFIG_PROVIDER_PORT

, ,


Configure this setting directly using the following Meltano command:

meltano config tap-file set airbyte_config provider.port [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_FILE_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-file set stream_maps [value]

Stream Map Config (stream_map_config)

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

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_FILE_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-file set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_FILE_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-file 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-file extractor to work, read the Airbyte connector FAQ, look for an existing issue in the Airbyte 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-file

Maintenance Status

  • Maintenance Status
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-file
  • License

Maintainer

  • Airbyte

Meltano Stats

  • Projects (Last 3 Months)

Keywords

  • airbyte_protocol