Key Concepts - 10.x

On this page

Introduction

SQL for Confluence is a powerful app with unlimited potential that allows users to fetch external data into Confluence pages. We've created this page for you to understand the key concepts and get the necessary background information so that you make the most of our product.

Data sources

SQL macros use data sources to access databases. A data source defines the access parameters, including credentials (e.g., UN/PW). To start using SQL macros and incorporating external data inside Confluence pages, your Confluence administrator must first create a data source or data source profile or both. 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, it's important that you understand the differences between them.

Table describing data source types:

Data Source TypePrimary BenefitKey AttributesExpress EditionPro Edition
Data source profilesConvenience
  • SQL for Confluence specific configuration
  • Convenience:
    • Configuration change in effect immediately
    • File system access not needed
  • Can reference application server defined data sources
  • Recommended for evaluation, testing, or short term scenarios
  • Medium or heavy use scenarios should also employ Cache for Confluence to improve page performance
(tick)(tick)
Application server defined data sourcePerformance
  • Application server based configuration
  • Best performance by connection pooling or reuse
  • Requires Confluence restart after a configuration change
  • Recommended for long-term or heavy use scenarios
(error)(tick)

Tables

SQL for Confluence comes pre-packaged with many of the capabilities of Advanced Tables for Confluence, another popular Bob Swift Marketplace app. Among many other things, this app allows you to send the output of external data that has been retrieved by one or more of our SQL macros to a table. Tables can be pretty powerful on their own when displaying results from your statements, but our team didn't stop there. Included within SQL for Confluence, you will find 25 of our most popular table parameters to help you format, style, organize, and summarize your data. We make it easy for you to interact with table parameters from each of our SQL macro editors. So, what are you waiting for? Make your spurious tuples in tables look amazing! Try saying that three times fast. (wink) 

Charting

Confluence provides native charting capability via its Chart macro. SQL for Confluence not only supports this macro but is tightly integrated with it. So, in a sense, our app knows how to speak charts. By simply wrapping one of our SQL macros with the native Chart macro, you can instantly send SQL output containing your external data to a beautiful chart. Pretty amazing stuff!

SQL parameters

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 our users with all the built-in capabilities from the database vendor their data sources are accessing. Knowing fully that some of these parameters can be sensitive, we also provide the ability for your administrator to control their usage.