Difference between revisions of "Database Direct"

From Hornbill
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
+
This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/advanced-tools-and-settings/database-direct/ Hornbill Document Library].
__NOTOC__
 
{| style="width:100%"
 
|[[Main Page|Home]] > [[Administration]] > [[System Administration | System]] > [[Data]] > Database Direct
 
|}
 
</div>
 
== 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 ==
+
[[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/esp-config/advanced-tools-and-settings/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 ==
+
{{breadcrumb|[[Main Page|Home]] > [[Configuration]] > [[System Administration|Platform Configuration]] > [[Data]] > Database Direct|Administration}}
 +
{{Section|
 +
==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.
 +
|}}
 +
{{Section|
 +
==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 be assigned the "'''Super User Role'''".
 
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 be assigned the "'''Super User Role'''".
 
<br>
 
<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.
 
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 ==
+
==Using Database Direct==
 
Once enabled, Database Direct can be found via '''Home > System > Data > Database Direct'''. The key features are outlined below.
 
Once enabled, Database Direct can be found via '''Home > System > Data > Database Direct'''. The key features are outlined below.
 
<br>
 
<br>
Line 43: Line 36:
 
# '''Export''' - export your result set to a variety of formats including CSV.
 
# '''Export''' - export your result set to a variety of formats including CSV.
 
# '''Result Set''' - The set of results returned by the last query you executed.
 
# '''Result Set''' - The set of results returned by the last query you executed.
 +
-->
 +
[[Category:HDOC]]
 +
<!-- References -->
 +
<!-- esp-config/advanced-tools-and-settings/database-direct -->

Latest revision as of 20:22, 20 November 2023

This document can now be found at its new location in the Hornbill Document Library.

Hornbill Cloud