Versions Compared

Old Version 4

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

Saved on

compared with

New Version 5

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

Saved on

Key

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

Description

...

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-editor-query-input

SQL script


Method of locating script














Specifies the list of options where CSV data is located. The included data will follow the body data based on the location selected.

Attachment - Data 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 - Data 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 - Data 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.
dataLocation

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,

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. 

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.


row-number

Runtime

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

Transaction isolation level 

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.

transactionIsolation

Maximum number of rows to retrieve and display
Specify the upper limit for the number of rows your SQL query returns. Administrators can configure the limit.limit

Maximum number of seconds for query to run 

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

...