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.

Connecting to Confluence

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 CData Cloud Services

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.

Connecting to Confluence

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.

Authenticating to Confluence

Confluence supports the following authentication methods: API token, Basic authentication, OAuth 2.0, and SSO.

API Token

Confluence Cloud Account

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.):

• AuthScheme: Set this to APIToken.
• User: The user to be used to authenticate with the Confluence server.
• APIToken: The API Token associated with the currently authenticated user.
• Url: The URL associated with your Confluence endpoint. For example, https://yoursitename.atlassian.net.

Basic Authentication

Confluence Server Instance

To authenticate to a Server instance, specify the following:

• AuthScheme: Set this to Basic.
• User: The user to authenticate with the Confluence instance.
• Password: The password which is used to authenticate with the Confluence server.
• Url: The URL associated with your Confluence endpoint. For example, https://yoursitename.atlassian.net.

OAuth

In all cases, you must set AuthScheme to OAuth and Scope to the value obtained from your application settings. In all the flows described below, it is assumed that you have done so. Note: OAuth 1.0 is deprecated in Confluence Cloud and should only be used by hosted Confluence users.

Crowd

Set the AuthScheme to Crowd, then configure these connection properties:

• User: The CROWD user account.
• Password: The password associated with the Crowd account.
• SSOLoginURL: The login URL associated with the Crowd account. You can find the IDP URL by navigating to your application > SSO > SSO information > Identity provider single sign-on URL.
• SSOAppName: The name of the application in which SSO is enabled.
• SSOAppPassword: The password of the application in which SSO is enabled.
• SSOExchangeUrl: The URL used used to exchange the SAML token for Confluence cookies. This URL may have the following formats:
  • https://<authority of Confluence instance>/plugins/servlet/samlconsumer
  • https://<authority of Confluence instance>/plugins/servlet/samlsso

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;

Okta

To connect to Okta, set the AuthScheme to Okta, and set these properties:

• User: The Okta user.
• Password: The Okta user's password.
• SSOLoginURL: The SSO provider's login URL.
• SSOExchangeUrl: The URL used used to exchange the SAML token for Confluence cookies. This URL may have the following formats:
  • https://<authority of Confluence instance>/plugins/servlet/samlconsumer
  • https://<authority of Confluence instance>/plugins/servlet/samlsso

If you are 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:

• APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
• MFAType: If you have configured the MFA flow, set this to one of the following supported types: OktaVerify, Email, or SMS.
• MFAPassCode: If you have configured the MFA flow, set this to a valid passcode.
  If you set this to empty or an invalid value, the Cloud issues a one-time password challenge to your device or email. After the passcode is received, reopen the connection where the retrieved one-time password value is set to the MFAPassCode connection property.
• MFARememberDevice: True by default. Okta supports remembering devices when MFA is required. If remembering devices is allowed according to the configured authentication policies, the Cloud sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable to False.

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.

Create an OAuth App

To obtain the OAuth client credentials, consumer key, and consumer secret:

1. Log in to your Confluence Cloud site.
2. Navigate to your application management (https://developer.atlassian.com/apps/).
3. Select Create new app, then name the application. The application is created.
4. If missing, add OAuth 2.0 functionality to your application by navigating to APIS AND FEATURES > + Add > Add OAuth 2.0 (3LO).
5. From APIS AND FEATURES > + Add, add the Confluence platform REST API to your application. Please note that you also need to add the Confluence application to get all of the functionalities of the driver.
6. From APIS AND FEATURES > + Confluence platform REST API, add the desired scopes to your application.
7. You also need to set your Callback URL. Navigate to APIS AND FEATURES > OAuth 2.0 (3LO). Enter a URL that is accessible to your applicationand save the changes.

Fine Tuning Data Access

You can use the following properties to gain more control over the data returned from Confluence:

• IncludeArchivedSpaces: Include content from archived spaces in the result. This defaults to false.
• SpaceKey: Search results will only display contents from the specified space.
• Timezone: The timezone of the Confluence instance. The appropriate datetime filters will be used to retrieve results in accordance with the specified timezone.

Customizing the SSL Configuration

By default, 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.

Client SSL Certificates

The Confluence Cloud also supports setting client certificates. Set the following to connect using a client certificate.

• SSLClientCert: The name of the certificate store for the client certificate.
• SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
• SSLClientCertPassword: The password for the TLS/SSL client certificate.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to Confluence APIs.

Key Features

• The Cloud models Confluence entities like pages, blogposts, comments, attachments, spaces, audit records and users as relational views, allowing you to write SQL to query Confluence data.
• Live connectivity to these objects means any changes to your Confluence account are immediately reflected when using the Cloud.

Views

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.

CData Cloud - Confluence Tables

Name	Description
Pages	Generated schema file.

Generated schema file.

Table Specific Information

Select

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).

