Versions Compared

Version Old Version 2 New Version 3
Changes made by

Saumya Sunder (Inactive) (Deactivated)

Saumya Sunder (Inactive) (Deactivated)

Saved on

Key

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

Overview

(info) At least one Data Source or Data Source Profile needs to be configured before you can use the SQL Macro or  or SQL-query Macro or  or SQL-file.

Description

This page describes two methods to configure of configuring Data Sources for the SQL macros provided by SQL for Confluence.

The 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 method remains the same. Similarly, the database must allow access using if the information provided no matter which method is , regardless of the method used.

MethodPrimary BenefitKey AttributesDocumentationExpress EditionPro Edition
Data Source ProfilesConvenience
  • SQL for Confluence specific configuration
  • Convenience 
    • Configuration change in affect 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 heavier Heavy use scenarios should also employ Cache for Confluence
Configure Data Source Profiles(tick)(tick)
Application Server-based Data SourcePerformance
  • Application server based configuration
  • Best performance via connection pooling/reuse
  • Requires Confluence restart after a configuration change
  • Recommended for long term/heavy use scenarios
Configure Application Server-based Data Sources - 9.x(error)(tick)


Tip

You can configure data sources using either of the methods or both - for . For instance, use a data source profile while testing or for low-use scenarios, then switch to a server-based data source when/if it becomes clear it is going to be around for a long while-term use.


Tip
titleMacro Security for data source access control

Macro Security for Confluence can be used to control access to specific Data Sources in the same way no matter what method is , as stated above, regardless of the method used.


Tip
titleUse Cache and Future macros around SQL macros

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

The Data Source is referenced using the dataSource (Data Source name) parameter. The exact configuration of a Data Source is specific to a database and application server and database specific. The configuration must be done by a Confluence administrator . A Confluence administrator must set up the configuration, and the Confluence application server must be restarted for changes to be activetake effect. The configuration must be done very carefully as any errors result in doing so, will render the Data Source being unusable (sad). Each database you need to access that is accessed in Confluence needs to requires a have a Data Source configuration.

Image RemovedConfigure Application Server-based Data Sources - 10.x