Confluence Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8895 of the connector.
Get Started¶
Confluence Version Support
The connector leverages the Confluence API v2 to enable bidirectional access to Confluence.
Establish a Connection¶
Connect 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
.
Authenticate to Confluence¶
Confluence supports the following authentication methods: Basic Authentication, standard OAuth2.0 Authentication and SSO.
Basic Authentication¶
Confluence Cloud Account¶
Aquire a Token
An API token is necessary for account authentication. To generate one, login 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 Basic.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 Jira endpoint. For example,https://yoursitename.atlassian.net.
Confluence Server Instance¶
To authenticate to a Server instance, specify the following:
AuthScheme
: Set this toBasic
.User
: The user which to be used to authenticate with the Confluence instance.Password
: The password which is used to authenticate with the Confluence server.URL
: The URL associated with your Jira endpoint. For example,https://yoursitename.atlassian.net
.
OAuth¶
In all cases, you must set AuthScheme
to OAuth
and Scope
to to the value obtained from your application settings. In all the flows described below, it is assumed that you have done so.
Desktop Applications¶
This section describes desktop authentication using the credentials for your custom OAuth app. See Creating a Custom OAuth App for more information.
Get an OAuth Access Token
After setting the following, you are ready to connect:
OAuthClientId
: Set to the client ID in your app settings.OAuthClientSecret
: Set to the client secret in your app settings.CallbackURL
: Set to the Redirect URL in your app settings.OAuthVersion
: Set to2.0
.URL
: The URL to your Confluence endpoint; for example,https://yoursitename.atlassian.net
.InitiateOAuth
: Set toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.
When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the following OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in
OAuthSettingsLocation
. These values persist across connections.
Crowd¶
Set the AuthScheme
to Crowd
. The following connection properties are used to connect to Crowd:
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 toyour 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/samlconsumerhttps://<authority
of Confluence instance>/plugins/servlet/samlsso
The following is an 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/samlconsumerhttps://<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
, orSMS
. -
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 connector 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 connector sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable toFalse
.
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;
Create a Custom OAuth App¶
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:
- Log in to your Confluence Cloud site.
- Navigate to your application management (
https://developer.atlassian.com/apps/
). - Select
Create new app
, then name the application. The application is created. - If missing, add OAuth 2.0 functionality to your application by navigating to APIS AND FEATURES > + Add > Add OAuth 2.0 (3LO).
- From
APIS AND FEATURES > + Add
, add theConfluence 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. - From
APIS AND FEATURES > + Confluence platform REST API
, add the desired scopes to your application. - 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¶
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.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Confluence connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Confluence and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
User Defined Views¶
The Confluence connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Pages WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert
property for the available formats to do so.
Client SSL Certificates¶
The Confluence connector 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.
Confluence Cloud Data Model¶
Overview
This section shows the available API objects and provides more information on executing SQL to Confluence APIs.
Key Features
- The connector 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 connector.
Views
Views describes the available views. Views are statically defined to model AuditRecords, Pages, Blogposts, Comments, Attachments, Contributors, Labels, Spaces and Users.
Views¶
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.
Confluence Connector 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. |
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. |
Pages | Get information about a specific page. |
Spaces | Returns information about a number of spaces. |
Tasks | Get information regarding tasks. |
Users | Get information about a user identified. |
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. |
Attachments¶
Get information about a specific attachment.
Table Specific Information¶
Select¶
The connector 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 connector. 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, NOT 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. |
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 |
AuditRecords¶
Fetch a paginated list of AuditRecord instances dating back to a certain time.
Table Specific Information¶
Select¶
The connector 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 connector.
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. |
Blogposts¶
Get information about a specific blogpost.
Table Specific Information¶
Select¶
The connector 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 connector. 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, NOT 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. |
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 |
Comments¶
Get information about a specific comment.
Table Specific Information¶
Select¶
The connector 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 connector. 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 | =, !=, LIKE, NOT LIKE, IN, NOT IN | 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. |
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 |
Contributors¶
Get information about the users who have contributed to the content.
Table Specific Information¶
Select¶
The connector 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 connector.
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. |
GroupMembers¶
Get users of a specific group.
Table Specific Information¶
Select¶
The connector 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 connector.
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 |
Groups¶
Get information about a specific group.
Table Specific Information¶
Select¶
The connector 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 connector.
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. |
Labels¶
Get information about the labels that a specific content has.
Table Specific Information¶
Select¶
The connector 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 connector.
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. |
PageAncestors¶
To look at a page hierarchy including who is the parent page.
Table Specific Information¶
Select¶
The connector 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. |
PageChildrens¶
To look at a page hierarchy including who is the child page.
Table Specific Information¶
Select¶
The connector 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 | Integer | 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. |
PageComments¶
Get comments specific to a page.
Table Specific Information¶
Select¶
The connector 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. |
PageContents¶
Get content from the page.
Table Specific Information¶
Select¶
The connector 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. |
Pages¶
Get information about a specific page.
Table Specific Information¶
Select¶
The connector 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 connector. 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 | References | SupportedOperators | Description |
---|---|---|---|---|
Id [KEY] | String | =, !=, IN, NOT IN | Id of the page. | |
Type | String | =, !=, IN, NOT IN | Type of the content. | |
Title | String | =, !=, LIKE, NOT LIKE, IN, NOT IN | Title of the page. | |
Status | String | Status of the page. | ||
SpaceKey | String | Spaces.Key | =, !=, IN, NOT IN | The key of the space that the page belongs to. |
SpaceType | String | Spaces.Type | =, !=, IN, NOT IN | The type of the space that the page belongs to. |
Position | String | Position of the page. | ||
URL | String | URL of the page. | ||
Excerpt | String | Excerpt of the page. | ||
IsLatest | Boolean | Indicator if this is the latest version of the page. | ||
CreatedByUserName | String | =, !=, IN, NOT IN | Username of the user who created the page. | |
CreatedByUserType | String | Type of the user who created the page. | ||
CreatedDate | Datetime | =, !=, >, >=, <, <= | Datetime for the creation of the page. | |
LastUpdatedDatetime | Datetime | =, !=, >, >=, <, <= | Datetime of the last updated version of the page. | |
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. |
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 |
Spaces¶
Returns information about a number of spaces.
Table Specific Information¶
Select¶
The connector 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 connector. 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 | =, LIKE, NOT LIKE | 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. |
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 |
Tasks¶
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. |
Users¶
Get information about a user identified.
Table Specific Information¶
Select¶
The connector 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 connector. 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, NOT 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 | =, CONTAINS | 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 |
ViewersAnalytics¶
Get the total number of distinct viewers a piece of content has.
Table Specific Information¶
Select¶
The connector 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 | =, IN | 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 |
ViewsAnalytics¶
Get the total number of views a piece of content has.
Table Specific Information¶
Select¶
The connector 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 | =, IN | 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 |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT 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.
Confluence Connector Stored Procedures¶
Name | Description |
---|---|
DownloadAttachment | Download attachment by specifying its Id. |
GetOAuthAccessToken | Gets an authentication token from Confluence. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with Confluence. |
DownloadAttachment¶
Download attachment by specifying its Id.
Input¶
Name | Type | Required | Description |
---|---|---|---|
Id | String | True | The ID of the content that the attachment is attached to. |
AttachmentId | String | True | The ID of the attachment to download. |
Version | String | False | The version of the attachment. If this parameter is absent, the redirect URI will download the latest version of the attachment. |
FileLocation | String | True | The location of where to save the file. |
Overwrite | String | False | If true, the procedure will override files if they exists. Default value is false. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows whether the operation was successful or not. |
GetOAuthAccessToken¶
Gets an authentication token from Confluence.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | Enter either APP or WEB. The type of authentication mode to use. Set to APP to get authentication tokens via a desktop app. Set to WEB to get authentication tokens via a Web app. The default value is APP. |
Verifier | String | False | The verifier token returned by Confluence after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
Scope | String | False | A comma-separated list of permissions to request from the user. Please check the Square API for a list of available permissions. The default value is read:content:confluence read:content-details:confluence read:space-details:confluence read:analytics.content:confluence read:audit-log:confluence read:configuration:confluence read:page:confluence read:blogpost:confluence read:custom-content:confluence read:attachment:confluence read:comment:confluence read:template:confluence readconfluence read:content.permission:confluence read:content.property:confluence read:content.restriction:confluence read:content.metadata:confluence read:watcher:confluence read:group:confluence read:inlinetask:confluence read:relation:confluence read:space:confluence read:space.permission:confluence read:space.property:confluence read:space.setting:confluence read:user:confluence offline_access. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Confluence app settings. |
AuthToken | String | False | The request token returned by GetOAuthAuthorizationURL. Required for only the Web AuthMode. Used for OAuth 1.0. |
AuthKey | String | False | The request token secret returned by GetOAuthAuthorizationURL. Required for only the Web AuthMode. Used for OAuth 1.0. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The access token used for communication with Confluence. |
OAuthAccessTokenSecret | String | The access token secret used for communication with Confluence. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
CloudId | String | The Cloud ID for the Atlassian site that was authorized. |
ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
GetOAuthAuthorizationURL¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
Scope | String | False | A comma-separated list of permissions to request from the user. Please check the Confluence API for a list of available permissions. The default value is read:content:confluence read:content-details:confluence read:space-details:confluence read:analytics.content:confluence read:audit-log:confluence read:configuration:confluence read:page:confluence read:blogpost:confluence read:custom-content:confluence read:attachment:confluence read:comment:confluence read:template:confluence readconfluence read:content.permission:confluence read:content.property:confluence read:content.restriction:confluence read:content.metadata:confluence read:watcher:confluence read:group:confluence read:inlinetask:confluence read:relation:confluence read:space:confluence read:space.permission:confluence read:space.property:confluence read:space.setting:confluence read:user:confluence offline_access. |
State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the QuickBooksOnline authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
AuthToken | String | A token used as input for the GetOAuthAccessToken stored procedure to verify the request and get the access token. |
AuthKey | String | A key used as input for the GetOAuthAccessToken stored procedure to verify the request and get the secret key. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with Confluence.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | Set this to the token value that expired. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from Confluence. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | This is the same as the access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
System Tables¶
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 connector 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.
sys_catalogs¶
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. |
sys_schemas¶
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. |
sys_tables¶
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. |
sys_tablecolumns¶
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. |
sys_procedures¶
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. |
sys_procedureparameters¶
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. |
sys_keycolumns¶
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. |
sys_foreignkeys¶
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. |
sys_primarykeys¶
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. |
sys_indexes¶
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. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:confluence:config:
This connection string enables you to query this table without a valid connection.
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. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Discover 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 |
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 Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The 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. |
sys_identity¶
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. |
sys_information¶
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 Sync required to use this connector. |
DataSyncCategory | String | The category of Sync functionality (e.g., Source, Destination). |
Advanced Configurations Properties¶
The advanced configurations 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. Click the links for further details.
Property | Description |
---|---|
AuthScheme | The type of authentication to use when connecting to Confluence. |
URL | The URL to your JIRA endpoint. |
CloudId | The Cloud ID for the Atlassian site that was authorized. |
User | The Confluence user account used to authenticate. |
Password | The password used to authenticate the user. |
APIToken | APIToken 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 in 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 |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthVersion | The version of OAuth being used. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
Scope | This determines the scopes that the OAuth application requests from Confluence. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CertificateStore | The certificate store used for Confluence authentication. |
CertificateStorePassword | The password of the certificate store used with Confluence authentication. |
CertificateSubject | The subject of the certificate used with Confluence Private Application authentication. |
CertificateStoreType | The type of certificate store used with Confluence Private Application authentication. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
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. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
IncludeArchivedSpaces | Whether to include content from archived spaces in the result. This defaults to false. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Confluence. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
SpaceKey | By specifying the SpaceKey, the search results will only display contents from this specific space. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
AuthScheme | The type of authentication to use when connecting to Confluence. |
URL | The URL to your JIRA endpoint. |
CloudId | The Cloud ID for the Atlassian site that was authorized. |
User | The Confluence user account used to authenticate. |
Password | The password used to authenticate the user. |
APIToken | APIToken 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. |
AuthScheme¶
The type of authentication to use when connecting to Confluence.
Possible Values¶
Auto
, OAuth
, Basic
, APIToken
, Crowd
, OKTA
Data Type¶
string
Default Value¶
Auto
Remarks¶
- Auto: Lets the driver decide automatically based on the other connection properties you have set.
- OAuth: Set to 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.
URL¶
The URL to your JIRA endpoint.
Data Type¶
string
Default Value¶
""
Remarks¶
The URL to your JIRA endpoint; for example, https://yoursitename.atlassian.net
.
CloudId¶
The Cloud ID for the Atlassian site that was authorized.
Data Type¶
string
Default Value¶
""
Remarks¶
This will be determined automatically during OAuth 2.0 authentication and returned from the GetOAuthAccessToken stored procedure. Do not set a value for CloudId when using InitiateOAuth.
User¶
The Confluence user account used to authenticate.
Data Type¶
string
Default Value¶
""
Remarks¶
Together with Password, this field is used to authenticate against the Confluence server.
Password¶
The password used to authenticate the user.
Data Type¶
string
Default Value¶
""
Remarks¶
The User and Password
are together used to authenticate with the server.
APIToken¶
APIToken of the currently authenticated user.
Data Type¶
string
Default Value¶
""
Remarks¶
APIToken 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.
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.
SSO¶
This section provides a complete list of SSO properties you can configure.
Property | Description |
---|---|
SSOLoginURL | The identity provider's login URL. |
SSOProperties | Additional properties required to connect to the identity provider in 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. |
SSOLoginURL¶
The identity provider's login URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The identity provider's login URL.
SSOProperties¶
Additional properties required to connect to the identity provider in a semicolon-separated list.
Data Type¶
string
Default Value¶
""
Remarks¶
Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction with the SSOLoginURL.
SSO configuration is discussed further in .
SSOExchangeUrl¶
The URL used for consuming the SAML response and exchanging it for service specific credentials.
Data Type¶
string
Default Value¶
""
Remarks¶
The Confluence connector 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.
SSOAppName¶
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.
SSOAppPassword¶
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.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthVersion | The version of OAuth being used. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
Scope | This determines the scopes that the OAuth application requests from Confluence. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CertificateStore | The certificate store used for Confluence authentication. |
CertificateStorePassword | The password of the certificate store used with Confluence authentication. |
CertificateSubject | The subject of the certificate used with Confluence Private Application authentication. |
CertificateStoreType | The type of certificate store used with Confluence Private Application authentication. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthVersion¶
The version of OAuth being used.
Possible Values¶
1.0
, 2.0
Data Type¶
string
Default Value¶
2.0
Remarks¶
The version of OAuth being used. The following options are available: 1.0,2.0
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
Scope¶
This determines the scopes that the OAuth application requests from Confluence.
Data Type¶
string
Default Value¶
read:content:confluence read:content-details:confluence read:space-details:confluence read:analytics.content:confluence read:audit-log:confluence read:configuration:confluence read:page:confluence read:blogpost:confluence read:custom-content:confluence read:attachment:confluence read:comment:confluence read:template:confluence read:label:confluence read:content.permission:confluence read:content.property:confluence read:content.restriction:confluence read:content.metadata:confluence read:watcher:confluence read:group:confluence read:inlinetask:confluence read:relation:confluence read:space:confluence read:space.permission:confluence read:space.property:confluence read:space.setting:confluence read:user:confluence offline_access
Remarks¶
Specify scope to obtain the initial access and refresh token.
By default the connector will request that the user authorize all required scopes. If you want to override this, you can set this property to a space-separated list of OAuth scopes. Please make sure that OAuth App Settings also has these scopes.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\Confluence Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\Confluence Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
- Mac: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
CertificateStore¶
The certificate store used for Confluence authentication.
Data Type¶
string
Default Value¶
""
Remarks¶
The location of the certificate store for the client certificate used in Confluence application authentication.
CertificateStorePassword¶
The password of the certificate store used with Confluence authentication.
Data Type¶
string
Default Value¶
""
Remarks¶
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
CertificateSubject¶
The subject of the certificate used with Confluence Private Application authentication.
Data Type¶
string
Default Value¶
""
Remarks¶
The subject of the client certificate used in Confluence private application authentication.
About the Confluence Client SSL Auth Flow¶
Confluence private application authentication uses SSL client authentication with digital certificates.
Loading a Certificate¶
When loading a certificate the subject is used to locate the certificate in the store.
- If an exact match is not found, the store is searched for subjects containing the value of the property.
- If a match is still not found, no certificate is selected.
- The special value "*" picks the first certificate in the certificate store.
Specifying the Subject¶
The certificate subject is a comma-separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=example@jbexample.com". Common fields and their meanings are displayed below.
Field | Meaning |
---|---|
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
Note: If a field value contains a comma it must be quoted.
Additional Connection Properties¶
To specify the private certificate, you need to set CertificateSubject
and the following additional properties:
CertificateStoreType¶
The type of certificate store used with Confluence Private Application authentication.
Possible Values¶
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_BLOB
, P10BFILE
, SSHPUBLIC_KEY_FILE
, PPKFILE
, XMLFILE
, XMLBLOB
Data Type¶
string
Default Value¶
USER
Remarks¶
The name of the certificate store for the client certificate used in Confluence private application authentication. Confluence private application authentication uses SSL client authentication with digital certificates.
Specifying the Certificate Store Type¶
The CertificateStoreType
property can take one of the following values:
Property | Description |
---|---|
User - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
Machine | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFile | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBlob | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFile | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBlob | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKeyFile | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PublicKeyFile | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PublicKeyBlob | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPublicKeyBlob | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P10BFile | The certificate store is the name of a PKCS10 file containing certificates. |
SSHPublicKeyFile | The certificate store is the name of a file that contains an SSH-style public key. |
PPKFile | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFile | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBlob | The certificate store is a string that contains a certificate in XML format. |
Related Connection Properties¶
To specify the private certificate, you may need to set the following properties in addition to CertificateStoreType
:
- CertificateStore: Set this to the name of the certificate store. For example, "MY" for a Windows certificate store or the file name of a file store.
- CertificateStorePassword: If the store is password-protected, provide the password here.
- CertificateSubject: Set this to the subject of the certificate. To locate the certificate in the store, the connector executes a search based on the specified subject. Refer to the CertificateSubject field for details.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
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. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLClientCert¶
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
Data Type¶
string
Default Value¶
""
Remarks¶
The name of the certificate store for the client certificate.
The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert
. If the store is password protected, specify the password in SSLClientCertPassword.
SSLClientCert
is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert
has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
Property | Description |
---|---|
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).
SSLClientCertType¶
The type of key store containing the TLS/SSL client certificate.
Possible Values¶
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PEMKEY_BLOB
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_FILE
, SSHPUBLIC_KEY_BLOB
, P7BFILE
, PPKFILE
, XMLFILE
, XMLBLOB
Data Type¶
string
Default Value¶
USER
Remarks¶
This property can take one of the following values:
Property | Description |
---|---|
USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
SSLClientCertPassword¶
The password for the TLS/SSL client certificate.
Data Type¶
string
Default Value¶
""
Remarks¶
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
SSLClientCertSubject¶
The subject of the TLS/SSL client certificate.
Data Type¶
string
Default Value¶
*
Remarks¶
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.
Field | Meaning |
---|---|
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
SSLServerCert¶
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.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\Confluence Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\Confluence Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
IncludeArchivedSpaces | Whether to include content from archived spaces in the result. This defaults to false. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Confluence. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
SpaceKey | By specifying the SpaceKey, the search results will only display contents from this specific space. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
IncludeArchivedSpaces¶
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.
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Pagesize¶
The maximum number of results to return per page from Confluence.
Data Type¶
int
Default Value¶
200
Remarks¶
The Pagesize
property affects the maximum number of results to return per page from Confluence. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
SpaceKey¶
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.
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Pages WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.