• Id supports the '=,!=,IN,NOT IN' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Title supports the '=,!=,LIKE,NOT LIKE,IN,NOT IN' comparisons.
• SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
• SpaceType supports the '=,!=,IN,NOT IN' comparisons.
• CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
• CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
• LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL

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

CQL

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"'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Description
Id [KEY]	String	False		=,!=,IN,NOT IN	Id of the content.
Type	String	True		=,!=,IN,NOT IN	Type of the content.
Title	String	False		=,!=,IN,NOT IN,LIKE	Title of the content.
Status	String	False		=,IN	Status of the content.
Storage	String	False			The body content storage of the page..
AtlasDocFormat	String	False			The body content in atlas doc format of the page.
Position	Integer	True			Position of the content.
OwnerId	String	False			Id of the owner of the page.
ParentId	Long	False			The Id of the parent page.
SpaceId	String	False		=,!=,IN,NOT IN	The Id of the space the page rests.
SpaceKey	String	True	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the content belongs to.
SpaceType	String	True	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the content belongs to.
Position	String	True			Position of the content.
URL	String	True			URL of the content.
Excerpt	String	True			Excerpt of the content.
IsLatest	Boolean	True			Indicator if this is the latest version of the content.
CreatedByUserName	String	True		=,!=,IN,NOT IN	Username of the user who created the content.
CreatedByUserType	String	True			Type of the user who created the content.
CreatedDate	Datetime	True		=,>,>=,<,<=	Datetime for the creation of the content.
LastUpdatedDatetime	Datetime	True		=,>,>=,<,<=	Datetime of the last updated version of the content.
LastUpdatedMessage	String	True			Message of the last updated version.
LastUpdatedNumber	Integer	True			Number of the last updated version.
LastUpdatedUserName	String	True			Username of the user who updated the latest version.
LastUpdatedUserType	String	True			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean	True			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean	True			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String	True			Username of the user who updated the previous version.
PreviousVersionUserType	String	True			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime	True			Datetime when the previous version was edited.
PreviousVersionMessage	String	True			Message for the previously edited version.
PreviousVersionNumber	String	True			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean	True			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean	True			Indicator if the previous version was hidden or not.
VersionUserName	String	True			Username of the user who updated the previous version.
VersionUserType	String	True			Type of the user who updated the previous version.
VersionDatetime	Datetime	True			Datetime when the previous version was edited.
VersionMessage	String	False			Message for the previously edited version.
VersionNumber	Integer	False			Number of the previously edited version.
VersionIsMinorEdit	Boolean	True			Indicator if the previous version was a minor edit.
VersionIsHidden	Boolean	True			Indicator if the previous version was hidden or not.
LinksEditui	String	True			The LinksEditui of the page content.
LinksSelf	String	True			The LinksSelf of the content.
LinksTinyui	String	True			The LinksTinyui of the content.
LinksWebui	String	True			The LinksWebui of the content.
ItemURL	String	True			The URL reference of the element in UI.

Pseudo-Columns

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	CQL (Confluence Query Language) allows you to build structured queries.

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.

CData Cloud - Confluence Views

Name	Description
Attachments	Get information about a specific attachment.
AuditRecords	Fetch a paginated list of AuditRecord instances dating back to a certain time.
Blogposts	Get information about a specific blogpost.
Comments	Get information about a specific comment.
Contributors	Get information about the users who have contributed to the content.
GroupMembers	Get users of a specific group.
Groups	Get information about a specific group.
GroupsContentRestrictions	Retrieve information related to the groups restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.
Labels	Get information about the labels that a specific content has.
PageAncestors	To look at a page hierarchy including who is the parent page.
PageChildrens	To look at a page hierarchy including who is the child page.
PageComments	Get comments specific to a page.
PageContents	Get content from the page.
SpacePermissions	Returns space permissions for the specified space(s).
Spaces	Returns information about a number of spaces.
Tasks	Get information regarding tasks.
Users	Get information about a user identified.
UsersContentRestrictions	Retrieve information related to the users restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.
ViewersAnalytics	Get the total number of distinct viewers a piece of content has.
ViewsAnalytics	Get the total number of views a piece of content has.

