=========================================
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**.

.. image:: /images/click_on_data_sources.png
    :width: 600
    :align: center

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

.. image:: /images/click_add_database.png
    :width: 600
    :align: center

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

.. image:: /images/click_new_database_button.png
    :width: 600
    :align: center

Clicking *new database* will lead you to a :ref:`database connection form <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.

.. image:: /images/click_databases_content_menu.png
    :width: 600
    :align: center

On the upper right corner of the content table, click on the "**Add Connection**" button. This will open 
a :ref:`database connection form <database_connection_form>`.

.. _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:

.. image:: /images/new_database_connection_popup.png
    :width: 800
    :align: center

To fill in this form, follow this guide:

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

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

    #. **Port**: Input the port that your database uses.

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

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

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

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

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

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