Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes two methods to configure Data Sources for the macros provided by SQL. SQL macros use data sources to access databases. A data source defines the access parameters including credentials. The same database access information is required for each methodmethods. Similarly, the database must allow access using the information provided no matter which method is used.

MethodPrimary BenefitKey AttributesDocumentationExpress EditionPro Edition
Data source profilesConvenience
  • SQL for Confluence specific configuration
  • Convenience 
    • Configuration change in affect immediately
    • File system access not needed
  • Can reference application server defined data sources
  • Recommended for evaluation, testing, short term scenarios
  • Medium or heavier use scenarios should also employ Cache for Confluence
Data Source Profiles(tick)(tick)
Application server defined data sourcePerformance
  • Application server based configuration
  • Best performance via connection pooling/reuse
  • Requires Confluence restart after configuration change
  • Recommended for long term/heavy use scenarios
Data source configuration - application server(error)(tick)

...

Tip
titleUse Cache and Future macros around SQL macros

Give your users better response times and reduce the load on your server by using Cache for Confluence macros for heavy use scenarios.

The Data Source is referenced using the dataSource (Data Source name) parameter. The exact configuration of a Data Source is application server and database specific. The configuration must be done by a Confluence administrator and the Confluence application server must be restarted for changes to be active. The configuration must be done very carefully as any errors result in the Data Source being unusable (sad). Each database you need to access in Confluence needs to a have a Data Source configuration.