Versions Compared

Version Old Version 3 New Version 4
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 data source or data source profile needs to be configured before you can use the use SQL Macro or SQL-query or SQL-file, SQL File or SQL Query macros.

Description

This page describes two methods of configuring Data Sources data sources for SQL macros.

The SQL Macros macros use Data Sources data sources to access databases. A Data Source data source defines the access parameters, including credentials. The database access information required for each method remains the same. Similarly, the database must allow access if the information provided, regardless of the method used.

MethodPrimary BenefitKey AttributesDocumentationExpress EditionPro Edition
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 Sourcesdata 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)
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 (error)(tick)


Tip

You can configure data sources using either of the methods or both. For instance, use a data source profile while testing or for low-use scenarios, then switch to a server-based data source for long-term use.


Tip
titleMacro Security for data source access control

Macro Security for Confluence can be used to control access to specific Data Sourcesdata sources, as stated above, regardless of the method used.


Tip
titleUse Cache and Future macros around SQL macros

Reduce the load on your server with faster response times by using Cache for Confluence app for heavy use scenarios.

The Data Source data source is referenced using the dataSource (Data Source data source name) parameter. The exact configuration of a Data Source data source is specific to a 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 must be done very carefully as any errors in doing so, will render the Data Source data source unusable. Each database that is accessed in Confluence requires a Data Source data source configuration.

Configure Application Server-based Data Sources - 10.x