Using PostgreSQL as the External Database

Version

Function Description

A FineDataLink system with an external database configured is stable in cluster environments or when dealing with high-volume data.

You can configure a PostgreSQL external database in FineDataLink by installing the PostgreSQL External Database plugin.

Note:

If an external database is configured, do not modify its username and password. Otherwise, the project startup will fail.

If you need to modify them, see Changing the Username and Password of the External Database.

Note

If the project is configured with a virtual directory, namely, the system can be accessed directly via the IP address when the project is deployed on Tomcat, modify the server configuration file before installing the plugin.

Open the server.xml file in TOMCAT installation directory/conf/, and set reloadable to false, as shown in the following figure.

Prepare the database where the platform data will be migrated. You are advised to create an empty database (refer to the "Hardware Configuration" section for recommended database size).

Note:

Different FineDataLink projects cannot share the same external database. Otherwise, data may become conflicted.

Database Version

The following table describes the supported types and versions of the external database.

Hardware Configuration

Notes:

1. Modify the occupied space according to the usage. You can set it to be one to two times larger than the size of the finedb folder in webapps/webroot/WEB-INF/embed (considering future use).

2. The recommended size of memory is intended for the project configuration database.

3. The external database should be in the same network segment as the FineDataLink project to avoid network fluctuations.

Installing the Plugin

You can download the plugin: PostgreSQL Database.

For details about how to install the plugin, see Plugin Management.

Checking the Configuration

If you are using the Data Pipeline function, pause the running synchronization tasks before configuring the external database.

External Database Configuration Entries

Log in to FineDataLink as the admin and choose System Management > System Setting > General > External Database, as shown in the following figure.

External Database Configuration

After you access the external database configuration page, select the database type and enter the information of the actual database, as shown in the following figure.

Setting Item

The following table describes each setting item.

Setting Item	Description
Database type	Select postgresql.
Driver	This parameter is automatically configured, requiring no modification.
Database name	Enter the name of the database created in the "Database Configuration" section. Notes: 1. Sharing a database with other projects is prohibited. You are advised to create a database. 2. The database name can contain only numbers, letters, underscores (_), and periods (.).
Username/Host/Password/Port	Enter these values based on the actual database configuration. Notes: 1. The hostname can contain only numbers, letters, underscores (_), hyphens (-), and periods (.).  2. You need to have the create, delete, alter, update, select, insert, and index permissions.
Mode	You can only select a mode from the drop-down list. After correctly setting the values of the above parameters, select Click to Connect Database from the drop-down list. The system will automatically connect to the database and read schemas. Select a schema (preferably the one matching the database username). Notes: 1. If a prompt indicating database connection failure is displayed, check the settings above. 2. Schema names do not support uppercase letters. If you create a schema, use lowercase letters.

Migrating Data to the Database to Be Enabled

You can determine whether to tick Migrate Data to Database to Be Enabled as needed. The following describes the details:

1. If the new external database is empty, and Migrate Data to Database to Be Enabled is ticked:

After you click Enable New Database, the platform data of the original FineDB database will be migrated to the new external database.

2. If the platform data already exists in the new external database, and Migrate Data to Database to Be Enabled is ticked:

After you click Enable New Database, the message "The platform data already exists in the database. Before data import, the original platform data will be cleared. Sure to connect to the database?" pops up.

After you click OK, the original platform data will be cleared, and the platform data of the original FineDB database will be migrated to the new external database.

3. If the new external database is empty, and Migrate Data to Database to Be Enabled is unticked:

After you click Enable New Database, the message "The target database is a new database and can be used after the current data is migrated to the target database." pops up.

After you click OK, the platform data of the original FineDB database will be migrated to the new external database.

4. If the platform data already exists in the new external database, and Migrate Data to Database to Be Enabled is unticked:

After you click Enable New Database, the BI project in 5.1.15 and later versions will automatically detect whether the JAR package version corresponding to the data in the target database is consistent with that in the current project.

• If the versions are inconsistent, the message "Unable to enable it. Project version required to enable the new database: xxx Current project version: xxx Ensure the project versions are consistent!" is displayed. In this case, you cannot proceed with the external database configuration.

• If the JAR package versions are consistent and the original FineDB database is a built-in database, the new external database is enabled directly.

• If the JAR package versions are consistent and the original FineDB database is an external database, the system automatically backs up the original database configuration before migration, generates a db.properties.bak file in webapps/webroot/WEB-INF/config, and enables the new external database, as shown in the following figure.

Successful Migration

Wait for the migration to complete. Different pop-up prompts may be displayed depending on the migration situation.

1. If the new external database uses data from the original FineDB database:

The message "The target database has been enabled successfully." pops up. Click OK to complete the migration, as shown in the following figure.

2. If the new external database uses its own existing data and the original FineDB database is a built-in database:

The message "Successfully switched to the target database. If data is different between the old and new databases, system running may be affected. You are advised to restart the project for normal use." pops up.

Click OK and restart the project to complete the migration, as shown in the following figure.

3. If the new external database uses its own existing data and the original FineDB database is an external database:

The following two messages pop up:

• Successfully switched to the target database. If data is different between the old and new databases, system running may be affected. You are advised to restart the project for normal use.

• The original database configuration has been backed up to the config folder. You can use the backup file to restore the database configuration if necessary.

Click OK and restart the project to complete the migration, as shown in the following figure.