View source for Relational database data source driver

==Description==

The Relational Database Source Driver is a configurable generic driver to obtain data from relational databases (tables) and create XBRL reports inside the automatization framework provided by the XBRL Mapper engine designed by Reporting Standard.

==Editors==

There are currently no specific editors designed for the Relational Database Source Driver configuration files. They are XML files than can be created using standard XML editors.

==Configuration file==

The configuration file is provided during the driver declaration inside the instance document template file. See [[XBRL Template File#Definition_of_data_sources]] for more information. The driver class is '''com.ihr.xbrl.mapper.source.SQLDataSource'''

Sample SQL Driver data source declaration:
<syntaxhighlight lang="xml">
  <datasources>
    <source 
      id="source0" 
      class="com.ihr.xbrl.mapper.source.SQLDataSource" 
      config="SQL-driver-config.xml"/>
  </datasources>
</syntaxhighlight>

The configuration file must be valid according to the XML Schema that has the following namespace <nowiki>http://www.reportingstandard.com/source/driver/SQLDriver-2009</nowiki> and that is published in the following official location <nowiki>http://www.reportingstandard.com/schemas/source/XBRLDataSourceSQL-2009.xsd</nowiki>

Sample configuration file:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<!-- Sample configuration file for SQLDataSource content -->
<XBRLDataSourceSQL xmlns="http://www.reportingstandard.com/source/driver/SQLDriver-2009" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.reportingstandard.com/source/driver/SQLDriver-2009 http://www.reportingstandard.com/schemas/source/XBRLDataSourceSQL-2009.xsd">
  <connection id="con0">
    <url>jdbc:mysql://localhost:3306/testdb</url>
    <user>root</user>
    <password>xbrl</password>
  </connection>
  <data connRef="con0">
    <precision>INF</precision>
    <table>GovernmentGrantsDisclosuresMasterTuple</table>
    <field identifier="ifrs-gp_GovernmentGrantsDisclosures" name="GovernmentGrantsDisclosures" />
    <field identifier="ifrs-gp_DetailOfGovernmentGrants" name="DetailOfGovernmentGrants" />
    <field identifier="ifrs-gp_AmountOfGovernmentGrantsNettedAgainstReportedExpenses" name="AmountOfGovernmentGrantsNettedAgainstReportedExpenses" />
    <where>fiscalCode = '12345'</where>
  </data>
  <data connRef="con0">
	<decimals>0</decimals>
	<table>GovernmentGrantsDisclosuresDetailsTuple</table>
	<field identifier="ifrs-gp_DescriptionOfGovernmentGrant" name="DescriptionOfGovernmentGrant"/>
	<field identifier="ifrs-gp_AmountOfGovernmentGrantRecognised" name="AmountOfGovernmentGrantRecognised"/>
	<field identifier="ifrs-gp_ExplanationOfUnfulfilledConditionsAndOtherContingenciesAttachingToGovernmentAssistance" name="ExplanationOfUnfulfilledConditions"/>
    <where>fiscalCode = '12345'</where>
  </data>
  <data connRef="con0">
	<decimals>INF</decimals>
	<table>GovernmentGrantsDisclosuresAmounts</table>
	<field identifier="GovermentGrantTuple" name="rut"/>
	<where>fiscalCode = '12345'</where>
  </data>
</XBRLDataSourceSQL>
</syntaxhighlight>

Each '''data''' element above defined a select statement to the database in order to retrieve information that may be relevant to create an XBRL report. Each '''data''' element has a '''connRef''' attribute that identify the database connection parameters.

The content of a '''data''' element is first either a '''decimals''' or a '''precision''' element that will be relevant for all numeric fields obtained by this select statement.

The next element is a '''table''' element that contains the SQL table o view name used to build the select statement.

Following the '''table''' element is a sequence of one or unlimited number of '''field''' elements. A field element maps a table field with a generation identifier name. The field name is indicated in the '''name''' attribute and the event generation identifier name is indicated in the '''identifier''' attribute.

Optionally, there may exist one '''where''' element that contains the text of a where clause that will be added to the end of the select statement.

===When the statement will be executed===

In the [[Mapper to driver data exchange dialog]], during the 2<sup>nd</sup> question, the mapper asks the driver about how may fact items for a specific identifier are in the data source. At this time, if the query has not been executed before, it is executed now (and the result is cached during the live of the execution of the XBRL report).

==Navigation==
[[Main Page]] | [[XBRLmapper]]