In this article

Overview

The MongoDB - Atlas Vector Search Snap enables you to efficiently perform advanced vector-based queries. This Snap is useful for Similarity searches, Approximate Nearest Neighbor (ANN) queries, and Range queries on vector data stored in MongoDB Atlas. Learn more about vector search queries.

You can run MongoDB Atlas Vector Search Snap in Groundplex and Cloudplex connecting through the MongoDB Atlas service.

Snap Type

The MongoDB - Atlas Vector Search Snap is a Read-type Snap.

Prerequisites

Create a MongoDB Atlas account.
Create a vector search index in MongoDB Atlas.
Configure MongoDB Atlas cluster and allow your IP in network security settings.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

The listSearchIndexes command can only be run on a deployment hosted on MongoDB Atlas, and requires an Atlas cluster tier of at least M10. Hence, for the suggestions list to populate in the Search index field, you must deploy the MongoDB Atlas cluster with at least an M10 tier. However, you can add the index manually, even if the Snap displays an error when populating the suggestions.

Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 1
Max: 1

Join
JSON Generator

Requires the MongoDB aggregate command to perform vector search.

Output

Document

Min: 1
Max: 1

Mapper
Copy

Retrieves query results from the collection as specified in the settings.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab:

Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon ( ): Indicates that you can remove fields from the field set.
Upload icon ( ): Indicates that you can upload files.

Field Name	Field Type	Description
Label* Default Value: MongoDB - Atlas Vector Search Example: Atlas Vector Search	String	Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.
Database name Default Value: N/A Example: chunking_strategy	String/Expression/Suggestion	Specify the database where the query is executed. If you do not specify, the database configured in the account is used.
Collection name* Default Value: N/A Example: chunk_metadata	String/Expression/Suggestion	Specify or select a MongoDB collection name to find indexes for vector search.
Search index* Default Value: N/A Example: vector_index	String/Expression/Suggestion	Specify the name of the vector search index to query. Alternatively, click the Suggestions icon to select the vector search index. For search index suggestions to work, you must deploy the MongoDB Atlas cluster with at least an M10 tier. Otherwise, you can add the index manually, even if the Snap displays an error when you click the Suggestion icon.
Vector field* Default Value: N/A Example: embedding	String/Expression/Suggestion	Specify the name of the vector field that you want to search.
Number of candidates* Default Value: 100 Example: 50	Integer/Expression	Specify the number of candidates for vector search. The Number of candidates value must be higher than the Limit value to increase the accuracy of the results. Maximum value: 10000 Minimum value: 0
Limit* Default Value: 4 Example: 10	Integer/Expression	Specify the number of results to return for each query. Maximum value: 10000 Minimum value: 0
Advanced settings	Configure the advanced settings as required.
Batch size* Default Value: 0 Example: 10	Integer	Specify the number of documents to return per batch.
Timezone hours offset Default Value: 0 Example: 12	Integer	Specify the time zone hour offset to apply to all DateTime fields. The values for this field must be in the range of (-12) through 14.
Timezone minutes offset Default Value: 0 Example: 1	Integer	Specify the time zone minutes offset to apply to all DateTime fields. The values for this field must be in the range of 0 through 59.
Number of retries Default Value: 0 Example: 4	Integer/Expression	Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response. If the Number of retries value is set to 0 (the default value), the retry option is disabled, and the Snap does not initiate a retry. The pipeline will not attempt to retry the operation in case of a failure—any failure encountered during the database operation will immediately result in the pipeline failing without any retry attempts to recover from the errors. If the Snap fails on all retries, it routes the last occurred exception to the error view.
Retry interval (seconds) Default Value: 1 Example: 5	Integer/Expression	Specify the time interval between two retry requests.
Snap Execution Default Value: Example: Validate & Execute	Dropdown list	Select one of the following three modes in which the Snap executes: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime. Execute only: Performs full execution of the Snap during pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.

Troubleshooting

