This page is for administrators who need to connect PhixFlow to external databases using Driver Classes.

Overview

In PhixFlow analysis models, you can use a Datasource to connect to an external database, and then load data from it. 

PhixFlow requires access to the database driver jar files in order to communicate with a database. Use the driver class properties to configure with the details of the database, its driver and the location of the jar files.

PhixFlow is installed with a set of driver jar files and their associated  Driver Classes in the full repository. You can use these driver classes in a datasource. However, you cannot update or change the pre-configured driver classes, which are:

• DB2
• Debug JDBC
• Google Big Query
• Hadoop Hive
• MariaDB
• Microsoft (MS) SQL Server
• MySQL
• Netezza
• Oracle
• Sun ODBC Bridge
• Teradata

How to Configure Driver Classes

You may need to configure additional database drivers to support:

• other types of database
• different versions a database.

To find out which (usually JDBC)  database drivers you require, read the documentation for your database. Also check the  System Requirements and Compatibility page.

1. An administrator with permission to add system files must download the required JDBC drivers and save them to the system.
   To avoid your drivers being overwritten during Tomcat or PhixFlow upgrades, we recommend that you save them in a different part of your file system. 
   
   
2. The PhixFlow administrator configures a driver class for the JDBC drivers by adding to the repository Driver Classes, specifying the database driver name and its path.

Adding or Changing a Driver Class

To create a driver class, in the full repository scroll down to the  Driver Classes section. 

To add a new driver, right-click Driver Classes and select  Add. PhixFlow opens a property tab where you can enter the details for the new driver.

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

Driver Classes and Driver Class File Properties

The driver classes configured in the repository populate the drop-down list in  Datasource properties Basic Settings → Driver Class. 

For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties.  For a full list of all the PhixFlow property tabs and windows, see Property Tabs.

Basic Settings

Driver Class File

This section has a toolbar with standard buttons.

The grid contains a list of jar files and their file path.  To add a jar file to the list:

1. Click  Add to open a the properties for a new Driver Class File Location.

2. In the Basic Settings section, set:

   Field	Description
   Name	Enter a unique name for the driver.
   Connector Jar File Location	Enter the full path to the jar file. Windows example path Linux example path /lib/something/jar

3. Click  OK to save and close the properties for the driver class file.

Some databases require multiple jar files. Add a Driver Class File Location for each of the jar files.

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

Using Drivers Across Multiple Instances

If you run multiple instances of PhixFlow, you must ensure that any custom driver classes you create:

• are exported and then imported to other instances
• have access to the database driver jar file from the other instances.

This ensures that all datasource objects that use the database driver continue to work on the other instances. 

How PhixFlow Decides Which Driver to Use

(Needed??) PhixFlow is configured with a class path for finding drivers. This will use the first appropriate driver it finds in the following locations:

1. The driver classes you configure In PhixFlow.
2. The system driver classes.
3. Database drivers in the Tomcat class directory.
4. Database drivers in the Tomcat lib directory.