Versions Compared

Version Old Version 2 New Version Current
Changes made by

Saumya Sunder (Inactive)

Saumya Sunder (Inactive)

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 SQL-query Macro or SQL-file.

...

Div
idProductTOC

On this page

Table of Contents
maxLevel2
minLevel2
excludeOn this page
typeflat
separatorpipe

Overview

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. 

Description

(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.

Info
  • 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 in affect 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 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 configuration change
  • Recommended for long term/heavy use scenarios
Configure Application Server-based Data Sources - 9.x(error)(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.

data source access control
Tip
titleMacro Security for data source access control
title
  • You can configure data sources using either or both of the methods
or both - for instance
  • mentioned above. For instance, use a data source profile
while testing or
  • for low-use
scenarios
  • scenarios like testing, and 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
Macro Security for Confluence can be used to Data Sources in the same way no matter what method is used.
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.

...

  • 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.

Image Modified