Step 1 - Add a Data Source
Last updated
Last updated
The first step in the project onboarding process is to connect a data source to the project.
If you have an existing database, you can attach it to this project using "Connect Data Source". Once the database is connected, Neurelo will perform an "introspection" on the data source and will try and infer the schema (data models) for the project from the database. If Neurelo finds a valid schema in the database, it will initialize the definitions with that schema (step 2 of the onboarding). If no valid schema is found, then the user will need to proceed to Step 2 and Build Definitions (Schema) to be used for the project.
Reference - Neurelo Supported Databases and Versions
You can connect a Managed or Self-hosted PostgreSQL, MySQL or MongoDB instance to the project in this step. Some examples of database cloud providers you can use are AWS RDS (PostgreSQL, MySQL), Atlas (MongoDB), Aiven (PostgreSQL, MySQL).
Neurelo Provisioned Databases (Preview): For evaluation purposes, Neurelo also supports provisioning an evaluation database for your project. Neurelo offers this database for evaluation purposes only, with no guarantees on availability, durability, or security. This database should not be used for production workloads.
Neurelo provisioned databases will be spun up for PostgreSQL and MySQL on AWS RDS, and on Atlas for MongoDB. You can spin up one Neurelo Provisioned database per organization.
Note - We are gradually rolling out this feature for our users, and it may not be available for your account yet.
Starting with 'Add a Data Source':
The first step in Quickstart is to connect your data source, which can be PostgreSQL, MongoDB, or MySQL.
If you already have a Database instance, Click on the "Connect Data Source" button to begin this process.
Alternatively, if you don't have a Database instance, Neurelo provides a seamless way to quickly provision an evaluation database instance for you.
Choosing How to Connect:
Upon clicking, a popup window will appear, asking you to name your data source.
Next, you have two options to establish the connection: using Connection Details or a Connection String.
Using Connection Details: If you opt for Connection Details, you'll need to provide specific information about your database:
Host: The URL endpoint of your database
Port: The port number used for the connection
Database: The exact name of the database to be used
Schema: Specify a schema, by default the schema will default to 'public', you can configure a different database schema for Neurelo to use based on your database configuration
Username: The username to be used for connecting to the database
Password: The password to be used for connecting to the database
Using a Connection String: Alternatively, if you choose the Connection String method, simply input the connection string provided by your database host
This single string contains all necessary connection details, simplifying the process.
If you have a firewall or security group configured in front of the data source, you may need add Neurelo IPs to the allowed list so that Neurelo can connect to the data source. There are multiple IPs for the selected region, all of which need to be permitted in the firewall or security group configuration
Below the connection details or connection string, there’s an option to select a region. Choose one that best suits your operational needs.
It is highly recommended that you create your Neurelo environments geographically as close to where the data source is as possible, for the best performance and lowest latency for your projects.
If you needed to configure Neurelo IPs to connect to your database, please make sure you spin up Environments that will use this database in the same region as the configured IPs selected.
To make sure that all the information has been correctly entered and the Neurelo IPs have been added to the allowlist, you can test the connection by clicking on "Test Connection", You will receive a pop up saying "Connection test in progress" and once the connection has been tested successfully, you receive a message "Connection test completed successfully".
You can then proceed to click on the "Submit" button. Once the data source is connected, Neurelo will perform an "introspection" on the data source and will try and infer the schema (data models) for the project from the database.
If the database is empty and no valid schema is found, or the introspection process could not be completed for other reasons then the user will need to proceed to Step 2 and Build Definitions (Schema) to be used for the project. The quick start flow would now look something like this -
If Neurelo finds a valid schema in the database during the introspection process, it will initialize the definitions with that schema (Step 2 of the onboarding). Steps 1 and 2 are both completed now. You can proceed directly to Step 3 (Create an Environment). The quick start flow would now look something like this -
By following these steps, you can successfully add a data source to your Neurelo project, setting the initial foundation for your subsequent activities and integrations within the platform.