Get information about a specific attachment.

Table Specific Information

Select

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).

• Id supports the '=,!=,IN,NOT IN' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Title supports the '=,!=,LIKE,NOT LIKE,IN,NOT IN' comparisons.
• SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
• SpaceType supports the '=,!=,IN,NOT IN' comparisons.
• CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
• CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
• LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL

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

CQL

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"'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT IN	Id of the attachment.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String		=,!=,LIKE,IN,NOT IN	Title of the attachment.
Status	String			Status of the attachment.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the attachment belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the attachment belongs to.
Position	String			Position of the attachment.
URL	String			URL of the attachment.
Excerpt	String			Excerpt of the attachment.
IsLatest	Boolean			Indicator if this is the latest version of the attachment.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the attachment.
CreatedByUserType	String			Type of the user who created the attachment.
CreatedDate	Datetime		=,>,>=,<,<=	Datetime for the creation of the attachment.
LastUpdatedDatetime	Datetime		=,>,>=,<,<=	Datetime of the last updated version of the attachment.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.
LinksEditui	String			The LinksEditui of the page content.
LinksSelf	String			The LinksSelf of the content.
LinksTinyui	String			The LinksTinyui of the content.
LinksWebui	String			The LinksWebui of the content.
ItemURL	String			The URL reference of the element in UI.
ContainerId	String			The Id of the container of the content.
MediaType	String			Media Type of the attachment.

Pseudo-Columns

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		CQL (Confluence Query Language) allows you to build structured queries.

Fetch a paginated list of AuditRecord instances dating back to a certain time.

Table Specific Information

Select

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.

• SearchString supports the '=' comparisons.
• StartDate supports the '=' comparisons.
• EndDate supports the '=' comparisons.

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'

Columns

Name	Type	References	SupportedOperators	Description
AffectedObjectName	String			Name of the object that was affected by changes.
AffectedObjectType	String			Type of the object that was affected by changes.
AuthorDisplayName	String			Display name of the person who made the changes.
AuthorType	String			Type of the author who made the changes.
UserKey	String			Unique identifier of the author.
UserName	String			User name of the author.
Category	String			Category of the object.
CreationDate	Datetime			Date when the object was created.
Description	String			Description of the object.
RemoteAddress	String			Remote address of the object.
Summary	String			Summary of the object.
IsSysAdmin	Boolean			Identifier whether object is system administered or not.
SearchString	String		=	Text that is inserted by the user to search for a specific object.
StartDate	Datetime		=	Start date of the audit.
EndDate	Datetime		=	End date of the audit.

Get information about a specific blogpost.

Table Specific Information

Select

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).

• Id supports the '=,!=,IN,NOT IN' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Title supports the '=,!=,LIKE,NOT LIKE,IN,NOT IN' comparisons.
• SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
• SpaceType supports the '=,!=,IN,NOT IN' comparisons.
• CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
• CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
• LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL

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

CQL

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"'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT IN	Id of the blogpost.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String		=,!=,LIKE,IN,NOT IN	Title of the blogpost.
Status	String			Status of the blogpost.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the blogpost belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the blogpost belongs to.
Position	String			Position of the blogpost.
URL	String			URL of the blogpost.
Excerpt	String			Excerpt of the blogpost.
IsLatest	Boolean			Indicator if this is the latest version of the blogpost.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the blogpost.
CreatedByUserType	String			Type of the user who created the blogpost.
CreatedDate	Datetime		=,>,>=,<,<=	Datetime for the creation of the blogpost.
LastUpdatedDatetime	Datetime		=,>,>=,<,<=	Datetime of the last updated version of the blogpost.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.
LinksEditui	String			The LinksEditui of the page content.
LinksSelf	String			The LinksSelf of the content.
LinksTinyui	String			The LinksTinyui of the content.
LinksWebui	String			The LinksWebui of the content.
ItemURL	String			The URL reference of the element in UI.
ContainerId	String			The Id of the container of the content.

Pseudo-Columns

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		CQL (Confluence Query Language) allows you to build structured queries.

Get information about a specific comment.

Table Specific Information

Select

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).

• Id supports the '=,!=,IN,NOT IN' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Title supports the '=,!=,LIKE,NOT LIKE,IN,NOT IN' comparisons.
• SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
• SpaceType supports the '=,!=,IN,NOT IN' comparisons.
• CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
• CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
• LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL

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

