Versions Compared

Key

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


Div
idProductTOC

On this page

Table of Contents
maxLevel2
excludeOn this page
typeflat
separatorpipe

...

SQL for Confluence is a powerful App that provides unlimited potential by allowing users to bring external data into Confluence pages. To make the most of our product, we've prepared this page containing the key concepts and helpful background information. 

Data Sources

SQL Macros use Data Sources to access databases. A Data Source defines the access parameters including credentials (e.g, UN/PW). To begin using SQL Macros and including external data within Confluence pages, your Confluence administrator must first create a Data Source and/or Data Source Profile. Once created, it is important that your Confluence administrator share the name of the Data Source with you. Each time you embed a SQL Macro on a Confluence page, you will be prompted to provide the name of the Data Source. 

Data Sources come in two flavors and as the downstream consumer of them, it's important that you understand their differences.

Table describing Data Source types:

Data Source TypePrimary BenefitKey AttributesExpress 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
(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
(error)(tick)

...

Over the years, we've grown the number of parameter and parameter options that you can flex within our SQL Macros. Ideally, we want to provide users of our product with all the built-in capabilities from the database vendor their Data Sources are accessing.  Understanding that some of these parameters can be sensitive, we also provide the ability for your administrator to control their usage. 

Next Up

With key concepts under your belt, we recommend you explore and familiarize yourself with the Macros that are shipped with SQL for Confluence.

Image Added