CData Cloud offers access to Confluence across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Confluence through CData Cloud.
CData Cloud allows you to standardize and configure connections to Confluence as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Confluence in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Confluence and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Confluence through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Confluence by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
You can establish a connection to any Confluence Cloud account or Confluence Server instance. To connect set the URL connection property. For example, https://yoursitename.atlassian.net.
Confluence supports the following authentication methods: API token, Basic authentication, OAuth 2.0, and SSO.
Acquire a Token
An API token is necessary for account authentication. To generate one, log in to your Atlassian account and select API tokens > Create API token. The generated token is displayed.
Authenticate Using the Token
To authenticate to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):
To authenticate to a Server instance, specify the following:
Set the AuthScheme to Crowd, then configure these connection properties:
Example connection string:
AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of Confluence instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;
To connect to Okta, set these properties:
If you are either using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties to authenticate using Okta. Set any of the following, as applicable:
Example connection string:
AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of Confluence instance>/plugins/servlet/samlconsumer;
If you do not have access to the user name and API token or do not wish to require them, you can use OAuth authentication. Confluence uses the OAuth authentication standard, which requires the authenticating user to interact with Confluence via the browser. Please note OAuth 2.0 only is supported for Confluence Cloud.
To obtain the OAuth client credentials, consumer key, and consumer secret:
You can use the following properties to gain more control over the data returned from Confluence:
To enable TLS, set the following:
With this configuration, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
The Confluence Cloud also supports setting client certificates. Set the following to connect using a client certificate.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Confluence APIs.
Views describes the available views. Views are statically defined to model AuditRecords, Pages, Blogposts, Comments, Attachments, Contributors, Labels, Spaces and Users.
The Cloud models the data in Confluence as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Pages | Contains structured data about all Confluence pages, including titles, content IDs, authors, and associated spaces. |
Contains structured data about all Confluence pages, including titles, content IDs, authors, and associated spaces.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Pages WHERE Id = '1234'
SELECT * FROM Pages WHERE Id IN ('1234', '2345')
SELECT * FROM Pages WHERE Id = '294922' OR Type = 'page'
SELECT * FROM Pages WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Pages ORDER BY Id DESC SELECT * FROM Pages ORDER BY CreatedByUserName ASC
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Pages WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
| Name | Type | ReadOnly | References | SupportedOperators | Description |
| Id [KEY] | String | False | =,!=,IN,NOT_IN |
The unique identifier of the page within Confluence. Used to reference the page in related operations and tables. | |
| Type | String | True | =,!=,IN,NOT_IN |
Specifies the content type, indicating that this record represents a page. | |
| Title | String | False | =,!=,IN,NOT_IN,LIKE |
The title of the page as displayed in Confluence. | |
| Status | String | False | =,IN |
Indicates the current state of the page, such as current, draft, or archived. | |
| Storage | String | False |
Contains the body content of the page in Confluence Storage Format, including text, macros, and formatting elements. | ||
| AtlasDocFormat | String | False |
Stores the page body content in Atlas Document Format (ADF), the structured format used by modern Confluence editors. | ||
| Position | Integer | True |
Indicates the position of the page within its parent hierarchy, defining its order among sibling pages. | ||
| OwnerId | String | False |
The unique identifier of the user who owns or created the page. | ||
| ParentId | Long | False |
The identifier of the parent page under which this page is nested. | ||
| SpaceId | String | False |
The unique identifier of the space in which the page resides. | ||
| SpaceKey | String | True |
Spaces.Key | =,!=,IN,NOT_IN |
The key of the space to which the page belongs. |
| SpaceType | String | True |
Spaces.Type | =,!=,IN,NOT_IN |
Specifies the type of space containing the page, such as global, personal, or team space. |
| URL | String | True |
The full URL of the page, providing direct access through the Confluence interface or API. | ||
| Excerpt | String | True |
A short summary or snippet of the page content, typically used in listings or search results. | ||
| IsLatest | Boolean | True |
If the value is 'true', this record represents the most recent version of the page. If the value is 'false', it refers to an earlier revision. | ||
| CreatedByUserName | String | True | =,!=,IN,NOT_IN |
The username of the user who originally created the page. | |
| CreatedByUserType | String | True |
Specifies the type of user who created the page, such as internal user, external collaborator, or system account. | ||
| CreatedDate | Datetime | True | =,>,>=,<,<= |
The date and time when the page was first created. | |
| LastUpdatedDatetime | Datetime | True | =,>,>=,<,<= |
The date and time when the page was most recently updated. | |
| LastUpdatedMessage | String | True |
The revision message or comment provided when saving the latest version of the page. | ||
| LastUpdatedNumber | Integer | True |
The version number corresponding to the latest update of the page. | ||
| LastUpdatedUserName | String | True |
The username of the user who performed the most recent update to the page. | ||
| LastUpdatedUserType | String | True |
Specifies the type of user who made the most recent update, such as internal or automated. | ||
| LastUpdatedIsMinorEdit | Boolean | True |
If the value is 'true', the last update was a minor edit that did not significantly alter the content. If the value is 'false', it was a major revision. | ||
| LastUpdatedIsHidden | Boolean | True |
If the value is 'true', the latest version of the page is hidden from general visibility. If the value is 'false', it is visible to users. | ||
| PreviousVersionUserName | String | True |
The username of the user who created or edited the previous version of the page. | ||
| PreviousVersionUserType | String | True |
Specifies the type of user who modified the previous version, such as internal user or automated process. | ||
| PreviousVersionDatetime | Datetime | True |
The date and time when the previous version of the page was edited. | ||
| PreviousVersionMessage | String | True |
The revision message or note entered for the previous version. | ||
| PreviousVersionNumber | String | True |
The version number assigned to the previous revision of the page. | ||
| PreviousVersionIsMinorEdit | Boolean | True |
If the value is 'true', the previous version was a minor edit. If the value is 'false', it represented a major revision. | ||
| PreviousVersionIsHidden | Boolean | True |
If the value is 'true', the previous version of the page is hidden from visibility. If the value is 'false', it is accessible to users. | ||
| VersionUserName | String | True |
The username of the user who created or edited this version of the page. | ||
| VersionUserType | String | True |
Specifies the type of user who modified this version, such as internal or system account. | ||
| VersionDatetime | Datetime | True |
The date and time when this version of the page was last modified. | ||
| VersionMessage | String | False |
The message or note provided when this version was saved. | ||
| VersionNumber | Integer | False |
The version number identifying this specific revision of the page. | ||
| VersionIsMinorEdit | Boolean | True |
If the value is 'true', this version was marked as a minor edit. If the value is 'false', it represents a major change. | ||
| VersionIsHidden | Boolean | True |
If the value is 'true', this version is hidden from general view. If the value is 'false', it is visible to users. | ||
| LinksEditui | String | True |
The URL of the edit interface (EditUI) for the page, allowing direct modification in the Confluence editor. | ||
| LinksSelf | String | True |
The self-referential API endpoint (Self link) for the page, used to retrieve its data programmatically. | ||
| LinksTinyui | String | True |
The short link (TinyUI) version of the page's URL, providing a concise format for sharing. | ||
| LinksWebui | String | True |
The standard web interface URL (WebUI) for viewing the page in Confluence. | ||
| ItemURL | String | True |
The full URL reference to the page as displayed in the Confluence user interface. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| CQL | String |
Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering pages. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AllUsers | Returns a complete list of all registered users in the Confluence instance, including both active and disabled accounts. This view is only available for server deployments. |
| Attachments | Retrieves metadata for attachments stored in Confluence, such as file names, sizes, and related content pages. |
| AuditRecords | Provides a paginated list of audit records detailing user and system activities performed since a specified time period. |
| Blogposts | Retrieves detailed information about blog posts, including titles, authors, publication dates, and associated spaces. |
| Comments | Returns information about comments made on pages, blog posts, or other content, including author details and timestamps. |
| Contributors | Lists the users who have contributed to a specific page or space, providing insight into collaboration and content ownership. |
| GroupMembers | Retrieves all users belonging to a specified group, including their display names and account details. |
| Groups | Returns information about user groups configured in Confluence, such as group names, descriptions, and membership details. |
| GroupsContentRestrictions | Retrieves restrictions applied to specific content items that limit access to certain user groups. Requires ContentId and supports up to 200 restrictions per operation. |
| Labels | Returns the labels associated with a specific piece of content, helping categorize and organize information within Confluence. |
| PageAncestors | Displays the parent hierarchy of a page, showing how the current page is positioned within the overall content structure. |
| PageChildren | Displays the child hierarchy of a page, showing which subpages are nested under a given parent page. |
| PageComments | Retrieves all comments made on a particular page, including text content, authors, and creation dates. |
| PageContents | Provides access to the textual and metadata content of a Confluence page, including version and author information. |
| SpacePermissions | Returns detailed permission settings for one or more spaces, specifying which users and groups have access or administrative rights. |
| Spaces | Retrieves metadata and configuration details about spaces, including names, keys, descriptions, and access settings. |
| Tasks | Provides information on tasks assigned or created within Confluence, including assignees, due dates, and completion status. |
| Users | Returns details for a specific user, such as username, display name, email address, and account status. |
| UsersContentRestrictions | Retrieves restrictions applied to specific content that limit access for individual users. Requires ContentId and supports up to 200 restrictions per operation. |
| ViewersAnalytics | Shows analytics data on unique viewers of a specific content item, helping track audience engagement. |
| ViewsAnalytics | Shows analytics data on total views of a specific content item, including repeated visits by the same user. |
| Whiteboards | Retrieves details about collaborative whiteboards created within Confluence, including titles, owners, and associated spaces. |
Returns a complete list of all registered users in the Confluence instance, including both active and disabled accounts. This view is only available for server deployments.
| Name | Type | References | SupportedOperators | Description |
| UserKey [KEY] | String | = | Unique identifier that distinguishes each user within the Confluence instance. Used to reference the user across related tables and views. | |
| UserName | String | The username associated with the user account, typically used for login and identification purposes. | ||
| Status | String | Indicates whether the user account is active, disabled, or pending activation. | ||
| Type | String | Specifies the user account type, such as internal or external, depending on how the user was created or synchronized. | ||
| ProfilePicturePath | String | The file path or URL that points to the user's profile picture stored in Confluence. | ||
| ProfilePictureWidth | Integer | The width, in pixels, of the user's profile picture. | ||
| ProfilePictureHeight | Integer | The height, in pixels, of the user's profile picture. | ||
| IsDefaultPicture | Boolean | If the value is 'true', the profile picture has never been changed and remains the system default. If the value is 'false', the user has uploaded a custom image. | ||
| DisplayName | String | The display name shown for the user throughout Confluence, such as in comments, mentions, or activity feeds. |
Retrieves metadata for attachments stored in Confluence, such as file names, sizes, and related content pages.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Attachments WHERE Id = '1234'
SELECT * FROM Attachments WHERE Id IN ('1234', '2345')
SELECT * FROM Attachments WHERE Id = '294922' OR Type = 'attachment'
SELECT * FROM Attachments WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Attachments ORDER BY Id DESC SELECT * FROM Attachments ORDER BY CreatedByUserName ASC
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Attachments WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | Unique identifier of the attachment within Confluence. Used to reference the attachment in related views or operations. | |
| Type | String | =,!=,IN,NOT_IN | Indicates the content type of the attachment, such as document, image, or other media file. | |
| Title | String | =,!=,IN,NOT_IN,LIKE | The display title of the attachment, typically matching the file name or user-defined label. | |
| Status | String | Indicates the current state of the attachment, such as current, archived, or deleted. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space where the attachment resides. This identifies the space context for the file. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space that contains the attachment, such as global, personal, or archived. |
| Position | String | Defines the attachment's position or ordering within the page or content hierarchy. | ||
| URL | String | The full URL used to access the attachment directly through the Confluence interface or API. | ||
| Excerpt | String | A brief summary or snippet of text associated with the attachment, providing quick reference information. | ||
| IsLatest | Boolean | If the value is 'true', the attachment record represents the most recent version. If the value is 'false', it refers to an older revision. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally uploaded or created the attachment. | |
| CreatedByUserType | String | Indicates the type of account that created the attachment, such as internal, external, or system. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the attachment was first created in Confluence. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the attachment was last updated or replaced by a newer version. | |
| LastUpdatedMessage | String | The comment or message entered by the user when the attachment was last updated. | ||
| LastUpdatedNumber | Integer | The version number corresponding to the latest update of the attachment. | ||
| LastUpdatedUserName | String | The username of the user who performed the latest update to the attachment. | ||
| LastUpdatedUserType | String | Specifies the type of user who made the latest update, such as internal user or automated process. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the most recent update was a minor edit that did not significantly alter the attachment. If the value is 'false', it represents a major revision. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the most recent version of the attachment is hidden from general users. If the value is 'false', it is visible. | ||
| PreviousVersionUserName | String | The username of the user who created or edited the previous version of the attachment. | ||
| PreviousVersionUserType | String | The type of user who modified the previous version of the attachment, such as internal or system user. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the attachment was last modified. | ||
| PreviousVersionMessage | String | The user's message or comment describing changes in the previous version. | ||
| PreviousVersionNumber | String | The version number assigned to the previous revision of the attachment. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was marked as a minor edit. If the value is 'false', it represented a major revision. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the attachment is hidden from general users. If the value is 'false', it remains visible. | ||
| LinksEditui | String | The URL of the edit interface for the attachment, allowing users to modify or replace the file. | ||
| LinksSelf | String | The self-reference URL of the attachment resource, used for API access or direct retrieval. | ||
| LinksTinyui | String | The shortened URL (TinyUI) that provides a compact link to the attachment for easy sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the attachment, used for navigation within the Confluence site. | ||
| ItemURL | String | The complete URL reference to the attachment as it appears in the Confluence user interface. | ||
| ContainerId | String | The unique identifier of the container (page or content item) that holds the attachment. | ||
| MediaType | String | Specifies the Multipurpose Internet Mail Extensions (MIME) media type of the attachment, which defines how the file is handled and displayed. | ||
| DownloadLink | String | The direct download URL for the attachment file, allowing users or systems to retrieve its content. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for filtering or searching attachments. |
Provides a paginated list of audit records detailing user and system activities performed since a specified time period.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM AuditRecords WHERE SearchString = 'your search string' SELECT * FROM AuditRecords WHERE StartDate = '2019-08-12' SELECT * FROM AuditRecords WHERE EndDate = '2019-08-15'
| Name | Type | References | SupportedOperators | Description |
| AffectedObjectName | String | The name of the Confluence object that was modified during the audited action, such as a page, space, or attachment. | ||
| AffectedObjectType | String | Specifies the type of object affected by the change, such as page, comment, or configuration item. | ||
| AuthorDisplayName | String | The display name of the user who performed the action recorded in the audit log. | ||
| AuthorType | String | Indicates the type of account that executed the action, such as internal user, external user, or automated system. | ||
| UserKey | String | The unique key that identifies the user who initiated the audited action within Confluence. | ||
| UserName | String | The username of the user responsible for the audited event. | ||
| Category | String | Defines the functional category of the audited event, such as content management, permissions, or configuration. | ||
| CreationDate | Datetime | The date and time when the audited event occurred and was recorded in the system. | ||
| Description | String | A detailed description of the change or event, providing context for what was modified or triggered. | ||
| RemoteAddress | String | The IP address or network origin from which the action was performed. | ||
| Summary | String | A concise summary of the audit event, highlighting the main change or activity. | ||
| IsSysAdmin | Boolean | If the value is 'true', the action was performed by a system administrator. If the value is 'false', it was performed by a standard user. | ||
| SearchString | String | = | The search term or keyword entered by the user when querying audit records or related data. | |
| StartDate | Datetime | = | The beginning timestamp that defines the start of the audit period for retrieved records. | |
| EndDate | Datetime | = | The ending timestamp that defines the end of the audit period for retrieved records. |
Retrieves detailed information about blog posts, including titles, authors, publication dates, and associated spaces.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Blogposts WHERE Id = '1234'
SELECT * FROM Blogposts WHERE Id IN ('1234', '2345')
SELECT * FROM Blogposts WHERE Id = '123458' AND Type = 'blogpost'
SELECT * FROM Blogposts WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Blogposts ORDER BY Id DESC SELECT * FROM Blogposts ORDER BY CreatedByUserName ASC
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Blogposts WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | Unique identifier of the blog post within Confluence. Used to reference the post in related operations or queries. | |
| Type | String | =,!=,IN,NOT_IN | Specifies the content type, indicating that this record represents a blog post. | |
| Title | String | =,!=,IN,NOT_IN,LIKE | The title of the blog post as displayed in Confluence, used for identification and navigation. | |
| Status | String | Indicates the current publishing state of the blog post, such as current, draft, or archived. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space in which the blog post is published. This links the content to its workspace. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space that contains the blog post, such as global, team, or personal. |
| Position | String | Defines the placement or ordering of the blog post within the space or among other content items. | ||
| URL | String | The full URL that provides direct access to the blog post through the Confluence interface or API. | ||
| Excerpt | String | A short summary or preview of the blog post content, typically displayed in listings or search results. | ||
| IsLatest | Boolean | If the value is 'true', this record represents the latest published version of the blog post. If the value is 'false', it refers to a previous version. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally created and published the blog post. | |
| CreatedByUserType | String | Specifies the type of user who created the blog post, such as internal user, external collaborator, or system account. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the blog post was initially created and saved in Confluence. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the blog post was last edited or updated. | |
| LastUpdatedMessage | String | The revision message or comment entered by the author when saving the most recent version. | ||
| LastUpdatedNumber | Integer | The version number associated with the latest update of the blog post. | ||
| LastUpdatedUserName | String | The username of the user who made the most recent update to the blog post. | ||
| LastUpdatedUserType | String | Indicates the type of user responsible for the latest update, such as internal, external, or system. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the latest change was a minor edit that did not significantly alter the content. If the value is 'false', the edit was a major revision. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the latest version of the blog post is hidden from general visibility. If the value is 'false', it is publicly visible. | ||
| PreviousVersionUserName | String | The username of the user who created or modified the previous version of the blog post. | ||
| PreviousVersionUserType | String | Specifies the type of user who edited the previous version, such as internal user or automated process. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the blog post was last modified. | ||
| PreviousVersionMessage | String | The revision message or note associated with the previous version of the blog post. | ||
| PreviousVersionNumber | String | The version number assigned to the previous revision of the blog post. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was marked as a minor edit. If the value is 'false', it was a major revision. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the blog post is hidden from visibility. If the value is 'false', it is viewable by users. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the blog post, allowing direct modification from the Confluence editor. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the blog post, used to retrieve its details programmatically. | ||
| LinksTinyui | String | The short link (TinyUI) version of the blog post URL, providing a concise format for sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the blog post as viewed within the Confluence site. | ||
| ItemURL | String | The complete URL reference to the blog post as displayed in the user interface. | ||
| ContainerId | String | The identifier of the container, typically the space or content collection, that holds the blog post. | ||
| StorageBody | String | The full content of the blog post in Confluence Storage Format, which preserves rich text, macros, and formatting. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering blog posts. |
Returns information about comments made on pages, blog posts, or other content, including author details and timestamps.
The Cloud uses the Confluence API to process WHERE clause conditions built with the following columns and operators. Conditions that use other supported operators are processed client-side by the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Comments WHERE Id = '1234'
SELECT * FROM Comments WHERE Id IN ('1234', '2345')
SELECT * FROM Comments WHERE Id = '294922' OR Type = 'comment'
SELECT * FROM Comments WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Comments ORDER BY Id DESC SELECT * FROM Comments ORDER BY CreatedByUserName ASC
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Comments WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | Unique identifier of the comment within Confluence. Used to reference the comment in related tables or operations. | |
| Type | String | =,!=,IN,NOT_IN | Specifies the content type, indicating that this record represents a comment. | |
| Title | String | The title or short reference for the comment, which may appear as the first line of text or a system-generated identifier. | ||
| Status | String | Indicates the current state of the comment, such as active, deleted, or archived. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space that contains the content to which the comment belongs. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space where the comment was made, such as global, personal, or team space. |
| Position | String | Defines the comment's position within the discussion thread or its relationship to the parent content. | ||
| URL | String | The full URL that provides direct access to the comment within the Confluence interface or API. | ||
| Excerpt | String | A short snippet of the comment's text content, used for previews or summaries. | ||
| IsLatest | Boolean | If the value is 'true', this comment represents the latest version of the text. If the value is 'false', it refers to an earlier revision. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally posted the comment. | |
| CreatedByUserType | String | Specifies the type of user who created the comment, such as internal user, external collaborator, or system account. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the comment was first posted. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the comment was most recently edited. | |
| LastUpdatedMessage | String | The revision note or message entered by the user when updating the comment. | ||
| LastUpdatedNumber | Integer | The version number corresponding to the latest update of the comment. | ||
| LastUpdatedUserName | String | The username of the user who performed the most recent update on the comment. | ||
| LastUpdatedUserType | String | Indicates the type of user who made the latest update, such as internal, external, or automated. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the last modification was a minor edit that did not significantly change the content. If the value is 'false', it was a major edit. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the most recent version of the comment is hidden from regular users. If the value is 'false', it is visible. | ||
| PreviousVersionUserName | String | The username of the user who created or edited the previous version of the comment. | ||
| PreviousVersionUserType | String | Specifies the type of user who updated the previous version, such as internal user or automated process. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the comment was modified. | ||
| PreviousVersionMessage | String | The user's revision note or message associated with the previous version of the comment. | ||
| PreviousVersionNumber | String | The version number assigned to the previous iteration of the comment. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was marked as a minor edit. If the value is 'false', it represented a major revision. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the comment is hidden from visibility. If the value is 'false', it remains visible. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the comment, allowing users to modify or reply within the Confluence editor. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the comment, used for programmatic retrieval. | ||
| LinksTinyui | String | The short link (TinyUI) URL of the comment, providing a concise version for quick sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the comment as viewed within Confluence. | ||
| ItemURL | String | The complete URL reference to the comment as displayed in the user interface. | ||
| ContainerId | String | The unique identifier of the container, such as the page or blog post, that the comment belongs to. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering comments. |
Lists the users who have contributed to a specific page or space, providing insight into collaboration and content ownership.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: Either ContentId, AccountId or ContentType must be specified in order to query the Contributors view.
For example, the following queries are processed server side:
SELECT * FROM Contributors WHERE ContentId = '1234'
SELECT * FROM Contributors WHERE ContentId != '1234'
SELECT * FROM Contributors WHERE ContentId IN ('1234', '2345')
SELECT * FROM Contributors WHERE ContentId NOT IN ('1234', '2345')
SELECT * FROM Contributors WHERE AccountId = '12345678'
SELECT * FROM Contributors WHERE AccountId IN ('12345678', '23456789')
SELECT * FROM Contributors WHERE ContentType = 'page'
SELECT * FROM Contributors WHERE ContentType != 'page'
SELECT * FROM Contributors WHERE ContentType IN ('page', 'attachment')
SELECT * FROM Contributors WHERE ContentType NOT IN ('page', 'attachment')
Additionally, ContentId column can be used in the ORDER BY clause, as following:
SELECT * FROM Contributors ORDER BY ContentId DESC
| Name | Type | References | SupportedOperators | Description |
| ContentId [KEY] | String | =,!=,IN,NOT_IN | The unique identifier of the content item that supports contributions, such as a page, blog post, comment, or attachment. This value corresponds to the 'Id' field in related tables like Attachments, Pages, Comments, or Blogposts. | |
| ContentType | String | =,!=,IN,NOT_IN | Specifies the type of content to which the contributor has added input, for example page, comment, or blog post. | |
| UserType | String | Indicates the type of user who contributed, such as internal user, external collaborator, or system account. | ||
| AccountId [KEY] | String | =,IN | The unique account identifier of the contributor, used to link the user to their contributions across Confluence content. |
Retrieves all users belonging to a specified group, including their display names and account details.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM GroupMembers WHERE Name = 'test1'
| Name | Type | References | SupportedOperators | Description |
| AccountId | String | The unique account identifier of the user who is a member of the group. | ||
| AccountType | String | Specifies the type of user account, such as internal, external, or system. | ||
| DisplayName | String | The display name of the user as it appears in Confluence: in mentions, comments, or activity feeds. | ||
| String | The email address associated with the user's Confluence account. | |||
| PublicName | String | The public name or nickname of the user, shown in areas where privacy settings restrict full display names. | ||
| ProfilePicturePath | String | The file path or URL that points to the user's profile picture within Confluence. | ||
| ProfilePictureWidth | Int | The width, in pixels, of the user's profile picture. | ||
| ProfilePictureHeight | Int | The height, in pixels, of the user's profile picture. | ||
| ProfilePictureIsDefault | Boolean | If the value is 'true', the profile picture is the default system image and has not been changed by the user. If the value is 'false', the user has uploaded a custom profile picture. | ||
| Operations | String | Describes available operations and the target entities they apply to, indicating possible actions for the user within the group context. | ||
| Type | String | Defines the type of user, such as standard user, administrator, or external collaborator. | ||
| GroupId | String | = | The unique identifier of the Confluence group that the user belongs to. | |
| Name | String | = | The name of the group to which these members are assigned. |
Returns information about user groups configured in Confluence, such as group names, descriptions, and membership details.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM Groups WHERE Name = 'test'
SELECT * FROM Groups WHERE Name IN ('test1', 'test2')
SELECT * FROM Groups WHERE Id = 'ef75d879-6b69-4260-942a-ff5231e08be0'
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | = | The unique identifier of the group within Confluence. Used to reference the group in membership and permission tables. | |
| Name [KEY] | String | = | The display name of the group as defined in Confluence, used for managing user membership and access control. | |
| Type | String | Specifies the type of group, such as internal (managed within Confluence) or external (synchronized from an identity provider). |
Retrieves restrictions applied to specific content items that limit access to certain user groups. Requires ContentId and supports up to 200 restrictions per operation.
| Name | Type | References | SupportedOperators | Description |
| Operation | String | Specifies the type of operation that the restriction governs, such as read or update access. | ||
| Name | String | The name of the group to which the content restriction applies, defining which members are affected. | ||
| Type | String | Indicates the type of group, such as internal or external, based on how it is managed or synchronized. | ||
| ContentId | String | = | The unique identifier of the content item (such as a page or blog post) where the restriction is applied. |
Returns the labels associated with a specific piece of content, helping categorize and organize information within Confluence.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: Either ContentId, LabelName or ContentType must be specified in order to query the Labels view.
For example, the following queries are processed server side:
SELECT * FROM Labels WHERE ContentId = '1234'
SELECT * FROM Labels WHERE ContentId! = '1234'
SELECT * FROM Labels WHERE ContentId IN ('1234', '2345')
SELECT * FROM Labels WHERE ContentId NOT IN ('1234', '2345')
SELECT * FROM Labels WHERE LabelName = 'test'
SELECT * FROM Labels WHERE LabelName IN ('test1', 'test2')
SELECT * FROM Labels WHERE ContentType = 'page'
SELECT * FROM Labels WHERE ContentType != 'page'
SELECT * FROM Labels WHERE ContentType IN ('page', 'attachment')
SELECT * FROM Labels WHERE ContentType NOT IN ('page', 'attachment')
Additionally, ContentId column can be used in the ORDER BY clause, as following:
SELECT * FROM Labels ORDER BY ContentId DESC
| Name | Type | References | SupportedOperators | Description |
| ContentId [KEY] | String | =,!=,IN,NOT_IN | The unique identifier of the content item that supports labels, such as a page, attachment, or blog post. This value corresponds to the 'Id' field in related tables like Attachments, Pages, or Blogposts. | |
| ContentType | String | =,!=,IN,NOT_IN | Specifies the type of content associated with the label, such as page, attachment, or blog post. | |
| LabelId [KEY] | String | The unique identifier of the label assigned to the content. | ||
| LabelName | String | =,IN | The name of the label applied to the content, used for categorization and search filtering. | |
| LabelPrefix | String | Defines the prefix associated with the label, which indicates its scope or origin, such as global or team-specific. |
Displays the parent hierarchy of a page, showing how the current page is positioned within the overall content structure.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
Note: PageId is required in order to query the PageAncestors view.
For example, the following queries are processed server side:
SELECT * FROM PageAncestors WHERE PageId = '33106'
SELECT * FROM PageAncestors WHERE PageId IN ('163902', '33106')
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the ancestor page within the Confluence hierarchy. | ||
| ExpandableAncestors | String | Provides a reference to additional ancestor pages that can be expanded to view the full hierarchy above the current page. | ||
| ExpandableBody | String | Links to the expandable section containing the page's body content, allowing access to detailed text data when requested. | ||
| ExpandableChildren | String | Links to the expandable section listing the direct child pages of the ancestor, enabling traversal down the hierarchy. | ||
| ExpandableChildTypes | String | Specifies the available types of child content that can be expanded under the ancestor page, such as page or comment. | ||
| ExpandableContainer | String | Provides a reference to the container element, such as a space, that holds the ancestor page. | ||
| ExpandableDescendants | String | Links to a list of all descendant pages that can be expanded from this ancestor, showing the entire subpage structure. | ||
| ExpandableHistory | String | Links to historical data about the ancestor page, including previous versions and edits. | ||
| ExpandableMetadata | String | Links to the expandable section containing metadata for the ancestor page, such as labels and properties. | ||
| ExpandableOperations | String | Lists available operations that can be performed on the ancestor page, such as view or edit. | ||
| ExpandableRestrictions | String | Links to the access restrictions applied to the ancestor page, including view and edit permissions. | ||
| ExpandableSchedulePublishDate | Datetime | Specifies the scheduled date and time when the ancestor page is set to be published, if applicable. | ||
| ExpandableSpace | String | Provides a link to the space that contains the ancestor page, allowing retrieval of related space information. | ||
| ExpandableVersion | String | Links to version details of the ancestor page, including version number and author information. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the ancestor page, allowing users to modify its content. | ||
| LinksSelf | String | The self-referential API link (Self link) for the ancestor page, used to retrieve its data programmatically. | ||
| LinksTinyui | String | The short link (TinyUI) version of the ancestor page's URL, providing a compact link for easy sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the ancestor page, used for navigation in Confluence. | ||
| ExtensionsPosition | String | Indicates the page's position within its parent hierarchy, defining its placement order among sibling pages. | ||
| Status | String | Indicates the publication status of the ancestor page, such as current, draft, or archived. | ||
| Title | String | The title of the ancestor page as displayed in Confluence. | ||
| Type | String | Specifies the content type, indicating that this record represents a page ancestor. | ||
| PageId [KEY] | String |
Pages.Id | =,!=,IN,NOT_IN | The unique identifier of the current page whose ancestor information is being retrieved. |
Displays the child hierarchy of a page, showing which subpages are nested under a given parent page.
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the child page within the Confluence hierarchy. | ||
| ExpandableAncestors | String | Provides a link to the expandable list of ancestor pages for the child, showing its position in the overall hierarchy. | ||
| ExpandableBody | String | Links to the expandable section containing the full body content of the child page, available when explicitly requested. | ||
| ExpandableChildren | String | Links to additional nested child pages under this page, allowing deeper traversal through the hierarchy. | ||
| ExpandableChildTypes | String | Specifies the available content types that can exist as children of this page, such as page or comment. | ||
| ExpandableContainer | String | Provides a link to the container that holds this child page, typically its parent page or associated space. | ||
| ExpandableDescendants | String | Links to the list of all descendant pages that can be expanded under this child, showing its complete subpage structure. | ||
| ExpandableHistory | String | Links to the historical versions of the child page, including revision data and previous authors. | ||
| ExpandableMetadata | String | Links to the expandable section containing metadata for the child page, such as labels and custom properties. | ||
| ExpandableOperations | String | Lists the available operations that can be performed on the child page, such as view, edit, or delete. | ||
| ExpandableRestrictions | String | Links to the restrictions that define who can view or edit the child page. | ||
| ExpandableSchedulePublishDate | Datetime | Specifies the date and time when the child page is scheduled to be published, if applicable. | ||
| ExpandableSpace | String | Provides a link to the space in which the child page resides, enabling retrieval of related space information. | ||
| ExpandableVersion | String | Links to the version details of the child page, including the version number and author metadata. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the child page, allowing direct editing in Confluence. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the child page, used for programmatic access. | ||
| LinksTinyui | String | The short link (TinyUI) version of the child page's URL, providing a compact format for easy sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) for the child page as viewed within Confluence. | ||
| ExtensionsPosition | String | Indicates the position of the child page within its parent's hierarchy, defining its order among sibling pages. | ||
| Status | String | Indicates the publication status of the child page, such as current, draft, or archived. | ||
| Title | String | The title of the child page as displayed in Confluence. | ||
| Type | String | Specifies the content type, indicating that this record represents a child page. | ||
| PageId | String |
Pages.Id | =,!=,IN,NOT IN | The unique identifier of the current page whose child pages are being retrieved. |
Retrieves all comments made on a particular page, including text content, authors, and creation dates.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
Note: PageId is required in order to query the PageComments view.
For example, the following queries are processed server side:
SELECT * FROM PageComments WHERE PageId = '163902'
SELECT * FROM PageComments WHERE PageId IN ('163902', '33106')
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the comment associated with the specified page. | ||
| ExpandableAncestors | String | Provides a link to ancestor elements in the hierarchy, such as the parent page or higher-level comments. | ||
| ExpandableChildren | String | Links to any nested replies or child comments related to the current comment. | ||
| ExpandableContainer | String | Provides a reference to the container element, typically the page that holds this comment. | ||
| ExpandableDescendants | String | Links to all descendant comments that can be expanded under this comment, displaying the full discussion thread. | ||
| ExpandableHistory | String | Links to the revision history of the comment, showing previous edits and versions. | ||
| ExpandableMetadata | String | Links to the expandable metadata for the comment, such as labels, properties, or custom fields. | ||
| ExpandableOperations | String | Lists the operations that can be performed on the comment, such as edit, delete, or reply. | ||
| ExpandableRestrictions | String | Links to the access restrictions applied to the comment, specifying who can view or edit it. | ||
| ExpandableSpace | String | Provides a link to the space in which the comment's parent page is located. | ||
| ExpandableVersion | String | Links to version information for the comment, including details about the latest edit and author. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the comment, used to retrieve its data programmatically. | ||
| LinksWebui | String | The standard web interface URL (WebUI) for the comment as viewed in the Confluence page. | ||
| BodyExpandableAnonymousExportView | String | Provides access to the anonymous export view of the comment body, which can be expanded to show public exportable content. | ||
| BodyExpandableEditor | String | Links to the editor view of the comment body, allowing access to the content in an editable format. | ||
| BodyExpandableExportView | String | Provides a link to the export view representation of the comment body, used when exporting or rendering content externally. | ||
| BodyExpandableStorage | String | Links to the storage representation of the comment body, which contains the raw data in Confluence Storage Format. | ||
| BodyExpandableStyledView | String | Provides access to the styled view of the comment body, showing formatted content as rendered in the Confluence interface. | ||
| BodyViewExpandableContent | String | Links to the view representation of the comment's main content, used for display purposes. | ||
| BodyViewExpandableWebresource | String | Links to associated web resources, such as embedded media or macros, included in the comment body. | ||
| BodyViewRepresentation | String | Specifies the current representation type of the comment body, such as view or storage. | ||
| BodyViewValue | String | Contains the actual text content of the comment in its rendered form. | ||
| ExtensionsExpandableResolution | String | Provides a link to additional resolution-related extensions, such as comment status or resolution metadata. | ||
| ExtensionsLocation | String | Indicates the location context of the comment within the page, such as inline or section-based placement. | ||
| Status | String | Indicates the current status of the comment, such as active, resolved, or deleted. | ||
| Title | String | The title or first line of the comment, often used as a summary or identifier in lists. | ||
| Type | String | Specifies the content type, indicating that this record represents a comment. | ||
| PageId | String |
Pages.Id | =,!=,IN,NOT_IN | The unique identifier of the page that contains this comment. |
Provides access to the textual and metadata content of a Confluence page, including version and author information.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
Note: PageId is required in order to query the PageContents view.
For example, the following queries are processed server side:
SELECT * FROM PageContents WHERE PageId = '163902'
SELECT * FROM PageContents WHERE PageId IN ('163902', '33106')
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the page content within Confluence. | ||
| ExpandableAncestors | String | Provides a link to the expandable list of ancestor pages, allowing retrieval of hierarchical context above the current page. | ||
| ExpandableChildren | String | Links to child content items associated with the page, such as subpages or embedded components. | ||
| ExpandableChildTypes | String | Specifies the types of child content that can exist under this page, for example page, comment, or attachment. | ||
| ExpandableContainer | String | Provides a link to the container element that holds this page, typically a space or parent page. | ||
| ExpandableDescendants | String | Links to all descendant content items that can be expanded from this page, showing the complete hierarchy below it. | ||
| ExpandableHistory | String | Links to the historical versions of the page, allowing retrieval of revision data, authors, and timestamps. | ||
| ExpandableMetadata | String | Links to the expandable metadata section, which includes labels, properties, and other contextual information. | ||
| ExpandableOperations | String | Lists available operations that can be performed on the page, such as view, edit, or delete. | ||
| ExpandableRestrictions | String | Links to the access restrictions applied to the page, defining user and group permissions. | ||
| ExpandableSchedulePublishDate | Datetime | Specifies the date and time when the page is scheduled for publication, if applicable. | ||
| ExpandableSpace | String | Provides a link to the space containing the page, allowing retrieval of related space-level details. | ||
| ExpandableVersion | String | Links to version information for the page, including version numbers, authors, and modification data. | ||
| LinksBase | String | The base API URL used as a reference point for the page's linked resources. | ||
| LinksCollection | String | Provides a link to the collection of related content items, such as pages within the same space. | ||
| LinksContext | String | Defines the contextual relationship of the page within Confluence, including references to its environment or parent container. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the page, allowing direct access to the page editor. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the page, used for direct retrieval via the Confluence API. | ||
| LinksTinyui | String | The short link (TinyUI) version of the page's URL, providing a compact, shareable format. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the page as accessed through the Confluence site. | ||
| BodyExpandableAnonymousExportView | String | Provides access to the anonymous export view of the page body, allowing public export without authentication. | ||
| BodyExpandableAtlasDocFormat | String | Links to the Atlas Document Format (ADF) representation of the page body, used for rich text and structured data rendering. | ||
| BodyExpandableDynamic | String | Provides a link to dynamically rendered sections of the page body, allowing runtime expansion of embedded content. | ||
| BodyExpandableEditor | String | Links to the editable representation of the page body as used in the Confluence editor. | ||
| BodyExpandableEditor2 | String | Provides a link to an alternate editor format of the page body, typically used for newer Confluence editor versions. | ||
| BodyExpandableExportView | String | Links to the export view of the page body, suitable for use in external formats or exports. | ||
| BodyExpandableStyledView | String | Provides access to the styled view of the page body, displaying formatted content as seen in the Confluence UI. | ||
| BodyExpandableView | String | Links to the view representation of the page body used for display in standard Confluence views. | ||
| BodyStorageExpandableContent | String | Provides access to the underlying storage content of the page body, including macros and embedded objects. | ||
| BodyStorageEmbeddedContent | String | Links to any embedded resources or files within the page's storage format. | ||
| BodyStorageRepresentation | String | Specifies the format used to represent the page body in storage, such as storage or view. | ||
| BodyStorageValue | String | Contains the actual content of the page body in Confluence Storage Format, including rich text and markup. | ||
| ExtensionsPosition | String | Indicates the position of the page within its parent hierarchy, defining its order among sibling content. | ||
| Status | String | Indicates the current status of the page, such as current, draft, or archived. | ||
| Title | String | The title of the page as displayed in Confluence. | ||
| Type | String | Specifies the content type, indicating that this record represents a page. | ||
| PageId | String |
Pages.Id | =,!=,IN,NOT_IN | The unique identifier of the page whose content is being retrieved. |
Returns detailed permission settings for one or more spaces, specifying which users and groups have access or administrative rights.
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the space permission record within Confluence. | ||
| OperationKey | String | Specifies the type of operation the permission applies to, such as view, edit, delete, or administer. | ||
| OperationTargetType | String | Indicates the type of entity that the operation targets, such as space, page, or content. | ||
| PrincipalId | String | The unique identifier of the user or group to whom the permission applies. | ||
| PrincipalType | String | Specifies whether the permission applies to a user, a group, or an anonymous role. | ||
| SpaceId | String |
Spaces.Id | = | The unique identifier of the space to which this permission record belongs. |
Retrieves metadata and configuration details about spaces, including names, keys, descriptions, and access settings.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Spaces WHERE Key = 'abc'
SELECT * FROM Spaces WHERE Name IN ('name1', 'name2')
SELECT * FROM Spaces WHERE Excerpt = 'driver development'
SELECT * FROM Spaces WHERE Key = 'abc' AND Type = 'global'
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Spaces WHERE CQL = 'type = space AND space.title~"Driver Development"' AND Excerpt = 'indexed'
| Name | Type | References | SupportedOperators | Description |
| Id | String | The unique identifier of the space within Confluence. Used to reference the space in related tables and operations. | ||
| Key [KEY] | String | =,!=,IN,NOT_IN | The unique key assigned to the space, typically a short code used in URLs and API requests. | |
| Name | String | =,!= | The display name of the space as shown in the Confluence interface. | |
| IconPath | String | The file path or URL to the space's icon image. | ||
| IconWidth | Integer | The width, in pixels, of the space icon image. | ||
| IconHeight | Integer | The height, in pixels, of the space icon image. | ||
| IsIconDefault | Boolean | If the value is 'true', the space uses the default Confluence icon. If the value is 'false', a custom icon has been set. | ||
| Excerpt | String | A short description or summary of the space content, typically shown in listings or search results. | ||
| Type | String | =,!=,IN,NOT_IN | Specifies the type of space, such as global, personal, or team. | |
| Url | String | The full URL used to access the space through the Confluence interface or API. | ||
| LastModified | Datetime | The date and time when the space or its metadata was last modified. | ||
| ItemURL | String | The complete URL reference to the space as displayed in the Confluence user interface. | ||
| Description | String | A detailed description of the space, outlining its purpose and content focus. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the space was originally created. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering spaces. |
Provides information on tasks assigned or created within Confluence, including assignees, due dates, and completion status.
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | = | The unique identifier of the task within Confluence. | |
| AssignedTo | String | = | The account ID of the user to whom the task is currently assigned. | |
| AtlasDoc | String | Contains the task content in Atlas Document Format (ADF), used for structured text and formatting within Confluence. | ||
| BlogPostId | String | = | The identifier of the blog post associated with the task, if the task is linked to one. | |
| CompletedAt | Datetime | The date and time when the task was marked as completed. | ||
| CompletedBy | String | = | The account ID of the user who completed the task. | |
| CreatedAt | Datetime | The date and time when the task was initially created. | ||
| CreatedBy | String | = | The account ID of the user who created the task. | |
| DueAt | Datetime | The date and time by which the task is due for completion. | ||
| LocalId | String | The local identifier of the task, used for referencing within the context of a specific page or space. | ||
| PageId | String | = | The unique identifier of the page associated with the task. | |
| SpaceId | String | = | The unique identifier of the space in which the task resides. | |
| Status | String | = | Indicates the current state of the task, such as open, in progress, or completed. | |
| Storage | String | Contains the body content of the task in Confluence Storage Format, including text and macros. | ||
| UpdatedAt | Datetime | The date and time when the task was last modified. |
Returns details for a specific user, such as username, display name, email address, and account status.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Users WHERE AccountId = '1234'
SELECT * FROM Users WHERE AccountId IN ('1234', '2345')
SELECT * FROM Users WHERE PublicName = 'confluenceuser'
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Users WHERE CQL = 'user.userKey = "4028d6096b696826016b696960860000" AND type = user' AND UserName = 'currentUser()'
| Name | Type | References | SupportedOperators | Description |
| AccountId [KEY] | String | =,IN | The unique account identifier of the user. This column is available only for Confluence Cloud. | |
| AccountType | String | Specifies the type of user account, such as standard or external. This column is available only for Confluence Cloud. | ||
| PublicName | String | LIKE | The full public name of the user as displayed in Confluence. This column is available only for Confluence Cloud. | |
| String | The email address associated with the user's Confluence account. This column is available only for Confluence Cloud. | |||
| UserKey [KEY] | String | =,!=,IN,NOT_IN | The unique key identifying the user in Confluence Server. This column is available only for Confluence Server. | |
| UserName | String | = | The username used for login and identification in Confluence Server. This column is available only for Confluence Server. | |
| Status | String | Indicates the account status of the user, such as active, disabled, or pending. This column is available only for Confluence Server. | ||
| Type | String | Specifies the user type, such as internal user, external collaborator, or system account. | ||
| Excerpt | String | A short text summary or snippet of information related to the user. | ||
| ProfilePicturePath | String | The file path or URL to the user's profile picture. | ||
| ProfilePictureWidth | Integer | The width, in pixels, of the user's profile picture. | ||
| ProfilePictureHeight | Integer | The height, in pixels, of the user's profile picture. | ||
| IsDefaultPicture | Boolean | If the value is 'true', the profile picture has never been changed and remains the default system image. If the value is 'false', the user has uploaded a custom image. | ||
| DisplayName | String | The display name of the user as shown throughout Confluence, for example in comments, mentions, and activity streams. | ||
| Url | String | The URL to the user's profile page in Confluence. | ||
| LastModified | Datetime | The date and time when the user's profile information was last updated. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering users. |
Retrieves restrictions applied to specific content that limit access for individual users. Requires ContentId and supports up to 200 restrictions per operation.
| Name | Type | References | SupportedOperators | Description |
| Operation | String | Specifies the type of operation that the restriction controls, such as read or update access. | ||
| UserKey | String | The unique user key identifying the user to whom the restriction applies. | ||
| DisplayName | String | The display name of the user who is subject to the restriction. | ||
| Username | String | The username of the user associated with the content restriction. | ||
| Type | String | Indicates the type of user, such as known, anonymous, or external. | ||
| ContentId | String | = | The unique identifier of the content item (such as a page or blog post) where the restriction is applied. |
Shows analytics data on unique viewers of a specific content item, helping track audience engagement.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server side:
SELECT * FROM ViewersAnalytics WHERE FromDate = '2023-01-02'
| Name | Type | References | SupportedOperators | Description |
| ContentId [KEY] | String | = | The unique identifier of the page or content item for which viewer analytics are recorded. | |
| NumberOfDistinctViewers | String | The total number of unique users who have viewed the content. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FromDate | Date | Specifies the start date from which viewer activity is counted when retrieving analytics data. |
Shows analytics data on total views of a specific content item, including repeated visits by the same user.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server side:
SELECT * FROM ViewsAnalytics WHERE FromDate = '2023-01-02'
| Name | Type | References | SupportedOperators | Description |
| ContentId [KEY] | String | = | The unique identifier of the page or content item for which view analytics are recorded. | |
| NumberOfViews | String | The total number of times the content has been viewed, including repeated views by the same user. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FromDate | Date | Specifies the start date from which view activity is counted when retrieving analytics data. |
Retrieves details about collaborative whiteboards created within Confluence, including titles, owners, and associated spaces.
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | The unique identifier of the whiteboard within Confluence. | |
| Title | String | =,!=,IN,NOT_IN,LIKE | The title of the whiteboard as displayed in Confluence. | |
| Status | String | Indicates the current status of the whiteboard, such as active, draft, or archived. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space that contains the whiteboard. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space the whiteboard belongs to, such as global, personal, or team space. |
| Position | String | Defines the whiteboard's position or order within its parent space or container. | ||
| URL | String | The full URL used to access the whiteboard through the Confluence interface or API. | ||
| Excerpt | String | A short summary or snippet of the whiteboard content, typically used for previews or search results. | ||
| IsLatest | Boolean | If the value is 'true', this record represents the most recent version of the whiteboard. If the value is 'false', it refers to a previous version. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally created the whiteboard. | |
| CreatedByUserType | String | Specifies the type of user who created the whiteboard, such as internal, external, or system account. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the whiteboard was created. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the whiteboard was last modified. | |
| LastUpdatedMessage | String | The revision message or note entered when the whiteboard was last updated. | ||
| LastUpdatedNumber | Integer | The version number associated with the most recent update of the whiteboard. | ||
| LastUpdatedUserName | String | The username of the user who performed the most recent update. | ||
| LastUpdatedUserType | String | Indicates the type of user who made the latest update, such as internal user or automated process. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the latest change was a minor edit. If the value is 'false', it represents a major update. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the most recent version of the whiteboard is hidden from general visibility. If the value is 'false', it is visible. | ||
| PreviousVersionUserName | String | The username of the user who modified the previous version of the whiteboard. | ||
| PreviousVersionUserType | String | Specifies the type of user who updated the previous version, such as internal user or system account. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the whiteboard was edited. | ||
| PreviousVersionMessage | String | The revision message or comment provided for the previous version. | ||
| PreviousVersionNumber | String | The version number assigned to the previous revision of the whiteboard. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was a minor edit. If the value is 'false', it represented a major change. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the whiteboard is hidden from users. If the value is 'false', it is visible. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the whiteboard, allowing direct editing in Confluence. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the whiteboard, used for retrieving its data programmatically. | ||
| LinksTinyui | String | The short link (TinyUI) version of the whiteboard's URL, providing a compact format for sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the whiteboard as viewed in Confluence. | ||
| ItemURL | String | The complete URL reference to the whiteboard as displayed in the user interface. | ||
| ContainerId | String | The unique identifier of the container, such as the page or space, that holds the whiteboard. | ||
| AnonymousExportViewBody | String | Contains the whiteboard body in anonymous export view format, allowing public export without authentication. | ||
| AtlasDocFormatBody | String | Contains the whiteboard body in Atlas Document Format (ADF), supporting structured and rich content. | ||
| BodyViewBody | String | Contains the rendered view representation of the whiteboard content as displayed in Confluence. | ||
| DynamicBody | String | Contains the dynamic representation of the whiteboard body, used for interactive or real-time updates. | ||
| ExportViewBody | String | Contains the whiteboard body in export view format, suitable for use in external exports. | ||
| EditorBody | String | Contains the whiteboard body in the editor format used in the Confluence editor. | ||
| Editor2Body | String | Contains the whiteboard body in the Editor2 format, used by newer Confluence editor versions. | ||
| StorageBody | String | Contains the whiteboard content in Confluence Storage Format, preserving text, drawings, and formatting. | ||
| StyledViewBody | String | Contains the whiteboard body in styled view format, showing the rendered version with formatting and layout. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering whiteboards. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Confluence.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Confluence, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Confluence:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Pages table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Pages'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Confluence procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Pages table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Pages'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Confluence Cloud Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Confluence. |
| URL | The URL to your JIRA endpoint. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| APIToken | APIToken of the currently authenticated user. |
| PAT | Personal Access Token of the currently authenticated user. |
| Timezone | Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York. |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| SSOExchangeURL | The URL used for consuming the SAML response and exchanging it for service specific credentials. |
| SSOAppName | App Name used with SSO for IdPs that require it. |
| SSOAppPassword | App Password used with SSO for IdPs that require it. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| FullOrderByPushDown | Enables pushing `ORDER BY` to the server for supported columns, including problematic datetime columns. For these columns, milliseconds are trimmed to align with the server's behavior. Note: When this property is enabled, millisecond precision is lost for problematic datetime columns, even if the query does not include an ORDER BY clause. |
| IgnoreErrorsOnPagination | This property allows the driver to skip pages that encounter specified server errors during paginated queries and continue retrieving the remaining pages. Note: This property only affects Data Center tables with client-side paging. |
| IncludeArchivedSpaces | Whether to include content from archived spaces in the result. This defaults to false. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Confluence. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SpaceKey | By specifying the SpaceKey, the search results will only display contents from this specific space. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Confluence. |
| URL | The URL to your JIRA endpoint. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| APIToken | APIToken of the currently authenticated user. |
| PAT | Personal Access Token of the currently authenticated user. |
| Timezone | Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York. |
The type of authentication to use when connecting to Confluence.
string
"Basic"
Confluence supports the following authentication schemes:
The URL to your JIRA endpoint.
string
""
The URL to your JIRA endpoint; for example, https://yoursitename.atlassian.net.
Specifies the authenticating user's user ID.
string
""
The authenticating server requires both User and Password to validate the user's identity.
Specifies the authenticating user's password.
string
""
The authenticating server requires both User and Password to validate the user's identity.
APIToken of the currently authenticated user.
string
""
APIToken of the currently authenticated user.
Personal Access Token of the currently authenticated user.
string
""
Personal Access Token of the currently authenticated user.
Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York.
string
""
Note: You can find the timezone in your Confluence Server by navigating to Settings -> General Configuration and then by clicking System Information on the left panel. On your Confluence Cloud, the timezone should be set. In order to set it, navigate to the User Profile icon on the bottom left corner and click Settings. In that section, you will be able to set the Timezone by clicking the Edit button.
This section provides a complete list of the SSO properties you can configure in the connection string for this provider.
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| SSOExchangeURL | The URL used for consuming the SAML response and exchanging it for service specific credentials. |
| SSOAppName | App Name used with SSO for IdPs that require it. |
| SSOAppPassword | App Password used with SSO for IdPs that require it. |
The identity provider's login URL.
string
""
The identity provider's login URL.
Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
string
""
Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
This is used with the SSOLoginURL.
SSO configuration is discussed further in .
The URL used for consuming the SAML response and exchanging it for service specific credentials.
string
""
The CData Cloud will use the URL specified here to consume a SAML response and exchange it for service specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with Confluence.
App Name used with SSO for IdPs that require it.
string
""
Along with SSOAppPassword, may be be specified to identify and authenticate to your app configured in the SSO IdP. Currently only Crowd supports it.
App Password used with SSO for IdPs that require it.
string
""
Along with SSOAppName, may be be specified to identify and authenticate to your app configured in the SSO IdP. Currently only Crowd supports it.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
string
""
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| FullOrderByPushDown | Enables pushing `ORDER BY` to the server for supported columns, including problematic datetime columns. For these columns, milliseconds are trimmed to align with the server's behavior. Note: When this property is enabled, millisecond precision is lost for problematic datetime columns, even if the query does not include an ORDER BY clause. |
| IgnoreErrorsOnPagination | This property allows the driver to skip pages that encounter specified server errors during paginated queries and continue retrieving the remaining pages. Note: This property only affects Data Center tables with client-side paging. |
| IncludeArchivedSpaces | Whether to include content from archived spaces in the result. This defaults to false. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Confluence. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SpaceKey | By specifying the SpaceKey, the search results will only display contents from this specific space. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
Enables pushing `ORDER BY` to the server for supported columns, including problematic datetime columns. For these columns, milliseconds are trimmed to align with the server's behavior. Note: When this property is enabled, millisecond precision is lost for problematic datetime columns, even if the query does not include an ORDER BY clause.
bool
false
Default: false – `ORDER BY` is not applied server-side for problematic datetime columns, as the server only supports ordering up to the second (ignoring milliseconds), which can cause inaccurate sorting.
When set to true, the driver applies `ORDER BY` on the server for these problematic datetime columns, trimming milliseconds to align with the server's second-level precision. As a result, millisecond precision is lost in these columns regardless of whether the query specifies an ORDER BY clause.
This property allows the driver to skip pages that encounter specified server errors during paginated queries and continue retrieving the remaining pages. Note: This property only affects Data Center tables with client-side paging.
string
"None"
When enabled, this property allows the driver to handle specific errors gracefully during paginated queries. If a server error occurs while fetching a page or batch — such as an HTTP 5xx status code — the error will be logged, the problematic page will be skipped, and the driver will proceed to retrieve the remaining pages. As a result, the query will return all data that was successfully fetched.
This property accepts:
* - Ignore all HTTP server error status codes
None - Disable error skipping (default)
Comma-separated list of server error status codes (e.g., "500,501,503") - Ignore only the specified server errors
Whether to include content from archived spaces in the result. This defaults to false.
bool
false
If this property is set to true, content such as comments, attachments, pages and blogspots belonging to an archived space will be included in the result.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the maximum number of records per page the provider returns when requesting data from Confluence.
int
200
When processing a query, instead of requesting all of the queried data at once from Confluence, the Cloud can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Cloud requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
By specifying the SpaceKey, the search results will only display contents from this specific space.
string
""
If SpaceKey is specified both in the SQL query as well as a connection property, the value in the SQL query will take precedence over the connection property.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.