Difference between revisions of "Database Direct"
Jump to navigation
Jump to search
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | 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]. | |
− | |||
− | |||
− | = | + | [[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/esp-config/advanced-tools-and-settings/database-direct/]] |
− | + | <!-- | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | ||
− | == Enabling Database Direct == | + | {{breadcrumb|[[Main Page|Home]] > [[Configuration]] > [[System Administration|Platform Configuration]] > [[Data]] > Database Direct|Administration}} |
− | 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 | + | {{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'''". | ||
<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> | ||
[[File:Database_Direct_Main.png|centre|1050px|Database Direct Interface]] | [[File:Database_Direct_Main.png|centre|1050px|Database Direct Interface]] | ||
− | + | <br> | |
# '''Query Editor''' - type your SQL query here | # '''Query Editor''' - type your SQL query here | ||
# '''Data Format menu''' - choose whether raw data values are displayed (e.g. boolean flags will appear as 0 or 1) or if data formatters are to be applied (e.g. No or Yes). Not all data is subject to data formating. | # '''Data Format menu''' - choose whether raw data values are displayed (e.g. boolean flags will appear as 0 or 1) or if data formatters are to be applied (e.g. No or Yes). Not all data is subject to data formating. | ||
Line 38: | 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.