Error	Reason	Resolution
The vector search operation failed.	The specified vector might be invalid.	Specify a valid vector and retry.
Unable to process the input document.	The input document might be invalid.	Specify valid input and retry.
The collection provided cannot be found.	The specified collection is not available.	Specify a valid collection and retry.
The index is not specified.	The index field is mandatory.	Specify a valid index and retry.
The input document does not have a 'vector' specified in the structure.	The input document must have a valid vector.	Add the vector to query the input document and retry.
Unable to retrieve index fields, OR No indexes were found querying database <name>, OR Command failed with error 8000 (AtlasError)	Unrecognized pipeline stage <name-of-the-pipeline>.	Ensure the cluster runs on MongoDB Atlas and has a cluster tier of at least M10. Additionally, confirm that the user has the required permissions to access the search index.

Examples

Vector search on a specific field

Th following example pipeline demonstrates how to use MongoDB - Atlas Vector Search Snap to perform an ANN (approximate nearest neighbor) search on a vector in the specified field.

Download this pipeline.

Step 1: Configure the Edit JSON field in the JSON Generator Snap with the prompt List movies.

Step 2: Configure the Azure OpenAI Embedder Snap as follows to create a vector embedding for the list of movies.

Azure OpenAI Embedder configuration	Azure OpenAI Embedder output

Step 3: Configure the Mapper Snap to pass the vector embedding to the MongoDB - Atlas Vector Search Snap.

Step 4: Configure the MongoDB - Atlas Vector Search Snap to run a search query on 10,000 nearest neighbor records for a single-matched record with a similar plot_embedding vector field.

On validation, one record is populated with a similar plot-embedding vector field.

Downloads

Download and import the pipeline into the SnapLogic Platform.
Configure Snap accounts, as applicable.
Provide Pipeline parameters, as applicable.

	File	Modified

No files shared here yet.

Snap Pack History

Click to view/expand