CQL

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"'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=,!=,IN,NOT IN	Id of the comment.
Type	String		=,!=,IN,NOT IN	Type of the content.
Title	String			Title of the comment.
Status	String			Status of the comment.
SpaceKey	String	Spaces.Key	=,!=,IN,NOT IN	The key of the space that the comment belongs to.
SpaceType	String	Spaces.Type	=,!=,IN,NOT IN	The type of the space that the comment belongs to.
Position	String			Position of the comment.
URL	String			URL of the comment.
Excerpt	String			Excerpt of the comment.
IsLatest	Boolean			Indicator if this is the latest version of the comment.
CreatedByUserName	String		=,!=,IN,NOT IN	Username of the user who created the comment.
CreatedByUserType	String			Type of the user who created the comment.
CreatedDate	Datetime		=,>,>=,<,<=	Datetime for the creation of the comment.
LastUpdatedDatetime	Datetime		=,>,>=,<,<=	Datetime of the last updated version of the comment.
LastUpdatedMessage	String			Message of the last updated version.
LastUpdatedNumber	Integer			Number of the last updated version.
LastUpdatedUserName	String			Username of the user who updated the latest version.
LastUpdatedUserType	String			Type of the user who updated the latest version.
LastUpdatedIsMinorEdit	Boolean			Indicator if this version is a minor edit.
LastUpdatedIsHidden	Boolean			Indicator if the last updated version is hidden or not.
PreviousVersionUserName	String			Username of the user who updated the previous version.
PreviousVersionUserType	String			Type of the user who updated the previous version.
PreviousVersionDatetime	Datetime			Datetime when the previous version was edited.
PreviousVersionMessage	String			Message for the previously edited version.
PreviousVersionNumber	String			Number of the previously edited version.
PreviousVersionIsMinorEdit	Boolean			Indicator if the previous version was a minor edit.
PreviousVersionIsHidden	Boolean			Indicator if the previous version was hidden or not.
LinksEditui	String			The LinksEditui of the page content.
LinksSelf	String			The LinksSelf of the content.
LinksTinyui	String			The LinksTinyui of the content.
LinksWebui	String			The LinksWebui of the content.
ItemURL	String			The URL reference of the element in UI.
ContainerId	String			The Id of the container of the content.

Pseudo-Columns

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		CQL (Confluence Query Language) allows you to build structured queries.

Get information about the users who have contributed to the content.

Table Specific Information

Select

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: ContentId is required in order to query the Contributors view.

• ContentId supports the '=,!=,IN,NOT IN' comparisons.
• AccountId supports the '=,!=,IN,NOT IN' comparisons.

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! = '12345678'

SELECT * FROM Contributors WHERE AccountId IN ('12345678', '23456789')

SELECT * FROM Contributors WHERE AccountId NOT IN ('12345678', '23456789')

Additionally, ContentId column can be used in the ORDER BY clause, as following:

SELECT * FROM Contributors ORDER BY ContentId DESC

Columns

Name	Type	References	SupportedOperators	Description
ContentId [KEY]	String		=,!=,IN,NOT IN	This is the Id of the content that support labels. This can be referenced from Attachments.Id, Pages.Id, Comments.Id or Blogposts.Id.
UserType	String			Type of the contributor.
AccountId	String		=,!=,IN,NOT IN	Unique account Id of the contributor. NOTE: This column is exclusive to Confluence Cloud.
UserName	String		=,!=,IN,NOT IN	Unique user key of the contributor. NOTE: This column is exclusive to Confluence Server.

Get users of a specific group.

Table Specific Information

Select

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.

• Name supports the '=' comparisons.

For example, the following queries are processed server side:

SELECT * FROM GroupMembers WHERE Name = 'test1'

Columns

Name	Type	References	SupportedOperators	Description
AccountId	String			Account Id of the user.
AccountType	String			Account Type of the user.
DisplayName	String			Display name of the user.
Email	String			Email address of the user.
PublicName	String			Public name or nickname of the user.
ProfilePicturePath	String			Path of the profile picture of the user.
ProfilePictureWidth	Int			Width of the profile picture of the user.
ProfilePictureHeight	Int			Height of the profile picture of the user.
ProfilePictureIsDefault	Boolean			If isDefault of the profile picture of the user.
Operations	String			An operation and the target entity that it applies to
Type	String			Type of the user.
GroupId	String		=	The Id of the group.

Pseudo-Columns

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
Name	String		Name of the Group to which these members belong to

Get information about a specific group.

Table Specific Information

Select

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.

• Name supports the '=,IN' comparisons.
• Id supports the '=' comparisons.

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'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=	Id of the group.
Name [KEY]	String			Name of the group.
Type	String			Type of the group.

