Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typeflat
separatorpipe
printablefalse

Overview

Provides access to the query objects created by reporters such as local-reporter, content-reporter, etc.

This is most easily accessible either

  • via the 'query' key of the Report

...

  • supplier

  • by storing the query in a variable

...

...

Details

Name:

Query Supplier

Prefix:

query(optional)

Supported Content:

Queries

Provided By:

Reporting for Confluence

, from version 3

Status
colourBlue
titlefrom v3.3.0

Supported Keys

The following are the list List of keys which that this supplier will return returns a value for.

Key

Content Types

Return Type

Description

size

Queries

Number

Returns the number of items that would be returned by the query, if executed at this moment.

Info

This may be a very expensive operation for some types of queries, as it may require executing and loading the whole result set into memory.

as collection

Queries

List of Anything

Executes the query and returns the results as a Collection.

Info

May be an expensive operation for both memory and performance on very large queries, as it will load all results into memory.

Examples

Storing a query in a variable

This will store Stores a list of all pages starting with 'Foo' in the 'My Query' variable.

...