CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるConfluence へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してConfluence に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Confluence への接続を標準化し、構成することができます。
このページでは、CData Cloud でのConfluence への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのConfluence への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してConfluence からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Confluence に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
You can establish a connection to any Confluence Cloud account or Confluence Server instance. To connect set the URL connection property. For example, https://yoursitename.atlassian.net.
Confluence supports the following authentication methods: Basic Authentication, standard OAuth2.0 Authentication and SSO.
Aquire a Token
An API token is necessary for account authentication. To generate one, login to your Atlassian account and select API tokens > Create API token. The generated token is displayed.
Authenticate Using the Token
To authenticate to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):
To authenticate to a Server instance, specify the following:
AuthScheme をCrowd に設定します。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 に接続するには、AuthScheme を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:
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Confluence Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
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.
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Attachments | Get information about a specific attachment. |
AuditRecords | Fetch a paginated list of AuditRecord instances dating back to a certain time. |
Blogposts | Get information about a specific blogpost. |
Comments | Get information about a specific comment. |
Contributors | Get information about the users who have contributed to the content. |
GroupMembers | Get users of a specific group. |
Groups | Get information about a specific group. |
Labels | Get information about the labels that a specific content has. |
PageAncestors | To look at a page hierarchy including who is the parent page. |
PageChildrens | To look at a page hierarchy including who is the child page. |
PageComments | Get comments specific to a page. |
PageContents | Get content from the page. |
Pages | Get information about a specific page. |
Spaces | Returns information about a number of spaces. |
Users | Get information about a user identified. |
ViewersAnalytics | Get the total number of distinct viewers a piece of content has. |
ViewsAnalytics | Get the total number of views a piece of content has. |
Get information about a specific attachment.
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 | Id of the attachment. | |
Type | String | =,!=,IN,NOT IN | Type of the content. | |
Title | String | =,!=,LIKE,NOT LIKE,IN,NOT IN | Title of the attachment. | |
Status | String | Status of the attachment. | ||
SpaceKey | String |
Spaces.Key | =,!=,IN,NOT IN | The key of the space that the attachment belongs to. |
SpaceType | String |
Spaces.Type | =,!=,IN,NOT IN | The type of the space that the attachment belongs to. |
Position | String | Position of the attachment. | ||
URL | String | URL of the attachment. | ||
Excerpt | String | Excerpt of the attachment. | ||
IsLatest | Boolean | Indicator if this is the latest version of the attachment. | ||
CreatedByUserName | String | =,!=,IN,NOT IN | Username of the user who created the attachment. | |
CreatedByUserType | String | Type of the user who created the attachment. | ||
CreatedDate | Datetime | =,!=,>,>=,<,<= | Datetime for the creation of the attachment. | |
LastUpdatedDatetime | Datetime | =,!=,>,>=,<,<= | Datetime of the last updated version of the attachment. | |
LastUpdatedMessage | String | Message of the last updated version. | ||
LastUpdatedNumber | Integer | Number of the last updated version. | ||
LastUpdatedUserName | String | Username of the user who updated the latest version. | ||
LastUpdatedUserType | String | Type of the user who updated the latest version. | ||
LastUpdatedIsMinorEdit | Boolean | Indicator if this version is a minor edit. | ||
LastUpdatedIsHidden | Boolean | Indicator if the last updated version is hidden or not. | ||
PreviousVersionUserName | String | Username of the user who updated the previous version. | ||
PreviousVersionUserType | String | Type of the user who updated the previous version. | ||
PreviousVersionDatetime | Datetime | Datetime when the previous version was edited. | ||
PreviousVersionMessage | String | Message for the previously edited version. | ||
PreviousVersionNumber | String | Number of the previously edited version. | ||
PreviousVersionIsMinorEdit | Boolean | Indicator if the previous version was a minor edit. | ||
PreviousVersionIsHidden | Boolean | Indicator if the previous version was hidden or not. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
CQL | String | CQL (Confluence Query Language) allows you to build structured queries. |
Fetch a paginated list of AuditRecord instances dating back to a certain time.
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 | Name of the object that was affected by changes. | ||
AffectedObjectType | String | Type of the object that was affected by changes. | ||
AuthorDisplayName | String | Display name of the person who made the changes. | ||
AuthorType | String | Type of the author who made the changes. | ||
UserKey | String | Unique identifier of the author. | ||
UserName | String | User name of the author. | ||
Category | String | Category of the object. | ||
CreationDate | Datetime | Date when the object was created. | ||
Description | String | Description of the object. | ||
RemoteAddress | String | Remote address of the object. | ||
Summary | String | Summary of the object. | ||
IsSysAdmin | Boolean | Identifier whether object is system administered or not. | ||
SearchString | String | = | Text that is inserted by the user to search for a specific object. | |
StartDate | Datetime | = | Start date of the audit. | |
EndDate | Datetime | = | End date of the audit. |
Get information about a specific blogpost.
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 | Id of the blogpost. | |
Type | String | =,!=,IN,NOT IN | Type of the content. | |
Title | String | =,!=,LIKE,NOT LIKE,IN,NOT IN | Title of the blogpost. | |
Status | String | Status of the blogpost. | ||
SpaceKey | String |
Spaces.Key | =,!=,IN,NOT IN | The key of the space that the blogpost belongs to. |
SpaceType | String |
Spaces.Type | =,!=,IN,NOT IN | The type of the space that the blogpost belongs to. |
Position | String | Position of the blogpost. | ||
URL | String | URL of the blogpost. | ||
Excerpt | String | Excerpt of the blogpost. | ||
IsLatest | Boolean | Indicator if this is the latest version of the blogpost. | ||
CreatedByUserName | String | =,!=,IN,NOT IN | Username of the user who created the blogpost. | |
CreatedByUserType | String | Type of the user who created the blogpost. | ||
CreatedDate | Datetime | =,!=,>,>=,<,<= | Datetime for the creation of the blogpost. | |
LastUpdatedDatetime | Datetime | =,!=,>,>=,<,<= | Datetime of the last updated version of the blogpost. | |
LastUpdatedMessage | String | Message of the last updated version. | ||
LastUpdatedNumber | Integer | Number of the last updated version. | ||
LastUpdatedUserName | String | Username of the user who updated the latest version. | ||
LastUpdatedUserType | String | Type of the user who updated the latest version. | ||
LastUpdatedIsMinorEdit | Boolean | Indicator if this version is a minor edit. | ||
LastUpdatedIsHidden | Boolean | Indicator if the last updated version is hidden or not. | ||
PreviousVersionUserName | String | Username of the user who updated the previous version. | ||
PreviousVersionUserType | String | Type of the user who updated the previous version. | ||
PreviousVersionDatetime | Datetime | Datetime when the previous version was edited. | ||
PreviousVersionMessage | String | Message for the previously edited version. | ||
PreviousVersionNumber | String | Number of the previously edited version. | ||
PreviousVersionIsMinorEdit | Boolean | Indicator if the previous version was a minor edit. | ||
PreviousVersionIsHidden | Boolean | Indicator if the previous version was hidden or not. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
CQL | String | CQL (Confluence Query Language) allows you to build structured queries. |
Get information about a specific comment.
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 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 | Id of the comment. | |
Type | String | =,!=,IN,NOT IN | Type of the content. | |
Title | String | =,!=,LIKE,NOT LIKE,IN,NOT IN | Title of the comment. | |
Status | String | Status of the comment. | ||
SpaceKey | String |
Spaces.Key | =,!=,IN,NOT IN | The key of the space that the comment belongs to. |
SpaceType | String |
Spaces.Type | =,!=,IN,NOT IN | The type of the space that the comment belongs to. |
Position | String | Position of the comment. | ||
URL | String | URL of the comment. | ||
Excerpt | String | Excerpt of the comment. | ||
IsLatest | Boolean | Indicator if this is the latest version of the comment. | ||
CreatedByUserName | String | =,!=,IN,NOT IN | Username of the user who created the comment. | |
CreatedByUserType | String | Type of the user who created the comment. | ||
CreatedDate | Datetime | =,!=,>,>=,<,<= | Datetime for the creation of the comment. | |
LastUpdatedDatetime | Datetime | =,!=,>,>=,<,<= | Datetime of the last updated version of the comment. | |
LastUpdatedMessage | String | Message of the last updated version. | ||
LastUpdatedNumber | Integer | Number of the last updated version. | ||
LastUpdatedUserName | String | Username of the user who updated the latest version. | ||
LastUpdatedUserType | String | Type of the user who updated the latest version. | ||
LastUpdatedIsMinorEdit | Boolean | Indicator if this version is a minor edit. | ||
LastUpdatedIsHidden | Boolean | Indicator if the last updated version is hidden or not. | ||
PreviousVersionUserName | String | Username of the user who updated the previous version. | ||
PreviousVersionUserType | String | Type of the user who updated the previous version. | ||
PreviousVersionDatetime | Datetime | Datetime when the previous version was edited. | ||
PreviousVersionMessage | String | Message for the previously edited version. | ||
PreviousVersionNumber | String | Number of the previously edited version. | ||
PreviousVersionIsMinorEdit | Boolean | Indicator if the previous version was a minor edit. | ||
PreviousVersionIsHidden | Boolean | Indicator if the previous version was hidden or not. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
CQL | String | CQL (Confluence Query Language) allows you to build structured queries. |
Get information about the users who have contributed to the content.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ContentId is required in order to query the Contributors view.
For example, the following queries are processed server side:
SELECT * FROM Contributors WHERE ContentId = '1234' SELECT * FROM Contributors WHERE ContentId! = '1234' SELECT * FROM Contributors WHERE ContentId IN ('1234', '2345') SELECT * FROM Contributors WHERE ContentId NOT IN ('1234', '2345') SELECT * FROM Contributors WHERE AccountId = '12345678' SELECT * FROM Contributors WHERE AccountId! = '12345678' SELECT * FROM Contributors WHERE AccountId IN ('12345678', '23456789') SELECT * FROM Contributors WHERE AccountId NOT IN ('12345678', '23456789')
Additionally, ContentId column can be used in the ORDER BY clause, as following:
SELECT * FROM Contributors ORDER BY ContentId DESC
Name | Type | References | SupportedOperators | Description |
ContentId [KEY] | String | =,!=,IN,NOT IN | This is the Id of the content that support labels. This can be referenced from Attachments.Id, Pages.Id, Comments.Id or Blogposts.Id. | |
UserType | String | Type of the contributor. | ||
AccountId | String | =,!=,IN,NOT IN | Unique account Id of the contributor. NOTE: This column is exclusive to Confluence Cloud. | |
UserName | String | =,!=,IN,NOT IN | Unique user key of the contributor. NOTE: This column is exclusive to Confluence Server. |
Get users of a specific group.
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 | Account Id of the user. | ||
AccountType | String | Account Type of the user. | ||
DisplayName | String | Display name of the user. | ||
String | Email address of the user. | |||
PublicName | String | Public name or nickname of the user. | ||
ProfilePicturePath | String | Path of the profile picture of the user. | ||
ProfilePictureWidth | Int | Width of the profile picture of the user. | ||
ProfilePictureHeight | Int | Height of the profile picture of the user. | ||
ProfilePictureIsDefault | Boolean | If isDefault of the profile picture of the user. | ||
Operations | String | An operation and the target entity that it applies to | ||
Type | String | Type of the user. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
Name | String | Name of the Group to which these members belong to |
Get information about a specific group.
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 | = | Id of the group. | |
Name [KEY] | String | =,IN | Name of the group. | |
Type | String | Type of the group. |
Get information about the labels that a specific content has.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note: ContentId is required in order to query the Labels view.
For example, the following queries are processed server side:
SELECT * FROM Labels WHERE ContentId = '1234' SELECT * FROM Labels WHERE ContentId! = '1234' SELECT * FROM Labels WHERE ContentId IN ('1234', '2345') SELECT * FROM Labels WHERE ContentId NOT IN ('1234', '2345') SELECT * FROM Labels WHERE LabelName = 'test' SELECT * FROM Labels WHERE LabelName != 'test' SELECT * FROM Labels WHERE LabelName IN ('test1', 'test2') SELECT * FROM Labels WHERE LabelName NOT IN ('test1', 'test2')
Additionally, ContentId column can be used in the ORDER BY clause, as following:
SELECT * FROM Labels ORDER BY ContentId DESC
Name | Type | References | SupportedOperators | Description |
ContentId [KEY] | String | =,!=,IN,NOT IN | This is the Id of the content that support labels. This can be referenced from Attachments.Id, Pages.Id, or Blogposts.Id. | |
LabelId | String | Id of the label. | ||
LabelName | String | =,!=,IN,NOT IN | Name of the label. | |
LabelPrefix | String | Prefix of the label. |
To look at a page hierarchy including who is the parent page.
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 Id of the PageAncestors. | ||
ExpandableAncestors | String | The ExpandableAncestors of the PageAncestors. | ||
ExpandableBody | String | The ExpandableBody of the PageAncestors. | ||
ExpandableChildren | String | The ExpandableChildren of the PageAncestors. | ||
ExpandableChildTypes | String | The ExpandableChildTypes of the PageAncestors. | ||
ExpandableContainer | String | The ExpandableContainer of the PageAncestors. | ||
ExpandableDescendants | String | The ExpandableDescendants of the PageAncestors. | ||
ExpandableHistory | String | The ExpandableHistory of the PageAncestors. | ||
ExpandableMetadata | String | The ExpandableMetadata of the PageAncestors. | ||
ExpandableOperations | String | The ExpandableOperations of the PageAncestors. | ||
ExpandableRestrictions | String | The ExpandableRestrictions of the PageAncestors. | ||
ExpandableSchedulePublishDate | Datetime | The ExpandableSchedulePublishDate of the PageAncestors. | ||
ExpandableSpace | String | The ExpandableSpace of the PageAncestors. | ||
ExpandableVersion | String | The ExpandableVersion of the PageAncestors. | ||
LinksEditui | String | The LinksEditui of the PageAncestors. | ||
LinksSelf | String | The LinksSelf of the PageAncestors. | ||
LinksTinyui | String | The LinksTinyui of the PageAncestors. | ||
LinksWebui | String | The LinksWebui of the PageAncestors. | ||
ExtensionsPosition | String | The ExtensionsPosition of the PageAncestors. | ||
Status | String | The Status of the PageAncestors. | ||
Title | String | The Title of the PageAncestors. | ||
Type | String | The Type of the PageAncestors. | ||
PageId | String |
Pages.Id | =,IN | Pseudo column: The Id of the page. |
To look at a page hierarchy including who is the child page.
The Cloud will use the Confluence API to process WHERE clause conditions built with the following column and operator.
Note: PageId is required in order to query the PageChildrens view.
For example, the following queries are processed server side:
SELECT * FROM PageChildrens WHERE PageId = '33106' SELECT * FROM PageChildrens WHERE PageId IN ('163902', '33106')
Name | Type | References | SupportedOperators | Description |
Id [KEY] | String | The Id of the PageChildrens. | ||
ExpandableAncestors | String | The ExpandableAncestors of the PageChildrens. | ||
ExpandableBody | String | The ExpandableBody of the PageChildrens. | ||
ExpandableChildren | String | The ExpandableChildren of the PageChildrens. | ||
ExpandableChildTypes | String | The ExpandableChildTypes of the PageChildrens. | ||
ExpandableContainer | String | The ExpandableContainer of the PageChildrens. | ||
ExpandableDescendants | String | The ExpandableDescendants of the PageChildrens. | ||
ExpandableHistory | String | The ExpandableHistory of the PageChildrens. | ||
ExpandableMetadata | String | The ExpandableMetadata of the PageChildrens. | ||
ExpandableOperations | String | The ExpandableOperations of the PageChildrens. | ||
ExpandableRestrictions | String | The ExpandableRestrictions of the PageChildrens. | ||
ExpandableSchedulePublishDate | Datetime | The ExpandableSchedulePublishDate of the PageChildrens. | ||
ExpandableSpace | String | The ExpandableSpace of the PageChildrens. | ||
ExpandableVersion | String | The ExpandableVersion of the PageChildrens. | ||
LinksEditui | String | The LinksEditui of the PageChildrens. | ||
LinksSelf | String | The LinksSelf of the PageChildrens. | ||
LinksTinyui | String | The LinksTinyui of the PageChildrens. | ||
LinksWebui | String | The LinksWebui of the PageChildrens. | ||
ExtensionsPosition | Integer | The ExtensionsPosition of the PageChildrens. | ||
Status | String | The Status of the PageChildrens. | ||
Title | String | The Title of the PageChildrens. | ||
Type | String | The Type of the PageChildrens. | ||
PageId | String |
Pages.Id | =,IN | Pseudo column: The Id of the page. |
Get comments specific to a page.
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 Id of the comments mentioned in the Page. | ||
ExpandableAncestors | String | The ExpandableAncestors of the page comments. | ||
ExpandableChildren | String | The ExpandableChildren of the page comments. | ||
ExpandableContainer | String | The ExpandableContainer of the page comments. | ||
ExpandableDescendants | String | The ExpandableDescendants of the page comments. | ||
ExpandableHistory | String | The ExpandableHistory of the page comments. | ||
ExpandableMetadata | String | The ExpandableMetadata of the page comments. | ||
ExpandableOperations | String | The ExpandableOperations of the page comments. | ||
ExpandableRestrictions | String | The ExpandableRestrictions of the page comments. | ||
ExpandableSpace | String | The ExpandableSpace of the page comments. | ||
ExpandableVersion | String | The ExpandableVersion of the page comments. | ||
LinksSelf | String | The LinksSelf of the page comments. | ||
LinksWebui | String | The LinksWebui of the page comments. | ||
BodyExpandableAnonymousExportView | String | The BodyExpandableAnonymousExportView of the page comments. | ||
BodyExpandableEditor | String | The BodyExpandableEditor of the page comments. | ||
BodyExpandableExportView | String | The BodyExpandableExportView of the page comments. | ||
BodyExpandableStorage | String | The BodyExpandableStorage of the page comments. | ||
BodyExpandableStyledView | String | The BodyExpandableStyledView of the page comments. | ||
BodyViewExpandableContent | String | The BodyViewExpandableContent of the page comments. | ||
BodyViewExpandableWebresource | String | The BodyViewExpandableWebresource of the page comments. | ||
BodyViewRepresentation | String | The BodyViewRepresentation of the page comments. | ||
BodyViewValue | String | The BodyViewValue of the page comments. | ||
ExtensionsExpandableResolution | String | The ExtensionsExpandableResolution of the page comments. | ||
ExtensionsLocation | String | The ExtensionsLocation of the page comments. | ||
Status | String | The Status of the page comments. | ||
Title | String | The Title of the page comments. | ||
Type | String | The Type of the page comments. | ||
PageId | String |
Pages.Id | =,IN | Pseudo column: The Id of the page. |
Get content from the page.
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 Id of the page content. | ||
ExpandableAncestors | String | The ExpandableAncestors of the page content. | ||
ExpandableChildren | String | The ExpandableChildren of the page content. | ||
ExpandableChildTypes | String | The ExpandableChildTypes of the page content. | ||
ExpandableContainer | String | The ExpandableContainer of the page content. | ||
ExpandableDescendants | String | The ExpandableDescendants of the page content. | ||
ExpandableHistory | String | The ExpandableHistory of the page content. | ||
ExpandableMetadata | String | The ExpandableMetadata of the page content. | ||
ExpandableOperations | String | The ExpandableOperations of the page content. | ||
ExpandableRestrictions | String | The ExpandableRestrictions of the page content. | ||
ExpandableSchedulePublishDate | Datetime | The ExpandableSchedulePublishDate of the page content. | ||
ExpandableSpace | String | The ExpandableSpace of the page content. | ||
ExpandableVersion | String | The ExpandableVersion of the page content. | ||
LinksBase | String | The LinksBase of the page content. | ||
LinksCollection | String | The LinksCollection of the page content. | ||
LinksContext | String | The LinksContext of the page content. | ||
LinksEditui | String | The LinksEditui of the page content. | ||
LinksSelf | String | The LinksSelf of the page content. | ||
LinksTinyui | String | The LinksTinyui of the page content. | ||
LinksWebui | String | The LinksWebui of the page content. | ||
BodyExpandableAnonymousExportView | String | The BodyExpandableAnonymousExportView of the page content. | ||
BodyExpandableAtlasDocFormat | String | The BodyExpandableAtlasDocFormat of the page content. | ||
BodyExpandableDynamic | String | The BodyExpandableDynamic of the page content. | ||
BodyExpandableEditor | String | The BodyExpandableEditor of the page content. | ||
BodyExpandableEditor2 | String | The BodyExpandableEditor2 of the page content. | ||
BodyExpandableExportView | String | The BodyExpandableExportView of the page content. | ||
BodyExpandableStyledView | String | The BodyExpandableStyledView of the page content. | ||
BodyExpandableView | String | The BodyExpandableView of the page content. | ||
BodyStorageExpandableContent | String | The BodyStorageExpandableContent of the page content. | ||
BodyStorageEmbeddedContent | String | The BodyStorageEmbeddedContent of the page content. | ||
BodyStorageRepresentation | String | The BodyStorageRepresentation of the page content. | ||
BodyStorageValue | String | The BodyStorageValue of the page content. | ||
ExtensionsPosition | String | The ExtensionsPosition of the page content. | ||
Status | String | The Status of the page content. | ||
Title | String | The Title of the page content. | ||
Type | String | The Type of the page content. | ||
PageId | String |
Pages.Id | =,IN | Pseudo column: The Id of the page. |
Get information about a specific page.
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 | References | SupportedOperators | Description |
Id [KEY] | String | =,!=,IN,NOT IN | Id of the page. | |
Type | String | =,!=,IN,NOT IN | Type of the content. | |
Title | String | =,!=,LIKE,NOT LIKE,IN,NOT IN | Title of the page. | |
Status | String | Status of the page. | ||
SpaceKey | String |
Spaces.Key | =,!=,IN,NOT IN | The key of the space that the page belongs to. |
SpaceType | String |
Spaces.Type | =,!=,IN,NOT IN | The type of the space that the page belongs to. |
Position | String | Position of the page. | ||
URL | String | URL of the page. | ||
Excerpt | String | Excerpt of the page. | ||
IsLatest | Boolean | Indicator if this is the latest version of the page. | ||
CreatedByUserName | String | =,!=,IN,NOT IN | Username of the user who created the page. | |
CreatedByUserType | String | Type of the user who created the page. | ||
CreatedDate | Datetime | =,!=,>,>=,<,<= | Datetime for the creation of the page. | |
LastUpdatedDatetime | Datetime | =,!=,>,>=,<,<= | Datetime of the last updated version of the page. | |
LastUpdatedMessage | String | Message of the last updated version. | ||
LastUpdatedNumber | Integer | Number of the last updated version. | ||
LastUpdatedUserName | String | Username of the user who updated the latest version. | ||
LastUpdatedUserType | String | Type of the user who updated the latest version. | ||
LastUpdatedIsMinorEdit | Boolean | Indicator if this version is a minor edit. | ||
LastUpdatedIsHidden | Boolean | Indicator if the last updated version is hidden or not. | ||
PreviousVersionUserName | String | Username of the user who updated the previous version. | ||
PreviousVersionUserType | String | Type of the user who updated the previous version. | ||
PreviousVersionDatetime | Datetime | Datetime when the previous version was edited. | ||
PreviousVersionMessage | String | Message for the previously edited version. | ||
PreviousVersionNumber | String | Number of the previously edited version. | ||
PreviousVersionIsMinorEdit | Boolean | Indicator if the previous version was a minor edit. | ||
PreviousVersionIsHidden | Boolean | Indicator if the previous version was hidden or not. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
CQL | String | CQL (Confluence Query Language) allows you to build structured queries. |
Returns information about a number of 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 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 | Id of the space. | ||
Key [KEY] | String | =,!=,IN,NOT IN | Unique key of the space. | |
Name | String | =,LIKE,NOT LIKE | Name of the space. | |
IconPath | String | Path of the space icon. | ||
IconWidth | Integer | Width of the space icon. | ||
IconHeight | Integer | Height of the space icon. | ||
IsIconDefault | Boolean | Indicator if the icon is default. | ||
Excerpt | String | = | Excerpt of the space. | |
Type | String | =,!=,IN,NOT IN | Type of the space. | |
Url | String | Url of the space. | ||
LastModified | Datetime | Last modified datetime. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
CQL | String | CQL (Confluence Query Language) allows you to build structured queries. |
Get information about a user identified.
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,NOT IN | Unique account id for the specific user. NOTE: This column is exclusive to Confluence Cloud. | |
AccountType | String | Type of the account for the specific user. NOTE: This column is exclusive to Confluence Cloud. | ||
PublicName | String | =,LIKE,NOT LIKE | Full name of the specific user. NOTE: This column is exclusive to Confluence Cloud. | |
String | Email of the specific user. NOTE: This column is exclusive to Confluence Cloud. | |||
UserKey [KEY] | String | =,!=,IN,NOT IN | Unique key for the specific user. NOTE: This column is exclusive to Confluence Server. | |
UserName | String | =,CONTAINS | User name of the specific user. NOTE: This column is exclusive to Confluence Server. | |
Status | String | Status of the specific user. NOTE: This column is exclusive to Confluence Server. | ||
Type | String | Type of the specific user. | ||
Excerpt | String | Excerpt of the user. | ||
ProfilePicturePath | String | Path of the profile picture file. | ||
ProfilePictureWidth | Integer | Profile picture width. | ||
ProfilePictureHeight | Integer | Profile picture height. | ||
IsDefaultPicture | Boolean | Indicator showing if the profile picture is never changed. | ||
DisplayName | String | Display name of the specific user. | ||
Url | String | Url of the user profile. | ||
LastModified | Datetime | Last modified timestamp of the user information. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
CQL | String | CQL (Confluence Query Language) allows you to build structured queries. |
Get the total number of distinct viewers a piece of content has.
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 | String | =,IN | The Id of the page content. | |
NumberOfDistinctViewers | String | the total number of distinct viewers a piece of content has. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
FromDate | Date | The number of views for the content from the date. |
Get the total number of views a piece of content has.
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 | String | =,IN | The Id of the page content. | |
NumberOfViews | String | the total number of views a piece of content has. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
FromDate | Date | The number of views for the content from the date. |
ストアドプロシージャはファンクションライクなインターフェースで、Confluence の単純なSELECT 処理にとどまらず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 から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
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
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、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 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:confluence:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
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、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to Confluence. |
URL | The URL to your JIRA endpoint. |
User | 認証で使用されるConfluence ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
APIToken | APIToken of the currently authenticated user. |
Timezone | Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York. |
プロパティ | 説明 |
SSOLoginURL | ID プロバイダーのログインURL。 |
SSOProperties | セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。 |
SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
SSOAppName | アプリ名を必要とするSSO のIdP で使用されるアプリ名. |
SSOAppPassword | アプリパスワードを必要とするSSO のIdP で使用されるアプリパスワード。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
IncludeArchivedSpaces | Whether to include content from archived spaces in the result. This defaults to false. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | Confluence から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
SpaceKey | By specifying the SpaceKey, the search results will only display contents from this specific space. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to Confluence. |
URL | The URL to your JIRA endpoint. |
User | 認証で使用されるConfluence ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
APIToken | APIToken of the currently authenticated user. |
Timezone | Specify the timezone of the Confluence instance in order to use the datetime filters accordingly and retrieve the results according to your timezone. An example of a timezone would be America/New_York. |
The type of authentication to use when connecting to Confluence.
string
"Basic"
The URL to your JIRA endpoint.
string
""
The URL to your JIRA endpoint; for example, https://yoursitename.atlassian.net.
認証で使用されるConfluence ユーザーアカウント。
string
""
このフィールドは、Password とともに、Confluence サーバーに対して認証をするために使われます。
APIToken of the currently authenticated user.
string
""
APIToken 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。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
IncludeArchivedSpaces | Whether to include content from archived spaces in the result. This defaults to false. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | Confluence から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
SpaceKey | By specifying the SpaceKey, the search results will only display contents from this specific space. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
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 を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Confluence から返されるページあたりの結果の最大数。
int
200
Pagesize プロパティは、Confluence から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"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.
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。