Using SQL Server as the External Database

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 SQL Server as the external database during initial setup or in System Management.

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.

Database Version

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

Hardware Configuration

Notes:

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

2. 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).

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

Creating a Database

Create a database to store platform-related data.

Standard database creation statement: CREATE DATABASE Database name COLLATE Chinese_PRC_CS_AS

Note:

1. Database names do not support numbers.

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

You can set the collation for the SQL Server database to Chinese_PRC_CS_AS (case-sensitive) or Chinese_PRC_CI_AS (case-insensitive). You are advised to use Chinese_PRC_CS_AS (case-sensitive).

• If you select Chinese_PRC_CS_AS, all data will be migrated intact.

• If you select Chinese_PRC_CI_AS and the migration reports an error indicating that the fine_conf_entity table violates the PRIMARY KEY constraint, this is typically caused by dirty data in the project.

    You can run the following SQL statement to view dirty data: select lower(ID),COUNT(1) FROM FINE_CONF_ENTITY GROUP   

    BY LOWER(ID) HAVING COUNT(1) >1

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

The three external database configuration entries are as follows.

1. You (the super admin) can configure an external database for the system upon first login, as shown in the following figure.

2. For systems that use built-in databases, you (the super admin) can log in to the system, choose System Management > System Setting > General > External Database > To Be Configured, and configure the external database for the system for the first time, as shown in the following figure.

3. For systems for which external databases have been enabled, you (the super admin) can log in to the system, choose System Management > System Setting > General > External Database > Configured, and migrate data to a new external database for the system, as shown in the following figure.

Configuring the External Database

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 sqlserver.
Driver	This parameter is automatically configured, requiring no modification.
Database name	Enter the name of the database created in the "Creating a Database" section. Notes: Sharing a database with other projects is prohibited. You are advised to create a database. The database name can contain only numbers, letters, underscores (_), and periods (.).
Username/Host/Password/Port	Enter these values based on the actual database configuration. Note: The hostname can contain only numbers, letters, underscores (_), hyphens (-), and periods (.).
Mode	You can 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). Note: If a prompt indicating database connection failure is displayed, check the settings above.

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 project automatically checks 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.

Deleting the Data Connection to the Built-in Database

The built-in FineDB database is an HSQL database that creates an in-memory database when used, which will occupy a large amount of memory when the data volume is large.

Therefore, after configuring the external database, check whether a data connection to the built-in FineDB database exists in Data Connection.

If so, delete the data connection in time. Otherwise, the connection will continue to occupy server memory.