Neurelo Build Docs
Neurelo Build Docs
  • Introduction
    • Core Concepts
    • Key Features
  • Getting Started
    • Sign-in/Sign-up
    • Dashboard
      • Collapsible Sidebar
      • Light/Dark Mode
      • Account Settings
      • Audit Events
      • User Management
        • Permissions (Member v/s Admin)
      • Org Settings
    • Starting your Neurelo Project
      • Quick Start Guide
      • Step 1 - Add a Data Source
      • Step 2 - Build Definitions
      • Step 3 - Create an Environment
      • Step 4 - Create an API Key
      • Step 5 - Start Runners
      • Try your Neurelo APIs
  • "How to" Videos
    • Product Overview
    • Neurelo APIs & SDKs
    • Project Setup
    • Definitions
    • Environments
    • Data Sources
    • Organization Management
    • Creating and Using Custom Queries
    • Using the Schema Builder to build Relationships
    • Mock Data Generation
  • Definitions
    • Neurelo Schema Editor
      • Schema Builder
      • JSON/YAML Editor
      • Schema Visualization: Entity-Relationship Diagram (ERD)
    • Custom APIs for Complex Queries
      • Write and Commit Custom Queries
      • AI-Assisted Query Generation
      • Deploying Custom API Endpoints
      • Using Variables in your Custom Query
    • Branches and Commits
    • API Docs
  • Environments
    • Creating a new Environment
    • API Playground
    • Observability
    • Migrations
    • API Keys
  • Data Sources
    • PostgreSQL
    • MySQL
    • MongoDB
  • Guides
    • Provisioning Cloud Databases for using with Neurelo
      • PostgreSQL
        • AWS RDS (PostgreSQL)
      • MySQL
        • AWS RDS (MySQL)
      • MongoDB Atlas
    • Mock Data Generation
    • Wipe Data Source
    • Remote Git Repository for Definitions
      • Connecting a Remote Git Repo
      • Creating Commits from Neurelo
      • Syncing Branches
    • Data Viewer
    • Environment/Data Source Tags
    • How to work with Embedded documents and References in MongoDB
    • How to download and use the Postman Collection for your Project
    • Building Python applications with Postgres and FastAPI
    • CI Integration using Neurelo CLI
    • Schema Migrations
    • Schema AI Assist
    • Auto-Introspection
    • Access Policies
    • User Auth
      • Google
      • GitHub
      • GitLab
    • MongoDB Atlas - Migrate GraphQL to Neurelo
    • MongoDB Atlas - Migrate REST Data APIs to Neurelo
  • MongoDB Atlas - Migrate REST Data APIs to Neurelo
  • MongoDB Atlas - Migrate GraphQL APIs to Neurelo
  • Neurelo Schema Language (NSL)
    • Example 1 - DVD Rentals
    • Example 2 - Simple "Posts" App
    • Example 3 - Bookstore
  • Neurelo API Reference (REST)
    • Examples of Neurelo Auto-Generated REST API endpoints
      • Example 1 - Simple “Posts” application
      • Example 2 - "DVD Rentals" application
      • Example 3 - "Bookstore” application
      • cURL API Examples
  • Neurelo API Reference (GraphQL)
  • SDKs
    • TypeScript / JavaScript SDK
    • Go SDK
    • Python SDK
      • Python SDK Tutorial -- News Application
        • News Application using Neurelo’s Python SDKs
  • CLI (Preview Version)
  • Self-Hosted Neurelo Gateways
  • Tutorials
    • Building a Real Time Chat Application with Neurelo and MongoDB using Python
    • Building A Financial Terminal with Neurelo and MongoDB in Rust
    • Building a Restaurant Management System with Neurelo and MongoDB using GraphQL in just a few minutes
    • Bringing Neurelo’s Data APIs to Life Instantly with MySQL
  • Project Examples
  • References
    • Supported Databases
    • Supported OS and Browsers
  • Support
Powered by GitBook
On this page
  • Overview
  • Get Started with MongoDB Atlas
  • Connection String Formats for Neurelo
  • Collect MongoDB connection details from the Atlas UI
  • Getting MongoDB database_name from the Atlas UI
  • Add MongoDB as a Data Source in a Neurelo Project
  • Connecting MongoDB Atlas with a Connection String
  1. Guides
  2. Provisioning Cloud Databases for using with Neurelo

MongoDB Atlas

PreviousAWS RDS (MySQL)NextMock Data Generation