Retrieve information related to the groups restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.

Columns

Name	Type	References	SupportedOperators	Description
Operation	String			Specifies the type of operation (read, update) that the restriction applies to.
Name	String			Stores the name of the group that the restriction applies to.
Type	String			Specifies the type of the group.
ContentId	String		=	The ID of the content where the restriction is applied.

Get information about the labels that a specific content has.

Table Specific Information

Select

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: ContentId is required in order to query the Labels view.

• ContentId supports the '=,!=,IN,NOT IN' comparisons.
• LabelName supports the '=,!=,IN,NOT IN' comparisons.

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 != 'test'

SELECT * FROM Labels WHERE LabelName IN ('test1', 'test2')

SELECT * FROM Labels WHERE LabelName NOT IN ('test1', 'test2')

Additionally, ContentId column can be used in the ORDER BY clause, as following:

SELECT * FROM Labels ORDER BY ContentId DESC

Columns

Name	Type	References	SupportedOperators	Description
ContentId [KEY]	String		=,!=,IN,NOT IN	This is the Id of the content that support labels. This can be referenced from Attachments.Id, Pages.Id, or Blogposts.Id.
LabelId	String			Id of the label.
LabelName	String		=,!=,IN,NOT IN	Name of the label.
LabelPrefix	String			Prefix of the label.

To look at a page hierarchy including who is the parent page.

Table Specific Information

Select

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.

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PageAncestors WHERE PageId = '33106'
SELECT * FROM PageAncestors WHERE PageId IN ('163902', '33106')

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The Id of the PageAncestors.
ExpandableAncestors	String			The ExpandableAncestors of the PageAncestors.
ExpandableBody	String			The ExpandableBody of the PageAncestors.
ExpandableChildren	String			The ExpandableChildren of the PageAncestors.
ExpandableChildTypes	String			The ExpandableChildTypes of the PageAncestors.
ExpandableContainer	String			The ExpandableContainer of the PageAncestors.
ExpandableDescendants	String			The ExpandableDescendants of the PageAncestors.
ExpandableHistory	String			The ExpandableHistory of the PageAncestors.
ExpandableMetadata	String			The ExpandableMetadata of the PageAncestors.
ExpandableOperations	String			The ExpandableOperations of the PageAncestors.
ExpandableRestrictions	String			The ExpandableRestrictions of the PageAncestors.
ExpandableSchedulePublishDate	Datetime			The ExpandableSchedulePublishDate of the PageAncestors.
ExpandableSpace	String			The ExpandableSpace of the PageAncestors.
ExpandableVersion	String			The ExpandableVersion of the PageAncestors.
LinksEditui	String			The LinksEditui of the PageAncestors.
LinksSelf	String			The LinksSelf of the PageAncestors.
LinksTinyui	String			The LinksTinyui of the PageAncestors.
LinksWebui	String			The LinksWebui of the PageAncestors.
ExtensionsPosition	String			The ExtensionsPosition of the PageAncestors.
Status	String			The Status of the PageAncestors.
Title	String			The Title of the PageAncestors.
Type	String			The Type of the PageAncestors.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The Id of the page.

To look at a page hierarchy including who is the child page.

Table Specific Information

Select

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 PageChildrens view.

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PageChildrens WHERE PageId = '33106'
SELECT * FROM PageChildrens WHERE PageId IN ('163902', '33106')

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The Id of the PageChildrens.
ExpandableAncestors	String			The ExpandableAncestors of the PageChildrens.
ExpandableBody	String			The ExpandableBody of the PageChildrens.
ExpandableChildren	String			The ExpandableChildren of the PageChildrens.
ExpandableChildTypes	String			The ExpandableChildTypes of the PageChildrens.
ExpandableContainer	String			The ExpandableContainer of the PageChildrens.
ExpandableDescendants	String			The ExpandableDescendants of the PageChildrens.
ExpandableHistory	String			The ExpandableHistory of the PageChildrens.
ExpandableMetadata	String			The ExpandableMetadata of the PageChildrens.
ExpandableOperations	String			The ExpandableOperations of the PageChildrens.
ExpandableRestrictions	String			The ExpandableRestrictions of the PageChildrens.
ExpandableSchedulePublishDate	Datetime			The ExpandableSchedulePublishDate of the PageChildrens.
ExpandableSpace	String			The ExpandableSpace of the PageChildrens.
ExpandableVersion	String			The ExpandableVersion of the PageChildrens.
LinksEditui	String			The LinksEditui of the PageChildrens.
LinksSelf	String			The LinksSelf of the PageChildrens.
LinksTinyui	String			The LinksTinyui of the PageChildrens.
LinksWebui	String			The LinksWebui of the PageChildrens.
ExtensionsPosition	String			The ExtensionsPosition of the PageChildrens.
Status	String			The Status of the PageChildrens.
Title	String			The Title of the PageChildrens.
Type	String			The Type of the PageChildrens.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The Id of the page.

