Versions Compared

Old Version 15

changes.mady.by.user Saumya Sunder (Inactive)

Saved on

compared with

New Version 16

changes.mady.by.user Saumya Sunder (Inactive)

Saved on

Key

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



Div
idProductTOC

On this page

Table of Contents
maxLevel2
minLevel2
excludeOn this page
typeflat
separatorpipe

...

TabsMacro Editor LabelDefaultDescriptionMacro Parameter

SQL settings

SQL statementData source profile


Specify the data source name. It represents an application server defined data source (Pro Edition) or data source profile defined by your administrator. This is a required field and some of the data sources may be restricted 

dataSource 



SQL statement

Enter the SQL statements you want to execute. There is no limit to the number of statements you can run.

Note

Parameter will not work with our SQL-file Macro. 



SQL script


Method of locating script

None








Specifies the list of options where SQL scripts are located. The results will be based on the scripts present in the selected location.

  • Attachment - The script is read from the list of options selected for the following parameters:
    • Space - Lists all available spaces.
    • Page - Lists all the pages available from the selected space.
      The following options indicate:
      • @self - current space or page

      • @home - homepage of current space

      • @parent - parent page of current page or space

  • Template - Scripts is read from a global page template specified in the 'Name of the template' field. (info) Special note: How to deal with templates on Confluence 4.3 and later.
Note

Above parameters will not work with our SQL-file Macro. 

  • Filename - The script is read from the input specified in the 'File name' field. You can specify the file located in confluence home directory/script/filename, also subdirectories.
  • File encoding - Encoding for an external file if different from the system default handling. Default file encoding is UTF8.
script

p1 through pn

Click + Add a parameter (s) to create a set of optional data parameters to refine your SQL statements during runtime.

Each parameter field allows you to create a set of optional data parameters to refine your query. Parameters apply to your SQL statements during runtime. Simply enter the number of parameters you want to create in the Start with parameter (s) field and click + Add a parameter (s) to define the parameters. You can define multiple parameters by clicking + Add value; there is no limit to the number of parameters you can add.

For example,

Code Block
languagesql
select * from example where name = ? or  department = ?

Note

Values for SQL parameter markers identified by "?" in SQL statements. On untrusted sites, prevent SQL injection attacks by using parameter markers. This is only necessary when the SQL statements are partially constructed from user input. 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. See Wikipedia: SQL injection.



Runtime

Auto commit SQL statements OnWikipedia:Autocommit or see your database documentation.autoCommit

Transaction isolation level Default

Most DBMSs offer a number of transaction isolation levels, which control the degree of locking that occurs when selecting data. You can select among a list of 5 kinds of transaction isolation levels:

  • Read committed
  • Read uncommitted
  • Repeatable read
  • Serializable: This is the highest isolation level.
  • None: Skips adding any controls while your data is being selected. 

To know more about what you can do with each type, refer to Wikipedia: Isolation or See your database documentation.

Info

The default transaction isolation level is set by the administrator via the Global configuration page. Selecting a value from the list overrides the default. Database and JDBC drivers should support the selected transaction isolation level.


transactionIsolation

Maximum number of rows to retrieve and displayDefault

Specify the upper limit for the number of rows your SQL query returns. Administrators can configure the limit.

Info
  • The default transaction isolation level is set by the administrator via the Global configuration page or Profile configuration page.
  • Selecting a value from the list overrides the default. The order of overriding the default settings is Macro level parameter > Profile configuration > Global configuration
  • Database and JDBC drivers should support the selected transaction isolation level.


limit

Maximum number of seconds for query to run Default

Time in seconds that a query runs before a forced timeout. The default value is set by your Confluence administrator in the global configuration for SQL for Confluence. Since 5.1.

Select a value from the list to override the default setting. Your database and JDBC driver must support the selected value to use this parameter. This parameter can be managed by Macro Security for Confluence App. Requires database/JDBC enablement.

queryTimeout

Render wiki markup macros in body OffIf requested, the body will be 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.macros



Display settings


Data layout


Output formathtml

Specifies how the output is formatted:

  • HTML - Generates HTML from the ResultSet. Data is HTML encoded unless data encoding is disabled.
  • wiki - Generates and renders wiki markup from ResultSet. If the data contains unintended wiki markup characters, set the escape parameter On.
  • XHTML (Pro Edition) - Generates and renders XHTML from ResultSet. Data is HTML encoded unless encoding has been disabled (disableAntiXss).
  • unrenderedWiki (Pro Edition) - Generates wiki markup from ResultSet, similar to wiki, without rendering. Wraps with a table-plus macro suitable for copying to another system.
output
Display rows vertically or horizontallyverticalNote that most of the styling, formatting, sorting, auto, and similar parameters are applicable to only the vertical orientation setting.rowOrientation
Show results as a tableOnFor example, turn this toggle on to produce single values that you want to include in the text.table
Use database column labelsOffChoose whether to use a column name or column label for a row header.columnLabel
Show number of rows updatedOffFor update SQL, determines whether or not to show the number of rows updated as a result of the operation.showUpdateCount
Show error if there are no rowsOffA ResultSet 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).noDataError
Text to display when there are no rows
Use @default to show a default error message.noDataMessage
Advanced formattingShow generated wiki markupOffWhen output is wiki-based, choose this option to show the generated wiki markup.showWiki

Escape special wiki charactersOffWhen 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.escape

Convert null fields to blankOnUse this parameter to avoid displaying null values in the column.convertNull

Stop encoding HTML charactersOffIf the SQL is producing HTML, this parameter needs to be selected (On). User must be authorized (via global add-on configuration or by more fine grained control using Macro Security for Confluence) to use this option due to security considerations.disableAntiXss

Expand array fieldsOnFor vertical row orientation, array fields can be expanded to one entry per line.expandArray

Show SQLOffDisplays SQL in a code macro.showSql

Options for showing SQL code
Since 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.showSqlOptions

...