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 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
Your PhixFlow instance is installed on a database, either MariaDB, SQL Server or Oracle. PhixFlow uses the driver class to communicate with its own database.
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 System Requirements and Compatibility.
- 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 the system. - The PhixFlow administrator configures a driver class for the driver, specifying the database driver name and its path.
Adding or Changing a Driver Class
To create a driver class, in the repository scroll down to the ICON section.
To add a new driver, right-click ICON and select . PhixFlow opens a Add Newproperty tab where you can enter the details for the new driver.
To open an existing driver class, in the repository click on its name. You cannot change the pre-configured driver classes supplied with your PhixFlow installation.
Driver Classes and Driver Class File Properties
The driver classes configured in the repository populate the the drop-down list in properties Basic Settings → Driver Class. Datasource
For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. We recommend you always add a Description that explains the purpose of the item you are creating.
For a full list of all the PhixFlow property tabs and windows, see Properties, Windows, Menus and Toolbars.
Basic Settings
Field | Description |
---|---|
Name | Enter a unique name for the driver, which will appear in the PhixFlow repository. |
Driver Class Name | Enter the driver class name, which you will find in the driver documentation. For example, for MySQL, the driver name is: |
Description | Optionally enter a description for the driver. |
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:
- Click to open a the properties for a new Driver Class File Location. Add New
In the Basic Settings section:
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
Click to save and close the properties for the driver class file. Apply and Close
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 . Delete
Do driver class files need a jira need something to restrict where it will look for the Jar files.
Driver Classes have their own privilege??? - should be restricted to admins and import export.... but may not be at the moment
Using Drivers Across Multiple Instances
For application building, once you have a custom driver, you need the same driver on all instances - so you need to export/import or you will lose the refences.
How PhixFlow Decides Which Driver to Use
The PhixFlow class path for finding drivers (but the drivers must be specified in the driver class so I'm not sure this is relevant any more
- Your drivers you configure
- Drivers saved to PhixFlow's lib directory
- Drivers in the Tomcat class directory
- Drivers in the Tomcat lib directory.