Get comments specific to a page.

Table Specific Information

Select

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.

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PageComments WHERE PageId = '163902' 
SELECT * FROM PageComments WHERE PageId IN ('163902', '33106')

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The Id of the comments mentioned in the Page.
ExpandableAncestors	String			The ExpandableAncestors of the page comments.
ExpandableChildren	String			The ExpandableChildren of the page comments.
ExpandableContainer	String			The ExpandableContainer of the page comments.
ExpandableDescendants	String			The ExpandableDescendants of the page comments.
ExpandableHistory	String			The ExpandableHistory of the page comments.
ExpandableMetadata	String			The ExpandableMetadata of the page comments.
ExpandableOperations	String			The ExpandableOperations of the page comments.
ExpandableRestrictions	String			The ExpandableRestrictions of the page comments.
ExpandableSpace	String			The ExpandableSpace of the page comments.
ExpandableVersion	String			The ExpandableVersion of the page comments.
LinksSelf	String			The LinksSelf of the page comments.
LinksWebui	String			The LinksWebui of the page comments.
BodyExpandableAnonymousExportView	String			The BodyExpandableAnonymousExportView of the page comments.
BodyExpandableEditor	String			The BodyExpandableEditor of the page comments.
BodyExpandableExportView	String			The BodyExpandableExportView of the page comments.
BodyExpandableStorage	String			The BodyExpandableStorage of the page comments.
BodyExpandableStyledView	String			The BodyExpandableStyledView of the page comments.
BodyViewExpandableContent	String			The BodyViewExpandableContent of the page comments.
BodyViewExpandableWebresource	String			The BodyViewExpandableWebresource of the page comments.
BodyViewRepresentation	String			The BodyViewRepresentation of the page comments.
BodyViewValue	String			The BodyViewValue of the page comments.
ExtensionsExpandableResolution	String			The ExtensionsExpandableResolution of the page comments.
ExtensionsLocation	String			The ExtensionsLocation of the page comments.
Status	String			The Status of the page comments.
Title	String			The Title of the page comments.
Type	String			The Type of the page comments.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The Id of the page.

Get content from the page.

Table Specific Information

Select

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.

• PageId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PageContents WHERE PageId = '163902'
SELECT * FROM PageContents WHERE PageId IN ('163902', '33106')

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The Id of the page content.
ExpandableAncestors	String			The ExpandableAncestors of the page content.
ExpandableChildren	String			The ExpandableChildren of the page content.
ExpandableChildTypes	String			The ExpandableChildTypes of the page content.
ExpandableContainer	String			The ExpandableContainer of the page content.
ExpandableDescendants	String			The ExpandableDescendants of the page content.
ExpandableHistory	String			The ExpandableHistory of the page content.
ExpandableMetadata	String			The ExpandableMetadata of the page content.
ExpandableOperations	String			The ExpandableOperations of the page content.
ExpandableRestrictions	String			The ExpandableRestrictions of the page content.
ExpandableSchedulePublishDate	Datetime			The ExpandableSchedulePublishDate of the page content.
ExpandableSpace	String			The ExpandableSpace of the page content.
ExpandableVersion	String			The ExpandableVersion of the page content.
LinksBase	String			The LinksBase of the page content.
LinksCollection	String			The LinksCollection of the page content.
LinksContext	String			The LinksContext of the page content.
LinksEditui	String			The LinksEditui of the page content.
LinksSelf	String			The LinksSelf of the page content.
LinksTinyui	String			The LinksTinyui of the page content.
LinksWebui	String			The LinksWebui of the page content.
BodyExpandableAnonymousExportView	String			The BodyExpandableAnonymousExportView of the page content.
BodyExpandableAtlasDocFormat	String			The BodyExpandableAtlasDocFormat of the page content.
BodyExpandableDynamic	String			The BodyExpandableDynamic of the page content.
BodyExpandableEditor	String			The BodyExpandableEditor of the page content.
BodyExpandableEditor2	String			The BodyExpandableEditor2 of the page content.
BodyExpandableExportView	String			The BodyExpandableExportView of the page content.
BodyExpandableStyledView	String			The BodyExpandableStyledView of the page content.
BodyExpandableView	String			The BodyExpandableView of the page content.
BodyStorageExpandableContent	String			The BodyStorageExpandableContent of the page content.
BodyStorageEmbeddedContent	String			The BodyStorageEmbeddedContent of the page content.
BodyStorageRepresentation	String			The BodyStorageRepresentation of the page content.
BodyStorageValue	String			The BodyStorageValue of the page content.
ExtensionsPosition	String			The ExtensionsPosition of the page content.
Status	String			The Status of the page content.
Title	String			The Title of the page content.
Type	String			The Type of the page content.
PageId	String	Pages.Id	=,!=,IN,NOT IN	The Id of the page.

