Connecting to Databases

Many of the advanced features of Ignition, such as the Transaction Groups and Tags Historian require a connection to an external database. If you don't have a database, like Microsoft SQL Server, MySQL, or Oracle installed, don't worry - you can come back to this step later.

Now that we've installed your database, lets connect to it. You can find detailed descriptions for many database connections in this User Manual (see Next on this page), however they all include the following three main steps: 

1. Add a Database Connection
   Once you are in the Gateway Configure section of the Gateway's web interface, use the menu on the left to go to the Databases > Connections section. On at the Database Connections page, click on the Create new Database Connection... link at the bottom of the table.
   
   
2. Pick a JDBC Driver
   Ignition connects to databases using JDBC drivers that are unique to each database. Drivers for the most popular databases are included so there is usually no need to install the JDBC driver manually.
   Ignition ships with drivers for Microsoft SQL Server, MySQL, Oracle, and PostgreSQL. Pick the JDBC driver for your database, and click on the Next button.
   If a suitable driver is not available in the list, you need to add a new JDBC driver for other databases, like IBM DB2, which is not very difficult to do, see Adding a JDBC Driver.
    

3. Configure the Connection
   After selecting the driver, you'll configure the settings for the connection. Some settings, such as the Connect URL are specific to the driver that you're using.
   
   

   Main Database Connection Properties
   Name	Each database connection needs a name, which consists of letters, numbers and underscores.
   Connect URL	A string that instructs the driver how to connect to the database. This string is the server address, and may include the port, instance name, database name, and so on. The format and parameters depend on the driver being used.
   Username	The username to use when connecting. Some databases support other authentication methods, such as Windows authentication, in which case this field is not used.
   Password	The password to use for the given username.
   Extra Connection Properties	Depending on which database you are connecting to, there will be different default values placed in this box. MS SQL Server requires you to place your database name here, but for other databases you can usually leave this at its default values. Each database has its own set of available extra connection properties so you must refer to your Database documentation to determine what is valid here.
   Enabled	Lets you to enable or disable a database connection.
   Failover Datasource	The connection to use when this connection is not available.
   Failover Mode	Lets you select how to handle failover and recovery. Database connections support failover, this means that the objects which use a database connection, will use a different connection if the one they are using becomes unavailable. The Failover Datasource property determines which connection is used, and the Failover Mode determines when, if ever, the connection is switch back to the primary connection.  There are two failover modes: • STANDARD mode dictates that the secondary connection will be used only until the primary connection is available again. • STICKY continues to use the secondary connection until that connection fails, or until the system is restarted.
   Slow Query Log Threshold	Queries that take longer than this amount of time, in milliseconds, are logged making it easier to find queries that are not performing well.
   Advanced Settings
   There are a many advanced settings that you don't need to change under normal circumstances. See the description for each property on the settings page.