The tap-mongodb extractor pulls data from MongoDB that can then be sent to a destination using a loader.
Alternate Implementations
-
Airbyte
🥈
-
Checkr
-
Andy Lu
-
Eric Eastwood
-
Meltano
-
rudybear
-
Stitch Data
🥈
-
Steve Hanna
- Wise🥈
-
Alex Butler
(default)
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 -
Configure the tap-mongodb
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-mongodb --variant transferwisemeltano config tap-mongodb set --interactivemeltano config tap-mongodb testNext 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
- log-based
- 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:
auth_databaseawait_time_msdatabasehostinclude_schemas_in_destination_stream_namepasswordportreplica_setsrvsslupdate_buffer_sizeuserverify_mode
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-mongodb 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.
Auth Database (auth_database)
-
Environment variable:
TAP_MONGODB_AUTH_DATABASE
The database name to authenticate on.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set auth_database [value]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.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set await_time_ms [value]Database Name (database)
-
Environment variable:
TAP_MONGODB_DATABASE
Database name to sync from.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set database [value]Host URL (host)
-
Environment variable:
TAP_MONGODB_HOST
The MongoDB host URL.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set host [value]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.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set include_schemas_in_destination_stream_name [value]Password (password)
-
Environment variable:
TAP_MONGODB_PASSWORD
The MongoDB password.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set password [value]Port (port)
-
Environment variable:
TAP_MONGODB_PORT
Connection port. Required if a non-srv connection is being used.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set port [value]Replica Set (replica_set)
-
Environment variable:
TAP_MONGODB_REPLICA_SET
Name of replica set
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set replica_set [value]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.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set srv [value]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.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set ssl [value]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.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set update_buffer_size [value]User (user)
-
Environment variable:
TAP_MONGODB_USER
The MongoDB user.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set user [value]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.
Configure this setting directly using the following Meltano command:
meltano config tap-mongodb set verify_mode [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-262,901-c0c0c4){kind=icon}
-40-c0c0c4){kind=icon}