Returns space permissions for the specified space(s).

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The ID of the space permission.
OperationKey	String			The type of operation that the space permission corresponds to.
OperationTargetType	String			The type of entity the operation type targets.
PrincipalId	String			The ID of the entity the space permissions corresponds to.
PrincipalType	String			The type of the entity the space permissions corresponds to.
SpaceId	String	Spaces.Id	=	The ID of the space that the permission is associated with.

Returns information about a number of spaces.

Table Specific Information

Select

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).

• Key supports the '=,!=,IN,NOT IN' comparisons.
• Name supports the '=,LIKE,NOT LIKE' comparisons.
• Type supports the '=,!=,IN,NOT IN' comparisons.
• Excerpt supports the '=' comparisons.

For example, the following queries are processed server side:

SQL

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'

CQL

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'

Columns

Name	Type	References	SupportedOperators	Description
Id	String			Id of the space.
Key [KEY]	String		=,!=,IN,NOT IN	Unique key of the space.
Name	String		=,!=	Name of the space.
IconPath	String			Path of the space icon.
IconWidth	Integer			Width of the space icon.
IconHeight	Integer			Height of the space icon.
IsIconDefault	Boolean			Indicator if the icon is default.
Excerpt	String			Excerpt of the space.
Type	String		=,!=,IN,NOT IN	Type of the space.
Url	String			Url of the space.
LastModified	Datetime			Last modified datetime.
ItemURL	String			The URL reference of the element in UI.
Description	String			Description of the space.

Pseudo-Columns

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		CQL (Confluence Query Language) allows you to build structured queries.

Get information regarding tasks.

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String		=	The ID of the task.
AssignedTo	String		=	Account ID of the user to whom this task is assigned.
AtlasDoc	String			The atlas doc format.
BlogPostId	String		=	The blog post ID of the task.
CompletedAt	Datetime			Time when task is completed.
CompletedBy	String		=	Account ID of the user who completed this task.
CreatedAt	Datetime			Time when task is created.
CreatedBy	String		=	Account ID of the user who created this task.
DueAt	Datetime			Time when task is due.
LocalId	String			The local ID.
PageId	String		=	The page ID of the task.
SpaceId	String		=	The space ID of the task.
Status	String		=	The status of the task.
Storage	String			The body storage of the task.
UpdatedAt	Datetime			Time when task is updated.

Get information about a user identified.

Table Specific Information

Select

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).

• AccountId supports the '=,!=,IN,NOT IN' comparisons.
• PublicName supports the '=,LIKE,NOT LIKE' comparisons.

For example, the following queries are processed server side:

SQL

SELECT * FROM Users WHERE AccountId = '1234'

SELECT * FROM Users WHERE AccountId IN ('1234', '2345')

SELECT * FROM Users WHERE PublicName = 'confluenceuser'

CQL

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()'

Columns

Name	Type	References	SupportedOperators	Description
AccountId [KEY]	String		=,!=,IN,NOT IN	Unique account id for the specific user. NOTE: This column is exclusive to Confluence Cloud.
AccountType	String			Type of the account for the specific user. NOTE: This column is exclusive to Confluence Cloud.
PublicName	String		=,LIKE	Full name of the specific user. NOTE: This column is exclusive to Confluence Cloud.
Email	String			Email of the specific user. NOTE: This column is exclusive to Confluence Cloud.
UserKey [KEY]	String		=,!=,IN,NOT IN	Unique key for the specific user. NOTE: This column is exclusive to Confluence Server.
UserName	String		=	User name of the specific user. NOTE: This column is exclusive to Confluence Server.
Status	String			Status of the specific user. NOTE: This column is exclusive to Confluence Server.
Type	String			Type of the specific user.
Excerpt	String			Excerpt of the user.
ProfilePicturePath	String			Path of the profile picture file.
ProfilePictureWidth	Integer			Profile picture width.
ProfilePictureHeight	Integer			Profile picture height.
IsDefaultPicture	Boolean			Indicator showing if the profile picture is never changed.
DisplayName	String			Display name of the specific user.
Url	String			Url of the user profile.
LastModified	Datetime			Last modified timestamp of the user information.

