Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is for data modellers who want to connect to an external database, either to load data or to export processed data back to a database.

Overview

The A datasource defines a connection is a modelling object whose properties provide the information needed to connect to an external database. You need to define at least one datasource modelling object in order to push and pull data to and from external database systems. You can configure several datasource objects must have one datasource for each type of database to which you need to connect. The datasource has the information needed to push data to and pull data from the external database. Optionally, you can configure several datasources for the same type of database. This is useful if you want to have several connections to the same database.

Datasource behaviour is also determined by these parameters set elsewhere in PhixFlow:

...

How a datasource behaves when you run analysis on the model is affected by:

  • the Privilege Allow anonymous updates on datasources'. Only a user with this privilege can modify change the 'Anonymous export allowed' flag on a Allow Anonymous Export tick box on the datasource.
  • the System Configuration. parameter ' option Allow anonymous export by default'. This causes the 'Anonymous export allowed' to be true . When selected, this system option sets Allow Anonymous Export to be ticked by default on all new datasources.

To configure a datasource you must specify:

  • a name
  • a driver class. This should match the type of datasource you are connecting to, e.g. Oracle; see Driver Classes.
  • The protect during import flag can be used to prevent this datasource being updated or deleted during import. 
    To prevent orphaned datasources, when a parent application is deleted by the import, its datasources will also be deleted.Remember to set the enabled flag to make the datasource active.


  • Most importantly, ensure you have configured at least one datasource instance.

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

The toolbar has the standard icons and 

Insert excerpt
_datasource_show_tables
_datasource_show_tables
nopaneltrue
, which opens a list of tables visible for this datasource using the default login details; see the Table Details window.

For information about other property tabs, see Property Tabs.

Basic Settings

FieldDescription
NameRequired. Enter the name for this datasource object. You will use this name to specify this datasource object in other collector and exporter objects.
Enabled

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 when the configuration is complete and the datasource is ready to be used.

URLEnter the URL to connect to the datasource; see Connection URLs below. what
Allow Anonymous Export

For datasources connected to an exporter being run by a task, such as a scheduled task.  The target database must permit anonymous updates.

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to allow an exporter to export data anonymously to a database using the datasource. The datasource uses the anonymous username and password configured ...?where.

The datasource can only use the logged in user's credentials (see Use user credentials below).

You need the Allow anonymous updates on datasources privilege to change this option.

Use User Credentials on Export

For datasources connected to an exporter being run interactively, when a user clicks 

Insert excerpt
_run_analysis
_run_analysis
nopaneltrue
 directly or via an application action.

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
  to connect to the target database using the PhixFlow username and password of the current logged-in user.


Note
The target database must already have the same username and password with the required permissions. Contact the database administrator to do this. 


Protect during import

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue

 to specify ??

 

  • can be used to prevent this datasource being updated or deleted during import.  To prevent orphaned datasources, when a parent application is deleted by the import, its datasources will also be deleted.
Password

Password for connecting to the datasource with the Anonymous Username.

I've ticked Allow Anonymous, and Use User, but I'm not seeing any fields where I can specify which user credentials to use. This option has gone.

Driver Class

Required. Select the driver class for the type of database to which the datasource object connects

.  This should match the type of datasource you are connecting to, e.g. Oracle;

Tip

Not all the driver classes listed are configured with the JDBC drivers; see Driver Classes.



Advanced

FieldDescription
Check Query
See Advanced Configuration.Datasource ProfileSee Advanced Configuration.DescriptionA description of the datasource instance.

...

A datasource instance must have a name, a URL, and a username and password used to connect to the external datasource. The URL should be in one of the following formats:

...

bgColor#e6f0ff
titleBGColor#99c2ff
titleExample connection strings

...

Platform

...

Connection String

...

...

jdbc:oracle:thin:@hostname:1521:phixflow

...

jdbc:oracle:thin:@hostname:1521/phixflow

...

Sql Server

...

jdbc:sqlserver://hostname\myservice;databaseName=phixflow

...

MySQL

...

jdbc:mysql://hostname/phixflow

...

bgColor#e6f0ff
titleBGColor#99c2ff
titleCheck Query

...

This is an advanced (optional) setting. Use this field when connections to the target database might go "stale", e.g. if the target database disconnects long running connections. Setting this field causes PhixFlow to run the query against the database just before each use of a "pooled" connection. If the query does not return a row, the connection is discarded and a new connection is created. To avoid any performance impact, the query should execute quickly. See also database collectors for guidance on writing SQL queries in PhixFlow.

...

Datasource ProfileThis is an advanced (optional) setting. Use this field when connections to the target database have certain requirements that are not covered by PhixFlow's default external Datasource configuration. The value entered in this field will determine which external datasource connection profile that this datasource instance will use to connect to the target database.

Connection URLs
Anchor
url
url

A datasource instance must have a name, a URL, and a username and password used to connect to the external datasource. The URL should be in one of the following formats:

Panel
bgColor#e6f0ff
titleBGColor#99c2ff
titleExample connection strings


Platform
Connection String

Oracle

jdbc:oracle:thin:@hostname:1521:phixflow

Oracle (> 12c with PDB containers)

jdbc:oracle:thin:@hostname:1521/phixflow

Sql Server

jdbc:sqlserver://hostname\myservice;databaseName=phixflow

MySQL

jdbc:mysql://hostname/phixflow

Big Queryjdbc:bigquery://@hostname:@port;ProjectId=@Project;