User Guide: Adding a Database Connection

This user guide provides instructions on how to add a database connection to our platform. There are two main methods available.

Method 1: Using the “Data Sources” Menu

Navigate to the main dashboard of the platform and from the BUILD menu, select Data Sources.

_images/click_on_data_sources.png

In the expanded Data Sources menu, click on Add Database.

_images/click_add_database.png

This will open a pop-up form that allows you to either choose from already connected databases or add a new database connection.

_images/click_new_database_button.png

Clicking new database will lead you to a database connection form.

Method 2: Using the “Add Connection” Button in the DATABASES Content Table

Navigate to the main dashboard of the platform and select the DATABASES Content table.

_images/click_databases_content_menu.png

On the upper right corner of the content table, click on the “Add Connection” button. This will open a database connection form.

Filling Out the Database Connection Form

Regardless of which method you used to connect a new database you will end up facing a following form:

_images/new_database_connection_popup.png

To fill in this form, follow this guide:

  1. Server: Input the host of your database. This will usually be an IP address or a domain name.

  2. Database: Input the name of the database to which you wish to connect.

  3. Port: Input the port that your database uses.

  4. Username: Enter the username that you use for accessing your database.

  5. Password: Enter the password that you use for accessing your database.

  6. Local: Check this box if the database is located on your local machine.

  7. Create new DB: Check this box if you want to create a new database schema with the specified name.

  8. SQL Dialect: Select the appropriate database dialect from the provided combobox.

  9. Finally, click on the “Submit” button to add the connection.

Warning

This process will add the database connection to the platform without checking the validity of the database details.