Pseudo-Columns

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		CQL (Confluence Query Language) allows you to build structured queries.

Retrieve information related to the users restrictions applied to a certain content. The maximum number of restrictions per operation is limited to 200. ContentId is required.

Columns

Name	Type	References	SupportedOperators	Description
Operation	String			Specifies the type of operation (read, update) that the restriction applies to.
UserKey	String			Specifies the UserKey, the unique identifier key for the user.
DisplayName	String			The display name of the user associated with the restriction.
Username	String			Specifies the Username of the user.
Type	String			Specifies the type of the user (for example, 'known').
ContentId	String		=	The ID of the content where the restriction is applied.

Get the total number of distinct viewers a piece of content has.

Table Specific Information

Select

The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.

• FromDate supports the '=' comparison.
• ContentId supports the '=,IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM ViewersAnalytics WHERE FromDate = '2023-01-02'

Columns

Name	Type	References	SupportedOperators	Description
ContentId	String		=	The Id of the page content.
NumberOfDistinctViewers	String			the total number of distinct viewers a piece of content has.

Pseudo-Columns

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		The number of views for the content from the date.

Get the total number of views a piece of content has.

Table Specific Information

Select

The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.

• FromDate supports the '=' comparison.
• ContentId supports the '=,IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM ViewsAnalytics WHERE FromDate = '2023-01-02'

Columns

Name	Type	References	SupportedOperators	Description
ContentId	String		=	The Id of the page content.
NumberOfViews	String			the total number of views a piece of content has.

Pseudo-Columns

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		The number of views for the content from the date.

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.

CData Cloud - Confluence Stored Procedures

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.

Schema Tables

The following tables return database metadata for Confluence:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

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
          

Columns

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' 

Columns

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.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

Columns

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.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time 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.

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' 
          

Columns

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'
          

Columns

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
          

Columns

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'
          

Columns

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 <> ''

Columns

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.

Discovering the Data Source's SELECT Capabilities

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.

Columns

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
          

Columns

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

Columns

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.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Confluence.
URL	The URL to your JIRA endpoint.
User	Specifies the user ID of the authenticating Confluence user account.
Password	Specifies the password of the authenticating user account.
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.

SSO

---

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.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

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.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
IncludeArchivedSpaces	Whether to include content from archived spaces in the result. This defaults to false.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Confluence, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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. The default is 60 seconds. Set to 0 to disable the timeout.

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 user ID of the authenticating Confluence user account.
Password	Specifies the password of the authenticating user account.
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.

Possible Values

OAuth, Basic, APIToken, Crowd, OKTA, PAT

Data Type

string

Default Value

"Basic"

Remarks

• OAuth: Set this to perform OAuth authentication.
• Basic: Set this to use basic User/Password authentication for Server instances.
• APIToken: Set this to use basic User/APIToken authentication for Cloud instances.
• Crowd: Set this to perform Crowd SSO authentication.
• OKTA: Set this to perform OKTA SSO authentication.
• PAT: Set this to use a Personal Access Token (PAT) for Server instances of Confluence 7.9 and later.

The URL to your JIRA endpoint.

Data Type

string

Default Value

""

Remarks

The URL to your JIRA endpoint; for example, https://yoursitename.atlassian.net.

Specifies the user ID of the authenticating Confluence user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the password of the authenticating user account.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

APIToken of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

APIToken of the currently authenticated user.

Personal Access Token of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, 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.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

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.

Data Type

string

Default Value

"1"

Remarks

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 .

Data Type

string

Default Value

""

Remarks

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
IncludeArchivedSpaces	Whether to include content from archived spaces in the result. This defaults to false.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Pagesize	Specifies the maximum number of results to return from Confluence, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
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. The default is 60 seconds. Set to 0 to disable the timeout.

Whether to include content from archived spaces in the result. This defaults to false.

Data Type

bool

Default Value

false

Remarks

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 rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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 results to return from Confluence, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Data Type

int

Default Value

200

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

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.

Data Type

string

Default Value

""

Remarks

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. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.