Last updated 6 months ago

Overview

This section outlines how to spin up Cloud Databases and connect them with Neurelo. While we mention certain cloud providers here, it's important to note that Neurelo is designed to work seamlessly with supported MongoDB databases across any Cloud, Hybrid, On-Prem or Local deployments

Reference -

Get Started with MongoDB Atlas

MongoDB Atlas () is a managed multi-cloud database service. You can use Atlas free clusters for a small-scale development environment to host your data. Free clusters never expire, and provide access to a of Atlas features

MongoDB Atlas offers both a user interface (UI) and a command-line interface (CLI) for accessing its services. Be sure to click on the "Atlas UI" option when using the MongoDB documentation website.

  • Sign up: If you don't already have an account, you can .

  • MongoDB Atlas Database Service: Instructions to . You must complete following steps:

    • Create an

    • Create an

    • Configure a

Connection String Formats for Neurelo

Neurelo will accept the connection string in either of these formats

  1. mongodb+srv://username:password@cluster0.cluster.mongodb.net/database_name

  2. mongodb://username:password@host:port/database_name

You need to replace the username, password, host, port, cluster, and database_name in the above strings as appropriate

Collect MongoDB connection details from the Atlas UI

To enable communication between Neurelo and your MongoDB database, configure your MongoDB instance on Atlas in your Neurelo project. You will need following information from Atlas Cloud:

  • Go to the Overview page for your project. If your desired project is not active in the UI, choose the appropriate project from the Projects menu in the top-left navigation panel.

  • Select "Databases" from the options in the left navigation panel.

  • On the "Database Deployments" page, locate the database deployment (cluster) you wish to connect to, then click on the "Connect" button associated with that deployment.

  • From the Connect page, select "Compass". Copy the connection string from the Compass view as shown (you can use the Copy icon on the right of the string)

Neurelo requires database_name to be present in the connection string. Atlas Cloud UI does not display the <database_name> in the connection string -- you will need to append it to the string.

Getting MongoDB database_name from the Atlas UI

  • To find and add the <database_name> in your connection string, go to the "Database Deployments" page in the Atlas UI, and locate the deployment (cluster) you wish to connect to, then click on the "Browse Collections" button associated with that deployment.

  • In the Collection view, you will find the list of databases. Copy the database name you wish to connect with Neurelo and append it to your connection string

  • In the below screenshot, there is a database called "nyc_civil_service" on "Cluster0". Use this database name in your connection string.

  • Your connection string would be -> mongodb+srv://<username>:<password>@cluster0.<cluster>.mongodb.net/nyc_civil_service

Add MongoDB as a Data Source in a Neurelo Project

Connecting MongoDB Atlas with a Connection String

  1. Login to your Neurelo Dashboard

  2. Choose the project where you want to add a new data source or create a new project for this purpose.

  3. For new projects, follow the Quick Start Guide and click on "Connect Data Source" button. For existing projects, navigate to "Data Sources" from the left navigation bar in the project and click on the "New" button

  4. Access the New Data Source dialog box. Enter the connection string obtained earlier from the MongoDB Atlas UI (and make sure it has <database_name> added).

  5. Allowed inbound IP addresses: The default setting for Atlas Cloud services does not allow access from all IP ranges. You must add Neurelo's IPs to your allowed list on Atlas Cloud

.

MongoDB Compass: You can also get the connection string and database name using the MongoDB Compass client -- details .

For each new project in Neurelo, you can utilize the Quick Start feature, a guided wizard for step-by-step onboarding, including like MongoDB Atlas. Additionally, you can create new Data Sources anytime within your project from the left-navigation panel.

Add Neurelo IP addresses to your . The Neurelo IP addresses to use for your project will be displayed in this dialog box.

After entering the connection details, click on "Test Connection" to verify that Neurelo can successfully connect to MongoDB Atlas. Once the test is successful, click Submit to save the configuration in Neurelo. Please refer to for additional information.

MongoDB
Neurelo Supported Databases and Versions
https://www.mongodb.com/atlas/database
subset
get started for free with Atlas
create MongoDB Atlas free cluster service
organization with a project
active database cluster in your account
database user in your cluster
Log in to Atlas
here
adding a new Data Source
Atlas IP access list
this page
MongoDB Atlas Cloud - Database Deployment View
Atlas Database Deployment page with the list of databases
New MongoDB Data Source with Connection String in Neurelo