CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるBacklog へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してBacklog に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Backlog への接続を標準化し、構成することができます。
このページでは、CData Cloud でのBacklog への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのBacklog への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してBacklog からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Backlog に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
認証方法にはAPI キーとOAuth があります。
AuthScheme をAPIToken に設定します。
ApiKey を取得するには:
オプション1:Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。
オプション2:OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Backlog API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、Teams、Users、TeamMembers などを静的にモデル化するように定義されています。
テーブル では、利用可能なテーブルを説明します。テーブルは、Projects、Issues、WikiPages などを静的にモデル化するように定義されています。
ストアドプロシージャ は、Backlog のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Backlog の操作を実行できます。
Cloud はBacklog のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
IssueAttachments | Returns data from issue attachments table. |
IssueComments | Returns data from issue comments table. |
IssueLinkedSharedFiles | Returns data from issue linked shared files table. |
Issues | Returns data from issues table. |
ProjectAdministrators | Returns data from project administrators table. |
ProjectCategories | Returns data from project categories table. |
ProjectCustomFieldItems | Returns data from project custom field items table. |
ProjectCustomFields | Returns data from project custom fields table. |
ProjectIssueTypes | Returns data from project issue types table. |
Projects | Returns data from projects table. |
ProjectStatuses | Returns data from project statuses table. |
ProjectTeams | Returns data from project teams table. |
ProjectUsers | Returns data from project users table. |
ProjectVersionMilestones | Returns data from project version milestones table. |
PullRequestAttachments | Returns data from pull request attachments table. |
PullRequestComments | Returns data from pull request comments table. |
PullRequests | Returns data from project pull requests table. |
Watchings | Returns data from watchings table. |
WikiPageAttachments | Gets list of files attached to Wiki. |
WikiPages | Returns data from wiki pages table. |
Returns data from issue attachments table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueAttachments WHERE IssueId = 6840954
INSERT は、このテーブルではサポートされていません。
UPDATE は、このテーブルではサポートされていません。
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM IssueAttachments WHERE IssueId = 6840954 AND Id = 3470553
Name | Type | ReadOnly | Description |
IssueId [KEY] | Int | False | |
Id [KEY] | Int | False | |
Name | String | False | |
Size | Int | False | |
Created | Datetime | False | |
CreatedById | Int | False | |
CreatedByUserId | String | False | |
CreatedByName | String | False | |
CreatedByKeyword | String | False | |
CreatedByRoleType | Int | False | |
CreatedByLanguage | String | False | |
CreatedByMailAddress | String | False | |
CreatedByNulabAccountName | String | False | |
CreatedByNulabId | String | False | |
CreatedByNulabAccountUniqueId | String | False |
Returns data from issue comments table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueComments WHERE IssueId = 6840954 SELECT * FROM IssueComments WHERE IssueId = 6840954 AND Id = 39040604
挿入は、IssueId およびContent を指定することで実行できます。
INSERT INTO IssueComments (IssueId, Content) VALUES ('6840954', 'Sample Comment')
UPDATE IssueComments SET Content = 'Third' WHERE IssueId = 6840954 AND Id = 39042035"
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM IssueComments WHERE IssueId = 6840954 AND Id = 39042338
Name | Type | ReadOnly | Description |
IssueId [KEY] | Int | False | |
Id [KEY] | Int | False | |
Content | String | False | |
Created | Datetime | False | |
Updated | Datetime | False | |
CreatedById | Int | False | |
CreatedByUserId | String | False | |
CreatedByName | String | False | |
CreatedByRoleType | Int | False | |
CreatedByLanguage | String | False | |
CreatedByMailAddress | String | False | |
CreatedByNulabAccountName | String | False | |
CreatedByNulabId | String | False | |
CreatedByNulabAccountUniqueId | String | False |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
NotifiedUserId | String | |
AttachmentId | String |
Returns data from issues table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Issues WHERE ID = 6840954 SELECT * FROM Issues WHERE ID IN (6840954, 6840954) SELECT * FROM Issues WHERE ProjectId = 112873 SELECT * FROM Issues WHERE ProjectId IN (112873, 6840954) SELECT * FROM Issues WHERE StatusId = 1 SELECT * FROM Issues WHERE StatusId IN (112873, 6840954) SELECT * FROM Issues WHERE ResolutionId = 0 SELECT * FROM Issues WHERE ResolutionId IN (0, 3)
挿入は、ProjectId、Summary、PriorityId、およびIssueTypeId を指定することで実行できます。
INSERT INTO Issues (ProjectId, Summary, PriorityId, IssueTypeId) VALUES (114706, 'Summary', 3, 530959)
UPDATE Issues SET Summary = 'UPDATED_KEY23', ParentIssueId = '6700745', Comment = 'test' WHERE Id = 6700474
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM Issues WHERE IssueId = 6840954 AND Id = 3470553
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False | |
ProjectId | Int | False | |
IssueKey | String | False | |
KeyId | Int | False | |
ParentIssueId | Int | False | |
Summary | String | False | |
Description | String | False | |
CustomAttributes | String | False | |
StartDate | Date | False | |
DueDate | Date | False | |
ActualHours | Decimal | False | |
EstimatedHours | Decimal | False | |
Created | Datetime | False | |
CreatedByUserName | String | False | |
CreatedByUserId | String | False | |
Updated | Datetime | False | |
UpdatedByUserName | String | False | |
UpdatedByUserId | String | False | |
ResolutionId | Int | False | |
ResolutionName | String | False | |
PriorityId | Int | False | |
PriorityName | String | False | |
IssueTypeId | Int | False | |
IssueTypeName | String | False | |
IssueTypeProjectId | Int | False | |
IssueTypeColor | String | False | |
IssueTypeDisplayOrder | Int | False | |
StatusId | Int | False | |
StatusProjectId | Int | False | |
StatusName | String | False | |
StatusColor | String | False | |
StatusDisplayOrder | Int | False | |
AssigneeId | Int | False | |
AssigneeName | String | False | |
AssigneeRoleType | Int | False | |
AssigneeLanguage | String | False | |
AssigneeMailAddress | String | False |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Category | String | |
Version | String | |
Milestone | String | |
ParentChild | Int |
使用できる値は次のとおりです。0, 1, 2, 3, 4 |
Attachment | Boolean | |
SharedFile | Boolean | |
CreatedSince | String | |
CreatedUntil | String | |
UpdatedSince | String | |
UpdatedUntil | String | |
StartDateSince | String | |
StartDateUntil | String | |
DueDateSince | String | |
DueDateUntil | String | |
Keyword | String | |
Comment | String |
Returns data from project administrators table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectAdministrators WHERE ProjectId = 114706
挿入は、ProjectId およびUserId を指定することで実行できます。
INSERT INTO ProjectAdministrators (ProjectId, UserId) VALUES ('114706', '280728')
UPDATE は、このテーブルではサポートされていません。
削除は、ProjectId AND UserId を指定することで実行できます。
DELETE FROM ProjectAdministrators WHERE ProjectId = 114706 AND UserId = 280728
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
UserId [KEY] | Int | False | |
UserCode | String | False | |
Name | String | False | |
Keyword | String | False | |
NulabAccountName | String | False | |
NulabId | String | False | |
NulabAccountUniqueId | String | False | |
RoleType | Int | False | |
Language | String | False | |
MailAddress | String | False |
Returns data from project categories table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectCategories WHERE ProjectId = 114706
挿入は、ProjectId およびName を指定することで実行できます。
INSERT INTO ProjectCategories (ProjectId, Name) VALUES ('114706', 'cat4')
UPDATE ProjectCategories SET Name = 'Sample' WHERE ProjectId = 114706 AND Id = 205625
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM ProjectCategories WHERE ProjectId = 114706 AND Id = 205622
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
Id [KEY] | Int | False | |
Name | String | False | |
DisplayOrder | Int | False |
Returns data from project custom field items table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectCustomFieldItems WHERE ProjectId = 114706
挿入は、ProjectId、CustomFieldId およびName を指定することで実行できます。
INSERT INTO ProjectCustomFieldItems (ProjectId, CustomFieldId, Name) VALUES ('114706', '44072', 'Fourth')
UPDATE ProjectCustomFieldItems SET Name = 'Fourth4' WHERE ProjectId = 114706 AND CustomFieldId = 44072 AND ItemId = 4
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM ProjectCustomFieldItems WHERE ProjectId = 114706 AND CustomFieldId = 44072 AND ItemId = 5
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
Id [KEY] | Int | False | |
DisplayOrder | String | True | |
Name | String | False | |
ItemId [KEY] | Int | False | |
ItemName | String | False | |
ItemDisplayOrder | String | True |
Returns data from project custom fields table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectCustomFields WHERE ProjectId = 114706
挿入は、ProjectId、typeId およびName を指定することで実行できます。
INSERT INTO ProjectCustomFields (ProjectId, Name, typeId) VALUES ('114706', 'Milestone4', 1)
UPDATE ProjectCustomFields SET Name = 'Third' WHERE ProjectId = 114706 AND Id = 44203
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM ProjectCustomFields WHERE ProjectId = 114706 AND Id = 44204
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
Id [KEY] | Int | False | |
TypeId | String | False | |
Name | String | False | |
Description | String | False | |
Required | Booelan | False | |
AllowAddItem | Booelan | False | |
UseIssueType | Booelan | False | |
ApplicableIssueTypes | String | False | |
DisplayOrder | String | False |
Returns data from project issue types table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectIssueTypes WHERE ProjectId = 114706
挿入は、ProjectId、Color およびName を指定することで実行できます。
INSERT INTO ProjectIssueTypes (ProjectId, Name, Color) VALUES ('114706', 'Sample', '#ff9200')
UPDATE ProjectIssueTypes SET Name = 'ytryet43' WHERE ProjectId = 114706 AND Id = 532089
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
Id [KEY] | Int | False | |
Name | String | False | |
Color | String | False | |
DisplayOrder | Int | True | |
TemplateSummary | String | False | |
TemplateDescription | String | False |
Returns data from projects table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Projects WHERE Id = 114706 SELECT * FROM Projects WHERE ProjectKey = 'SAMPLE_KEY' SELECT * FROM Projects WHERE All = true SELECT * FROM Projects WHERE Archived = false
挿入は、Name、ProjectKey、chartEnabled、projectLeaderCanEditProjectLeader、subtaskingEnabled、textFormattingRule、ProjectLeaderCanEditProjectLeader、UseDevAttributes およびUseWikiTreeView を指定することで実行できます。
INSERT INTO Projects (Name, ProjectKey, chartEnabled, projectLeaderCanEditProjectLeader, subtaskingEnabled, textFormattingRule, ProjectLeaderCanEditProjectLeader, UseDevAttributes, UseWikiTreeView) VALUES ('InsertedName', 'INSERTED_KEY_3', false, true, true, markdown, true, false, false)
UPDATE Projects SET ProjectKey = 'UPDATED_KEY2', Name = 'UpdatedName2' WHERE Id = 112873
削除は、ID を指定することで実行できます。
DELETE FROM Projects WHERE Id = 113332
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False | |
ProjectKey | String | False | |
Name | String | False | |
DisplayOrder | Int | False | |
ChartEnabled | Boolean | False | |
SubtaskingEnabled | Boolean | False | |
ProjectLeaderCanEditProjectLeader | Boolean | False | |
UseDevAttributes | Boolean | False | |
UseWikiTreeView | Boolean | False | |
TextFormattingRule | String | False | |
Archived | Boolean | False | |
useResolvedForChart | Boolean | False | |
useWiki | Boolean | False | |
useFileSharing | Boolean | False | |
useOriginalImageSizeAtWiki | Boolean | False |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
All | Boolean |
Returns data from project statuses table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectStatuses WHERE ProjectId = 114706
挿入は、ProjectId およびColor を指定することで実行できます。
Color カラムに指定可能な値は#ea2c00、#e87758 、#e07b9a、#868cb7、#3b9dbd、#4caf93、#b0be3c、#eda62a、#f42858、#393939 です。
INSERT INTO ProjectStatuses (ProjectId, Name, Color) VALUES ('117182', 'Sample', '#3b9dbd')
UPDATE ProjectStatuses SET Name = 'Sample', color = '#ea2c00' WHERE ProjectId = 114706 AND Id = 18504
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False | |
ProjectId [KEY] | Int | False | |
Name | String | False | |
Color | String | False | |
DisplayOrder | Int | True |
Returns data from project teams table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectTeams WHERE ProjectId = 114706
挿入は、ProjectId およびTeamId を指定することで実行できます。
INSERT INTO ProjectTeams (ProjectId, TeamId) VALUES ('114706', '55083')
UPDATE は、このテーブルではサポートされていません。
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM ProjectTeams WHERE ProjectId = 114706 AND TeamId = 55082
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
TeamId [KEY] | Int | False | |
Name | String | True | |
DisplayOrder | Int | True | |
Created | Datetime | True | |
CreatedById | Int | True | |
CreatedByUserId | String | True | |
CreatedByName | String | True | |
CreatedByRoleType | Int | True | |
CreatedByLang | String | True | |
CreatedByMailAddress | String | True | |
Updated | Datetime | True | |
UpdatedById | Int | True | |
UpdatedByUserId | String | True | |
UpdatedByName | String | True | |
UpdatedByRoleType | Int | True | |
UpdatedByLang | String | True | |
UpdatedByMailAddress | String | True |
Returns data from project users table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectUsers WHERE ProjectId = 114706
挿入は、ProjectId およびUserId を指定することで実行できます。
INSERT INTO ProjectUsers (ProjectId, UserId) VALUES ('114706', '280728')
UPDATE は、このテーブルではサポートされていません。
削除は、ProjectId AND UserId を指定することで実行できます。
DELETE FROM ProjectUsers WHERE ProjectId = 114706 AND UserId = 280728
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
UserId [KEY] | Int | False | |
UserCode | String | False | |
Name | String | False | |
Keyword | String | False | |
NulabAccountName | String | False | |
NulabId | String | False | |
NulabAccountUniqueId | String | False | |
RoleType | Int | False | |
Language | String | False | |
MailAddress | String | False |
Returns data from project version milestones table.
projectversionmilestones
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectVersionMilestones WHERE ProjectId = 114706
挿入は、ProjectId およびName を指定することで実行できます。
INSERT INTO ProjectVersionMilestones (ProjectId, Name) VALUES ('114706', 'Milestone4')
UPDATE ProjectVersionMilestones SET Name = 'Sample' WHERE ProjectId = 114706 AND Id = 138889
削除は、ProjectId AND ID を指定することで実行できます。
DELETE FROM ProjectVersionMilestones WHERE ProjectId = 114706 AND Id = 138890
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
Id [KEY] | Int | False | |
Name | String | False | |
Description | String | False | |
DisplayOrder | Int | True | |
StartDate | Date | False | |
ReleaseDueDate | Date | False | |
Archived | Boolean | True |
Returns data from pull request attachments table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestAttachments WHERE ProjectId = '94706' AND RepositoryId = 21949 AND PullRequestNumber = 2
INSERT は、このテーブルではサポートされていません。
UPDATE は、このテーブルではサポートされていません。
削除は、ProjectId、RepositoryId、PullRequestNumber AND ID を指定することで実行できます。
DELETE FROM PullRequestAttachments WHERE ProjectId = 39470 AND RepositoryId = 21949 AND PullRequestNumber = 2 AND ID = 3
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | True | |
RepositoryId [KEY] | Int | True | |
PullRequestNumber [KEY] | Int | True | |
Id [KEY] | Int | True | |
Name | String | True | |
Size | Int | True | |
Created | Datetime | True | |
CreatedById | Int | True | |
CreatedByUserId | String | True | |
CreatedByName | String | True | |
CreatedByKeyword | String | True | |
CreatedByRoleType | Int | True | |
CreatedByLanguage | String | True | |
CreatedByMailAddress | String | True | |
CreatedByNulabAccountName | String | True | |
CreatedByNulabId | String | True | |
CreatedByNulabAccountUniqueId | String | True |
Returns data from pull request comments table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestComments WHERE ProjectId = 114706 AND RepositoryId = 22462 AND PullRequestNumber = 2
挿入は、ProjectId、RepositoryId、PullRequestNumber およびContent を指定することで実行できます。
INSERT INTO PullRequestComments (ProjectId, RepositoryId, PullRequestNumber, Content) VALUES ('114706', '22462', '2', 'FirstComment')
UPDATE PullRequestComments SET Content = 'Third' WHERE ProjectId = 114706 AND RepositoryId = 22462 AND PullRequestNumber = 2 AND ID = 3
削除はこのテーブルではサポートされていません。
Name | Type | ReadOnly | Description |
ProjectId | Int | False | |
RepositoryId | Int | False | |
PullRequestNumber | Int | False | |
Id [KEY] | Int | False | |
Content | String | False | |
Created | Datetime | True | |
Updated | Datetime | True | |
CreatedById | Int | True | |
CreatedByUserId | String | True | |
CreatedByName | String | True | |
CreatedByRoleType | Int | True | |
CreatedByLanguage | String | True | |
CreatedByMailAddress | String | True | |
CreatedByNulabAccountName | String | True | |
CreatedByNulabId | String | True | |
CreatedByNulabAccountUniqueId | String | True |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
NotifiedUserId | String |
Returns data from project pull requests table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId およびRepositoryId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequests WHERE ProjectId = '114706' AND RepositoryId = 22462" SELECT * FROM PullRequests WHERE ProjectId = '114706' AND RepositoryId = 22462 AND Number = 2
挿入は、ProjectId、RepositoryId、Summary、description、base およびbranch を指定することで実行できます。
INSERT INTO PullRequests (ProjectId, RepositoryId, Summary, description, base, branch) VALUES ('114706', '22462', 'First', 'FirstPullReq', 'main', 'sample')
UPDATE PullRequests SET Summary = 'Third' WHERE ProjectId = 114706 AND RepositoryId = 22462 AND Number = 44203
削除はこのテーブルではサポートされていません。
Name | Type | ReadOnly | Description |
ProjectId [KEY] | Int | False | |
RepositoryId [KEY] | Int | False | |
Id [KEY] | Int | False | |
Number | Int | False | |
Summary | String | False | |
Description | String | False | |
Base | String | False | |
Branch | String | False | |
BaseCommit | String | True | |
BranchCommit | String | True | |
CloseAt | Datetime | True | |
MergeAt | Datetime | True | |
StatusId | Int | True | |
StatusName | String | True | |
IssueId | Int | False | |
AssigneeId | Int | False | |
AssigneeName | String | True | |
AssigneeRoleType | Int | True | |
AssigneeLanguage | String | True | |
AssigneeMailAddress | String | True | |
Created | Datetime | True | |
CreatedById | Int | True | |
CreatedByUserId | String | True | |
CreatedByName | String | True | |
CreatedByKeyword | String | True | |
CreatedByRoleType | Int | True | |
CreatedByLanguage | String | True | |
CreatedByMailAddress | String | True | |
CreatedByNulabAccountName | String | True | |
CreatedByNulabId | String | True | |
CreatedByNulabAccountUniqueId | String | True | |
Updated | Datetime | True | |
UpdatedById | Int | True | |
UpdatedByUserId | String | True | |
UpdatedByName | String | True | |
UpdatedByKeyword | String | True | |
UpdatedByRoleType | Int | True | |
UpdatedByLanguage | String | True | |
UpdatedByMailAddress | String | True | |
UpdatedByNulabAccountName | String | True | |
UpdatedByNulabId | String | True | |
UpdatedByNulabAccountUniqueId | String | True |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
NotifiedUserId | String | |
AttachmentId | String |
Returns data from watchings table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Watchings WHERE UserId = '280688' SELECT * FROM Watchings WHERE Id = '145169'
挿入は、IssueId およびNote を指定することで実行できます。
INSERT INTO Watchings (IssueId, Note) VALUES ('6868643', 'Sample')
UPDATE Watchings SET Note = 'Third' WHERE Id = 145171
削除は、ID を指定することで実行できます。
DELETE FROM Watchings WHERE Id = 145170
Name | Type | ReadOnly | Description |
UserId | Int | False | |
Id [KEY] | Int | False | |
Note | String | False | |
Type | String | True | |
IssueId | String | True | |
ResourceAlreadyRead | Boolean | True | |
LastContentUpdated | Datetime | True | |
Created | Datetime | True | |
Updated | Datetime | True |
Gets list of files attached to Wiki.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPageAttachments WHERE WikiPageId = '639459'
INSERT は、このテーブルではサポートされていません。
UPDATE は、このテーブルではサポートされていません。
削除は、IssueId AND ID を指定することで実行できます。
DELETE FROM WikiPageAttachments WHERE WikiPageId = 639459 AND Id = 188522
Name | Type | ReadOnly | Description |
WikiPageId [KEY] | Int | False | |
Id [KEY] | Int | False | |
Name | String | False | |
Size | Int | False | |
Created | Datetime | False | |
CreatedById | Int | False | |
CreatedByUserId | String | False | |
CreatedByName | String | False | |
CreatedByKeyword | String | False | |
CreatedByRoleType | Int | False | |
CreatedByLanguage | String | False | |
CreatedByMailAddress | String | False | |
CreatedByNulabAccountName | String | False | |
CreatedByNulabId | String | False | |
CreatedByNulabAccountUniqueId | String | False |
Returns data from wiki pages table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPages WHERE ProjectId = '114706' SELECT * FROM WikiPages WHERE Id = 639460
挿入は、ProjectId、Content、およびName を指定することで実行できます。
INSERT INTO WikiPages (ProjectId, Name, Content) VALUES ('114706', 'FirstWiki3', 'Sample Comment')
UPDATE WikiPages SET Name = 'UPDATED', Content = 'UPDATED' WHERE Id = 639460
削除は、ID を指定することで実行できます。
DELETE FROM WikiPages WHERE Id = 639461
Name | Type | ReadOnly | Description |
ProjectId | Int | False | |
Id [KEY] | Int | False | |
Name | String | False | |
Content | String | False | |
Created | Datetime | True | |
CreatedById | Int | True | |
CreatedByUserId | String | True | |
CreatedByName | String | True | |
CreatedByKeyword | String | True | |
CreatedByRoleType | Int | True | |
CreatedByLanguage | String | True | |
CreatedByMailAddress | String | True | |
CreatedByNulabAccountName | String | True | |
CreatedByNulabId | String | True | |
CreatedByNulabAccountUniqueId | String | True | |
Updated | Datetime | True | |
UpdatedById | Int | True | |
UpdatedByUserId | String | True | |
UpdatedByName | String | True | |
UpdatedByKeyword | String | True | |
UpdatedByRoleType | Int | True | |
UpdatedByLanguage | String | True | |
UpdatedByMailAddress | String | True | |
UpdatedByNulabAccountName | String | True | |
UpdatedByNulabId | String | True | |
UpdatedByNulabAccountUniqueId | String | True |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
MailNotify | Boolean |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
IssueCategories | Returns data from issue categories table. |
IssueCommentChangeLog | Returns data from issue comment change log table. |
IssueCommentNotifications | Returns data from issue comment notifications table. |
IssueCommentStars | Returns data from issue comment starts table. |
IssueMilestones | Returns data from issue milestones table. |
IssueParticipants | Returns list of participants of an issue. |
IssueVersions | Returns data from issue versions table. |
Licenses | Returns licence. |
Notifications | Returns own notifications. |
Priorities | Returns data from priorities table. |
ProjectRecentUpdates | Returns recent update in the project. |
ProjectSharedFiles | Gets list of Project Shared Files |
ProjectTeamMembers | Returns data from project team members table. |
PullRequestCommentChangeLog | Returns data from pull request comment changelog table. |
PullRequestCommentNotifications | Returns data from pull request comment notifications table. |
PullRequestCommentStars | Returns data from pull request comment starts table. |
Repositories | Returns data from project repositories table. |
Resolutions | Returns data from resolutions table. |
Space | Returns information about your space. |
SpaceDiskUsage | Returns information about space disk usage. |
SpaceDiskUsageDetails | Returns information about space disk details usage. |
SpaceNotifications | Returns space notification. |
SpaceUpdates | Returns recent updates in your space. |
TeamMembers | Returns data from team members table. |
Teams | Returns data from teams table. |
UserReceivedStars | Returns the list of stars that user received. |
UserRecentlyViewedIssues | Returns list of issues which the user viewed recently. |
UserRecentlyViewedProjects | Returns list of projects which the user viewed recently. |
UserRecentlyViewedWikiPages | Returns list of Wikis which the user viewed recently. |
UserRecentUpdates | Returns user recent updates. |
Users | Returns data from users table. |
WikiPageHistory | Returns history of Wiki page. |
WikiPageLinkedSharedFiles | Returns data from wiki page linked shred files table. |
WikiPageStars | Returns list of stars received on the Wiki page. |
WikiPageTags | Returns list of tags that are used in the project. |
Returns data from issue categories table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueCategories WHERE IssueId = 6840954
Name | Type | Description |
IssueId | String | |
Id [KEY] | Int | |
Name | String | |
DisplayOrder | String |
Returns data from issue comment change log table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueCommentChangeLog WHERE IssueId = 6840954
Name | Type | Description |
IssueId | Int | |
CommentId | Int | |
AttachmentInfo | String | |
AttributeInfo | String | |
Field | String | |
NewValue | String | |
NotificationInfo | String | |
OriginalValue | String |
Returns data from issue comment notifications table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueCommentNotifications WHERE IssueId = 6840954
Name | Type | Description |
IssueId | Int | |
CommentId | Int | |
NotificationId [KEY] | Int | |
Reason | String | |
AlreadyRead | Boolean | |
ResourceAlreadyRead | Boolean | |
CreatedById | Int | |
CreatedByUserId | String | |
CreatedByName | String | |
CreatedByKeyword | String | |
CreatedByRoleType | Int | |
CreatedByLanguage | String | |
CreatedByMailAddress | String | |
CreatedByNulabAccountName | String | |
CreatedByNulabId | String | |
CreatedByNulabAccountUniqueId | String |
Returns data from issue comment starts table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueCommentStars WHERE IssueId = 6840954
Name | Type | Description |
IssueId | Int | |
CommentId | Int | |
StarId [KEY] | Int | |
Comment | String | |
Title | String | |
Url | String | |
Created | Datetime | |
PresenterId | Int | |
PresenterUserId | String | |
PresenterName | String | |
PresenterKeyword | String | |
PresenterRoleType | Int | |
PresenterLanguage | String | |
PresenterMailAddress | String | |
PresenterNulabAccountName | String | |
PresenterNulabId | String | |
PresenterNulabAccountUniqueId | String |
Returns data from issue milestones table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueMilestones WHERE IssueId = 6868745
Name | Type | Description |
IssueId | String | |
Id [KEY] | Int | |
Name | String | |
Description | String | |
Archived | Boolean | |
ProjectId | Int | |
ReleaseDueDate | Date | |
StartDate | Date | |
DisplayOrder | String |
Returns list of participants of an issue.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueParticipants WHERE IssueId = '6840954'
Name | Type | Description |
IssueId | Int | |
Id [KEY] | Int | |
UserId | String | |
Name | String | |
Keyword | String | |
NulabAccountName | String | |
NulabId | String | |
NulabAccountUniqueId | String | |
RoleType | Int | |
Language | String | |
MailAddress | String |
Returns data from issue versions table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはIssueId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM IssueVersions WHERE IssueId = 6868745
Name | Type | Description |
IssueId | String | |
Id [KEY] | Int | |
Name | String | |
Description | String | |
Archived | Boolean | |
ProjectId | Int | |
ReleaseDueDate | Date | |
StartDate | Date | |
DisplayOrder | String |
Returns licence.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Active | Boolean | |
AttachmentLimit | Int | |
AttachmentLimitPerFile | Int | |
AttachmentNumLimit | Int | |
Attribute | Boolean | |
AttributeLimit | Int | |
Burndown | Boolean | |
CommentLimit | Int | |
ComponentLimit | Int | |
FileSharing | Boolean | |
Gantt | Boolean | |
Git | Boolean | |
IssueLimit | Int | |
LicenceTypeId | Int | |
LimitDate | Date | |
NulabAccount | Boolean | |
ParentChildIssue | Boolean | |
PostIssueByMail | Boolean | |
ProjectGroup | Boolean | |
ProjectLimit | Int | |
PullRequestAttachmentLimitPerFile | Int | |
PullRequestAttachmentNumLimit | Int | |
RemoteAddress | Boolean | |
RemoteAddressLimit | Int | |
StartedOn | Datetime | |
StorageLimit | Int | |
Subversion | Boolean | |
SubversionExternal | Boolean | |
UserLimit | Int | |
VersionLimit | Int | |
WikiAttachment | Boolean | |
WikiAttachmentLimitPerFile | Int | |
WikiAttachmentNumLimit | Int |
Returns own notifications.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Id [KEY] | Int | |
AlreadyRead | Boolean | |
Reason | Int | |
ResourceAlreadyRead | Int | |
Created | Int | |
ProjectId | Int | |
ProjectKey | String | |
ProjectName | String | |
ProjectDisplayOrder | Int | |
ProjectChartEnabled | Boolean | |
ProjectSubtaskingEnabled | Boolean | |
ProjectProjectLeaderCanEditProjectLeader | Boolean | |
ProjectUseDevAttributes | Boolean | |
ProjectUseWikiTreeView | Boolean | |
ProjectTextFormattingRule | String | |
ProjectArchived | Boolean | |
IssueId | Int | |
IssueProjectId | Int | |
IssueKey | String | |
IssueKeyId | Int | |
IssueTypeId | Int | |
IssueTypeName | String | |
IssueTypeColor | String | |
IssueTypeProjectId | Int | |
IssueTypeDisplayOrder | Int | |
IssueSummary | String | |
IssueDescription | String | |
IssueResolutions | String | |
IssuePriorityId | Int | |
IssuePriorityName | String | |
IssueStatusId | Int | |
IssueStatusName | String | |
IssueStatusColor | String | |
IssueStatusProjectId | Int | |
IssueStatusDisplayOrder | Int | |
IssueAssigneeId | Int | |
IssueAssigneeName | String | |
IssueAssigneeRoleType | Int | |
IssueAssigneeLanguage | String | |
IssueAssigneeMailAddress | String | |
IssueCategories | String | |
IssueVersions | String | |
IssueMilestones | String | |
IssueCustomFields | String | |
IssueAttachments | String | |
IssueSharedFiles | String | |
IssueStars | String | |
IssueStartDate | Date | |
IssueDueDate | Date | |
IssueEstimatedHours | Decimal | |
IssueActualHours | Decimal | |
IssueParentIssueId | Int | |
IssueCreated | Datetime | |
IssueCreatedById | Int | |
IssueCreatedByUserId | String | |
IssueCreatedByName | String | |
IssueCreatedByKeyword | String | |
IssueCreatedByNulabAccountName | String | |
IssueCreatedByNulabId | String | |
IssueCreatedByNulabAccountUniqueId | String | |
IssueCreatedByRoleType | Int | |
IssueCreatedByLanguage | String | |
IssueCreatedByMailAddress | String | |
IssueUpdated | Datetime | |
IssueUpdatedById | Int | |
IssueUpdatedByUserId | String | |
IssueUpdatedByName | String | |
IssueUpdatedByKeyword | String | |
IssueUpdatedByNulabAccountName | String | |
IssueUpdatedByNulabId | String | |
IssueUpdatedByNulabAccountUniqueId | String | |
IssueUpdatedByRoleType | Int | |
IssueUpdatedByLanguage | String | |
IssueUpdatedByMailAddress | String | |
CommentId | Int | |
CommentContent | String | |
CommentCreated | String | |
SentById | Int | |
SentByUserId | String | |
SentByName | String | |
SentByKeyword | String | |
SentByNulabAccountName | String | |
SentByNulabId | String | |
SentByNulabAccountUniqueId | String | |
SentByRoleType | Int | |
SentByLanguage | String | |
SentByMailAddress | String |
Returns data from priorities table.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Id [KEY] | Int | |
Name | String |
Returns recent update in the project.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectRecentUpdates WHERE ProjectId = 114706
Name | Type | Description |
Id [KEY] | Int | |
Created | Datetime | |
Type | String | |
ContentId | Int | |
Content | String | |
ContentDiff | String | |
ContentKeyId | String | |
ContentDescription | String | |
ContentSummary | String | |
ContentRepository | String | |
ContentAttachments | String | |
ContentSharedFiles | String | |
ContentComments | String | |
ContentChanges | String | |
ContentParties | String | |
ProjectId | Int | |
ProjectKey | String | |
ProjectName | String | |
ProjectDisplayOrder | Int | |
ProjectChartEnabled | Boolean | |
ProjectSubtaskingEnabled | Boolean | |
ProjectProjectLeaderCanEditProjectLeader | Boolean | |
ProjectUseDevAttributes | Boolean | |
ProjectUseWikiTreeView | Boolean | |
ProjectTextFormattingRule | String | |
ProjectArchived | Boolean | |
CreatedById | Int | |
CreatedByUserId | String | |
CreatedByName | String | |
CreatedByKeyword | String | |
CreatedByNulabAccountName | String | |
CreatedByNulabId | String | |
CreatedByNulabAccountUniqueId | String | |
CreatedByRoleType | Int | |
CreatedByLanguage | String | |
CreatedByMailAddress | String |
Returns data from project team members table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProjectTeamMembers WHERE ProjectId = 114706
Name | Type | Description |
ProjectId | Int | |
TeamId | Int | |
MemberId | Int | |
UserId | String | |
Name | String | |
Keyword | String | |
NulabAccountName | String | |
NulabId | String | |
NulabAccountUniqueId | String | |
RoleType | Int | |
Lang | String | |
MailAddress | String |
Returns data from pull request comment changelog table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestCommentChangeLog WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2
Name | Type | Description |
ProjectId | Int | |
RepositoryId | Int | |
PullRequestNumber | Int | |
AttachmentInfo | String | |
AttributeInfo | String | |
Field | String | |
NewValue | String | |
NotificationInfo | String | |
OriginalValue | String |
Returns data from pull request comment notifications table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestCommentNotifications WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2
Name | Type | Description |
ProjectId | Int | |
RepositoryId | Int | |
PullRequestNumber | Int | |
NotificationId [KEY] | Int | |
Reason | String | |
AlreadyRead | Boolean | |
ResourceAlreadyRead | Boolean | |
CreatedById | Int | |
CreatedByUserId | String | |
CreatedByName | String | |
CreatedByKeyword | String | |
CreatedByRoleType | Int | |
CreatedByLanguage | String | |
CreatedByMailAddress | String | |
CreatedByNulabAccountName | String | |
CreatedByNulabId | String | |
CreatedByNulabAccountUniqueId | String |
Returns data from pull request comment starts table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId、RepositoryId、PullRequestNumber が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM PullRequestCommentStars WHERE ProjectId = '114706' AND RepositoryId = 22462 AND PullRequestNumber = 2
Name | Type | Description |
ProjectId | Int | |
RepositoryId | Int | |
PullRequestNumber | Int | |
StarId [KEY] | Int | |
Comment | String | |
Title | String | |
Url | String | |
Created | Datetime | |
PresenterId | Int | |
PresenterUserId | String | |
PresenterName | String | |
PresenterKeyword | String | |
PresenterRoleType | Int | |
PresenterLanguage | String | |
PresenterMailAddress | String | |
PresenterNulabAccountName | String | |
PresenterNulabId | String | |
PresenterNulabAccountUniqueId | String |
Returns data from project repositories table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Repositories WHERE ProjectId = 117182 SELECT * FROM Repositories WHERE ProjectId = 117182 AND Id = 22862 SELECT * FROM Repositories WHERE ProjectId = 117182 AND Name = 'First'
Name | Type | Description |
Id [KEY] | Int | |
ProjectId | Int | |
Name | String | |
Description | String | |
HookUrl | String | |
HttpUrl | String | |
SshUrl | String | |
DisplayOrder | Int | |
PushedAt | Datetime | |
Created | Datetime | |
CreatedById | Int | |
CreatedByUserId | String | |
CreatedByName | String | |
CreatedByKeyword | String | |
CreatedByRoleType | Int | |
CreatedByLanguage | String | |
CreatedByMailAddress | String | |
CreatedByNulabAccountName | String | |
CreatedByNulabId | String | |
CreatedByNulabAccountUniqueId | String | |
Updated | Datetime | |
UpdatedById | Int | |
UpdatedByUserId | String | |
UpdatedByName | String | |
UpdatedByKeyword | String | |
UpdatedByRoleType | Int | |
UpdatedByLanguage | String | |
UpdatedByMailAddress | String | |
UpdatedByNulabAccountName | String | |
UpdatedByNulabId | String | |
UpdatedByNulabAccountUniqueId | String |
Returns data from resolutions table.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Id [KEY] | Int | |
Name | String |
Returns information about your space.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
SpaceKey | String | |
Name | String | |
OwnerId [KEY] | Int | |
Language | String | |
Timezone | String | |
ReportSendTime | Hour | |
TextFormattingRule | String | |
Created | Datetime | |
Updated | Datetime |
Returns information about space disk usage.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Capacity | String | |
Issue | String | |
Wiki | String | |
File | Int | |
Subversion | Int | |
Git | Int | |
GitLFS | Int | |
PullRequest | Int |
Returns information about space disk details usage.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
ProjectId | String | |
File | Int | |
Git | Int | |
GitLFS | Int | |
Issue | String | |
Wiki | String | |
Subversion | Int |
Returns space notification.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Content | String | |
Updated | Datetime |
Returns recent updates in your space.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM SpaceUpdates WHERE Type = 13 SELECT * FROM SpaceUpdates WHERE Type IN (13, 5)
Name | Type | Description |
Id [KEY] | Int | |
Created | Datetime | |
Type | String | |
ContentId | Int | |
Content | String | |
ContentDiff | String | |
ContentKeyId | String | |
ContentDescription | String | |
ContentSummary | String | |
ContentRepository | String | |
ContentAttachments | String | |
ContentSharedFiles | String | |
ContentComments | String | |
ContentChanges | String | |
ContentParties | String | |
ProjectId | Int | |
ProjectKey | String | |
ProjectName | String | |
ProjectDisplayOrder | Int | |
ProjectChartEnabled | Boolean | |
ProjectSubtaskingEnabled | Boolean | |
ProjectProjectLeaderCanEditProjectLeader | Boolean | |
ProjectUseDevAttributes | Boolean | |
ProjectUseWikiTreeView | Boolean | |
ProjectTextFormattingRule | String | |
ProjectArchived | Boolean | |
CreatedById | Int | |
CreatedByUserId | String | |
CreatedByName | String | |
CreatedByKeyword | String | |
CreatedByNulabAccountName | String | |
CreatedByNulabId | String | |
CreatedByNulabAccountUniqueId | String | |
CreatedByRoleType | Int | |
CreatedByLanguage | String | |
CreatedByMailAddress | String |
Returns data from team members table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはTeamId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM TeamMembers WHERE TeamId = 54836
Name | Type | Description |
TeamId | Int | |
Id [KEY] | Int | |
UserId | String | |
Name | String | |
Keyword | String | |
NulabAccountName | String | |
NulabId | String | |
NulabAccountUniqueId | String | |
RoleType | Int | |
Lang | String | |
MailAddress | String |
Returns data from teams table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Teams WHERE Id = 55081
Name | Type | Description |
Id [KEY] | Int | |
Name | String | |
DisplayOrder | Int | |
Members | String | |
Created | Datetime | |
CreatedById | Int | |
CreatedByUserId | String | |
CreatedByName | String | |
CreatedByRoleType | Int | |
CreatedByLang | String | |
CreatedByMailAddress | String | |
Updated | Datetime | |
UpdatedById | Int | |
UpdatedByUserId | String | |
UpdatedByName | String | |
UpdatedByRoleType | Int | |
UpdatedByLang | String | |
UpdatedByMailAddress | String |
Returns the list of stars that user received.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM UserReceivedStars WHERE UserId = 263366
Name | Type | Description |
UserId | String | |
Id [KEY] | Int | |
Comment | String | |
Title | String | |
Url | String | |
Created | Datetime | |
PresenterId | Int | |
PresenterUserId | String | |
PresenterName | String | |
PresenterKeyword | String | |
PresenterRoleType | Int | |
PresenterLanguage | String | |
PresenterMailAddress | String | |
PresenterNulabAccountName | String | |
PresenterNulabId | String | |
PresenterNulabAccountUniqueId | String |
Returns list of issues which the user viewed recently.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Id [KEY] | Int | |
ProjectId | Int | |
IssueKey | String | |
KeyId | Int | |
ParentIssueId | Int | |
Summary | String | |
Description | String | |
StartDate | Date | |
DueDate | Date | |
ActualHours | Decimal | |
EstimatedHours | Decimal |
Returns list of projects which the user viewed recently.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
Id [KEY] | Int | |
ProjectKey | String | |
Name | String | |
DisplayOrder | Int | |
ChartEnabled | Boolean | |
SubtaskingEnabled | Boolean | |
ProjectLeaderCanEditProjectLeader | Boolean | |
UseDevAttributes | Boolean | |
UseWikiTreeView | Boolean | |
TextFormattingRule | String | |
Archived | Boolean |
Returns list of Wikis which the user viewed recently.
Backlog は、このテーブルをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。
Name | Type | Description |
ProjectId | Int | |
Id [KEY] | Int | |
Name | String | |
Content | String | |
Created | Datetime |
Returns user recent updates.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはUserId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM UserRecentUpdates WHERE UserId = 263366 SELECT * FROM UserRecentUpdates WHERE UserId = 263366 AND Type = 3 SELECT * FROM UserRecentUpdates WHERE UserId = 263366 AND Type IN (3, 5)
Name | Type | Description |
UserId | String | |
Id [KEY] | Int | |
Created | Datetime | |
Type | String | |
ContentId | Int | |
Content | String | |
ContentDiff | String | |
ContentKeyId | String | |
ContentDescription | String | |
ContentSummary | String | |
ContentRepository | String | |
ContentAttachments | String | |
ContentSharedFiles | String | |
ContentComments | String | |
ContentChanges | String | |
ContentParties | String | |
ProjectId | Int | |
ProjectKey | String | |
ProjectName | String | |
ProjectDisplayOrder | Int | |
ProjectChartEnabled | Boolean | |
ProjectSubtaskingEnabled | Boolean | |
ProjectProjectLeaderCanEditProjectLeader | Boolean | |
ProjectUseDevAttributes | Boolean | |
ProjectUseWikiTreeView | Boolean | |
ProjectTextFormattingRule | String | |
ProjectArchived | Boolean | |
CreatedById | Int | |
CreatedByUserId | String | |
CreatedByName | String | |
CreatedByKeyword | String | |
CreatedByNulabAccountName | String | |
CreatedByNulabId | String | |
CreatedByNulabAccountUniqueId | String | |
CreatedByRoleType | Int | |
CreatedByLanguage | String | |
CreatedByMailAddress | String |
Returns data from users table.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Users WHERE Id = 54836
Name | Type | Description |
Id [KEY] | Int | |
UserId | String | |
Name | String | |
NulabAccountName | String | |
NulabAccountID | String | |
NulabAccountUniqueId | String | |
RoleType | Int | |
Lang | String | |
MailAddress | String |
Returns history of Wiki page.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPageHistory WHERE WikiPageId = '639459'
Name | Type | Description |
WikiPageId | Int | |
PageId [KEY] | Int | |
Name | String | |
Content | String | |
Version | Int | |
Created | Datetime | |
CreatedById | Int | |
CreatedByUserId | String | |
CreatedByName | String | |
CreatedByKeyword | String | |
CreatedByRoleType | Int | |
CreatedByLanguage | String | |
CreatedByMailAddress | String | |
CreatedByNulabAccountName | String | |
CreatedByNulabId | String | |
CreatedByNulabAccountUniqueId | String |
Returns list of stars received on the Wiki page.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはWikiPageId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPageStars WHERE WikiPageId = '528251'
Name | Type | Description |
WikiPageId | Int | |
CommentId | Int | |
StarId [KEY] | Int | |
Comment | String | |
Title | String | |
Url | String | |
Created | Datetime | |
PresenterId | Int | |
PresenterUserId | String | |
PresenterName | String | |
PresenterKeyword | String | |
PresenterRoleType | Int | |
PresenterLanguage | String | |
PresenterMailAddress | String | |
PresenterNulabAccountName | String | |
PresenterNulabId | String | |
PresenterNulabAccountUniqueId | String |
Returns list of tags that are used in the project.
Cloud は Backlog API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。リクエストを行うにはProjectId が必要です。その他のフィルタはクライアント側でCloud 内部で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM WikiPageTags WHERE ProjectId = '94706'
Name | Type | Description |
ProjectId | Int | |
Id [KEY] | Int | |
Name | String |
ストアドプロシージャはファンクションライクなインターフェースで、Backlog の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにBacklog から関連するレスポンスデータを返します。
Name | Description |
AddStar | Adds star. |
AttachFileToWiki | Attaches file to Wiki. |
LinkSharedFilesToWiki | Links Shared Files to Wiki. |
MarkWatchingAsRead | Mark a watching as read. |
PostAttachmentFile | Posts an attachment file for issue or wiki. |
RemoveProjectIssueType | Delete the Project Issue Type. |
RemoveProjectStatus | Delete the Project Status. |
RemoveSharedFileFromWiki | Removes link to shared file from Wiki. |
UpdatePullRequestCommentInformation | Updates pull request comment information.Authenticated user can update his own comments. |
UpdateSpaceNotification | Updates space notification. |
Adds star.
Name | Type | Required | Description |
IssueId | String | False | Id of the issue. |
CommentId | String | False | Id of the comment. |
WikiId | String | False | Id of the wiki. |
PullRequestId | String | False | Id of the pullRequest. |
PullRequestCommentId | String | False | Id of the pullRequestComment. |
Name | Type | Description |
Success | String | Returns True if procedure succeeded. |
Attaches file to Wiki.
Name | Type | Required | Description |
WikiId | String | True | Id of the issue. |
AttachmentId | String | True | Id of the attachment. You can specify multiple ids separating them by comma ','. |
Name | Type | Description |
Success | String | Returns True if the attachment succeeded. |
Mark a watching as read.
Name | Type | Required | Description |
WatchingId | String | True | Id of the watching. |
Name | Type | Description |
Success | String | Returns True if procedure succeeded. |
Posts an attachment file for issue or wiki.
Name | Type | Required | Description |
FileLocation | String | True | Location of the downloaded file. EX: C:\Temp\downloads\file.txt |
Name | Type | Description |
Success | String | Returns True if the upload succeeded. |
Delete the Project Issue Type.
Backlog allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
EXECUTE RemoveProjectIssueType ProjectId ='123844', Id = '530228', SubstituteIssueTypeId = '530140'
Name | Type | Required | Description |
ProjectId | String | True | ProjectId. |
Id | String | True | Project Issue Type Id. |
SubstituteIssueTypeId | String | True | Project Issue Type Id to change linked issue. |
Name | Type | Description |
Success | String | Returns true if procedure succeeded. |
Delete the Project Status.
Backlog allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison.
For example:
EXECUTE RemoveProjectStatus ProjectId ='123844', Id = '4', SubstituteStatusId = '3'
Name | Type | Required | Description |
ProjectId | String | True | ProjectId. |
Id | String | True | Project Status Id. |
SubstituteStatusId | String | True | Project Status Id to replace linked issues statuses. Issues which status are set to the deleted status will be set to the specied substitute status. |
Name | Type | Description |
Success | String | Returns true if procedure succeeded. |
Updates pull request comment information.Authenticated user can update his own comments.
Name | Type | Required | Description |
ProjectId | String | True | Id of the project. |
RepositoryId | String | True | Id of the repository. |
Number | String | True | Number of the pull request. |
CommentId | String | True | Id of the comment. |
Content | String | True | Content of the comment. |
Name | Type | Description |
Success | String | Returns True if procedure succeeded. |
Updates space notification.
Name | Type | Required | Description |
Content | String | True | Content of the update. |
Name | Type | Description |
Success | String | Returns True if the update succeeded. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Backlog のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
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 | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Issues テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Issues'
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 などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、AddStar ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddStar' 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 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Issues テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Issues'
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:backlog: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 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
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、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
URL | Backlog アカウントのURL。 |
AuthScheme | Backlog に接続する際に使用する認証の種類。 |
ApiKey | API キーを使用すると、Backlog API へのリクエストを行うことができます。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
IncludeCustomFields | 課題テーブルからカスタムフィールドを取得する場合は、True に設定します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
MaxThreads | 最大スレッド数。 |
Pagesize | Backlog から返されるページあたりの結果の最大数。 |
ProjectId | 特定のプロジェクトのId。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
URL | Backlog アカウントのURL。 |
AuthScheme | Backlog に接続する際に使用する認証の種類。 |
ApiKey | API キーを使用すると、Backlog API へのリクエストを行うことができます。 |
Backlog アカウントのURL。
string
""
"https://{sample}.backlog.com" 形式のBacklog アカウントのURL。
Backlog に接続する際に使用する認証の種類。
string
"APIToken"
API キーを使用すると、Backlog API へのリクエストを行うことができます。
string
""
API リクエストにAPI キーを追加してアカウントからデータを返します。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 プロパティの全リストを提供します。
プロパティ | 説明 |
IncludeCustomFields | 課題テーブルからカスタムフィールドを取得する場合は、True に設定します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
MaxThreads | 最大スレッド数。 |
Pagesize | Backlog から返されるページあたりの結果の最大数。 |
ProjectId | 特定のプロジェクトのId。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
課題テーブルからカスタムフィールドを取得する場合は、True に設定します。
bool
false
True に設定すると、ProjectId 接続プロパティも必須となります。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
最大スレッド数。
string
"1"
Backlog から返されるページあたりの結果の最大数。
int
100
Pagesize プロパティは、Backlog から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
特定のプロジェクトのId。
string
""
特定のプロジェクトのId。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。