Difference between revisions of "Database Direct"

From Hornbill
Jump to navigation Jump to search
Line 1: Line 1:
 
__NOTOC__[[Main Page|Home]] > [[Administration]] > [[System Administration | System]] > [[Data]] > Database Direct
 
__NOTOC__[[Main Page|Home]] > [[Administration]] > [[System Administration | System]] > [[Data]] > Database Direct
 
== Introduction ==
 
== Introduction ==
 +
Database Direct is an advanced feature of the Hornbill Platform which allows you to query the database that underpins your Hornbill instance using Structured Query Language (SQL). Every Hornbill instance incorporates this feature however it is not exposed by default. This feature is intended for advanced users only.
 +
 +
== Understanding the Risks when using Database Direct ==
 +
While Database Direct offers a significant amount of flexibility to those skilled in SQL, there are risks when interacting directly with a database. The seasoned database administrators reading this will be well aware of those risks and appreciate that direct interaction circumvents much of the protection offered by the web services API's that would typically be selecting, inserting, and updating the data via the user interface.
 +
<br>
 +
<br>
 +
It is important you understand the potential risks of making changes directly to the database and the disruption they may cause to your service if an inaccurate query was executed via database direct.
 +
<br>
 +
<br>
 +
<font color="red"><b>PLEASE NOTE:</b>  If any SQL executed via Database Direct effects the integrity of your data, the resulting data recovery exercise will not be covered by your Hornbill Success Plan and will be subject to an additional charge.</font>
 +
 +
== Enabling Database Direct ==
 +
The visibility of Database Direct is governed by a system setting '''security.database.allowSqlQueryOperation''' which is found via '''Home > System > Settings > Advanced'''. Any user wishing to use database direct must posses the "Super User Role".
 +
<br>
 +
Once the application setting has been enabled, it may be necessary to refresh your browser to allow this change in system setting to be acknowledged. If the association of a role is also required, it will be necessary for the user to log out and then log in again to ensure the users session is aware of the recent association of the Super User role.
 +
 +
== Using Database Direct ==
 +
Once enabled, Database Direct can be found via '''Home > System > Data > Database Direct'''.

Revision as of 17:39, 23 January 2018

Home > Administration > System > Data > Database Direct

Introduction

Database Direct is an advanced feature of the Hornbill Platform which allows you to query the database that underpins your Hornbill instance using Structured Query Language (SQL). Every Hornbill instance incorporates this feature however it is not exposed by default. This feature is intended for advanced users only.

Understanding the Risks when using Database Direct

While Database Direct offers a significant amount of flexibility to those skilled in SQL, there are risks when interacting directly with a database. The seasoned database administrators reading this will be well aware of those risks and appreciate that direct interaction circumvents much of the protection offered by the web services API's that would typically be selecting, inserting, and updating the data via the user interface.

It is important you understand the potential risks of making changes directly to the database and the disruption they may cause to your service if an inaccurate query was executed via database direct.

PLEASE NOTE: If any SQL executed via Database Direct effects the integrity of your data, the resulting data recovery exercise will not be covered by your Hornbill Success Plan and will be subject to an additional charge.

Enabling Database Direct

The visibility of Database Direct is governed by a system setting security.database.allowSqlQueryOperation which is found via Home > System > Settings > Advanced. Any user wishing to use database direct must posses the "Super User Role".
Once the application setting has been enabled, it may be necessary to refresh your browser to allow this change in system setting to be acknowledged. If the association of a role is also required, it will be necessary for the user to log out and then log in again to ensure the users session is aware of the recent association of the Super User role.

Using Database Direct

Once enabled, Database Direct can be found via Home > System > Data > Database Direct.