Comma Separated Values (CSV)

tap-csv from meltanolabs

Generic data extractor of CSV (comma separated value) files

The tap-csv extractor pulls data from Comma Separated Values (CSV) that can then be sent to a destination using a loader.

Available Variants

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-csv extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-csv
  3. Configure the tap-csv settings using
    meltano config
    :
  4. meltano config tap-csv set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-csv test

Next steps

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

Capabilities

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

  • discover
  • catalog
  • state

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

Settings

The tap-csv 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 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.

Files (files)

  • Environment variable: TAP_CSV_FILES

Array of objects with entity, path, keys, and encoding [Optioanl] keys:

  • entity: The entity name, used as the table name for the data loaded from that CSV.
  • path: Local path (relative to the project's root) to the file to be ingested. Note that this may be a directory, in which case all files in that directory and any of its subdirectories will be recursively processed
  • keys: The names of the columns that constitute the unique keys for that entity.
  • encoding: [Optional] The file encoding to use when reading the file (i.e. "latin1", "UTF-8"). Use this setting when you get a UnicodeDecodeError error. Each input CSV file must be a traditionally-delimited CSV (comma separated columns, newlines indicate new rows, double quoted values).

The following entries are passed through in an internal CSV dialect that then is used to configure the CSV reader:

  • delimiter: A one-character string used to separate fields. It defaults to ','.
  • doublequote: Controls how instances of quotechar appearing inside a field should themselves be quoted. When True, the character is doubled. When False, the escapechar is used as a prefix to the quotechar. It defaults to True.
  • escapechar: A one-character string used by the reader, where the escapechar removes any special meaning from the following character. It defaults to None, which disables escaping.
  • quotechar: A one-character string used to quote fields containing special characters, such as the delimiter or quotechar, or which contain new-line characters. It defaults to '"'.
  • skipinitialspace: When True, spaces immediately following the delimiter are ignored. The default is False.
  • strict: When True, raise exception Error on bad CSV input. The default is False.

The first row is the header defining the attribute name for that column and will result to a column of the same name in the database. It must have a valid format with no spaces or special characters (like for example ! or @, etc).

CSV Files Definition (csv_files_definition)

  • Environment variable: TAP_CSV_CSV_FILES_DEFINITION

Project-relative path to JSON file holding array of objects as described under Files - with entity, path, keys, and other optional keys:

[
  {
    "entity": "<entity>",
    "path": "<path>",
    "keys": ["<key>"],
  },
  // ...
]

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-csv 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-csv

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Meltano Community

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • filemeltano_sdk