SQL-file Macro

Owned by Bob Swift
Last updated: Jun 12, 2018 by Jeff Pierce

On this page

Description | Parameters | Examples

Description

This macro has similar parameters as the SQL Macro and behaves similarly in most cases. There are two primary reasons for using sql-file:

  1. Security - it can be secured separately from the other SQL macros. 
    1. Using Macro Security for Confluence, more general users can be authorized to use this macro since the administrator controls what queries can be accessed.
    2. When not using Macro Security for Confluence, the administrator can disable the sql and sql-query macros and still allow the sql-file macro, since it has a fixed set of queries that can be run. 
  2. Simplified file access parameter.

Parameters

ParameterRequiredDefaultMacro Browser LabelDescription

file

  • may be restricted
(tick)
File

File path in the configured Confluence server home directory under the script directory.


Common SQL parameters

Some parameters may have values that are restricted by your administrator for security or operational reasons. The following parameters are available on all sql macros:

ParameterRequiredDefaultMacro Browser LabelDescription

dataSource

  • may be restricted
(tick)
Data source name

Specify the data source name. It represents an application server defined data source (Pro Edition) or data source profile defined by your administrator.

output
htmlOutput format

Determines how the output is formatted:

  • html - Generates HTML from the result set data. Data is HTML encoded unless encoding has been disabled.
  • wiki - Generates and renders wiki markup from result set data. If the data contains unintended wiki markup characters, set the escape parameter as true.
  • xhtml (Pro Edition) - Generates and renders XHTML from result set data. Data is HTML encoded unless encoding has been disabled (disableAntiXss).
  • unrenderedWiki (Pro Edition) - Generates wiki markup from result set data, similar to wiki, without rendering. Wraps with a table-plus macro suitable for copying to another system.
script
macro bodyLocation of SQL statements

Additional SQL statements can be added after the SQL in macro body by specifying another location:

  • ^attachment - Data is read from an attachment to the current page.
  • page^attachment - Data is read from an attachment to the page name provided.
  • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
  • #filename (Pro Edition) - Data is read from the file located in Confluence home directory/script/filename. Subdirectories can be specified.
  • global page template name (Pro Edition) - Data is read from a global page template.
  • space:page template name (Pro Edition) - Data is read from a space template.
heading
1Number of heading rowsSpecify heading=0 to not show any heading lines. Heading rows do not participate in sorting.
border
normalTable border widthBorder width in pixels.
width
100%Table widthWidth in pixels or %.
rowOrientation
verticalDisplay rows vertically or horizontallyNote that most of the styling, formatting, sorting, auto, and similar parameters only apply to the vertical orientation setting.
table
trueShow results as a tableFor example, false can be used to produce single values that you want to include in text.
showSql
falseShow SQLDisplays SQL in a code macro.
showUpdateCount
falseShow number of rows updatedDetermines whether or not to show the number of rows updated as a result of the update SQL operation.
macros
falseEvaluate  wiki markup macros If requested, the body is rendered to expand wiki markup macros. The rendered macros must produce valid SQL syntax.This is useful to run macros from Scripting for Confluence or similar that can produce SQL output.
expandArray
trueExpand array fieldsFor vertical row orientation, array fields can be expanded to one entry per line.
autoCommit
trueAuto commit SQL statementsWikipedia:Autocommit or see your database documentation.
columnLabel
falseUse database column labelsChoose whether to use column name or column label for a row header.
showWiki
falseShow generated wiki markupWhen output is wiki based, choose this option to show the generated wiki markup.
escape
false

Escape special wiki characters

When output is wiki based, choose this option to escape special characters in wiki markup. Use this to prevent unintended wiki characters from interfering with table formatting.

convertNull
trueConvert null fields to blankOtherwise, null appears in the column.
noDataError
falseShow error if there are no rowsA result set with no rows may indicate an error. Use this parameter to control what should happen in this case. A non-blank message must be available (noDataMessage).
noDataMessage

Text to display when there are no rowsUse @default to show a default error message.

p1 through p10




Parameter marker

Values for SQL parameter markers identified by ? in SQL statements. On untrusted sites, prevent SQL injection attacks by using parameter markers. This in only necessary when the SQL statements are partially constructed from user input. See Wikipedia: SQL injection. Wiki markup sql macros support an arbitrary number of parameter markers. An arbitrary number of parameter markers can be provided when using the wiki markup version of the SQL macro.

Example SQL with 2 parameter markers

select * from example where name = ? or  department = ?

transactionIsolation
READ_COMMITTEDTransaction isolation level

Wikipedia: Isolation. See your database documentation.

  • READ_COMMITTED
  • READ_UNCOMMITTED
  • REPEATABLE_READ
  • SERIALIZABLE
  • NONE
showSqlOptions

Options for showing SQL codeSince 6.4. A comma separated list of code or code-pro (Code Pro macro) parameters used when Show SQL is selected. This allows for customization of how the SQL code is shown. See How to improve the display of SQL source.
limit
no limitMaximum number of rows to displaySystem administrator may have configured a limit.
queryTimeout
no limitMaximum number of seconds for query to runSystem administrator may have configured a limit. Since 5.1. Requires database/JDBC enablement.
disableAntiXss
falseStop encoding HTML charactersIf the SQL is producing HTML, this parameter must be selected (true). User must be authorized (via global app configuration or with a more fine grained control using Macro Security for Confluence) to use this option due to security considerations.
encoding
system defaultFile encoding

Encoding for an external file if different from the system default handling. Example: UTF8.

Common table parameters

The following parameters are part of our common table capabilities that are available to many macros that produce or modify tables.

(info) Click a column heading to toggle the sorting of that column.

Examples

 {sql-file:dataSource=testDS|file=authorized.sql}

 

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.