Add and Manage Databases

Last updated 21/10/2024

Who Can Add and Manage Databases?

Please refer to the chapter Five's Users and Roles.

Supported External Databases

You can select to create a connection to the following external Database Management Systems (DBMS).

• MSSQL
• MySQL

Connection String Details

tip

When importing an SQL file, the name of your database in the external database must exactly match the name of your database in Five. This is the value in the Database ID field for the database record.

To use an external database, you will need to have an account created with the database provider.

The connection string configures Five's database connection to connect to the external DBMS. You need to provide the connection string to establish the database connection. The connection string represents a set of parameters in the form of key=value pairs separated by semicolons.

Key	Value	Example
Driver	The database driver allows you to interact with your chosen DBMS through Five's interface.	driver=mssql
URL	A database connection URL provides a way of identifying a database so that the selected driver recognizes it and connects to it, this can be a host name or an IP address including the port number.	url=serverdb.host.com:1433
Username	Your username in your DBMS.	username=user
Password	Your password in your DBMS.	password=password
Name	The name of your database in your DBMS.	name=exampleDB

Example

driver=mssql; url=serverdb.host.com:1433; username=user; password=password; name=exampleDB

caution

The value in the Database ID field must exactly match the name value in your connection string as shown in the image below, meaning, the Database ID and the name of your external database must exactly match.

Figure 1 - Database form

Add a Database

1. Navigate to the Databases view.

2. Click the Add Item button.

Figure 2 - Add Item button

3. Type an ID in the Database ID field.

info

This must be exactly the same as your external database name.

4. Click the lookup icon in the Database Type field and select the type.

5. Type your connection string in the Connection String field following the above guidelines.

Figure 3 - Add a database

6. Click the Save button in the form app bar.

Figure 4 - Save button

Edit a Database

info

The database created by Five when you first save an application is read-only, therefore, it cannot be edited. Only external databases can be edited.

1. Select the database record in the list.

2. Either click the Edit button in the form app bar, or click directly in a field.

Figure 5 - Edit button

3. Make your changes.

4. Click the Save button in the form app bar.

Figure 6 - Save button

Delete a Database

caution

Deleting a database will delete all the data in the database. It is recommended to backup your data first!

1. Select the database record in the list.

2. Click the Edit button in the form app bar.

3. Click the Delete button in the form app bar.

Figure 7 - Delete button

4. Click the Yes button.

Figure 8 - Yes button