Versions Compared

Key

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

Version differences

The database installation process differs between version 10 and version 11, please follow the relevant instructions below:

...

titleVersion 11 - Show Details

Introduction

...

Introduction

PhixFlow manages most of the process for schema installation and upgrade.

...

A DBA, however, is required to configure the initial database user/schema that

...

PhixFlow will use.

...

PhixFlow manages its own tables and therefore requires being connected with a user with sufficient permissions to create and drop tables and indexes.

Create the database user

If you are  Database Administrator (DBA) and no database / login have previously been set up, you should use the following commands to create a new database / user.

Creating the database user is dependent on the database platform, and will often have to be varied to meet local requirements regarding naming and security. These example commands will be adequate basic installations.

Platform

Create the database user

Oracle:

This command will prompt for the name of the user to be created.

Code Block
sqlplus SYS/SYSPassword@SID as SYSDBA @install/oracle/create_user


Sql Server:

Before creating the database, ensure that default collation is Latin1_General_CI_AS

Code Block
SELECT SERVERPROPERTY('collation');

If it is not, please talk to the database administrator to get this updated to the required collation (see also Install MS SQL Server).

This command creates a local (SQL Server) login, a user with required user mappings, sets the password for the login and creates the database.

Code Block
sqlcmd -S localhost\myservice -i /install/sql_server/create_database_and_user.sql -v dbName="phixflow" dbLogin="phixflow" dbUser="phixflow" dbPassword="mypass"

Run the following command to confirm the collation setting is correct.

Code Block
SELECT DATABASEPROPERTYEX('DBNAME', 'Collation');


MySQL:

Anchor
MariaDB database creation
MariaDB database creation
Connect to the database as root (or an administrator):

Code Block
mysql --user=<myrootuser> --password

If you followed the suggested PhixFlow installation notes for installing MySQL, you will be using unix_socket authentication (see Install MySQL), and the command to log into the database as root is simply:

Code Block
sudo mysql

Create the user, supplying the name of the database, the user and the password in the commands below:

Code Block
create database phixflow CHARACTER SET = 'utf8' COLLATE = 'utf8_bin';
create user '<myuser>'@'%' identified by '<mypass>';
grant all privileges on phixflow.* to '<myuser>'@'%';
exit


SQL Server:

This command will prompt for the name of the user to be created.

Note

If a database, with login details, was provided (i.e. you did not perform the step above for creating the login, user and database), please check that the database has the correct collation:

E.g.

Code Block

Introduction

The schema installation prepares Phixflow to be able to use the database has 4 main steps, regardless of platform:

  1. Create the database user
  2. Create the tables required
  3. Populate them with initial configuration data
  4. Set the customer name

All of the commands below should be run from an operating system command window e.g. bash (Linux) or cmd (Windows), and the current directory should be set to that containing the installation instructions for the target platform. E.g.

Code Block
cd $RELEASE/phixflow-x.y.z-yyyymmdd/install

Create the database user

If you are  Database Administrator (DBA) and no database / login have previously been set up, you should use the following commands to create a new database / user.

Creating the database user is dependent on the database platform, and will often have to be varied to meet local requirements regarding naming and security. These example commands will be adequate basic installations.

Platform

Create the database user

Oracle:

Code Block
sqlplus SYS/SYSPassword@SID as SYSDBA @schema/oracle/install/create_user

Sql Server:

Before creating the database, ensure that default collation is Latin1_General_CI_AS:

Code Block
SELECT SERVERPROPERTY('collation');

If it is not, please talk to the database administrator to get this updated to the required collation (see also Install MS SQL Server).

This command creates a local (SQL Server) login, a user with required user mappings, sets the password for the login and creates the database.

Code Block
sqlcmd -S localhost\myservice -i schema/sql_server/install/create_database_and_user.sql -v dbName="phixflow" dbLogin="phixflow" dbUser="phixflow" dbPassword="mypass"

MySQL:

AnchorMariaDB database creationMariaDB database creationConnect to the database as root (or an administrator):
Code Block
mysql --user=<myrootuser> --password

If you followed the suggested PhixFlow installation notes for installing MySQL, you will be using unix_socket authentication (see Install MySQL), and the command to log into the database as root is simply:

Code Block
sudo mysql

Create the user, supplying the name of the database, the user and the password in the commands below:

Code Block
create database phixflow CHARACTER SET = 'utf8' COLLATE = 'utf8_bin';
create user '<myuser>'@'%' identified by '<mypass>';
grant all privileges on phixflow.* to '<myuser>'@'%';
exit

Populate the Database

Once you have created the database and/or database user, run the installer to create the database tables and initial data.

  1. In your command console, change to the directory where you extracted the release zip  then to the install directory. 
  2. Run the installation command for your database (listed below).

The customer name in the commands below must exactly match the customer name used by PhixFlow Support to generate licence files. This argument (–customer="Your Customer Name") is optional, but if you don't specify a valid customer name you will not be able to install the licence key and you will not be able to run any tasks in PhixFlow.

The database connection strings given here should cover most cases of connecting to PhixFlow's own database. For more details, see Database URLs for how connection strings are constructed for the various database platforms supported by PhixFlow.

Code Block
cd $RELEASE/phixflow-x.y.z-yyyymmdd/install

SQL Server:

Note

If a database, with login details, was provided (i.e. you did not perform the step above for creating the login, user and database), please check that the database has the correct collation:

Code Block
SELECT DATABASEPROPERTYEX('DBNAME', 'Collation');

E.g.

Code Block
SELECT DATABASEPROPERTYEX('phixflow', 'Collation');

Then run the command:

Code Block
java -jar bin/installer.jar -url="jdbc:sqlserver://myhost\myserver;databaseName=phixflow" -user=myuser -pass=mypass -install -customer="Your Customer Name"

MySQL:

Code Block
java -jar bin/installer.jar -url="jdbc:mysql://localhost/phixflow" -user=<myuser> -pass=<mypass> -install -customer="Your Customer Name"

Oracle:

Code Block
java -jar bin/installer.jar -url="jdbc:oracle:thin:@localhost:1521:phixflow" -user=myuser -pass=mypass -install -customer="Your Customer Name"

Oracle (> 12c with PDB containers):

Code Block
SELECT DATABASEPROPERTYEX('phixflow', 'Collation');
Expand
titleVersion 10 - Show Details
java -jar bin/installer.jar -url="jdbc:oracle:thin:@hostname:1521/phixflow" -user=myuser -pass=mypass -install -customer="Your Customer Name"