Configure Data Sources - 10.x

On this page


This page describes the ways of configuring a data source in the SQL for Confluence app to access a database. A data source defines the access parameters, which includes credentials. 


(info) You will have to configure at least one data source or data source profile before you can use SQL, SQL File or SQL Query macros.

  • Access parameters and database access information for a data source profile or an application server based data source remain the same. 
  • The credential information for accessing databases remains the same for either of the methods mentioned below.
MethodPrimary BenefitKey AttributesDocumentationExpress EditionPro Edition
Application Server Based Data SourcePerformance
  • Application server based configuration
  • Best performance via connection pooling or reuse
  • Requires Confluence restart after a configuration change
  • Recommended for long term or heavy use scenarios
Configure Application Server based Data Sources (error)(tick)
Data Source ProfilesConvenience
  • SQL for Confluence specific configuration
  • Convenience 
    • Configuration change immediately takes effect
    • File system access not needed
  • Can reference application server defined data sources
  • Recommended for evaluation, testing, and short term scenarios
  • Medium or heavy use scenarios should also employ Cache for Confluence
Configure Data Source Profiles(tick)(tick)

The data source is referenced using the dataSource parameter (data source name). The exact configuration of a data source is specific to each database and application server. A Confluence administrator must set up the configuration, and the Confluence application server must be restarted for changes to take effect. The configuration has to be done very carefully as any errors in doing so, will render the data source unusable. Every database accessed by Confluence requires a data source configuration.

Macro Security for data source access control

  • You can configure data sources using either or both of the methods mentioned above. For instance, use a data source profile for low-use scenarios like testing, and then switch to a server based data source for long-term use.
  • You can use Macro Security for Confluence to control access to specific data sources, for the methods mentioned above.
  • For heavy use scenarios, use the Cache for Confluence app to reduce the load on your server with a faster response time.