PhixFlow automatically uses the appropriate database driver class to communicate with its own database. You can use these driver classes pre-configured database drivers in a datasource. However, you cannot update their properties or see their driver class jar files.

You may need to configure additional database drivers to support:

• other types of database
• different versions a database.

How to Configure a Database Driver

1. Find out which JDBC database drivers you require. This information is available in the documentation for your database. Also check the System Requirements and Compatibility page for supported versions. Communication to a database may require multiple JDBC driver files. 
2. Download the required JDBC driver files from:
   • either the database supplier (recommended)
   • or an open source repository, such as https://mvnrepository.com/.
3. Save the files to the Database Driver Class File Directory. You need permission to add system files to do this.
   
   • If it has been set in the PhixFlow database, it will be listed in the System Configuration.
   • If it has not been set:
     

     Insert excerpt
     _set_driver_dir _set_driver_dir nopanel true

4. In the PhixFlow application, for each type of database, create one Driver Classone database driver; see Adding or Changing a Database Driver Class, below.
5. In the database driver class properties → Database Driver Class File section, add all the JDBC driver files that the database requires; see Driver Classes and Driver Class File Database Drivers Properties, below.
6. For each driver class jar file, specify the full path to the file, which is stored in the Database Driver Class File Directory, or a sub-directory of it.

Adding or Changing a Database Driver

Anchor
_add _add

To create a database driver class, in the full repository scroll down to the

To add a new driver, right-click Driver Classes Database Drivers and select 

To open an existing driver classdatabase drivver, in the repository click on its name.

Database Driver

Properties 

Anchor
properties properties

The driver classes database drivers configured in the repository populate the drop-down list in

Basic Settings

Advanced

Database Driver

File

This section has a toolbar with standard buttons. 

The grid lists the jar files for this database driver class. Each database usually requires multiple jar files. To add a jar file to the list:

1. Click

   Insert excerpt
   _new _new nopanel true

    to open a the properties for a new Database Driver Class File Location.
   (Database Driver Class File Location properties are only available from this grid. They are not listed in the repository.)

2. In the Basic Settings section, set:

   Field	Description
   Name	Enter a unique name for the driver.
   Connector Jar File Location	The root Database Driver Class File Directory, must be specified in System Configuration.  Specify a path, relative to the root Database Driver Class File Directory: either to a specific driver class jar file or to a sub-directory that contains multiple driver class multiple driver jar files. For example: if the file is /opt/phixflow-drivers/BigQueryJDBC/driverfile.jar and the Database Driver Class File Directory is set to /opt/phixflow-drivers/ then enter: for Linux: BigQueryJDBC/driverfile.jar Windows:  BigQueryJDBC\driverfile.jar If you specify a sub-directory, all jar files will be loaded but further sub-directories will be ignored.

   
   

3. Click 

   Insert excerpt
   _finish _finish nopanel true

    to save and close the properties and return to the database driver class properties.

To remove a jar file from the grid, use the toolbar button 

Using Drivers Across Multiple Instances

If you run multiple instances of PhixFlow, you must ensure that:

• a custom database driver class used by a datasource, is moved with the datasource to another PhixFlow instance
• AND the database driver class has access to the database driver jar file from the other instance.

This means all datasource objects continue to work in other instances. 

You cannot move the following system database drivers into a package:

• MariaDB
• MS SQL Server
• Oracle.

This is because they are installed on all PhixFlow instances.

How PhixFlow Decides Which Driver to Use

PhixFlow is configured with a class path for finding drivers. This will use the first appropriate driver it finds in:

1. The Connector Jar File Location configured for the driver classes database drivers file. 
2. tomcat/webapps/phixflow/WEB-INF/lib
3. tomcat/lib.

Deprecated

Database Drivers

The repository includes the following, deprecated driver classesdatabase drivers, for backwards compatibility. 

• DB2
• Debug JDBC
• Google Big Query
• Hadoop Hive
• MySQL
• Netezza
• Sun ODBC Bridge
• Teradata