CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるConfluence へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してConfluence に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Confluence への接続を標準化し、構成することができます。
このページでは、CData Cloud でのConfluence への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのConfluence への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してConfluence からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Confluence に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。
Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。
トークンの取得
アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。
トークンを使用する認証
Cloud アカウントへの認証を行うには、以下を入力します（Note：Password はCloud アカウントへの接続には非推奨となり、Server インスタンスへの接続にのみ使用されるようになりました）。
Server インスタンスへの認証を行うには、以下のように指定します。
AuthScheme をCrowd に設定し、次の接続プロパティを設定します。
接続文字列の例：
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 に接続するには以下のプロパティを設定します。
Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシのいずれかを使用する場合、またはMFA を設定している場合は、Okta を使用して認証するためにSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。
接続文字列の例：
AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of Confluence instance>/plugins/servlet/samlconsumer;
If you do not have access to the user name and API token or do not wish to require them, you can use OAuth authentication. Confluence uses the OAuth authentication standard, which requires the authenticating user to interact with Confluence via the browser. Please note OAuth 2.0 only is supported for Confluence Cloud.
To obtain the OAuth client credentials, consumer key, and consumer secret:
You can use the following properties to gain more control over the data returned from Confluence:
TLS を有効化するには、以下を設定します。
この設定により、Cloud はサーバーとのTLS ネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
Confluence Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
This section shows the available API objects and provides more information on executing SQL to Confluence APIs.
ビュー describes the available views. Views are statically defined to model AuditRecords, Pages, Blogposts, Comments, Attachments, Contributors, Labels, Spaces and Users.
Cloud はConfluence のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Pages | Contains structured data about all Confluence pages, including titles, content IDs, authors, and associated spaces. |
Contains structured data about all Confluence pages, including titles, content IDs, authors, and associated spaces.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Pages WHERE Id = '1234'
SELECT * FROM Pages WHERE Id IN ('1234', '2345')
SELECT * FROM Pages WHERE Id = '294922' OR Type = 'page'
SELECT * FROM Pages WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Pages ORDER BY Id DESC SELECT * FROM Pages ORDER BY CreatedByUserName ASC
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Pages WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
| Name | Type | ReadOnly | References | SupportedOperators | Description |
| Id [KEY] | String | False | =,!=,IN,NOT_IN |
The unique identifier of the page within Confluence. Used to reference the page in related operations and tables. | |
| Type | String | True | =,!=,IN,NOT_IN |
Specifies the content type, indicating that this record represents a page. | |
| Title | String | False | =,!=,IN,NOT_IN,LIKE |
The title of the page as displayed in Confluence. | |
| Status | String | False | =,IN |
Indicates the current state of the page, such as current, draft, or archived. | |
| Storage | String | False |
Contains the body content of the page in Confluence Storage Format, including text, macros, and formatting elements. | ||
| AtlasDocFormat | String | False |
Stores the page body content in Atlas Document Format (ADF), the structured format used by modern Confluence editors. | ||
| Position | Integer | True |
Indicates the position of the page within its parent hierarchy, defining its order among sibling pages. | ||
| OwnerId | String | False |
The unique identifier of the user who owns or created the page. | ||
| ParentId | Long | False |
The identifier of the parent page under which this page is nested. | ||
| SpaceId | String | False |
The unique identifier of the space in which the page resides. | ||
| SpaceKey | String | True |
Spaces.Key | =,!=,IN,NOT_IN |
The key of the space to which the page belongs. |
| SpaceType | String | True |
Spaces.Type | =,!=,IN,NOT_IN |
Specifies the type of space containing the page, such as global, personal, or team space. |
| URL | String | True |
The full URL of the page, providing direct access through the Confluence interface or API. | ||
| Excerpt | String | True |
A short summary or snippet of the page content, typically used in listings or search results. | ||
| IsLatest | Boolean | True |
If the value is 'true', this record represents the most recent version of the page. If the value is 'false', it refers to an earlier revision. | ||
| CreatedByUserName | String | True | =,!=,IN,NOT_IN |
The username of the user who originally created the page. | |
| CreatedByUserType | String | True |
Specifies the type of user who created the page, such as internal user, external collaborator, or system account. | ||
| CreatedDate | Datetime | True | =,>,>=,<,<= |
The date and time when the page was first created. | |
| LastUpdatedDatetime | Datetime | True | =,>,>=,<,<= |
The date and time when the page was most recently updated. | |
| LastUpdatedMessage | String | True |
The revision message or comment provided when saving the latest version of the page. | ||
| LastUpdatedNumber | Integer | True |
The version number corresponding to the latest update of the page. | ||
| LastUpdatedUserName | String | True |
The username of the user who performed the most recent update to the page. | ||
| LastUpdatedUserType | String | True |
Specifies the type of user who made the most recent update, such as internal or automated. | ||
| LastUpdatedIsMinorEdit | Boolean | True |
If the value is 'true', the last update was a minor edit that did not significantly alter the content. If the value is 'false', it was a major revision. | ||
| LastUpdatedIsHidden | Boolean | True |
If the value is 'true', the latest version of the page is hidden from general visibility. If the value is 'false', it is visible to users. | ||
| PreviousVersionUserName | String | True |
The username of the user who created or edited the previous version of the page. | ||
| PreviousVersionUserType | String | True |
Specifies the type of user who modified the previous version, such as internal user or automated process. | ||
| PreviousVersionDatetime | Datetime | True |
The date and time when the previous version of the page was edited. | ||
| PreviousVersionMessage | String | True |
The revision message or note entered for the previous version. | ||
| PreviousVersionNumber | String | True |
The version number assigned to the previous revision of the page. | ||
| PreviousVersionIsMinorEdit | Boolean | True |
If the value is 'true', the previous version was a minor edit. If the value is 'false', it represented a major revision. | ||
| PreviousVersionIsHidden | Boolean | True |
If the value is 'true', the previous version of the page is hidden from visibility. If the value is 'false', it is accessible to users. | ||
| VersionUserName | String | True |
The username of the user who created or edited this version of the page. | ||
| VersionUserType | String | True |
Specifies the type of user who modified this version, such as internal or system account. | ||
| VersionDatetime | Datetime | True |
The date and time when this version of the page was last modified. | ||
| VersionMessage | String | False |
The message or note provided when this version was saved. | ||
| VersionNumber | Integer | False |
The version number identifying this specific revision of the page. | ||
| VersionIsMinorEdit | Boolean | True |
If the value is 'true', this version was marked as a minor edit. If the value is 'false', it represents a major change. | ||
| VersionIsHidden | Boolean | True |
If the value is 'true', this version is hidden from general view. If the value is 'false', it is visible to users. | ||
| LinksEditui | String | True |
The URL of the edit interface (EditUI) for the page, allowing direct modification in the Confluence editor. | ||
| LinksSelf | String | True |
The self-referential API endpoint (Self link) for the page, used to retrieve its data programmatically. | ||
| LinksTinyui | String | True |
The short link (TinyUI) version of the page's URL, providing a concise format for sharing. | ||
| LinksWebui | String | True |
The standard web interface URL (WebUI) for viewing the page in Confluence. | ||
| ItemURL | String | True |
The full URL reference to the page as displayed in the Confluence user interface. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| CQL | String |
Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering pages. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| AllUsers | Returns a complete list of all registered users in the Confluence instance, including both active and disabled accounts. This view is only available for server deployments. |
| Attachments | Retrieves metadata for attachments stored in Confluence, such as file names, sizes, and related content pages. |
| AuditRecords | Provides a paginated list of audit records detailing user and system activities performed since a specified time period. |
| Blogposts | Retrieves detailed information about blog posts, including titles, authors, publication dates, and associated spaces. |
| Comments | Returns information about comments made on pages, blog posts, or other content, including author details and timestamps. |
| Contributors | Lists the users who have contributed to a specific page or space, providing insight into collaboration and content ownership. |
| GroupMembers | Retrieves all users belonging to a specified group, including their display names and account details. |
| Groups | Returns information about user groups configured in Confluence, such as group names, descriptions, and membership details. |
| GroupsContentRestrictions | Retrieves restrictions applied to specific content items that limit access to certain user groups. Requires ContentId and supports up to 200 restrictions per operation. |
| Labels | Returns the labels associated with a specific piece of content, helping categorize and organize information within Confluence. |
| PageAncestors | Displays the parent hierarchy of a page, showing how the current page is positioned within the overall content structure. |
| PageChildren | Displays the child hierarchy of a page, showing which subpages are nested under a given parent page. |
| PageComments | Retrieves all comments made on a particular page, including text content, authors, and creation dates. |
| PageContents | Provides access to the textual and metadata content of a Confluence page, including version and author information. |
| SpacePermissions | Returns detailed permission settings for one or more spaces, specifying which users and groups have access or administrative rights. |
| Spaces | Retrieves metadata and configuration details about spaces, including names, keys, descriptions, and access settings. |
| Tasks | Provides information on tasks assigned or created within Confluence, including assignees, due dates, and completion status. |
| Users | Returns details for a specific user, such as username, display name, email address, and account status. |
| UsersContentRestrictions | Retrieves restrictions applied to specific content that limit access for individual users. Requires ContentId and supports up to 200 restrictions per operation. |
| ViewersAnalytics | Shows analytics data on unique viewers of a specific content item, helping track audience engagement. |
| ViewsAnalytics | Shows analytics data on total views of a specific content item, including repeated visits by the same user. |
| Whiteboards | Retrieves details about collaborative whiteboards created within Confluence, including titles, owners, and associated spaces. |
Returns a complete list of all registered users in the Confluence instance, including both active and disabled accounts. This view is only available for server deployments.
| Name | Type | References | SupportedOperators | Description |
| UserKey [KEY] | String | = | Unique identifier that distinguishes each user within the Confluence instance. Used to reference the user across related tables and views. | |
| UserName | String | The username associated with the user account, typically used for login and identification purposes. | ||
| Status | String | Indicates whether the user account is active, disabled, or pending activation. | ||
| Type | String | Specifies the user account type, such as internal or external, depending on how the user was created or synchronized. | ||
| ProfilePicturePath | String | The file path or URL that points to the user's profile picture stored in Confluence. | ||
| ProfilePictureWidth | Integer | The width, in pixels, of the user's profile picture. | ||
| ProfilePictureHeight | Integer | The height, in pixels, of the user's profile picture. | ||
| IsDefaultPicture | Boolean | If the value is 'true', the profile picture has never been changed and remains the system default. If the value is 'false', the user has uploaded a custom image. | ||
| DisplayName | String | The display name shown for the user throughout Confluence, such as in comments, mentions, or activity feeds. |
Retrieves metadata for attachments stored in Confluence, such as file names, sizes, and related content pages.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Attachments WHERE Id = '1234'
SELECT * FROM Attachments WHERE Id IN ('1234', '2345')
SELECT * FROM Attachments WHERE Id = '294922' OR Type = 'attachment'
SELECT * FROM Attachments WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Attachments ORDER BY Id DESC SELECT * FROM Attachments ORDER BY CreatedByUserName ASC
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Attachments WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | Unique identifier of the attachment within Confluence. Used to reference the attachment in related views or operations. | |
| Type | String | =,!=,IN,NOT_IN | Indicates the content type of the attachment, such as document, image, or other media file. | |
| Title | String | =,!=,IN,NOT_IN,LIKE | The display title of the attachment, typically matching the file name or user-defined label. | |
| Status | String | Indicates the current state of the attachment, such as current, archived, or deleted. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space where the attachment resides. This identifies the space context for the file. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space that contains the attachment, such as global, personal, or archived. |
| Position | String | Defines the attachment's position or ordering within the page or content hierarchy. | ||
| URL | String | The full URL used to access the attachment directly through the Confluence interface or API. | ||
| Excerpt | String | A brief summary or snippet of text associated with the attachment, providing quick reference information. | ||
| IsLatest | Boolean | If the value is 'true', the attachment record represents the most recent version. If the value is 'false', it refers to an older revision. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally uploaded or created the attachment. | |
| CreatedByUserType | String | Indicates the type of account that created the attachment, such as internal, external, or system. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the attachment was first created in Confluence. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the attachment was last updated or replaced by a newer version. | |
| LastUpdatedMessage | String | The comment or message entered by the user when the attachment was last updated. | ||
| LastUpdatedNumber | Integer | The version number corresponding to the latest update of the attachment. | ||
| LastUpdatedUserName | String | The username of the user who performed the latest update to the attachment. | ||
| LastUpdatedUserType | String | Specifies the type of user who made the latest update, such as internal user or automated process. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the most recent update was a minor edit that did not significantly alter the attachment. If the value is 'false', it represents a major revision. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the most recent version of the attachment is hidden from general users. If the value is 'false', it is visible. | ||
| PreviousVersionUserName | String | The username of the user who created or edited the previous version of the attachment. | ||
| PreviousVersionUserType | String | The type of user who modified the previous version of the attachment, such as internal or system user. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the attachment was last modified. | ||
| PreviousVersionMessage | String | The user's message or comment describing changes in the previous version. | ||
| PreviousVersionNumber | String | The version number assigned to the previous revision of the attachment. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was marked as a minor edit. If the value is 'false', it represented a major revision. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the attachment is hidden from general users. If the value is 'false', it remains visible. | ||
| LinksEditui | String | The URL of the edit interface for the attachment, allowing users to modify or replace the file. | ||
| LinksSelf | String | The self-reference URL of the attachment resource, used for API access or direct retrieval. | ||
| LinksTinyui | String | The shortened URL (TinyUI) that provides a compact link to the attachment for easy sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the attachment, used for navigation within the Confluence site. | ||
| ItemURL | String | The complete URL reference to the attachment as it appears in the Confluence user interface. | ||
| ContainerId | String | The unique identifier of the container (page or content item) that holds the attachment. | ||
| MediaType | String | Specifies the Multipurpose Internet Mail Extensions (MIME) media type of the attachment, which defines how the file is handled and displayed. | ||
| DownloadLink | String | The direct download URL for the attachment file, allowing users or systems to retrieve its content. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for filtering or searching attachments. |
Provides a paginated list of audit records detailing user and system activities performed since a specified time period.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM AuditRecords WHERE SearchString = 'your search string' SELECT * FROM AuditRecords WHERE StartDate = '2019-08-12' SELECT * FROM AuditRecords WHERE EndDate = '2019-08-15'
| Name | Type | References | SupportedOperators | Description |
| AffectedObjectName | String | The name of the Confluence object that was modified during the audited action, such as a page, space, or attachment. | ||
| AffectedObjectType | String | Specifies the type of object affected by the change, such as page, comment, or configuration item. | ||
| AuthorDisplayName | String | The display name of the user who performed the action recorded in the audit log. | ||
| AuthorType | String | Indicates the type of account that executed the action, such as internal user, external user, or automated system. | ||
| UserKey | String | The unique key that identifies the user who initiated the audited action within Confluence. | ||
| UserName | String | The username of the user responsible for the audited event. | ||
| Category | String | Defines the functional category of the audited event, such as content management, permissions, or configuration. | ||
| CreationDate | Datetime | The date and time when the audited event occurred and was recorded in the system. | ||
| Description | String | A detailed description of the change or event, providing context for what was modified or triggered. | ||
| RemoteAddress | String | The IP address or network origin from which the action was performed. | ||
| Summary | String | A concise summary of the audit event, highlighting the main change or activity. | ||
| IsSysAdmin | Boolean | If the value is 'true', the action was performed by a system administrator. If the value is 'false', it was performed by a standard user. | ||
| SearchString | String | = | The search term or keyword entered by the user when querying audit records or related data. | |
| StartDate | Datetime | = | The beginning timestamp that defines the start of the audit period for retrieved records. | |
| EndDate | Datetime | = | The ending timestamp that defines the end of the audit period for retrieved records. |
Retrieves detailed information about blog posts, including titles, authors, publication dates, and associated spaces.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Blogposts WHERE Id = '1234'
SELECT * FROM Blogposts WHERE Id IN ('1234', '2345')
SELECT * FROM Blogposts WHERE Id = '123458' AND Type = 'blogpost'
SELECT * FROM Blogposts WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Blogposts ORDER BY Id DESC SELECT * FROM Blogposts ORDER BY CreatedByUserName ASC
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Blogposts WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | Unique identifier of the blog post within Confluence. Used to reference the post in related operations or queries. | |
| Type | String | =,!=,IN,NOT_IN | Specifies the content type, indicating that this record represents a blog post. | |
| Title | String | =,!=,IN,NOT_IN,LIKE | The title of the blog post as displayed in Confluence, used for identification and navigation. | |
| Status | String | Indicates the current publishing state of the blog post, such as current, draft, or archived. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space in which the blog post is published. This links the content to its workspace. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space that contains the blog post, such as global, team, or personal. |
| Position | String | Defines the placement or ordering of the blog post within the space or among other content items. | ||
| URL | String | The full URL that provides direct access to the blog post through the Confluence interface or API. | ||
| Excerpt | String | A short summary or preview of the blog post content, typically displayed in listings or search results. | ||
| IsLatest | Boolean | If the value is 'true', this record represents the latest published version of the blog post. If the value is 'false', it refers to a previous version. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally created and published the blog post. | |
| CreatedByUserType | String | Specifies the type of user who created the blog post, such as internal user, external collaborator, or system account. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the blog post was initially created and saved in Confluence. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the blog post was last edited or updated. | |
| LastUpdatedMessage | String | The revision message or comment entered by the author when saving the most recent version. | ||
| LastUpdatedNumber | Integer | The version number associated with the latest update of the blog post. | ||
| LastUpdatedUserName | String | The username of the user who made the most recent update to the blog post. | ||
| LastUpdatedUserType | String | Indicates the type of user responsible for the latest update, such as internal, external, or system. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the latest change was a minor edit that did not significantly alter the content. If the value is 'false', the edit was a major revision. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the latest version of the blog post is hidden from general visibility. If the value is 'false', it is publicly visible. | ||
| PreviousVersionUserName | String | The username of the user who created or modified the previous version of the blog post. | ||
| PreviousVersionUserType | String | Specifies the type of user who edited the previous version, such as internal user or automated process. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the blog post was last modified. | ||
| PreviousVersionMessage | String | The revision message or note associated with the previous version of the blog post. | ||
| PreviousVersionNumber | String | The version number assigned to the previous revision of the blog post. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was marked as a minor edit. If the value is 'false', it was a major revision. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the blog post is hidden from visibility. If the value is 'false', it is viewable by users. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the blog post, allowing direct modification from the Confluence editor. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the blog post, used to retrieve its details programmatically. | ||
| LinksTinyui | String | The short link (TinyUI) version of the blog post URL, providing a concise format for sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the blog post as viewed within the Confluence site. | ||
| ItemURL | String | The complete URL reference to the blog post as displayed in the user interface. | ||
| ContainerId | String | The identifier of the container, typically the space or content collection, that holds the blog post. | ||
| StorageBody | String | The full content of the blog post in Confluence Storage Format, which preserves rich text, macros, and formatting. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering blog posts. |
Returns information about comments made on pages, blog posts, or other content, including author details and timestamps.
The Cloud uses the Confluence API to process WHERE clause conditions built with the following columns and operators. Conditions that use other supported operators are processed client-side by the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Comments WHERE Id = '1234'
SELECT * FROM Comments WHERE Id IN ('1234', '2345')
SELECT * FROM Comments WHERE Id = '294922' OR Type = 'comment'
SELECT * FROM Comments WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')
Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:
SELECT * FROM Comments ORDER BY Id DESC SELECT * FROM Comments ORDER BY CreatedByUserName ASC
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Comments WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | Unique identifier of the comment within Confluence. Used to reference the comment in related tables or operations. | |
| Type | String | =,!=,IN,NOT_IN | Specifies the content type, indicating that this record represents a comment. | |
| Title | String | The title or short reference for the comment, which may appear as the first line of text or a system-generated identifier. | ||
| Status | String | Indicates the current state of the comment, such as active, deleted, or archived. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space that contains the content to which the comment belongs. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space where the comment was made, such as global, personal, or team space. |
| Position | String | Defines the comment's position within the discussion thread or its relationship to the parent content. | ||
| URL | String | The full URL that provides direct access to the comment within the Confluence interface or API. | ||
| Excerpt | String | A short snippet of the comment's text content, used for previews or summaries. | ||
| IsLatest | Boolean | If the value is 'true', this comment represents the latest version of the text. If the value is 'false', it refers to an earlier revision. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally posted the comment. | |
| CreatedByUserType | String | Specifies the type of user who created the comment, such as internal user, external collaborator, or system account. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the comment was first posted. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the comment was most recently edited. | |
| LastUpdatedMessage | String | The revision note or message entered by the user when updating the comment. | ||
| LastUpdatedNumber | Integer | The version number corresponding to the latest update of the comment. | ||
| LastUpdatedUserName | String | The username of the user who performed the most recent update on the comment. | ||
| LastUpdatedUserType | String | Indicates the type of user who made the latest update, such as internal, external, or automated. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the last modification was a minor edit that did not significantly change the content. If the value is 'false', it was a major edit. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the most recent version of the comment is hidden from regular users. If the value is 'false', it is visible. | ||
| PreviousVersionUserName | String | The username of the user who created or edited the previous version of the comment. | ||
| PreviousVersionUserType | String | Specifies the type of user who updated the previous version, such as internal user or automated process. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the comment was modified. | ||
| PreviousVersionMessage | String | The user's revision note or message associated with the previous version of the comment. | ||
| PreviousVersionNumber | String | The version number assigned to the previous iteration of the comment. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was marked as a minor edit. If the value is 'false', it represented a major revision. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the comment is hidden from visibility. If the value is 'false', it remains visible. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the comment, allowing users to modify or reply within the Confluence editor. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the comment, used for programmatic retrieval. | ||
| LinksTinyui | String | The short link (TinyUI) URL of the comment, providing a concise version for quick sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the comment as viewed within Confluence. | ||
| ItemURL | String | The complete URL reference to the comment as displayed in the user interface. | ||
| ContainerId | String | The unique identifier of the container, such as the page or blog post, that the comment belongs to. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering comments. |
Lists the users who have contributed to a specific page or space, providing insight into collaboration and content ownership.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: Either ContentId, AccountId or ContentType must be specified in order to query the Contributors view.
For example, the following queries are processed server side:
SELECT * FROM Contributors WHERE ContentId = '1234'
SELECT * FROM Contributors WHERE ContentId != '1234'
SELECT * FROM Contributors WHERE ContentId IN ('1234', '2345')
SELECT * FROM Contributors WHERE ContentId NOT IN ('1234', '2345')
SELECT * FROM Contributors WHERE AccountId = '12345678'
SELECT * FROM Contributors WHERE AccountId IN ('12345678', '23456789')
SELECT * FROM Contributors WHERE ContentType = 'page'
SELECT * FROM Contributors WHERE ContentType != 'page'
SELECT * FROM Contributors WHERE ContentType IN ('page', 'attachment')
SELECT * FROM Contributors WHERE ContentType NOT IN ('page', 'attachment')
Additionally, ContentId column can be used in the ORDER BY clause, as following:
SELECT * FROM Contributors ORDER BY ContentId DESC
| Name | Type | References | SupportedOperators | Description |
| ContentId [KEY] | String | =,!=,IN,NOT_IN | The unique identifier of the content item that supports contributions, such as a page, blog post, comment, or attachment. This value corresponds to the 'Id' field in related tables like Attachments, Pages, Comments, or Blogposts. | |
| ContentType | String | =,!=,IN,NOT_IN | Specifies the type of content to which the contributor has added input, for example page, comment, or blog post. | |
| UserType | String | Indicates the type of user who contributed, such as internal user, external collaborator, or system account. | ||
| AccountId [KEY] | String | =,IN | The unique account identifier of the contributor, used to link the user to their contributions across Confluence content. |
Retrieves all users belonging to a specified group, including their display names and account details.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM GroupMembers WHERE Name = 'test1'
| Name | Type | References | SupportedOperators | Description |
| AccountId | String | The unique account identifier of the user who is a member of the group. | ||
| AccountType | String | Specifies the type of user account, such as internal, external, or system. | ||
| DisplayName | String | The display name of the user as it appears in Confluence: in mentions, comments, or activity feeds. | ||
| String | The email address associated with the user's Confluence account. | |||
| PublicName | String | The public name or nickname of the user, shown in areas where privacy settings restrict full display names. | ||
| ProfilePicturePath | String | The file path or URL that points to the user's profile picture within Confluence. | ||
| ProfilePictureWidth | Int | The width, in pixels, of the user's profile picture. | ||
| ProfilePictureHeight | Int | The height, in pixels, of the user's profile picture. | ||
| ProfilePictureIsDefault | Boolean | If the value is 'true', the profile picture is the default system image and has not been changed by the user. If the value is 'false', the user has uploaded a custom profile picture. | ||
| Operations | String | Describes available operations and the target entities they apply to, indicating possible actions for the user within the group context. | ||
| Type | String | Defines the type of user, such as standard user, administrator, or external collaborator. | ||
| GroupId | String | = | The unique identifier of the Confluence group that the user belongs to. | |
| Name | String | = | The name of the group to which these members are assigned. |
Returns information about user groups configured in Confluence, such as group names, descriptions, and membership details.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM Groups WHERE Name = 'test'
SELECT * FROM Groups WHERE Name IN ('test1', 'test2')
SELECT * FROM Groups WHERE Id = 'ef75d879-6b69-4260-942a-ff5231e08be0'
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | = | The unique identifier of the group within Confluence. Used to reference the group in membership and permission tables. | |
| Name [KEY] | String | = | The display name of the group as defined in Confluence, used for managing user membership and access control. | |
| Type | String | Specifies the type of group, such as internal (managed within Confluence) or external (synchronized from an identity provider). |
Retrieves restrictions applied to specific content items that limit access to certain user groups. Requires ContentId and supports up to 200 restrictions per operation.
| Name | Type | References | SupportedOperators | Description |
| Operation | String | Specifies the type of operation that the restriction governs, such as read or update access. | ||
| Name | String | The name of the group to which the content restriction applies, defining which members are affected. | ||
| Type | String | Indicates the type of group, such as internal or external, based on how it is managed or synchronized. | ||
| ContentId | String | = | The unique identifier of the content item (such as a page or blog post) where the restriction is applied. |
Returns the labels associated with a specific piece of content, helping categorize and organize information within Confluence.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: Either ContentId, LabelName or ContentType must be specified in order to query the Labels view.
For example, the following queries are processed server side:
SELECT * FROM Labels WHERE ContentId = '1234'
SELECT * FROM Labels WHERE ContentId! = '1234'
SELECT * FROM Labels WHERE ContentId IN ('1234', '2345')
SELECT * FROM Labels WHERE ContentId NOT IN ('1234', '2345')
SELECT * FROM Labels WHERE LabelName = 'test'
SELECT * FROM Labels WHERE LabelName IN ('test1', 'test2')
SELECT * FROM Labels WHERE ContentType = 'page'
SELECT * FROM Labels WHERE ContentType != 'page'
SELECT * FROM Labels WHERE ContentType IN ('page', 'attachment')
SELECT * FROM Labels WHERE ContentType NOT IN ('page', 'attachment')
Additionally, ContentId column can be used in the ORDER BY clause, as following:
SELECT * FROM Labels ORDER BY ContentId DESC
| Name | Type | References | SupportedOperators | Description |
| ContentId [KEY] | String | =,!=,IN,NOT_IN | The unique identifier of the content item that supports labels, such as a page, attachment, or blog post. This value corresponds to the 'Id' field in related tables like Attachments, Pages, or Blogposts. | |
| ContentType | String | =,!=,IN,NOT_IN | Specifies the type of content associated with the label, such as page, attachment, or blog post. | |
| LabelId [KEY] | String | The unique identifier of the label assigned to the content. | ||
| LabelName | String | =,IN | The name of the label applied to the content, used for categorization and search filtering. | |
| LabelPrefix | String | Defines the prefix associated with the label, which indicates its scope or origin, such as global or team-specific. |
Displays the parent hierarchy of a page, showing how the current page is positioned within the overall content structure.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
Note: PageId is required in order to query the PageAncestors view.
For example, the following queries are processed server side:
SELECT * FROM PageAncestors WHERE PageId = '33106'
SELECT * FROM PageAncestors WHERE PageId IN ('163902', '33106')
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the ancestor page within the Confluence hierarchy. | ||
| ExpandableAncestors | String | Provides a reference to additional ancestor pages that can be expanded to view the full hierarchy above the current page. | ||
| ExpandableBody | String | Links to the expandable section containing the page's body content, allowing access to detailed text data when requested. | ||
| ExpandableChildren | String | Links to the expandable section listing the direct child pages of the ancestor, enabling traversal down the hierarchy. | ||
| ExpandableChildTypes | String | Specifies the available types of child content that can be expanded under the ancestor page, such as page or comment. | ||
| ExpandableContainer | String | Provides a reference to the container element, such as a space, that holds the ancestor page. | ||
| ExpandableDescendants | String | Links to a list of all descendant pages that can be expanded from this ancestor, showing the entire subpage structure. | ||
| ExpandableHistory | String | Links to historical data about the ancestor page, including previous versions and edits. | ||
| ExpandableMetadata | String | Links to the expandable section containing metadata for the ancestor page, such as labels and properties. | ||
| ExpandableOperations | String | Lists available operations that can be performed on the ancestor page, such as view or edit. | ||
| ExpandableRestrictions | String | Links to the access restrictions applied to the ancestor page, including view and edit permissions. | ||
| ExpandableSchedulePublishDate | Datetime | Specifies the scheduled date and time when the ancestor page is set to be published, if applicable. | ||
| ExpandableSpace | String | Provides a link to the space that contains the ancestor page, allowing retrieval of related space information. | ||
| ExpandableVersion | String | Links to version details of the ancestor page, including version number and author information. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the ancestor page, allowing users to modify its content. | ||
| LinksSelf | String | The self-referential API link (Self link) for the ancestor page, used to retrieve its data programmatically. | ||
| LinksTinyui | String | The short link (TinyUI) version of the ancestor page's URL, providing a compact link for easy sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the ancestor page, used for navigation in Confluence. | ||
| ExtensionsPosition | String | Indicates the page's position within its parent hierarchy, defining its placement order among sibling pages. | ||
| Status | String | Indicates the publication status of the ancestor page, such as current, draft, or archived. | ||
| Title | String | The title of the ancestor page as displayed in Confluence. | ||
| Type | String | Specifies the content type, indicating that this record represents a page ancestor. | ||
| PageId [KEY] | String |
Pages.Id | =,!=,IN,NOT_IN | The unique identifier of the current page whose ancestor information is being retrieved. |
Displays the child hierarchy of a page, showing which subpages are nested under a given parent page.
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the child page within the Confluence hierarchy. | ||
| ExpandableAncestors | String | Provides a link to the expandable list of ancestor pages for the child, showing its position in the overall hierarchy. | ||
| ExpandableBody | String | Links to the expandable section containing the full body content of the child page, available when explicitly requested. | ||
| ExpandableChildren | String | Links to additional nested child pages under this page, allowing deeper traversal through the hierarchy. | ||
| ExpandableChildTypes | String | Specifies the available content types that can exist as children of this page, such as page or comment. | ||
| ExpandableContainer | String | Provides a link to the container that holds this child page, typically its parent page or associated space. | ||
| ExpandableDescendants | String | Links to the list of all descendant pages that can be expanded under this child, showing its complete subpage structure. | ||
| ExpandableHistory | String | Links to the historical versions of the child page, including revision data and previous authors. | ||
| ExpandableMetadata | String | Links to the expandable section containing metadata for the child page, such as labels and custom properties. | ||
| ExpandableOperations | String | Lists the available operations that can be performed on the child page, such as view, edit, or delete. | ||
| ExpandableRestrictions | String | Links to the restrictions that define who can view or edit the child page. | ||
| ExpandableSchedulePublishDate | Datetime | Specifies the date and time when the child page is scheduled to be published, if applicable. | ||
| ExpandableSpace | String | Provides a link to the space in which the child page resides, enabling retrieval of related space information. | ||
| ExpandableVersion | String | Links to the version details of the child page, including the version number and author metadata. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the child page, allowing direct editing in Confluence. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the child page, used for programmatic access. | ||
| LinksTinyui | String | The short link (TinyUI) version of the child page's URL, providing a compact format for easy sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) for the child page as viewed within Confluence. | ||
| ExtensionsPosition | String | Indicates the position of the child page within its parent's hierarchy, defining its order among sibling pages. | ||
| Status | String | Indicates the publication status of the child page, such as current, draft, or archived. | ||
| Title | String | The title of the child page as displayed in Confluence. | ||
| Type | String | Specifies the content type, indicating that this record represents a child page. | ||
| PageId | String |
Pages.Id | =,!=,IN,NOT IN | The unique identifier of the current page whose child pages are being retrieved. |
Retrieves all comments made on a particular page, including text content, authors, and creation dates.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
Note: PageId is required in order to query the PageComments view.
For example, the following queries are processed server side:
SELECT * FROM PageComments WHERE PageId = '163902'
SELECT * FROM PageComments WHERE PageId IN ('163902', '33106')
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the comment associated with the specified page. | ||
| ExpandableAncestors | String | Provides a link to ancestor elements in the hierarchy, such as the parent page or higher-level comments. | ||
| ExpandableChildren | String | Links to any nested replies or child comments related to the current comment. | ||
| ExpandableContainer | String | Provides a reference to the container element, typically the page that holds this comment. | ||
| ExpandableDescendants | String | Links to all descendant comments that can be expanded under this comment, displaying the full discussion thread. | ||
| ExpandableHistory | String | Links to the revision history of the comment, showing previous edits and versions. | ||
| ExpandableMetadata | String | Links to the expandable metadata for the comment, such as labels, properties, or custom fields. | ||
| ExpandableOperations | String | Lists the operations that can be performed on the comment, such as edit, delete, or reply. | ||
| ExpandableRestrictions | String | Links to the access restrictions applied to the comment, specifying who can view or edit it. | ||
| ExpandableSpace | String | Provides a link to the space in which the comment's parent page is located. | ||
| ExpandableVersion | String | Links to version information for the comment, including details about the latest edit and author. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the comment, used to retrieve its data programmatically. | ||
| LinksWebui | String | The standard web interface URL (WebUI) for the comment as viewed in the Confluence page. | ||
| BodyExpandableAnonymousExportView | String | Provides access to the anonymous export view of the comment body, which can be expanded to show public exportable content. | ||
| BodyExpandableEditor | String | Links to the editor view of the comment body, allowing access to the content in an editable format. | ||
| BodyExpandableExportView | String | Provides a link to the export view representation of the comment body, used when exporting or rendering content externally. | ||
| BodyExpandableStorage | String | Links to the storage representation of the comment body, which contains the raw data in Confluence Storage Format. | ||
| BodyExpandableStyledView | String | Provides access to the styled view of the comment body, showing formatted content as rendered in the Confluence interface. | ||
| BodyViewExpandableContent | String | Links to the view representation of the comment's main content, used for display purposes. | ||
| BodyViewExpandableWebresource | String | Links to associated web resources, such as embedded media or macros, included in the comment body. | ||
| BodyViewRepresentation | String | Specifies the current representation type of the comment body, such as view or storage. | ||
| BodyViewValue | String | Contains the actual text content of the comment in its rendered form. | ||
| ExtensionsExpandableResolution | String | Provides a link to additional resolution-related extensions, such as comment status or resolution metadata. | ||
| ExtensionsLocation | String | Indicates the location context of the comment within the page, such as inline or section-based placement. | ||
| Status | String | Indicates the current status of the comment, such as active, resolved, or deleted. | ||
| Title | String | The title or first line of the comment, often used as a summary or identifier in lists. | ||
| Type | String | Specifies the content type, indicating that this record represents a comment. | ||
| PageId | String |
Pages.Id | =,!=,IN,NOT_IN | The unique identifier of the page that contains this comment. |
Provides access to the textual and metadata content of a Confluence page, including version and author information.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
Note: PageId is required in order to query the PageContents view.
For example, the following queries are processed server side:
SELECT * FROM PageContents WHERE PageId = '163902'
SELECT * FROM PageContents WHERE PageId IN ('163902', '33106')
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the page content within Confluence. | ||
| ExpandableAncestors | String | Provides a link to the expandable list of ancestor pages, allowing retrieval of hierarchical context above the current page. | ||
| ExpandableChildren | String | Links to child content items associated with the page, such as subpages or embedded components. | ||
| ExpandableChildTypes | String | Specifies the types of child content that can exist under this page, for example page, comment, or attachment. | ||
| ExpandableContainer | String | Provides a link to the container element that holds this page, typically a space or parent page. | ||
| ExpandableDescendants | String | Links to all descendant content items that can be expanded from this page, showing the complete hierarchy below it. | ||
| ExpandableHistory | String | Links to the historical versions of the page, allowing retrieval of revision data, authors, and timestamps. | ||
| ExpandableMetadata | String | Links to the expandable metadata section, which includes labels, properties, and other contextual information. | ||
| ExpandableOperations | String | Lists available operations that can be performed on the page, such as view, edit, or delete. | ||
| ExpandableRestrictions | String | Links to the access restrictions applied to the page, defining user and group permissions. | ||
| ExpandableSchedulePublishDate | Datetime | Specifies the date and time when the page is scheduled for publication, if applicable. | ||
| ExpandableSpace | String | Provides a link to the space containing the page, allowing retrieval of related space-level details. | ||
| ExpandableVersion | String | Links to version information for the page, including version numbers, authors, and modification data. | ||
| LinksBase | String | The base API URL used as a reference point for the page's linked resources. | ||
| LinksCollection | String | Provides a link to the collection of related content items, such as pages within the same space. | ||
| LinksContext | String | Defines the contextual relationship of the page within Confluence, including references to its environment or parent container. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the page, allowing direct access to the page editor. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the page, used for direct retrieval via the Confluence API. | ||
| LinksTinyui | String | The short link (TinyUI) version of the page's URL, providing a compact, shareable format. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the page as accessed through the Confluence site. | ||
| BodyExpandableAnonymousExportView | String | Provides access to the anonymous export view of the page body, allowing public export without authentication. | ||
| BodyExpandableAtlasDocFormat | String | Links to the Atlas Document Format (ADF) representation of the page body, used for rich text and structured data rendering. | ||
| BodyExpandableDynamic | String | Provides a link to dynamically rendered sections of the page body, allowing runtime expansion of embedded content. | ||
| BodyExpandableEditor | String | Links to the editable representation of the page body as used in the Confluence editor. | ||
| BodyExpandableEditor2 | String | Provides a link to an alternate editor format of the page body, typically used for newer Confluence editor versions. | ||
| BodyExpandableExportView | String | Links to the export view of the page body, suitable for use in external formats or exports. | ||
| BodyExpandableStyledView | String | Provides access to the styled view of the page body, displaying formatted content as seen in the Confluence UI. | ||
| BodyExpandableView | String | Links to the view representation of the page body used for display in standard Confluence views. | ||
| BodyStorageExpandableContent | String | Provides access to the underlying storage content of the page body, including macros and embedded objects. | ||
| BodyStorageEmbeddedContent | String | Links to any embedded resources or files within the page's storage format. | ||
| BodyStorageRepresentation | String | Specifies the format used to represent the page body in storage, such as storage or view. | ||
| BodyStorageValue | String | Contains the actual content of the page body in Confluence Storage Format, including rich text and markup. | ||
| ExtensionsPosition | String | Indicates the position of the page within its parent hierarchy, defining its order among sibling content. | ||
| Status | String | Indicates the current status of the page, such as current, draft, or archived. | ||
| Title | String | The title of the page as displayed in Confluence. | ||
| Type | String | Specifies the content type, indicating that this record represents a page. | ||
| PageId | String |
Pages.Id | =,!=,IN,NOT_IN | The unique identifier of the page whose content is being retrieved. |
Returns detailed permission settings for one or more spaces, specifying which users and groups have access or administrative rights.
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | The unique identifier of the space permission record within Confluence. | ||
| OperationKey | String | Specifies the type of operation the permission applies to, such as view, edit, delete, or administer. | ||
| OperationTargetType | String | Indicates the type of entity that the operation targets, such as space, page, or content. | ||
| PrincipalId | String | The unique identifier of the user or group to whom the permission applies. | ||
| PrincipalType | String | Specifies whether the permission applies to a user, a group, or an anonymous role. | ||
| SpaceId | String |
Spaces.Id | = | The unique identifier of the space to which this permission record belongs. |
Retrieves metadata and configuration details about spaces, including names, keys, descriptions, and access settings.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Spaces WHERE Key = 'abc'
SELECT * FROM Spaces WHERE Name IN ('name1', 'name2')
SELECT * FROM Spaces WHERE Excerpt = 'driver development'
SELECT * FROM Spaces WHERE Key = 'abc' AND Type = 'global'
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Spaces WHERE CQL = 'type = space AND space.title~"Driver Development"' AND Excerpt = 'indexed'
| Name | Type | References | SupportedOperators | Description |
| Id | String | The unique identifier of the space within Confluence. Used to reference the space in related tables and operations. | ||
| Key [KEY] | String | =,!=,IN,NOT_IN | The unique key assigned to the space, typically a short code used in URLs and API requests. | |
| Name | String | =,!= | The display name of the space as shown in the Confluence interface. | |
| IconPath | String | The file path or URL to the space's icon image. | ||
| IconWidth | Integer | The width, in pixels, of the space icon image. | ||
| IconHeight | Integer | The height, in pixels, of the space icon image. | ||
| IsIconDefault | Boolean | If the value is 'true', the space uses the default Confluence icon. If the value is 'false', a custom icon has been set. | ||
| Excerpt | String | A short description or summary of the space content, typically shown in listings or search results. | ||
| Type | String | =,!=,IN,NOT_IN | Specifies the type of space, such as global, personal, or team. | |
| Url | String | The full URL used to access the space through the Confluence interface or API. | ||
| LastModified | Datetime | The date and time when the space or its metadata was last modified. | ||
| ItemURL | String | The complete URL reference to the space as displayed in the Confluence user interface. | ||
| Description | String | A detailed description of the space, outlining its purpose and content focus. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the space was originally created. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering spaces. |
Provides information on tasks assigned or created within Confluence, including assignees, due dates, and completion status.
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | = | The unique identifier of the task within Confluence. | |
| AssignedTo | String | = | The account ID of the user to whom the task is currently assigned. | |
| AtlasDoc | String | Contains the task content in Atlas Document Format (ADF), used for structured text and formatting within Confluence. | ||
| BlogPostId | String | = | The identifier of the blog post associated with the task, if the task is linked to one. | |
| CompletedAt | Datetime | The date and time when the task was marked as completed. | ||
| CompletedBy | String | = | The account ID of the user who completed the task. | |
| CreatedAt | Datetime | The date and time when the task was initially created. | ||
| CreatedBy | String | = | The account ID of the user who created the task. | |
| DueAt | Datetime | The date and time by which the task is due for completion. | ||
| LocalId | String | The local identifier of the task, used for referencing within the context of a specific page or space. | ||
| PageId | String | = | The unique identifier of the page associated with the task. | |
| SpaceId | String | = | The unique identifier of the space in which the task resides. | |
| Status | String | = | Indicates the current state of the task, such as open, in progress, or completed. | |
| Storage | String | Contains the body content of the task in Confluence Storage Format, including text and macros. | ||
| UpdatedAt | Datetime | The date and time when the task was last modified. |
Returns details for a specific user, such as username, display name, email address, and account status.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud. You can also search for Attachments using CQL (Confluence Query Language).
For example, the following queries are processed server side:
SELECT * FROM Users WHERE AccountId = '1234'
SELECT * FROM Users WHERE AccountId IN ('1234', '2345')
SELECT * FROM Users WHERE PublicName = 'confluenceuser'
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Users WHERE CQL = 'user.userKey = "4028d6096b696826016b696960860000" AND type = user' AND UserName = 'currentUser()'
| Name | Type | References | SupportedOperators | Description |
| AccountId [KEY] | String | =,IN | The unique account identifier of the user. This column is available only for Confluence Cloud. | |
| AccountType | String | Specifies the type of user account, such as standard or external. This column is available only for Confluence Cloud. | ||
| PublicName | String | LIKE | The full public name of the user as displayed in Confluence. This column is available only for Confluence Cloud. | |
| String | The email address associated with the user's Confluence account. This column is available only for Confluence Cloud. | |||
| UserKey [KEY] | String | =,!=,IN,NOT_IN | The unique key identifying the user in Confluence Server. This column is available only for Confluence Server. | |
| UserName | String | = | The username used for login and identification in Confluence Server. This column is available only for Confluence Server. | |
| Status | String | Indicates the account status of the user, such as active, disabled, or pending. This column is available only for Confluence Server. | ||
| Type | String | Specifies the user type, such as internal user, external collaborator, or system account. | ||
| Excerpt | String | A short text summary or snippet of information related to the user. | ||
| ProfilePicturePath | String | The file path or URL to the user's profile picture. | ||
| ProfilePictureWidth | Integer | The width, in pixels, of the user's profile picture. | ||
| ProfilePictureHeight | Integer | The height, in pixels, of the user's profile picture. | ||
| IsDefaultPicture | Boolean | If the value is 'true', the profile picture has never been changed and remains the default system image. If the value is 'false', the user has uploaded a custom image. | ||
| DisplayName | String | The display name of the user as shown throughout Confluence, for example in comments, mentions, and activity streams. | ||
| Url | String | The URL to the user's profile page in Confluence. | ||
| LastModified | Datetime | The date and time when the user's profile information was last updated. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering users. |
Retrieves restrictions applied to specific content that limit access for individual users. Requires ContentId and supports up to 200 restrictions per operation.
| Name | Type | References | SupportedOperators | Description |
| Operation | String | Specifies the type of operation that the restriction controls, such as read or update access. | ||
| UserKey | String | The unique user key identifying the user to whom the restriction applies. | ||
| DisplayName | String | The display name of the user who is subject to the restriction. | ||
| Username | String | The username of the user associated with the content restriction. | ||
| Type | String | Indicates the type of user, such as known, anonymous, or external. | ||
| ContentId | String | = | The unique identifier of the content item (such as a page or blog post) where the restriction is applied. |
Shows analytics data on unique viewers of a specific content item, helping track audience engagement.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server side:
SELECT * FROM ViewersAnalytics WHERE FromDate = '2023-01-02'
| Name | Type | References | SupportedOperators | Description |
| ContentId [KEY] | String | = | The unique identifier of the page or content item for which viewer analytics are recorded. | |
| NumberOfDistinctViewers | String | The total number of unique users who have viewed the content. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FromDate | Date | Specifies the start date from which viewer activity is counted when retrieving analytics data. |
Shows analytics data on total views of a specific content item, including repeated visits by the same user.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
For example, the following queries are processed server side:
SELECT * FROM ViewsAnalytics WHERE FromDate = '2023-01-02'
| Name | Type | References | SupportedOperators | Description |
| ContentId [KEY] | String | = | The unique identifier of the page or content item for which view analytics are recorded. | |
| NumberOfViews | String | The total number of times the content has been viewed, including repeated views by the same user. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| FromDate | Date | Specifies the start date from which view activity is counted when retrieving analytics data. |
Retrieves details about collaborative whiteboards created within Confluence, including titles, owners, and associated spaces.
| Name | Type | References | SupportedOperators | Description |
| Id [KEY] | String | =,!=,IN,NOT_IN | The unique identifier of the whiteboard within Confluence. | |
| Title | String | =,!=,IN,NOT_IN,LIKE | The title of the whiteboard as displayed in Confluence. | |
| Status | String | Indicates the current status of the whiteboard, such as active, draft, or archived. | ||
| SpaceKey | String |
Spaces.Key | =,!=,IN,NOT_IN | The unique key of the space that contains the whiteboard. |
| SpaceType | String |
Spaces.Type | =,!=,IN,NOT_IN | Specifies the type of space the whiteboard belongs to, such as global, personal, or team space. |
| Position | String | Defines the whiteboard's position or order within its parent space or container. | ||
| URL | String | The full URL used to access the whiteboard through the Confluence interface or API. | ||
| Excerpt | String | A short summary or snippet of the whiteboard content, typically used for previews or search results. | ||
| IsLatest | Boolean | If the value is 'true', this record represents the most recent version of the whiteboard. If the value is 'false', it refers to a previous version. | ||
| CreatedByUserName | String | =,!=,IN,NOT_IN | The username of the user who originally created the whiteboard. | |
| CreatedByUserType | String | Specifies the type of user who created the whiteboard, such as internal, external, or system account. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the whiteboard was created. | |
| LastUpdatedDatetime | Datetime | =,>,>=,<,<= | The date and time when the whiteboard was last modified. | |
| LastUpdatedMessage | String | The revision message or note entered when the whiteboard was last updated. | ||
| LastUpdatedNumber | Integer | The version number associated with the most recent update of the whiteboard. | ||
| LastUpdatedUserName | String | The username of the user who performed the most recent update. | ||
| LastUpdatedUserType | String | Indicates the type of user who made the latest update, such as internal user or automated process. | ||
| LastUpdatedIsMinorEdit | Boolean | If the value is 'true', the latest change was a minor edit. If the value is 'false', it represents a major update. | ||
| LastUpdatedIsHidden | Boolean | If the value is 'true', the most recent version of the whiteboard is hidden from general visibility. If the value is 'false', it is visible. | ||
| PreviousVersionUserName | String | The username of the user who modified the previous version of the whiteboard. | ||
| PreviousVersionUserType | String | Specifies the type of user who updated the previous version, such as internal user or system account. | ||
| PreviousVersionDatetime | Datetime | The date and time when the previous version of the whiteboard was edited. | ||
| PreviousVersionMessage | String | The revision message or comment provided for the previous version. | ||
| PreviousVersionNumber | String | The version number assigned to the previous revision of the whiteboard. | ||
| PreviousVersionIsMinorEdit | Boolean | If the value is 'true', the previous version was a minor edit. If the value is 'false', it represented a major change. | ||
| PreviousVersionIsHidden | Boolean | If the value is 'true', the previous version of the whiteboard is hidden from users. If the value is 'false', it is visible. | ||
| LinksEditui | String | The URL of the edit interface (EditUI) for the whiteboard, allowing direct editing in Confluence. | ||
| LinksSelf | String | The self-referential API endpoint (Self link) for the whiteboard, used for retrieving its data programmatically. | ||
| LinksTinyui | String | The short link (TinyUI) version of the whiteboard's URL, providing a compact format for sharing. | ||
| LinksWebui | String | The standard web interface URL (WebUI) of the whiteboard as viewed in Confluence. | ||
| ItemURL | String | The complete URL reference to the whiteboard as displayed in the user interface. | ||
| ContainerId | String | The unique identifier of the container, such as the page or space, that holds the whiteboard. | ||
| AnonymousExportViewBody | String | Contains the whiteboard body in anonymous export view format, allowing public export without authentication. | ||
| AtlasDocFormatBody | String | Contains the whiteboard body in Atlas Document Format (ADF), supporting structured and rich content. | ||
| BodyViewBody | String | Contains the rendered view representation of the whiteboard content as displayed in Confluence. | ||
| DynamicBody | String | Contains the dynamic representation of the whiteboard body, used for interactive or real-time updates. | ||
| ExportViewBody | String | Contains the whiteboard body in export view format, suitable for use in external exports. | ||
| EditorBody | String | Contains the whiteboard body in the editor format used in the Confluence editor. | ||
| Editor2Body | String | Contains the whiteboard body in the Editor2 format, used by newer Confluence editor versions. | ||
| StorageBody | String | Contains the whiteboard content in Confluence Storage Format, preserving text, drawings, and formatting. | ||
| StyledViewBody | String | Contains the whiteboard body in styled view format, showing the rendered version with formatting and layout. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to build structured queries for retrieving or filtering whiteboards. |
ストアドプロシージャはファンクションライクなインターフェースで、Confluence の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにConfluence から関連するレスポンスデータを返します。
| Name | Description |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Confluence のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類（テーブルまたはビュー）。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Pages テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Pages'
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | カラムを含むテーブルまたはビューの名前。 |
| ColumnName | String | カラム名。 |
| DataTypeName | String | データ型の名前。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| Length | Int32 | カラムのストレージサイズ。 |
| DisplaySize | Int32 | 指定されたカラムの通常の最大幅（文字数）。 |
| NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。 |
| NumericScale | Int32 | カラムのスケール（小数点以下の桁数）。 |
| IsNullable | Boolean | カラムがNull を含められるかどうか。 |
| Description | String | カラムの簡単な説明。 |
| Ordinal | Int32 | カラムのシーケンスナンバー。 |
| IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
| IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
| IsHidden | Boolean | カラムが非表示かどうか。 |
| IsArray | Boolean | カラムが配列かどうか。 |
| IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
| IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
| ColumnType | String | スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
| SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
| ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
| ColumnName | String | ストアドプロシージャパラメータの名前。 |
| Direction | Int32 | パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| DataTypeName | String | データ型の名前。 |
| NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。 |
| Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
| NumericScale | Int32 | 数値データの小数点以下の桁数。 |
| IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
| IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
| IsArray | Boolean | パラメータが配列かどうか。 |
| Description | String | パラメータの説明。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| Values | String | このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。 |
| SupportsStreams | Boolean | パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。 |
| IsPath | Boolean | パラメータがスキーマ作成操作のターゲットパスかどうか。 |
| Default | String | 何も値が指定されていない場合に、このパラメータで使用される値。 |
| SpecificName | String | 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。 |
| IsCDataProvided | Boolean | プロシージャがネイティブのConfluence プロシージャではなく、CData によって追加 / 実装されているかどうか。 |
| Name | Type | Description |
| IncludeResultColumns | Boolean | 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。 |
主キーおよび外部キーについて説明します。
次のクエリは、Pages テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Pages'
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
| IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| 名前 | タイプ | 説明 |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
| ForeignKeyType | String | 外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | インデックスを含むデータベースの名前。 |
| SchemaName | String | インデックスを含むスキーマの名前。 |
| TableName | String | インデックスを含むテーブルの名前。 |
| IndexName | String | インデックス名。 |
| ColumnName | String | インデックスに関連付けられたカラムの名前。 |
| IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
| IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
| Type | Int16 | インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
| SortOrder | String | 並べ替え順序：A が昇順、D が降順。 |
| OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | 接続プロパティ名。 |
| ShortDescription | String | 簡単な説明。 |
| Type | String | 接続プロパティのデータ型。 |
| Default | String | 明示的に設定されていない場合のデフォルト値。 |
| Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
| Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
| Required | Boolean | プロパティが接続に必要かどうか。 |
| Category | String | 接続プロパティのカテゴリ。 |
| IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
| Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
| PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
| Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
| Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
| ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
| SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
| SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| 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 | サポートされている数値関数。 | 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 | サポートされている日付および時刻関数。 | 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 | レプリケーション中にスキップされたテーブルを示します。 | |
| REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。 | |
| IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
| SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
| DIALECT | 使用するSQL ダイアレクトを示します。 | |
| KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
| SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | 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 | 使用したいcacheOptions を指定する文字列値。 | |
| ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
| PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
| MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
| REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
| REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
| REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
| CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、Confluence Cloud データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | 製品名。 |
| Version | String | 製品のバージョン番号。 |
| Datasource | String | 製品が接続するデータソースの名前。 |
| NodeId | String | 製品がインストールされているマシンの固有識別子。 |
| HelpURL | String | 製品のヘルプドキュメントのURL。 |
| License | String | 製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。） |
| Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
| Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
| DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
| DataSyncCategory | String | CData Sync 機能のカテゴリ（例：Source、Destination）。 |
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Confluence. |
| URL | The URL to your JIRA endpoint. |
| User | 認証するユーザーのユーザーID を指定します。 |
| Password | 認証するユーザーのパスワードを指定します。 |
| APIToken | APIToken of the currently authenticated user. |
| PAT | Personal Access Token of the currently authenticated user. |
| Timezone | Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York. |
| プロパティ | 説明 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
| SSOExchangeURL | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| SSOAppName | アプリ名を必要とするSSO のIdP で使用されるアプリ名. |
| SSOAppPassword | アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| FullOrderByPushDown | Enables pushing `ORDER BY` to the server for supported columns, including problematic datetime columns. For these columns, milliseconds are trimmed to align with the server's behavior. Note: When this property is enabled, millisecond precision is lost for problematic datetime columns, even if the query does not include an ORDER BY clause. |
| IgnoreErrorsOnPagination | This property allows the driver to skip pages that encounter specified server errors during paginated queries and continue retrieving the remaining pages. Note: This property only affects Data Center tables with client-side paging. |
| IncludeArchivedSpaces | Whether to include content from archived spaces in the result. This defaults to false. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Pagesize | provider がConfluence にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| SpaceKey | By specifying the SpaceKey, the search results will only display contents from this specific space. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Confluence. |
| URL | The URL to your JIRA endpoint. |
| User | 認証するユーザーのユーザーID を指定します。 |
| Password | 認証するユーザーのパスワードを指定します。 |
| APIToken | APIToken of the currently authenticated user. |
| PAT | Personal Access Token of the currently authenticated user. |
| Timezone | Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York. |
The type of authentication to use when connecting to Confluence.
string
"Basic"
Confluence supports the following authentication schemes:
The URL to your JIRA endpoint.
string
""
The URL to your JIRA endpoint; for example, https://yoursitename.atlassian.net.
APIToken of the currently authenticated user.
string
""
APIToken of the currently authenticated user.
Personal Access Token of the currently authenticated user.
string
""
Personal Access Token of the currently authenticated user.
Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York.
string
""
Note: You can find the timezone in your Confluence Server by navigating to Settings -> General Configuration and then by clicking System Information on the left panel. On your Confluence Cloud, the timezone should be set. In order to set it, navigate to the User Profile icon on the bottom left corner and click Settings. In that section, you will be able to set the Timezone by clicking the Edit button.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 |
| SSOExchangeURL | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| SSOAppName | アプリ名を必要とするSSO のIdP で使用されるアプリ名. |
| SSOAppPassword | アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。 |
ID プロバイダーのログインURL。
string
""
ID プロバイダーのログインURL。
ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
string
""
ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
SSOLoginURL と一緒に使用します。
SSO 設定については、 で詳しく説明します。
SAML 応答を処理してサービスの資格情報と交換するために使用するURL。
string
""
CData Cloud はここで指定されたURL を使用してSAML 応答を処理し、サービスの資格情報と交換します。 取得した資格情報はSSO 接続時の最後の情報であり、Confluence との通信に使用されます。
アプリ名を必要とするSSO のIdP で使用されるアプリ名.
string
""
SSOAppPassword とともに、SSO IdP で設定されたアプリを識別して認証するために指定できます。 現在、クラウドのみサポートしています。
アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。
string
""
SSOAppName とともに、SSO IdP で設定されたアプリを識別して認証するために指定できます。 現在、クラウドのみサポートしています。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
string
""
このプロパティは2つのケースで必要となります：
（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。）
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
string
""
このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes：
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります：
| 説明 | 例 |
| フルPEM 証明書（例では省略されています） | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵（例では省略されています） | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint（hex 値はスペースまたはコロン区切り） | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint（hex 値はスペースまたはコロン区切り） | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| FullOrderByPushDown | Enables pushing `ORDER BY` to the server for supported columns, including problematic datetime columns. For these columns, milliseconds are trimmed to align with the server's behavior. Note: When this property is enabled, millisecond precision is lost for problematic datetime columns, even if the query does not include an ORDER BY clause. |
| IgnoreErrorsOnPagination | This property allows the driver to skip pages that encounter specified server errors during paginated queries and continue retrieving the remaining pages. Note: This property only affects Data Center tables with client-side paging. |
| IncludeArchivedSpaces | Whether to include content from archived spaces in the result. This defaults to false. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Pagesize | provider がConfluence にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| SpaceKey | By specifying the SpaceKey, the search results will only display contents from this specific space. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
Enables pushing `ORDER BY` to the server for supported columns, including problematic datetime columns. For these columns, milliseconds are trimmed to align with the server's behavior. Note: When this property is enabled, millisecond precision is lost for problematic datetime columns, even if the query does not include an ORDER BY clause.
bool
false
Default: false – `ORDER BY` is not applied server-side for problematic datetime columns, as the server only supports ordering up to the second (ignoring milliseconds), which can cause inaccurate sorting.
When set to true, the driver applies `ORDER BY` on the server for these problematic datetime columns, trimming milliseconds to align with the server's second-level precision. As a result, millisecond precision is lost in these columns regardless of whether the query specifies an ORDER BY clause.
This property allows the driver to skip pages that encounter specified server errors during paginated queries and continue retrieving the remaining pages. Note: This property only affects Data Center tables with client-side paging.
string
"None"
When enabled, this property allows the driver to handle specific errors gracefully during paginated queries. If a server error occurs while fetching a page or batch — such as an HTTP 5xx status code — the error will be logged, the problematic page will be skipped, and the driver will proceed to retrieve the remaining pages. As a result, the query will return all data that was successfully fetched.
This property accepts:
* - Ignore all HTTP server error status codes
None - Disable error skipping (default)
Comma-separated list of server error status codes (e.g., "500,501,503") - Ignore only the specified server errors
Whether to include content from archived spaces in the result. This defaults to false.
bool
false
If this property is set to true, content such as comments, attachments, pages and blogspots belonging to an archived space will be included in the result.
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
int
-1
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
provider がConfluence にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
int
200
クエリを処理する際、Confluence でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。
この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。
Note：大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：
*=*
By specifying the SpaceKey, the search results will only display contents from this specific space.
string
""
If SpaceKey is specified both in the SQL query as well as a connection property, the value in the SQL query will take precedence over the connection property.
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
int
60
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.