Release	Snap Pack Version	Date	Type	Updates
November 2024	main29029	13 Nov 2024	Stable	Enhanced the MongoDB Replica and Mongo ReplicaSet Dynamic Accounts to define read preference options when querying data. The default option is Primary, so you cannot allocate read load to the secondary node. Note that the Secondary preferred mode is not supported for the MongoDB Execute Snap.
August 2024	main27765	21 Aug 2024	Stable	Updated and certified against the current Snaplogic Platform release.
May 2024	437patches27343	30 Jul 2024	Latest	The MongoDB - Atlas Vector Search Snap now supports the following: Suggestions for the Search index field that enables the Snap to populate the associated indices in the list. The input schema displays the mandatory vector field and optional filter suggestion (if the Search index contains a filter type query) in alignment with the fields expected by the Snap.
May 2024	437patches26832	24 Jun 2024	Latest	Fixed the inconsistency in `ObjectId` and `Date` representation in the output preview between MongoDB - Execute and MongoDB - Find snaps. Enhanced the MongoDB Execute Snap with the Timezone Offset field set that enables you to apply the timezone offset on the date fields.
May 2024	437patches26721	12 Jun 2024	Latest	Added Number of retries and Retry interval (seconds) fields, to MongoDB Delete, Update, Find, Group, Insert, and Atlas Vector Search Snaps that enable you to handle retries during a connection failure. Fixed an issue with the MongoDB - Execute Snap, where data was missing when the database server restarted and the error view was enabled. Fixed an issue with the MongoDB - Execute Snap where the log file missed the retry attempts information.
May 2024	main26341	08 May 2024	Stable	Enhanced the MongoDB Update Snap with the Array Filters field, which enables you to use array filters in the update operation. Additionally, the Update Query field is modified into a text box for visibility and usability of input queries. Upgraded Spring dependencies to the latest supported Java 11 version for MongoDB Snap Pack.
February 2024	436patches26244	01 May 2024	Latest	Added the following Snap to the MongoDB Snap Pack: MongoDB - Atlas Vector Search: Performs advanced vector-based queries, such as Similarity searches, Approximate Nearest Neighbor (ANN) queries, and Range queries on vector data stored in MongoDB Atlas.
February 2024	436patches25893	10 Apr 2024	Latest	Added MongoDB Execute Snap to the MongoDB Snap Pack.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	main22460	16 Aug 2023	Stable	Updated and certified against the current SnapLogic Platform release.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	main18944	10 Nov 2022	Stable	Upgraded with the latest SnapLogic Platform release.
September 2022	430patches18223	27 Sep 2022	Latest	The MongoDB Update Snap in a low-latency feed Ultra Pipeline now correctly acknowledges the requests.
August 2022	430patches17472	18 Aug 2022	Latest	The MongoDB Account with Encryption type set to TLS/SSL does not fail with the "URL cannot be null" error.
August 2022	main17386	11 Aug 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.29Patches	429patches15807	23 Jun 2022	Latest	Updated the expected output for the MongoDB - Update Snap that is changed because of the upgrade of Spring Core framework version.
4.29	main15993	14 May 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.28	main14627	12 Feb 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.27	main12833	13 Nov 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25	main9554	08 May 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.24	main8556	13 Feb 2021	Stable	Fixed an issue in the MongoDB accounts to connect to Atlas Free Tier and Shared Cluster database using the Use cursor timeout checkbox in the MongoDB cursor properties. If selected, this option enables the server to close a cursor automatically after a period of inactivity. For the existing accounts that does not have this field, the value for this checkbox returns false, which is backward compatible.
4.23	main7430	14 Nov 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21 Patch	421patches6272	27 Jul 2020	Latest	Fixes the issue where Snowflake SCD2 Snap generates two output documents despite no changes to Cause-historization fields with DATE, TIME and TIMESTAMP Snowflake data types, and with Ignore unchanged rows field selected.
4.21 Patch	421patches6144	20 Jul 2020	Latest	Fixes the following issues with DB Snaps: The connection thread waits indefinitely causing the subsequent connection requests to become unresponsive. Connection leaks occur during Pipeline execution.
4.21 Patch	MULTIPLE8841	19 May 2020	Latest	Fixes the connection issue in Database Snaps by detecting and closing open connections after the Snap execution ends.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20	snapsmrc535	08 Feb 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.19	snaprsmrc528	14 Nov 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.18	snapsmrc523	10 Aug 2019	Stable	Added the following fields to the Mongo DB Find Snap: Projection Condition, Sort Condition, Offset, Limit, and Group result. Added a new Snap, MongoDB Group, which enables you to group input documents by a specified expression, and output to the next stage, one document for each distinct grouping. Added a new field to the Mongo DB Update Snap, Update operation and Exclude list, which enable you to update operations and exclude a list of JSON properties before sending the updated documents to MongoDB.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17 Patch	db/mongo7331	24 May 2019	Latest	Fixed an issue with the MongoDB - Update Snap wherein the Snap converts all non-updated integer and float data types to string data type. Fixed a Null Pointer Exception for old MongoDB accounts that did not have driver jars.
4.17	snapsmrc515	11 Jun 2019	Latest	Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16	snapsmrc508	16 Feb 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.15 Patch	db/mongo6783	18 Feb 2019	Latest	Fixed connection timeout issue with MongoDB.
4.15 Patch	db/mongo6465	09 Jan 2019	Latest	Fixed an issue wherein REST calls to Ultra tasks returned an error message.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14 Patch	db/mongo5666	13 Aug 2018	Latest	Fixed the Update, Delete, and Find Snaps to populate input view schema for a given table, similar to the Insert Snap.
4.14	snapsmrc490	11 Aug 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.13 Patch	mongo5537	24 Jul 2018	Latest	Fixed the Update, Delete, and Find Snaps to populate input view schema for a given table, similar to the Insert Snap.
4.13	snapsmrc486	12 May 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.12	snapsmrc480	17 Feb 2018	Stable	Added the SSl certification properties to all the MongoDB Accounts to ensure the validation of the certificate.
4.11	snapsmrc465	11 Nov 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.10 Patch	mongo3978	05 Oct 2017	Latest	Resolved an issue where the NumberFormatException was not handled properly for some of the valid Number Types like "NaN"/ "+Infinity"/ "-Infinity".
4.10	snapsmrc414	12 Aug 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.9.0 Patch	mongodb3259	17 Jul 2017	Latest	Addressed an issue in MongoDB Update where Upsert Date failed with "Can't find a codec for class org.joda.time". MongoDB Insert Snap - Collectio name expression evaluate fixed.
4.9	snapsmrc405	13 May 2017	Stable	Query Condition property is now an expression that evaluates to an object or JSON string. Updated the Snap with Database name property to support the users defined in an authentication database.
4.8.0 Patch	mongodb2735	14 Mar 2018	Latest	Added SSL encryption type to all MongoDB accounts and Replica set Accounts and removed the MongoDB SSL account.
4.8	snapsmrc398	11 Feb 2017	Stable	The MongoDB Delete Snap and MongoDB Update Snap were introduced in this release. Enhanced the MongoDB Snap account with SSL Account type. Updated the Batch Size property in MongoDB Find with the default value of 0. Enhanced the MongoDB Find Snap documentation with an example. Info tab added to accounts. Database accounts now invalidate connection pools if account properties are modified and login attempts fail.
4.7 Patch	mongo2375	06 Jan 2018	Latest	Update the MongoDB java driver to 3.0.4; Add exception handling to each record processing. MongoDB SSL Account removed and replaced with the new configuration for all the Accounts (Encryption type Property).
4.7 Patch	mongo2338	27 Dec 2017	Latest	Add an account for MongoDB SSL connection without certificates validation
4.7 Patch	mongo2200	28 Nov 2017	Latest	Fixed an issue for database Select Snaps regarding Limit rows not supporting an empty string from a pipeline parameter.
4.7	snapsmrc382	23 Nov 2016	Stable	Updated the Snap account with the LDAP Authentication type.
4.6	snapsmrc362	13 Aug 2016	Stable	Resolved an issue in MongoDB Insert Snap that processed and inserted all numeric fields as strings.
4.5.1	snapsmrc344	18 May 2016	Stable	Resolved and issue with MongoDB Insert with an empty input view failed. Resolved an issue with MongoDB Insert that changed a numeric type field in MongoDB as String. Resolved an issue that caused Snap execution failures when accessing MongoDB using a Replica Set account.
4.3.2		15 Jan 2016	Stable	Resolved an issue with MongoDB Find returning nothing when nothing was found.
4.3			Stable	Resolved an issue with an incorrect resolution displaying during account validation if the username was blank. Resolved an issue in the MongoDB Find Snap with nested arrays. Resolved an issue in MongoDB Find with data not being usable be other Snaps.
4.2.2			Stable	Username and Password are no longer required fields when creating a MongoDB account because it is possible to configure an instance where that information is not required. MongoDB Aaccount now supports Mongo Java Driver 3.0.2. MongoDB Find Resolved an issue with MongoDB Find not properly supporting the expression language. Resolved an issue with MongoDB Find returning "Current context not an ARRAY but OBJECT" for a deep nested ObjectId object. Resolved an issue with MongoDB Find when data had built-in datatype. Resolved a null pointer exception in MongoDB Find. Resolved an issue with MongoDB Find not routing failed documents to the error view. Resolved an issue with MongoDB error handling when maximum number of documents reached. Improved the error message presented when MongoDB database could not reach the JCC.
4.2.1			Stable	MongoDB - Find: Resolved Error- Failure: java.util.HashMap cannot be cast to java.lang.String when in query condition passes without single quotes. MongoDB - Find: Resolved failure with Query Using Operators. Resolved MongoDB driver and account do not support current version of MongoDB. Resolved a failure MongoDB Insert with custom _id.

Related links:

https://www.mongodb.com/docs/atlas/

https://www.mongodb.com/docs/atlas/atlas-vector-search/tutorials/vector-search-quick-start/