The tap-mongodb Meltano extractor pulls data from MongoDB that can then be sent to a destination using a loader.

Alternative variants #

Multiple variants of tap-mongodb are available. This document describes the default singer-io variant, which is recommended for new users.

Alternative variants are:

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-mongodb extractor to your project using meltano add :

    meltano add extractor tap-mongodb
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-mongodb requires the configuration of the following settings:

The settings for extractor tap-mongodb that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Host URL (host) #

The MongoDB host URL.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set host <host>

export TAP_MONGODB_HOST=<host>

Port (port) #

The MongoDB port.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set port 27017

export TAP_MONGODB_PORT=27017

User (user) #

The MongoDB user.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set user <user>

export TAP_MONGODB_USER=<user>

Password (password) #

The MongoDB password.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set password <password>

export TAP_MONGODB_PASSWORD=<password>

Database Name (database) #

This is the database used for authentication, not the database used for extraction. The data extracted is determined by following the selecting entities and attributes instructions.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set database <database>

export TAP_MONGODB_DATABASE=<database>

Replica Set (replica_set) #

The name of the replica set.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set replica_set <replica_set>

export TAP_MONGODB_REPLICA_SET=<replica_set>

SSL (ssl) #

Whether to use SSL connection or not.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set ssl true

export TAP_MONGODB_SSL=true

Verify Mode (verify_mode) #

SSL Verify Mode

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set verify_mode false

export TAP_MONGODB_VERIFY_MODE=false

Include Schemas In Destination Stream Name (include_schemas_in_destination_stream_name) #

Forces the stream names to take the form <database_name>_<collection_name> instead of <collection_name>

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-mongodb set include_schemas_in_destination_stream_name true

export TAP_MONGODB_INCLUDE_SCHEMAS_IN_DESTINATION_STREAM_NAME=true

Looking for help? #

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

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!