tap-mongodb - Meltano Hub

MongoDB

tap-mongodb from singer-io

General purpose, document-based, distributed database

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

Other Available Variants

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

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

meltano add extractor tap-mongodb --variant singer-io

Configure the tap-mongodb settings using
```
meltano config
```
:

meltano config tap-mongodb set --interactive

Test that extractor settings are valid using

meltano test

meltano test tap-mongodb

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

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
discover
state

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

Settings

The tap-mongodb 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:

host
port
user
password
database
replica_set
ssl
verify_mode
include_schemas_in_destination_stream_name

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.

Host URL (host)

Environment variable: TAP_MONGODB_HOST
Default Value: localhost

The MongoDB host URL.

Port (port)

Environment variable: TAP_MONGODB_PORT
Default Value: 27017

The MongoDB port.

User (user)

Environment variable: TAP_MONGODB_USER

The MongoDB user.

Password (password)

Environment variable: TAP_MONGODB_PASSWORD

The MongoDB password.

Database Name (database)

Environment variable: TAP_MONGODB_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.

Replica Set (replica_set)

Environment variable: TAP_MONGODB_REPLICA_SET

The name of the replica set.

SSL (ssl)

Environment variable: TAP_MONGODB_SSL
Default Value: false

Whether to use SSL connection or not.

Verify Mode (verify_mode)

Environment variable: TAP_MONGODB_VERIFY_MODE
Default Value: true

SSL Verify Mode

Include Schemas In Destination Stream Name (include_schemas_in_destination_stream_name)

Environment variable: TAP_MONGODB_INCLUDE_SCHEMAS_IN_DESTINATION_STREAM_NAME
Default Value: false

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

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

Install

meltano add extractor tap-mongodb --variant singer-io

Homepage

Maintenance Status

Repo

https://github.com/singer-io/tap-mongodb

Maintainer

Meltano Stats

Keywords