MongoDB

tap-mongodb from transferwise

General purpose, document-based, distributed database.

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

Next steps

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:

  • state
  • catalog
  • discover
  • log-based

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:

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.

Password (password)

  • Environment variable: TAP_MONGODB_PASSWORD

The MongoDB password.

User (user)

  • Environment variable: TAP_MONGODB_USER

The MongoDB user.

Host URL (host)

  • Environment variable: TAP_MONGODB_HOST

The MongoDB host URL.

Auth Database (auth_database)

  • Environment variable: TAP_MONGODB_AUTH_DATABASE

The database name to authenticate on.

Database Name (database)

  • Environment variable: TAP_MONGODB_DATABASE

Database name to sync from.

SRV (srv)

  • Environment variable: TAP_MONGODB_SRV

Uses a mongodb+srv protocol to connect. Disables the usage of port argument if set to true. Warning - this uses a string representation of a boolean, use lowercase true.

Port (port)

  • Environment variable: TAP_MONGODB_PORT

Connection port. Required if a non-srv connection is being used.

Replica Set (replica_set)

  • Environment variable: TAP_MONGODB_REPLICA_SET

Name of replica set

SSL (ssl)

  • Environment variable: TAP_MONGODB_SSL

Can be set to true to connect using ssl. Warning - this uses a string representation of a boolean, use lowercase true.

Verify Mode (verify_mode)

  • Environment variable: TAP_MONGODB_VERIFY_MODE

Default SSL verify mode. Warning - this uses a string representation of a boolean, use lowercase true.

Include Schemas In Destination Stream Name (include_schemas_in_destination_stream_name)

  • Environment variable: TAP_MONGODB_INCLUDE_SCHEMAS_IN_DESTINATION_STREAM_NAME

Forces the stream names to take the form <database_name>_<collection_name> instead of <collection_name>. Warning - this uses a string representation of a boolean, use lowercase true.

Update Buffer Size (update_buffer_size)

  • Environment variable: TAP_MONGODB_UPDATE_BUFFER_SIZE

(LOG_BASED) The size of the buffer that holds detected update operations in memory, the buffer is flushed once the size is reached.

Await Time Milliseconds (await_time_ms)

  • Environment variable: TAP_MONGODB_AWAIT_TIME_MS

(LOG_BASED) The maximum amount of time in milliseconds the loge_base method waits for new data changes before exiting.

Commands

The tap-mongodb extractor supports the following commands that can be used with
meltano invoke
:

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

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Wise

Meltano Stats

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

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • database