PostgreSQL

Overview

If you have an existing database, you can attach it to your project either by following Quick Start guide or by going to the "Data Source" section of your project. You can connect a Managed or Self-hosted PostgreSQL instance to the project. Some examples of database cloud providers you can use are AWS RDS, and Aiven.

Adding a Data Source in a Neurelo Project

• Add a Data Source:

  • If you already have a Database instance, Click on the "Data Sources" option from the left navigation bar inside your project.

  • Click on the "New" button.

  
• 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 the following 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:

    • Multiple Schema support (default): If you would like to use all the schemas within a PostgreSQL database, simply leave the Schema field empty (default). Neurelo will automatically detect and introspect all available schemas.

    • Notes

      • This feature is only supported for PostgreSQL

      • If the introspection process detects a schema which is empty, that schema will be skipped

  • 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

Multiple schema support: If you would like to use all the schemas within a PostgreSQL database, then make sure the connection string ends with the database name and a schema is not explicitly specified. Neurelo will automatically detect all the available schemas.

• This feature is only supported for PostgreSQL

• If the introspection process detects a schema which is empty, that schema will be skipped

Alternatively, you can specify a schema name at the end of the connection string to limit the introspection to a single schema.

• Example of a connection string with Database name only

  • postgres://user:secret@host:port/postgres

• Example of a connection string with Database and Schema name

  • postgres://user:secret@host:port/postgres?schema=public

This single string contains all necessary connection details, simplifying the process.

Selecting a Region and Allowing Neurelo IP Addresses:

• If you have a firewall or security group configured in front of the database, you may need add Neurelo IPs to the allowed list so that Neurelo can connect to the database. 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.

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".

Saving the Data Source

Once the connection has been successfully tested, you can proceed to click on the "Submit" button. This will create a new data source for your database. You can always come back to this Data Source section to verify database details including health check history.